Deployments Quickstart

In this tutorial, we'll be using the Blackbird CLI to deploy our code to a dedicated environment.

Before you get started

This tutorial assumes you have already have the Blackbird CLI installed and have an entry in our API catalog. If not, please download the Blackbird CLI by following the Getting Started guide and follow the API Quickstart Guide, Mocking Quickstart Guide, and Code Quickstart Guide. If you haven't done those already, you should do so now.

Once we have the Blackbird CLI downloaded, an entry in our API catalog and a generated project, we can look to deploy our project to a dedicated environment.

1. Creating a Deployment

Now that we have a debugged and generated code project, we can use the deployment create command to override the mocked URL.

Once the command is finished running, we should notice that our existing mocked URL has been used again with the containerized API code. This command is similar to code run, but instead of running locally, everything is deployed within a Blackbird environment.

2. Testing our Deployment

Now that we have a deployed simple-api project, we can double-check the status of the deployment and curl to the mocked URL.

Additionally, we can view the logs of the API with the addition of the --logs flag.

We should see our curled GET request now appearing in the Application logs.

Deployments can be used to replace mocks or run separately if a new name is provided. In the quickstart, we replaced our existing mock.

3. Next Steps

At this point you should have a good understanding of all the various Blackbird functionality and how Blackbird can help you accelerate your API development process. Please feel free to checkout other documentation such as how to secure your instances and our user management guide.