Creating Deployment Instances with Blackbird

The API Deployment Feature is a robust solution aimed at enhancing the development and quality assurance processes by providing a dedicated non-production environment. This feature enables teams to test, validate, and collaborate on APIs without affecting the production environment. Prerequisite includes having an API in your organization’s catalog.

Create a new Deployment

To create a new deployment, run the deployment create command with your Dockerfile and context provided as arguments. If you have an existing Mock associated with a given name, you'll be prompted to delete it before proceeding.

Note: At this time deployments can only accept traffic on port 80. Due to this limitation, your application must listen on this port.

You can also associate a deployment with an existing API by passing the --api-name or --spec-path flag.

or

Delete a Deployment

To delete a running deployment, you can run the deployment delete command to remove it.

Deployment Status

To check the status of a running deployment, you can run the deployment status command.

Deployment Status with Application Logs

To check the status of a running deployment and see the application logs, you can run the deployment status command with the logs argument.

List Deployments

To list the running deployments, you can run the list command with the live deployment argument.

Secure a Deployment

By default the deployment endpoints are available to the public. In order to secure these endpoints we can use APIKeys. We can also create and set an APIKey on creation with the --apikey-header flag.