Dataiku DSSInstall

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Plugin resource and the Get Plugin Settings operation, it retrieves the configuration settings of a specified plugin within the Dataiku DSS environment.

Common scenarios where this node is beneficial include:

• Automating the retrieval of plugin configurations for auditing or monitoring purposes.
• Integrating plugin settings retrieval into larger workflows that manage or deploy plugins programmatically.
• Fetching plugin settings as part of troubleshooting or validation steps in CI/CD pipelines involving Dataiku DSS plugins.

Example use case:

• A user wants to automatically fetch and log the current settings of a plugin before performing an update or deployment, ensuring they have a backup or audit trail of the existing configuration.

Properties

Note: The provided input properties JSON only includes "Plugin ID" relevant to many plugin-related operations, including "Get Plugin Settings".

Output

The output of the node is a JSON object representing the settings of the specified plugin as returned by the Dataiku DSS API.

• The json field contains the plugin settings data structure, which typically includes configuration details such as plugin metadata, version, dependencies, and other plugin-specific settings.
• If the operation involves downloading files (not applicable here), binary data would be returned; however, for "Get Plugin Settings", the output is purely JSON.

Example output snippet (conceptual):

{
  "pluginId": "example-plugin",
  "name": "Example Plugin",
  "version": "1.0.0",
  "description": "A sample plugin description",
  "settings": {
    // plugin-specific configuration fields
  }
}

Dependencies

• Requires an active connection to a Dataiku DSS instance.
• Requires valid API credentials (an API key) for authenticating requests to the Dataiku DSS API.
• The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
• No additional external services or environment variables are required beyond the API credentials.

Troubleshooting

• Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing Dataiku DSS API credentials. Ensure the API key credential is properly configured.
• Required Parameter Missing: The node validates required parameters such as Plugin ID. If these are missing, it throws descriptive errors like "Plugin ID is required".
• API Request Failures: Network issues, incorrect server URLs, or insufficient permissions can cause API request failures. Check connectivity, verify the API key permissions, and ensure the plugin ID exists.
• Unexpected Response Format: If the API returns non-JSON or unexpected data, parsing errors may occur. This usually indicates an issue with the API endpoint or response content.

Links and References

• Dataiku DSS API Documentation
• Dataiku DSS Plugins Guide
• n8n Documentation - Creating Custom Nodes

This summary focuses on the "Plugin" resource and the "Get Plugin Settings" operation as requested, based on static analysis of the provided source code and input property definitions.