IBM Cloud Docs
Deploying a new version of a deployable architecture

Deploying a new version of a deployable architecture

This tutorial walks you through updating a deployable architecture configuration in a project to a new version with minimal downtime. When a new version of a deployable architecture is made available, you don't need to undeploy anything. You can edit the deployable architecture configuration in your project to use the new version, configure any new inputs, and then deploy the changes.

Imagine you are a software developer for Example Corp enterprise. Your infrastructure architect discovered the Cloud automation for Code Engine deployable architecture and your cloud automation engineering professional customized it to fully meet your business needs. You deployed that customized architecture to two regions. However, that deployable architecture is now updated to a new version in your private catalog. You want to take advantage of the latest version of the deployable architecture, so you need to update your project and deploy the changes.

This tutorial uses a fictitious scenario to help you understand how to update a deployable architecture configuration in your project when a new version of the architecture is made available to you. As you complete the tutorial, adapt each step to match your organization's needs.

Before you begin

  1. Create a customized deployable architecture called Example Corp's infrastructure and onboard it to a private catalog called Example Corp catalog.
  2. Deploy Example Corp's infrastructure to two regions by using a project called Example Corp infrastructure.
  3. Update Example Corp's infrastructure with a new version in the private catalog and add two database options that your users can choose from.
  4. Understand that completing this tutorial might result in costs to your account. Cloud automation for Code Engine was customized to create Example Corp's infrastructure. For more information about associated costs for using Code Engine, go to Pricing for Code Engine. The latest version of Example Corp's infrastructure includes two database options that are deployed as a part of this tutorial. The Summary panel in the catalog listing includes an estimated cost for deploying the architectures:
    1. Cloud automation for Databases for Elasticsearch catalog listing.
    2. Cloud automation for Databases for PostgreSQL catalog listing.

Now, you're ready to update the configurations in your Example Corp infrastructure project so you can deploy the latest version of Example Corp's infrastructure to the two regions that you previously deployed to.

Updating configurations in your project

First, update the configurations in your project to use the latest version of Example Corp's infrastructure that was recently made available to you. Complete the following steps:

  1. In the IBM Cloud console, click the Navigation menu icon Navigation Menu icon > Projects.
  2. Click Example Corp infrastructure to open the project.
  3. Click Configurations.
  4. Click the Options icon Options icon for example-corp-us-south > Edit.
  5. In the Details section, the Version menu displays an alert that a new version of Example Corp's infrastructure is available. Select 0.0.2 from the menu.
  6. Click Change notices to view information about the latest version. Close the panel when you're done.
  7. Click Save.

Repeat the steps but this time, edit example-corp-us-east to use version 0.0.2 of the deployable architecture.

Selecting a database option to use for each deployment

Based on the change notice, you know that version 0.0.2 of Example Corp's infrastructure includes two optional databases that you can choose between. Now that the deployable architecture configurations are updated to use the latest version from your private catalog, select which database option you want to use with each configuration. Complete the following steps:

  1. From the Example Corp infrastructure project, select Configurations.

  2. Click the Options icon Options icon for example-corp-us-south > Customize architecture.

  3. Select Cloud automation for Databases for PostgreSQL to add it to your project and click Save.

  4. Click the Options icon Options icon for example-corp-us-south > Validate.

    If the validation fails, you can troubleshoot the failure. Or, an administrator on the IBM Cloud Projects service can review the results through the Schematics service and override the failure and approve the configuration to deploy anyway. However, make sure that the pipeline failed due to the Code Risk Analyzer scan and not because of a validation or plan failure. It is not recommended to override a failure that is flagged due to a validation or plan failure as the configuration cannot deploy successfully. For more information about security and compliance in projects, see Achieving continuous compliance as an enterprise.

  5. Repeat the steps for example-corp-us-east, but this time, select Cloud automation for Databases for Elasticsearch as the database to add to your project.

During the configuration and deployment process, monitor your Needs attention items. The widget reflects any issue that occurs in your configurations.

Approving and deploying changes

It can be beneficial to deploy your first configuration to make sure that your changes work as expected. Then, if the deployment is successful, you can continue to deploy your second configuration.

You must address any outstanding Needs attention items on the Overview tab before you can approve and deploy your configurations.

  1. From the Example Corp infrastructure project, select Configurations.
  2. Click example-corp-us-south > View details to view the last validation and approve the changes.
  3. Add a comment with more details about the approval, and click Approve.
  4. Click Deploy and wait for the deployment to finish.
  5. Repeat the steps, but this time, approve and deploy example-corp-us-east.

Next steps

Your running deployments are now updated to use the latest version of your deployable architecture. If you need to revert the deployments to the previous version, you can do so by using the CLI. For more information, go to rolling back an update.