Concept | API deployer#

Watch the video

Once an API service has been designed and is ready for deployment to an API node, the deployment is accomplished by using the API services component of the Dataiku Deployer (which we refer to as the API Deployer).

API Deployer#

The Dataiku Deployer is accessible from any project in the Design or Automation node, and it consists of a Project Deployer and an API Deployer.

Image showing the Dataiku Deployer's components.

Using the API Deployer, you can:

  • Define API infrastructures, with each infrastructure pointing to an already-installed API node or to a Kubernetes cluster.

  • Deploy new API services on one or more of these infrastructures.

  • Monitor the health and status of your API nodes.

  • Manage the lifecycle of your APIs from development to production. Given that all API services are versioned in the API Deployer, you can roll back to previous versions of an API service at any time.

Deployer set-up and architecture#


An administrator will be responsible for configuring the Deployer as needed. The reference documentation covers Setting up the Deployer in detail, but we’ll briefly cover some key points about the Deployer in this lesson.

There are two modes of installing the Deployer:

  • Local Deployer. When your infrastructure has a single Design or Automation node that you will use to create API services and/or projects, the Deployer can be part of this Design or Automation node itself. This way, no additional setup is required.

  • Standalone (or remote) Deployer. When your infrastructure includes multiple Design and/or Automation nodes that you will use to create API services and/or projects, you can install a separate Dataiku node which will act as the centralized Deployer for all your Design and Automation nodes.

Image showing the modes for installing the Deployer.

Furthermore, each deployment infrastructure can either be:

  • A Static infrastructure, that is, a set of pre-deployed API nodes that the API Deployer manages.

  • A Kubernetes infrastructure, in which case the API Deployer dynamically creates containers in your Kubernetes cluster to run the API node server.

These deployment infrastructures are organized into Lifecycle Stages (like “Development”, “Test”, and “Production”) that organize how your various deployments will be shown.

Image showing the deployment lifecycle stages.

What’s next?#

Now that you’ve had an introduction to the basics of the API Deployer in Dataiku, follow Tutorial | Real-time API basics for practical experience.