Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

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 Pull From Git Remote operation, it allows pulling (and rebasing) the content of a plugin from a previously-declared git remote repository. This is useful for synchronizing local plugin code with the latest changes from a remote Git repository, facilitating collaborative development and version control of plugins within Dataiku DSS.

Common scenarios include:

  • Keeping a plugin up-to-date with the latest code changes pushed by team members.
  • Automating plugin updates as part of CI/CD pipelines.
  • Managing plugin versions and ensuring consistency between local and remote repositories.

Example use case:

  • A developer wants to update a plugin in Dataiku DSS with the latest commits from its Git remote. Using this node operation, they can pull and rebase the plugin's content automatically without manual intervention.

Properties

Name Meaning
Plugin ID The unique identifier of the plugin to operate on. Required for all plugin-related actions.

Note: The provided input properties JSON only includes "Plugin ID" relevant to the Plugin resource operations.

Output

The node outputs data in JSON format or binary data depending on the operation:

  • For the Pull From Git Remote operation, the output will be JSON containing the response from the Dataiku DSS API about the pull operation status or result.
  • If the operation involves downloading files (not applicable here), the node would output binary data representing the downloaded file.
  • In case of textual responses like logs, the output JSON contains a logs field with the log content.

The output structure generally reflects the raw API response from Dataiku DSS, which may include details such as success status, messages, or error information.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs valid credentials including the DSS server URL and a user API key for authentication.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API.
  • No additional external services are required beyond the Dataiku DSS API access.

Troubleshooting

  • Missing Credentials Error: The node throws an error if the Dataiku DSS API credentials are not set or invalid. Ensure that the API key and server URL are correctly configured.
  • Required Parameter Missing: The node validates required parameters such as Plugin ID for plugin operations. Missing these will cause errors. Provide all mandatory fields.
  • API Request Failures: Network issues, incorrect URLs, or insufficient permissions can cause API call failures. Check network connectivity, API endpoint correctness, and user permissions in Dataiku DSS.
  • Unexpected Response Format: If the API returns unexpected data, parsing errors might occur. Verify the API version compatibility and response formats.
  • Operation Not Supported: Using an unsupported operation or resource combination will throw an error indicating unknown resource or operation.

Links and References


This summary focuses on the Plugin resource and the Pull From Git Remote operation as requested, based on static analysis of the provided source code and property definitions.

Discussion