Setting up the IBM Cloud Schematics CLI

Before you begin using the IBM Cloud® Schematics CLI to deploy IBM Spectrum Symphony, review and complete the following prerequisites:

1. Install the IBM Cloud CLI.

2. Log in to the IBM Cloud CLI with your IBMid. If you have multiple accounts, you are prompted to select which account to use. If you do not specify a region with the -r flag, you must also select a region.

   ibmcloud login
   

   If your credentials are rejected, you might be using a federated ID. To log in with a federated ID, use the --sso flag. For more information, see Logging in with a federated ID.

3. Install and set up the IBM Cloud Schematics CLI plug-in.

4. Make sure to generate your IBM Cloud API key. For more information, see Managing user API keys.

5. Create the config.json file that represents the configuration parameters that you would like to use to build the IBM Spectrum Symphony cluster. To learn more about all the properties, see Deployment values. You can view a sample configuration file here. For more information about the sample JSON file used by the Schematics CLI, see IBM Cloud Schematics CLI. If you need to override any default parameters, you can redefine them in variablestore.

6. Update the mandatory properties for api_key, ssh_key_name, and symphony_license_confirmation based on your specific setup.

7. Review and update any optional properties in the config.json file to fit your specific IBM Spectrum Symphony cluster instance.