Onboarding your deployable architecture by using a Visual Studio Code extension
You can onboard your deployable architecture by using the IBM Cloud Deployable Architecture Builder Visual Studio Code extension. Using the extension autogenerates materials that are required and it can avoid or minimize issues where a separate configuration is made each time the user runs validation through the catalog. The extension helps you to easily onboard your deployable architecture to your private catalog and a project.
Before you begin
Before you can onboard your deployable architecture, be sure that you complete the following prerequisites.
- Download Visual Studio Code
- Verify that you're using a Pay-As-You-Go or Subscription account. See Viewing your account type for more details.
- Verify that you have the required access to work with private catalogs and deployable architectures.
- Manager role on the IBM Cloud Schematics service
- Editor role on the Catalog Management service
- Viewer role on all resource groups in your account
- SecretsReader role on the Secrets Manager service if you plan to store your secure values in an instance of Secrets Manager
- Reader role on the Security and Compliance Center service
- Other roles that are required for specific resources in your customized deployable architecture.
- Ensure that you have the source code for your deployable architecture stored in a GitHub. For help with getting your source code into a repository, see Setting up your source code repository.
- A Terraform module in a public or private GitHub repository that is cloned to a local folder. For experimentation, you can make a fork of this sample Terraform module. If your repository is
private, you need a personal access token with
repo
andread:user
permissions.
Getting the VS Code extension
To get the extension, open VS Code, go to Extensions, search for and select IBM Cloud Deployable Architecture Builder to download. After you download, you can follow the walkthrough to get started or use the
following steps. If the walkthrough doesn't automatically open, you can use the command palette. Go to View > Command Palette. Search for Walkthrough
, click Welcome: Open Walkthrough..., then
select Get started with IBM Cloud Deployable Architecture Builder.
Onboarding your deployable architecture
The first time that you validate your deployable architecture, you go through the steps for onboarding it to IBM Cloud. Use the following steps to onboard your deployable architecture:
- Log in to your IBM Cloud account.
- To log in to your account, click View and select Command Palette.
- In the search field, search for
IBM Cloud - Log in
. - Select IBM Cloud - Log in and log in with an API key, federated ID, or username and password.
- (Optional) You can change your login environment. Click View, select Command Palette, search for
IBM Cloud - Log in
, and select IBM Cloud - Log in > Change login environment. From the menu, select Production or Staging.
- Make sure that you're logged in to GitHub from VS Code.
- Select the
> Sign in to Sync Settings.
- Select your account.
- Click Authorize Visual-Studio-Code.
- Select the
- Clone your repo and add it to a VS Code workspace.
- Clone your deployable architectures repo from GitHub.
- To add it to your workspace within VS Code, click File > Add folder to workspace..., then select the repo from your files.
- Add the catalog manifest files to the Terraform module.
- To add the catalog manifest, right-click the module folder in your workspace.
- Select IBM Cloud > Add deployable architecture manifest files.
- Onboard and validate your deployable architecture.
- Right-click the
ibm_catalog.json
file, and select IBM Cloud > Validate a deployable architecture on IBM Cloud. - Select the repo branch. Or you can click + and enter the name of a new one that will be created.
- Select an existing private catalog. Or you can click + and enter the name of a new one that will be created.
- Enter the offering version.
- Select an existing project. Or you can click + and enter the name of a new one that will be created for you.
- Enter your IBM Cloud API key for the account where resources will be deployed.
- Enter the relative path for the architectural diagram. If you don't have a diagram, a placeholder is provided.
- (Optional) If the GitHub repository is private or in GitHub Enterprise, enter your personal access token.
- The YAML inputs file is opened. Edit the values under the
inputs
property and save the file. - Click Continue
- Right-click the
When validation begins, an Output channel is opened that shows the validation logs. If it does not, in the Output view, select the DA Validation
channel from the menu. Validation can take several minutes to complete.