Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

Actions364

Overview

This node integrates with the Dataiku DSS API to perform various operations related to security management, specifically including updating code environment packages within a DSS instance. It allows users to interact programmatically with DSS resources such as code environments, users, groups, and other security-related entities.

The "Update Code Env Packages" operation under the "Security" resource updates the packages installed in a specified DSS code environment. This is useful for maintaining or upgrading the software dependencies of code environments used in DSS projects, ensuring that the environments have the required libraries and versions for execution.

Common scenarios:

  • Automating package updates in DSS code environments after adding new dependencies.
  • Synchronizing code environment packages across multiple DSS instances.
  • Integrating package update workflows into CI/CD pipelines for DSS projects.

Practical example:
A data engineer wants to update the Python packages in a DSS code environment named "my-env" to include the latest versions of pandas and numpy. Using this node, they can trigger the update operation with the appropriate parameters, automating the process without manual intervention in the DSS UI.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to customize the API request. Includes many possible keys such as active, allUsers, archivePath, codeEnvName, deletionMode, forceRebuildEnv, includeLibs, limit, name, versions, wait, and many others. For this operation, relevant parameters would typically include codeEnvName (the name of the code environment to update), forceRebuildEnv (boolean to force rebuilding the environment), and wait (boolean to wait for the operation to complete).
Resource Fixed to "Security" for this context.
Operation Fixed to "Update Code Env Packages" for this context.

Note: The full list of query parameters is extensive and generic for many operations; for this specific operation, the key parameters are those related to identifying the code environment and controlling the update behavior.

Output

The node outputs the response from the Dataiku DSS API call:

  • If the response is JSON, it returns it as a JSON object in the json output field.
  • If the response includes binary data (not typical for this operation), it would be returned as binary data prepared by the node.
  • For this operation, the output will typically be a JSON object indicating the status or result of the package update request, such as success confirmation or details about the updated environment.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires credentials providing:
    • The DSS server URL.
    • An API authentication token (user API key) with sufficient permissions to update code environments.
  • No additional external services are needed beyond the Dataiku DSS API.
  • The node uses HTTP requests to communicate with the DSS REST API.

Troubleshooting

  • Missing Credentials Error: The node throws an error if the required API credentials are not provided. Ensure that the API key and DSS server URL are correctly configured in n8n credentials.
  • Required Parameter Missing: The node validates required parameters like codeEnvName. If missing, it throws an error specifying which parameter is required.
  • API Request Failures: Errors from the DSS API (e.g., permission denied, invalid environment name) will be surfaced as node errors with messages from the API. Check the API key permissions and the correctness of parameters.
  • Timeouts or Long Operations: Updating code environment packages may take time. Use the wait parameter to control whether the node waits for completion or returns immediately.
  • Unexpected Response Format: If the API returns non-JSON or unexpected data, the node attempts to parse it but may return raw text or binary data.

Links and References

This summary focuses on the "Security" resource and the "Update Code Env Packages" operation, describing how the node constructs the API request, handles input properties, and processes the output accordingly.

Discussion