Skip to content

Manage Deployment Tracks for Choreo Components

Choreo allows you to create and manage dedicated deployment tracks for components, facilitating independent version control and deployment. This capability also allows you to unlink deployment tracks from associated branches or relink them to different branches so that you can align with your preferred Git workflows, such as the feature branch workflow or GitFlow workflow.

Info

Deployment track creation and management does not apply to API Proxy and BYOI components.

Create a deployment track

Prerequisites:

  • Create a component in Choreo.

Follow the steps below to create a deployment track for a component:

  1. Sign in to the Choreo Console.
  2. In the Component Listing pane, click on the component you want to create a deployment track for.
  3. On the header of the component overview page, click the Deployment Track drop-down list.
  4. Click + Create New to open the Create Deployment Track dialog.
  5. In the Create Deployment Track dialog, do the following:
    1. Select a branch to associate with the deployment track.
    2. Optionally, specify a description for the deployment track.
    3. To create a deployment track for a service component, specify a unique API version indicating the major and minor version numbers.
  6. Click Create.

If you want to detach a branch reference from a deployment track, you must unlink the branch.

Info

When you unlink the branch of a deployment track, the active deployments are unaffected. However, while you can redeploy the existing deployment, you cannot perform a new deployment.

Follow the steps below to unlink a deployment track of a component:

  1. Sign in to the Choreo Console.
  2. In the Component Listing pane, click on the component for which you want to unlink a deployment track.
  3. On the header of the component overview page, click the Deployment Track drop-down list and then click View All. This takes you to the component settings page where you can see all the deployment tracks linked to the component.
  4. Click the edit icon corresponding to the deployment track you want to unlink.
  5. In the Edit Branch dialog that opens, click the Branch Name list and select None.
  6. Click Save.

To associate a branch reference to an unlinked deployment track, you must link a branch.

Info

To build and deploy the contents of the linked branch, you must perform a manual build and deploy.

Prerequisites:

  • A minimum of two branches in your GitHub repository.

Follow the steps below to link a branch to an unlinked deployment track:

  1. Sign in to the Choreo Console.
  2. In the Component Listing pane, click on the component you want to associate a branch reference for.
  3. On the header of the component overview page, click the Deployment Track drop-down list and then click View All. This takes you to the component settings page where you can see all the deployment tracks linked to the component.
  4. Click + Link Branch corresponding to the unlinked deployment track for which you want to associate a branch.
  5. In the Link Branch dialog that opens, click the Branch Name list and select the branch you want to relink.
  6. Click Save.

To switch the branch reference of a linked deployment track, you must relink to an appropriate branch.

Info

If you unlink the existing branch of a deployment track and link a different branch, you must perform a manual build and deploy to build and deploy the contents of the recently linked branch.

Prerequisites:

  • A minimum of two branches in your GitHub repository.

Follow the steps below to switch the branch reference of a linked deployment track:

  1. Sign in to the Choreo Console.
  2. In the Component Listing pane, click on the component you want to relink a deployment track for.
  3. On the header of the component overview page, click the Deployment Track drop-down list and then click View All. This takes you to the component settings page where you can see all the deployment tracks linked to the component.
  4. Click the Edit Branch icon corresponding to the deployment track you want to relink.
  5. In the Edit Branch dialog that opens, click the Branch Name list and select the branch you want to relink.
  6. Click Save.

Now that you understand how to create and manage deployment tracks for components, let’s explore a sample scenario to see how a developer can use deployment tracks to manage version releases in Choreo.

Sample Scenario: Manage version releases with deployment tracks

Let’s consider the following version release scenario:

  • To initiate work on a new feature, a developer creates a new branch, named feature-x from either the main or dev branch.
  • Once development is complete, the developer proceeds to merge the feature-x branch into the dev branch for testing.
  • Upon successful testing in the dev branch, the developer proceeds to merge all the changes into the main branch for production deployment.

Following are the actions you need to take from a deployment track perspective to manage the version release:

  1. To prepare for the new version release, unlink the main branch from the associated deployment track (let’s consider this as the deployment track 1).
  2. Proceed to merge the dev branch containing the tested changes into the main branch.
  3. Unlink the dev branch from the associated deployment track (let’s consider this as deployment track 2).
  4. Link deployment track 2 containing the latest version of the service to the main branch for deployment.
  5. To facilitate ongoing development and testing, create another deployment track (let’s consider this as deployment track 3) and link it to the dev branch.

Tip

  • As a developer, you can strategically unlink and relink deployment tracks to effectively manage different versions of your services within Choreo.
  • You can create new deployment tracks for ongoing development branches like dev to ensure a continuous development and release cycle.

Delete a deployment track

If you no longer need a deployment track, you can delete it.

Note

If the component exposes an endpoint or proxy and you want to delete the last version in the major version range, the recommended approach is to retire that version first. This allows consumers to transition to the next major version and prevents a sudden break in their experience. For example, if you have deployment tracks for v1.0 and v2.0, notify consumers to switch to v2.0 before deleting v1.0. Then, retire the APIs in v1.0 and proceed to delete the associated deployment track.

Prerequisites:

  • At least 2 deployment tracks in a component.

Follow the steps below to delete a deployment track:

  1. Sign in to the Choreo Console.
  2. In the Component Listing pane, click on the component for which you want to delete a deployment track.
  3. On the header of the component overview page, click the Deployment Track drop-down list.
  4. Click + View All. This takes you to the component settings page where you can see all the deployment tracks linked to the component.
  5. Click the Delete icon corresponding to the deployment track you want to delete.
  6. Click Delete to confirm the deletion.