vania-janet/multiturn-rag-retrieval-data huggingface dataset:
* ibmcloud is instance-template-create my-template-name 72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 us-south-1 bx2-2x8 72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 --catalog-offering crn:v1:bluemix:public:globalcatalog-collection:global:a/efe5afc483594adaa8325e2b4d1290df:2497ae83-40cb-46ba-ac7f-5303514a2669:offering:54372a73-7a0a-4799-ac9c-8736620c67f1 Create instance template with catalog offering.
* ibmcloud is instance-template-create my-template-name 72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 us-south-1 bx2-2x8 72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 --catalog-offering-version crn:v1:bluemix:public:globalcatalog-collection:global:a/efe5afc483594adaa8325e2b4d1290df:2497ae83-40cb-46ba-ac7f-5303514a2669:offering:54372a73-7a0a-4799-ac9c-8736620c67f1 Create instance template with catalog offering version.
* ibmcloud is instance-template-create --interactive Create instance template interactively.







 Command options 



* INSTANCE_TEMPLATE_NAME: Name of the instance template.
* VPC: ID or name of the VPC.
* ZONE_NAME: Name of the zone.
* PROFILE_NAME: Name of the profile.
* SUBNET: ID or name of the subnet.
* --image: ID or name of the image.
ibmcloud schematics logs --id <WORKSPACE_ID>





 Next steps 

After you've successfully generated a plan, you can begin [Applying a plan](https://cloud.ibm.com/docs/ibm-spectrum-symphony?topic=ibm-spectrum-symphony-applying-planapply-plan-cli) 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](https://cloud.ibm.com/docs/hpc-spectrum-symphony?topic=hpc-spectrum-symphony-retrieve-action-logsexample-request-retrieve-action-logs) 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](https://cloud.ibm.com/apidocs/schematics?code=pythonapi-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](https://cloud.ibm.com/docs/hpc-spectrum-symphony?topic=hpc-spectrum-symphony-creating-workspace&interface=api) task or from the IBM Cloud console for Schematics, for example, us-south.workspace.Terraform-Schematics-Python-Workspace.b3bbc9f5.
* [ibmcloud schematics resource query create](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-create-rq)
* [ibmcloud schematics resource query delete](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-delete-resource-query)
* [ibmcloud schematics resource query get](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-get-rq)
* [ibmcloud schematics resource query list](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-list-rq)
* [ibmcloud schematics resource query update](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-update-rq)



* [Stop commands](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referencestop-cmds)



* [ibmcloud schematics workspace job stop](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-stop-job)



* [Terraform commands](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referencetf-cmds)



* [Commands](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referencecmds)



* [Terraform state file commands](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referencestate-file-cmds)
* [ibmcloud schematics help](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-help-cmd)
* [ibmcloud schematics version](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-version)



* [Inventories commands](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceinv-commands)



* [ibmcloud schematics inventory create](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-create-inv)
* [ibmcloud schematics inventory delete](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-delete-inventory)
* [ibmcloud schematics inventory get](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-get-inv)
* [ibmcloud schematics inventory list](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-list-inv)
* [ibmcloud schematics inventory update](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-update-inv)



* [Job commands](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-job-commands)
* [Next steps](https://cloud.ibm.com/docs/schematics?topic=schematics-auto-deploy-urlsample-actions-nextsteps)







 Managing Inventories 

[Creating resource inventories for Schematics Actions](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupinventories-setup)



* [Creating static inventory files](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupstatic-inv)



* [File format](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupinv-file-format)
* [Limitations](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupinv-file-limitation)



* [Dynamically building resource inventories from Schematics Workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupdynamic-inv)



* [Supported resource queries](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupsupported-queries)
* [Limitations](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupdynamic-inv-limitation)









 Managing Integrations 

[Logging integration](https://cloud.ibm.com/docs/schematics?topic=schematics-logging-integrationlogging-integration)



* [Launching logging](https://cloud.ibm.com/docs/schematics?topic=schematics-logging-integrationlogging-ui)



[Monitoring integration](https://cloud.ibm.com/docs/schematics?topic=schematics-monitoring-integrationmonitoring-integration)
testwspace31jan us-east.workspace.testwspace31jan.a31438c6 terraform workspace Terraform v1.0.11 INACTIVE True

OK


On successful plan returns the update details of an existing workspace.

For more information about FAQ, see [troubleshooting section](https://cloud.ibm.com/docs/schematics?topic=schematics-wks-create-api&interface=cli).







 Generate a workspace plan using the API 



1. Follow the [steps](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-apics_api) to retrieve your IAM access token and authenticate with IBM Cloud Schematics by using the API.
2. Generate plan for the existing workspace.

Example

POST /v1/workspaces/{w_id}/plan HTTP/1.1
Host: schematics.cloud.ibm.com
Content-Type: application/json
Authorization: <auth-token>
Cache-Control: no-cache
Postman-Token: bdc869fd-dc7c-06a6-5e99-4de6e3aa7dd9

{
"name": "testwspace31jan",
"type": [
"terraform_v1.0"
],
"description": "terraform workspace",
"location": "us-east",
"tags": [
"department:HR",
"application:compensation",
"environment:production"
],
"template_repo": {
"url": "<gitrepo-url>"
},
"workspace_status": {
"frozen": true
},
"template_data": [{
"folder": ".",
"type": "terraform_v1.0",
"variablestore": {
"name": "sample_var",
"total_matching_documents": 32708,
"estimated_matching_results": 32708
}
] ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
}
Show more
<-- </section "id="section-group_by-example" "> --><-- </section "id="section-group_by" "> --><-- <section "id="section-histogram" "> --> histogram Creates numeric interval segments to categorize documents.<-- <section "id="section-histogram-syntax" "> --> Syntax histogram({field},{interval})
Uses field values from a single numeric field to describe the category. The field that is used to create the histogram must have a number data type, such as integer, float, double, or date.Nonnumber types such as string are not supported. For example, "price": 1.30 is a number value that works, and "price": "1.30" is a string, so it doesn’t work.Use the interval argument to define the size of the sections for the results to be split into. Interval values must be whole, nonnegative numbers.
Getting the latest version of a schema requires at least both:



* Reader role access to the Event Streams cluster resource type.
* Reader role access to the schema resource that matches the schema that is retrieved.







 Listing all of the versions of a schema 

To list all versions of a schema currently stored in the registry, make a GET request to the /artifacts/{schema-id}/versions endpoint (where {schema-id} is the ID of the schema). If successful, a list of all current version numbers for the schema is returned in the payload of the response.

Example curl request:

curl -u token:$APIKEY $URL/artifacts/my-schema/versions

Example response:

[1,2,3,5,6,8,100]

Getting the list of available versions of a schema requires at least both:



* Reader role access to the Event Streams cluster resource type.
* Reader role access to the schema resource that matches the schema that is retrieved.







 Deleting a version of a schema 

Schema versions are deleted from the registry by issuing a DELETE request to the /artifacts/{schema-id}/versions/{version} endpoint (where {schema-id} is the ID of the schema, and {version} is the version number of the schema version). If successful, an empty response, and a status code of 204 (no content) is returned. Deleting the only remaining version of a schema also deletes the schema.

Example curl request:

curl -u token:$APIKEY -X DELETE $URL/artifacts/my-schema/versions/3

Deleting a schema version requires at least both:



* Reader role access to the Event Streams cluster resource type.
* Manager role access to the schema resource that matches the schema that is deleted.



An activity tracker event is generated to report the action. For more information, see [Activity Tracker events](https://cloud.ibm.com/docs/EventStreams?topic=EventStreams-at_eventsevents).





 Getting the specific global unique ID of a schema version
"region": "us-south"
},
"type": [
"terraform_v1.0"
],
"description": "terraform workspace",
"template_repo": {
"url": "https://github.com/xxxx/test-template-private-module"
},
"template_data": [
{
"folder": ".",
"type": "terraform_v1.0",
"env_values":
{
"__netrc__":"'github.com','testuser','ghp_x0000000xxxxxxxx000000efZxxxxxxxV']]"
}
]
}
]
}
Show more

Example to create workspace:

ibmcloud schematics workspace new --file testexample.json

Run ibmcloud schematics workspace get --id WORKSPACE_ID command to analyze the success workspace creation or use [user interface](https://cloud.ibm.com/schematics), to view all the files from the modules are cloned and used in your workspace to provision.
offering_version_crn="crn:v1:staging:public:globalcatalog-collection:global:a/efe5afc483594adaa8325e2b4d1290df:0b322820-dafd-4b5e-b694-6465da6f008a:version:136559f6-4588-4af2-8585-f3c625eee09d/8ae92879-e253-4a7c-b09f-8d30af12e518"



After you know these values, use them to run the instance-template-create command. In addition to the information that you gathered, you must specify a name for the instance.

The following example creates an instance template by using a stock image or a custom image from your account.

ibmcloud is instance-template-create INSTANCE_TEMPLATE_NAME VPC ZONE_NAME PROFILE_NAME SUBNET --image-id IMAGE_ID

For example, if you create an instance template that is called my-instance-template in us-south-1, use the bx2-2x8 profile, with a custom image _r008-54e9238a-feaa-4f90-9742-7424cb2b9ff1_ your instance-template-create command would look similar to the following sample.

ibmcloud is instance-template-create my-instance-template r134-680c56cb-7fbb-41e6-833b-029beb7b6ba3 us-south-3 bx2-2x8 0076-2249dabc-8c71-4a54-bxy7-953701ca3999 --image-id r008-54e9238a-feaa-4f90-9742-7424cb2b9ff1

Where:



* INSTANCE_TEMPLATE_NAME is my-instance-template
* VPC is r134-680c56cb-7fbb-41e6-833b-029beb7b6ba3
* ZONE_NAME is us-south-3
Schematics 

Review the available platform and service roles and the actions mapped to each to help you assign access. If you're using the CLI or API to assign access, use schematics for the service name.

Platform roles

Service roles

Actions



Table 140. Platform roles - Schematics
Use the tab buttons to change the context of the table. This table has row and column headers. The row headers provide the platform role name and the column headers identify the specific information available about each role.

 Role Description 

 Administrator As an administrator, you can perform all platform actions based on the resource this role is being assigned, including assigning access policies to other users. 
 Editor As an editor, you can perform all platform actions except for managing the account and assigning access policies. 
 Operator As an operator, you can perform platform actions required to configure and operate service instances, such as viewing a service's dashboard. 
 Viewer As a viewer, you can view service instances, but you can't modify them. 







 Secrets Manager 

Review the available platform and service roles and the actions mapped to each to help you assign access. If you're using the CLI or API to assign access, use secrets-manager for the service name.

Platform roles

Service roles

Actions



Table 141. Platform roles - Secrets Manager
Use the tab buttons to change the context of the table. This table has row and column headers. The row headers provide the platform role name and the column headers identify the specific information available about each role.

 Role Description 

 Administrator As an administrator, you can perform all platform actions based on the resource this role is being assigned, including assigning access policies to other users. 
 Editor As an editor, you can perform all platform actions except for managing the account and assigning access policies. 
 Operator As an operator, you can perform platform actions required to configure and operate service instances, such as viewing a service's dashboard. 







 Simulated Instruments Analytics API 

Review the available platform and service roles and the actions mapped to each to help you assign access. If you're using the CLI or API to assign access, use sia for the service name.

Platform roles

Service roles
* ibmcloud is instance-template-create my-template-name 72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 us-south-1 bx2-2x8 72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 --image r123-72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 --volume-attach '[{"volume": {"id":"67531475-bd8a-478e-bcfe-2e53365cd0aa"}}]' Create instance template with existing volume in volume attachment.
* ibmcloud is instance-template-create my-template-name 72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 us-south-1 bx2-2x8 72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 --image r123-72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 --keys 72b27b5c-f4b0-48bb-b954-5becc7c1dcb8,72b27b5c-f4b0-48bb-b954-5becc7c1dcb3 Create instance template with multiple SSH keys.
[Import Terms](https://cloud.ibm.com/docs-content/v1/content/50eddb8fd81f33092880335ff107a78ff5cd0f65/watson-knowledge-studio/images/import_terms.jpg). If an error is displayed during the import, ensure that the file does not contain unprintable characters such as Line Feed or Backspace.









 Defining a mapping table 

When analyzing text that contains synonyms, alternate spellings for a term, or encoded values, you can define a mapping table to map terms in the text to a desired term.

A mapping table is analogous to a lookup table or a key-value pair table. Examples of instances in which you might define a mapping table include matching:



* Nicknames like Maggy and Peggy for Margaret
* Abbreviations and alternate forms of an organization name such as I.B.M., IBM Deutschland and International Business Machines for the commonly used name IBM
* 404 to File Not Found when translating HTML error codes in a log file
* The area code 408 to California



For best performance, use long or complex mapping tables in a second step, after the text extraction step.



1. Click ![New Dictionary](https://cloud.ibm.com/docs-content/v1/content/50eddb8fd81f33092880335ff107a78ff5cd0f65/watson-knowledge-studio/images/new_extractor_dictionary.png) on the canvas toolbar.
2. Specify a name for the dictionary. You can extend the name with a description. Lengthy text is truncated but is displayed when you hover over the dictionary.
3. On the Settings tab under Extractor Properties, click Map Terms.
4. Complete the two-column table manually or by loading from a file. The first column contains the terms to search for in the text and the second column lists the values to generate in the results. The maximum length for an entry is 1024 characters. If a term is repeated in the first column, only the first mapped value is used.
Fetch the [ibmcloud schematics job logs](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-logs-job).
5. Run the [ibmcloud schematics apply](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-apply).
6. Run the [ibmcloud schematics job run](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-run-job) to create a job in Schematics Workspace.

ibmcloud schematics job run --command-object workspace --command-object-id <workspace_id> --command-name drift
7. Run the [ibmcloud schematics workspace action](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-workspace-action) to retrieve all activities of your workspace.

ibmcloud schematics workspace action --id <workspace_id>
8. Run the [ibmcloud schematics job logs](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-logs-job) to retrieve the detailed logs of a job to view the drift details.

ibmcloud schematics logs --id <workspace_id> --act-id <Job_id>









 Creating and viewing the detect drift through API 

Review the CURL commands to create and view the drift through API.



1. Retrieve your IAM access [steps](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-apics_api) to authenticate with the IBM Cloud Schematics.
2.
After you've successfully generated a plan, you can begin [Applying a plan](https://cloud.ibm.com/docs/hpc-spectrum-scale?topic=hpc-spectrum-scale-applying-plan&interface=cli) to deploy your IBM Cloud resources to build a Spectrum Scale 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](https://cloud.ibm.com/docs/hpc-spectrum-scale?topic=hpc-spectrum-scale-generate-plan&interface=apiexample-request-generate) 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](https://cloud.ibm.com/apidocs/schematics?code=pythonapi-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](https://cloud.ibm.com/docs/hpc-spectrum-scale?topic=hpc-spectrum-scale-creating-workspace&interface=api) 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>”
"name": "ibm_customer_number",
"value": "12345",
},
{
"name": "compute_cluster_gui_username",
"value": "admin",
},
{
"name": "compute_cluster_gui_password",
"value": "P@ssw0rd",
},
{
"name": "storage_cluster_gui_username",
"value": "admin",
},
{
"name": "storage_cluster_gui_password",
"value": "P@ssw0rd",
},
{
"name": "storage_cluster_key_pair",
"value": "scale-hpcc-key",
},
{
"name": "compute_cluster_key_pair",
"value": "scale-hpcc-key",
}]

template_repo_request_model = {}
template_repo_request_model['url'] = 'https://github.com/IBM/ibm-spectrum-scale-ibm-cloud-schematics'

logging.info("Started Creating Schematic Workspace")

workspace_response = schematics_service.create_workspace(
description="HPC Cluster schematic workspace using API",
name="Sample Schematic API workspace",
template_data=[template_source_data_request_model],
template_repo=template_repo_request_model,
type=['terraform_v1.0.0'],
location="us-south",
resource_group="Default",
tags=[""]
).get_result()

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





 Example Python response 

The following Python response is a generic example for reference.
Command examples 



* ibmcloud is instance-template-create-override-source-template --source-template e4a29d1a-2ef0-42a6-8fd2-350deb1c647e Create instance template copying from a source template
* ibmcloud is instance-template-create-override-source-template --source-template e4a29d1a-2ef0-42a6-8fd2-350deb1c647e --name my-template-name --image r123-72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 --profile bx2-2x8 Create instance template by overriding a source template and providing overriding options
* ibmcloud is instance-template-create-override-source-template --source-template my-template --name my-instance --subnet my-subnet --image ibm-ubuntu-20-04-2-minimal-amd64-1 --volume-attach '[{"volume": {"name":"my-vol-1"}}]' Create instance template by overriding a source template with existing volume in volume attachment by using resource name.
* ibmcloud is instance-template-create-override-source-template --source-template my-template --name my-instance --primary-network-interface '{"name": "primary-nic", "allow_ip_spoofing": true, "subnet": {"name":"my-subnet"}, "primary_ip": {"name": "my-reserved-ip"}, "security_groups": [{"name": "my-security-group-1"}, {"name": "my-security-group-2"}]}' Create instance template by overriding a source template with primary network interface configuration by using resource name.







 Command options 



* --source-template: ID or name of the template.
* --name: Name of instance template.
* --profile: Name of the instance profile.