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 Dataiku DSS resources. Specifically for the Security resource and the Create Code Env operation, it allows users to create a new code environment within Dataiku DSS. This is useful for managing isolated environments where code dependencies are installed and executed, ensuring reproducibility and separation of concerns in data science projects.

Common scenarios include:

  • Automating the creation of Python or R code environments for different projects.
  • Managing multiple code environments programmatically as part of CI/CD pipelines.
  • Integrating environment setup into larger workflows that provision or configure Dataiku DSS projects.

Example use case:

  • A user wants to create a new Python 3.8 environment named "py38_env" to run specific recipes with custom packages. This node can be configured to call the API to create this environment automatically.

Properties

Name Meaning
Env Lang The programming language of the code environment to create (e.g., "python", "r").
Env Name The name identifier for the new code environment to be created.
Request Body JSON object containing additional parameters or configuration details for the environment.

Output

The output is a JSON object representing the response from the Dataiku DSS API after attempting to create the code environment. It typically includes details about the newly created environment such as its ID, name, language, status, and other metadata returned by the API.

If the operation involves downloading files or binary content (not applicable for this operation), the node would output binary data accordingly, but for creating a code environment, the output is purely JSON.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs an API key credential for authentication with 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 are required beyond the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the API key or server URL is not set, the node will throw an error indicating missing credentials. Ensure the API key credential is properly configured.
  • Required Parameters Missing: The node validates that both Env Lang and Env Name are provided. Omitting these will cause errors. Provide valid values for these properties.
  • API Errors: If the Dataiku DSS API returns an error (e.g., environment name already exists, invalid language), the node will throw an error with the message from the API. Check the API documentation and ensure parameters are correct.
  • Network Issues: Connectivity problems to the Dataiku DSS server will result in request failures. Verify network access and server availability.

Links and References


This summary focuses on the Security resource's Create Code Env operation based on the provided source code and property definitions.

Discussion