Generating a plan

Generating a plan using the UI

1. In the IBM Cloud® console, after the workspace is created, you can review the properties and the variables that are associated with that workspace by using the Settings tab. Make sure to update the following required parameters: api_key, ssh_key_name, ibm_customer_number, and zone.
2. After you review all of the values and make any applicable changes, click Generate plan.
3. When you click Generate plan, a new log is generated that can be viewed in the Jobs tab by clicking Jobs.
4. Review the log file for any errors, fix the properties, and regenerate the plan by clicking Generate plan again.

Next steps

After you've successfully generated a plan, you can begin Applying a plan to deploy your IBM Cloud resources to build a IBM Spectrum Symphony cluster instance.

Generating a plan using the CLI

Run the following command to generate the plan for your workspace.

ibmcloud schematics plan --id <WORKSPACE_ID>

You can view the log file to look for errors or confirm that the action was completed successfully. You might need to run this command multiple times to track the outcome of the command until it's completed.

ibmcloud schematics logs --id <WORKSPACE_ID>

Next steps

After you've successfully generated a plan, you can begin Applying a plan to deploy your IBM Cloud resources to build a IBM Spectrum Symphony cluster instance.

Generating a plan using the API

1. To generate a plan by using IBM Cloud Schematics Python APIs, create a Python file and provide a name of your choice, for example, schematics_generate_plan.py.

2. Copy and paste the Generate a plan using Schematics Python API example request to your Python file.

3. Change the following parameters as part of the request:

   • Replace your IBM Cloud API key to the authenticator = IAMAuthenticator('<ibm-api-key>') variable.
   • Change the API endpoint to the endpoint mentioned in API endpoints according to the location you want your Schematics workspace to reside, for example, schematics_service.set_service_url('https://us.schematics.cloud.ibm.com').

4. Inside the schematics_service.plan_workspace_command function, provide the following parameters:

   • Provide the workspace ID that you created in the Create a workspace task or from the IBM Cloud console for Schematics, for example, us-south.workspace.Terraform-Schematics-Python-Workspace.b3bbc9f5.
   • Export your IBM Cloud API key by using the following command:

   export IBMCLOUD_API_KEY =”<ibm-cloud-api-key>”
   

   • Run the following curl command to create a refresh token:

   curl -X POST "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx
   

5. Make sure to update the following required parameters: api_key, ssh_key_name, ibm_customer_number, and zone.

6. Run the Python script by using python3 <python-file-name> to generate a plan in the IBM Cloud.

7. You get an activity ID in the response if the parameters passed as part of the request are valid. You should be able to see the plan generating in the Schematics workspace that you created in the IBM Cloud console. If you don’t get a successful response, the error response contains the errors that you need to resolve. Resolve those errors and run the script until you are able to get a valid response and generate a plan.

8. If you want to check the logs of the action, see Retrieving action logs with Schematics API to retrieve the logs. The response contains the status of the action, and it appears in either a COMPLETED or FAILED state.

# Generate a plan using Schematics Python API

import json, logging

from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
from ibm_schematics.schematics_v1 import SchematicsV1

logging.basicConfig()
logging.root.setLevel(logging.NOTSET)
logging.basicConfig(level=logging.NOTSET)

authenticator = IAMAuthenticator('<ibmcloud-api-key>')

schematics_service = SchematicsV1(authenticator = authenticator)

schematics_service.set_service_url('https://us.schematics.cloud.ibm.com')

logging.info("Started Generating Schematic Plan")

workspace_activity_plan_result = schematics_service.plan_workspace_command(
    w_id='<workspace id>',
    refresh_token='<refresh-token>'
).get_result()

print(json.dumps(workspace_activity_plan_result, indent=2))

logging.info("Completed Generating Schematic Plan")

INFO:root:Started Generating Schematic Plan
DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): iam.cloud.ibm.com:443
DEBUG:urllib3.connectionpool:https://iam.cloud.ibm.com:443 "POST /identity/token HTTP/1.1" 200 985
DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): us.schematics.cloud.ibm.com:443
DEBUG:urllib3.connectionpool:https://us.schematics.cloud.ibm.com:443 "POST /v1/workspaces/us-south.workspace.Schematic-Sunil-Test-Workspace.5a4cbf11/plan HTTP/1.1" 202 49
{
  "activityid": "8c2ce5f031d23a60d26690d3cb398bb1"
}
INFO:root:Completed Generating Schematic Plan

Next steps

After you've successfully generated a plan, you can begin Applying a plan to deploy your IBM Cloud resources to build a IBM Spectrum Symphony cluster instance.