Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

The "Upload Bundle" operation of the Project Deployer resource in this node allows users to upload a project bundle to an existing project on a Dataiku DSS instance via its API. This is useful for automating deployment workflows where project bundles (which may contain code, configurations, and data) need to be programmatically uploaded to a deployment environment.

Typical scenarios include:

  • Automating continuous integration/continuous deployment (CI/CD) pipelines by uploading updated project bundles.
  • Managing multiple project deployments from external systems or orchestrations.
  • Integrating Dataiku project deployment into broader automation workflows.

For example, a user might export a project bundle from a development environment and then use this node to upload it to a production deployment project automatically.

Properties

Name Meaning
Query Parameters Optional key-value pairs appended as query parameters to the API request URL. Various options are available such as active, archivePath, deletionMode, dropData, exportAnalysisModels, forceRebuildEnv, includeLibs, limit, name, wait, etc. These control specific behaviors of the upload or other API calls.
File The binary file content representing the bundle to upload. This is used when the operation requires sending a file stream (e.g., uploading a bundle archive).
Project Key The identifier of the target project to which the bundle will be uploaded. This is required to specify the destination project.
Bundle ID Identifier of a bundle, used in some operations related to bundles but not specifically required for upload unless referencing an existing bundle.
Request Body JSON object containing additional data to send in the body of the API request. For upload, this can include metadata or configuration details relevant to the bundle upload.

Note: The full list of query parameter options is extensive and includes booleans, strings, numbers, and flags that influence how the upload or other API calls behave.

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 is a downloadable file (binary), such as a bundle archive or documentation, it returns the binary data prepared for further use or saving.
  • If the response is plain text logs, it returns them under a logs JSON property.
  • If no content is returned (HTTP 204), it outputs a status message indicating no content.

This flexible output handling allows downstream nodes to process either metadata responses or binary files depending on the operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance with a valid API key credential.
  • The node expects the base URL of the DSS server and a user API key for authentication.
  • The node uses HTTP requests to interact with the Dataiku DSS REST API endpoints.
  • For file uploads, it uses multipart form-data encoding.
  • No additional external services beyond the Dataiku DSS API are required.

Troubleshooting

  • Missing Credentials: The node throws an error if the required API credentials are missing. Ensure you have configured the API key credential properly.
  • Required Parameters Missing: Many operations require specific parameters like Project Key, Bundle ID, or Deployment ID. Errors will indicate which parameter is missing. Provide all required inputs.
  • Invalid URLs or Endpoints: If the constructed API endpoint URL is incorrect due to missing or wrong parameters, the API call will fail. Double-check input values.
  • File Upload Issues: When uploading bundles, ensure the file binary data is correctly provided and accessible.
  • API Errors: Any errors returned by the Dataiku DSS API are wrapped and reported with messages including the original error message and stack trace if available.
  • Timeouts or Network Issues: Network connectivity problems to the DSS server will cause request failures. Verify network access and server availability.

Links and References

This summary focuses on the "Upload Bundle" operation within the Project Deployer resource, describing its purpose, inputs, outputs, dependencies, and common troubleshooting points based on static analysis of the node's source code and provided properties.

Discussion