Using Clients to Deploy Builds

Understanding the OpComm Client Builds window

The OpComm Client Builds window allows you to:

• Create new clients

• View existing clients and their associated builds

• Deploy new builds with existing clients

Creating a New Client

1. Under New Client, specify the following:

   • Name – Type the name of the new client, such as stage. Special characters are not supported.

   • Subscription – Specify where to create the infrastructure, either a production environment or a staging environment.

   • Region – Specify the region where you want to deploy the infrastructure and the build.

2. Click Create.

   The new client name is available in the Clients list.

You cannot edit a client once you create it, but you can delete it and create a new one. See Deleting a Client.

Viewing a Client's Deployment Details

In the Clients list, select a client. The selected client displays the following information:

• Versions – To see the currently deployed version of the build, click View.

  

  A pop-up window displays a list of all previously deployed versions, with the most recent one highlighted at the top.

If the client has not deployed a build yet, this list will be empty.

• Subscription – The environment to which the client deploys the infrastructure.

• Region – The region where the client deploys the infrastructure and the build.

Deploying a Build

1. In the Clients list, select the client you want to use to deploy a build.

2. Click the Version dropdown, and then select the build version you want to deploy.

3. Click Install All.

4. On the confirmation message, click Yes.

The version names are the tags created in GitHub. To make sure you see the latest updates, click Refresh at the top of the window. See Creating New Build Versions.

The installation then performs the following steps:

• Creates the infrastructure and the build for all the app services and the function app.

• Deploys app services and the function app.

• Runs the SQL script associated with the tag in the repository.

• Integrates the Azure function and API management.

• Creates the Couchbase infrastructure.

If an exception occurs, the installation stops and the log displays a detailed exception message. When the exception is resolved in the code, click Install All for the same version. The installation starts over and updates or repairs anything that was created during the previous attempt.

Deleting a Client

1. In the Clients list, select a client.

2. Click Delete.

Client Naming Conventions

[Under discussion.]

Creating New Build Versions

1. Go to GitHub.

2. Under the OpComm repo tree, go to Tags.

3. Click New tag.

4. On the Create a tag window, specify the following:

   • Name – This is the name that will be available in the Version dropdown on the OpComm Client Builds window.

   • Based on – The branch on which to base the tag.

5. Click Create.

   The new tag is now available as a version to deploy on the OpComm Client Builds window.