Skip to main contentIBM Garage for Cloud

Install with the toolkit on IBM Cloud VPC infrastructure

Steps to prepare an environment using the Cloud-Native Toolkit for new IBM Cloud-managed clusters running on VPC infrastructure or existing IBM Cloud-managed clusters running on classic or VPC infrastructure.

See the following for instructions on how to provision new IBM Cloud-managed clusters running on classic infrastructure

One of the features of the IBM Cloud Catalog is support for private catalog tiles. These can contain custom Terraform definitions that can accelerate SRE teams in the execution of common and repetitive tasks. The Cloud-Native Toolkit tools installation can be configured as a private catalog tile. This is the recommended approach for using this asset multiple times. This asset enables the easy transition of a default cluster into a cluster that supports Cloud-Native CI/CD development tools.

A. Create the catalog

  1. Log in to the IBM Cloud Console
  2. Click Manage->Catalogs from the top menu
  3. Click on Create Catalog
  4. In the Create a catalog dialog, provide the following values:
    • name: the name of the catalog, for example Team Catalog
    • description: (optional) a brief description of the purpose of the catalog
    • products: select Start with no products
    • resource group: click Update to change the default resource group for the catalog
  5. Click Create to complete the catalog creation

B. Register the Cloud-Native Toolkit tiles in the catalog

  1. Download from the latest Iteration Zero release and make the file executable

    LATEST_RELEASE=$(curl -sL | jq -r '.tag_name')
    curl -OL "${LATEST_RELEASE}/"
    chmod +x
  2. Run the scripts passing in the API Key and the name of the catalog that you created

    ./ {API_KEY} "Team Catalog"

C. Apply the tile

Once the tile has been installed it can be used repeatedly to set up clusters with the CNCF tools. Each time the tile is applied, a set of configuration variables are required.

  1. Log in to the IBM Cloud Console.

  2. Select Catalog from the top menu.

  3. From the side menu, select your catalog from the drop-down list (e.g. Team Catalog). (IBM Cloud catalog should be selected initially.)

  4. Click Private on the side menu to see the private catalog entries

  5. Click on the Cloud-Native Toolkit tile

  6. Enter values for the variables list provided.

    VariableDescriptioneg. Value
    ibmcloud_api_keyThe API key from IBM Cloud Console that has ClusterAdmin access and supports service creation{guid API key from Console}
    resource_group_nameExisting resource group in the account where the cluster has been createddev-team-one
    regionThe region where the cluster has been provisionedus-east, eu-gb, etc
    cluster_existsFlag indicating if the cluster already exists. (false means the cluster should be provisioned)true or false
    vpc_clusterFlag indicating that the cluster has been built on VPC infrastructuretrue or false
    vpc_zone_namesA comma-separated list of the VPC zones that should be used for worker nodes. This value is requored if cluster_exists is set to false and vpc_cluster is set to trueus-south-1 or us-east-1,us-east-2
    cluster_nameThe name of the cluster (If cluster_exists is set to true then this name should match an existing cluster)dev-team-one-iks-117-vpc
    cluster_typeThe type of cluster into which the toolkit will be installedkubernetes, ocp3, ocp4 or ocp44
    registry_namespaceThe namespace that should be used in the IBM Container Registry. If not provided the value will default to the resource group namedev-team-one-registry-2020
    provision_logdnaFlag indicating that a new instance of LogDNA should be provisionedtrue or false
    logdna_nameThe name of the LogDNA instance (If provision_logdna is set to false this value is used by the scripts to bind the existing LogDNA instance to the cluster)cntk-showcase-logdna
    provision_sysdigFlag indicating that a new instance of Sysdig should be provisionedtrue or false
    sysdig_nameThe name of the Sysdig instance (If provision_sysdig is set to false this value is used by the scripts to bind the existing Sysdig instance to the cluster)cntk-showcase-sysdig

  1. Check the box to accept the Apache 2 license for the tile.
  2. Click Install to start the install process

This will kick off the installation of the Cloud-Native Toolkit using an IBM Cloud Private Catalog Tile. The progress can be reviewed from the Schematics entry

Post-installation steps

Once the Terraform has completed, walk through the post installation steps to explore and verify the environment.


If you find that the Terraform provisioning has failed, for Private Catalog delete the workspace and for Iteration Zero try re-running the script again. The state will be saved and Terraform will try and apply the configuration to match the desired end state.

If you find that some of the services have failed to create in the time allocated, try the following with Iteration zero:

  1. Manually delete the service instances in your resource group
  2. Re-run the script with the --delete argument to clean up the state
    ./ --delete