vania-janet/multiturn-rag-retrieval-data huggingface dataset:
The following options use the [secure-kube-toolchain template](https://github.com/open-toolchain/secure-kube-toolchain), which uses a Tekton pipeline structure.

[![Deploy to Kubernetes on IBM Cloud (secured)](https://cloud.ibm.com/docs-content/v1/content/efbf7b33e3aca029f69f9244bced9dd4d8acb848/apps/images/Deploy_to_kube_Secured.svg)](https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/Scalable-web-app-node/tree/master/terraform/secure-kube&terraform_version=terraform_v1.3)[![Deploy to OpenShift on IBM Cloud (secured)](https://cloud.ibm.com/docs-content/v1/content/efbf7b33e3aca029f69f9244bced9dd4d8acb848/apps/images/Deploy_to_Openshift_Secured.svg)](https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/Scalable-web-app-node/tree/master/terraform/secure-openshift&terraform_version=terraform_v1.3)

Based on which option you select, the corresponding Terraform template from this repository is automatically imported into the new Schematics workspace. The Terraform engine version is v1.3.
2. Verify the information, and then click Create. The Schematics workspace is created, and the Settings page for the Schematics workspace is displayed.







 Step 2: Apply the Terraform execution plan 



1. In the Variables section of the Schematics Settings page, enter the values for each variable. Required fields are the fields without default values. However, default values can be overridden.
* [11 February 2022](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-feb1122)



* Release Schematics command-line plug-in





* [January 2022](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-jan22)



* Review the release notes for January 2022.
* [31 January 2022](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-jan3122)



* Release Schematics command-line plug-in
* Supports installer for PowerLinux™ and System/390 Linux™





* [December 2021](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-dec21)



* Review the release notes for December 2021.
* [30 December 2021](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-dec3021)



* Release Schematics command-line plug-in





* [November 2021](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-nov21)



* Review the release notes for November 2021.
* [30 November 2021](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-nov302021)



* Centrally manage access tags for Schematics Workspaces in your account
* Support WinRM in user interface
* Global catalog settings for Schematics Workspaces location
* About compact download
* About Schematics Job files
* ResourceQuery attribute deprecated
template_repo_request_model['url'] = 'https://github.com/IBM-Cloud/hpc-cluster-symphony'

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_v0.14.11'],
location="us-south",
resource_group="Default",
tags=[""]
).get_result()

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





 Example Python response 

The Python response is a generic example. Versioning and deployment values are subject to change due to frequent code updates.

INFO:root:Started Creating Schematic Workspace
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 1086
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 HTTP/1.1" 201 1974
INFO:root:Completed Creating Schematic Workspace
{
"id": "us-south.workspace.Sample-Schematic-API-workspace.341cedd5",
"name": "Sample Schematic API workspace",
The following options use the [secure-kube-toolchain template](https://github.com/open-toolchain/secure-kube-toolchain), which uses a Tekton pipeline structure.

[![Deploy to Kubernetes on IBM Cloud (secured)](https://cloud.ibm.com/docs-content/v1/content/efbf7b33e3aca029f69f9244bced9dd4d8acb848/apps/images/Deploy_to_kube_Secured.svg)](https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/Scalable-web-app-java/tree/master/terraform/secure-kube&terraform_version=terraform_v1.3)[![Deploy to OpenShift on IBM Cloud (secured)](https://cloud.ibm.com/docs-content/v1/content/efbf7b33e3aca029f69f9244bced9dd4d8acb848/apps/images/Deploy_to_Openshift_Secured.svg)](https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/Scalable-web-app-java/tree/master/terraform/secure-openshift&terraform_version=terraform_v1.3)

Based on which option you select, the corresponding Terraform template from this repository is automatically imported into the new Schematics workspace. The Terraform engine version is v1.3.
2. Verify the information, and then click Create. The Schematics workspace is created, and the Settings page for the Schematics workspace is displayed.







 Step 2: Apply the Terraform execution plan 



1. In the Variables section of the Schematics Settings page, enter the values for each variable. Required fields are the fields without default values. However, default values can be overridden.
* UI
* CLI
* API





Schematics Blueprints is a [beta feature](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-beta-limitations) that are available for evaluation and testing purposes. It is not intended for production usage. Refer to the list of [limitations](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-beta-limitationssc-bp-beta-limitation) for the beta release.



 Delete a blueprint configuration 

When a blueprint environment is no longer required, it can be deleted which will terminate billing for all deployed resources. See the [deleting blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-delete-blueprint) lifecycle stage to understand the process of deleting blueprint environments and the steps. Deleting an environment is a two-step process that first destroys all the associated cloud resources (environment) and second deletes the blueprint config in Schematics.

Deleting the blueprint configuration is the second step required to completely delete a blueprint from Schematics. To protect from accidental deletion, the config can only be deleted when cloud resources in all the blueprint modules have been deleted and the modules are in Inactive state. The first step is to run the [blueprint destroy](https://cloud.ibm.com/docs/schematics?topic=schematics-destroy-blueprint&interface=ui) command to destroy the resources in the blueprint environment and remove the environment.

This behavior can be overridden using the -force-delete flag when modules cannot be returned to an Inactive state due to a Schematics or Terraform error.



 Deleting a blueprint config using the CLI 

For more information, see the [blueprint delete](https://cloud.ibm.com/docs/schematics?topic=schematics-delete-blueprint) command.
* Change the API endpoint to the endpoint mentioned in [API endpoints](https://cloud.ibm.com/apidocs/schematics?code=pythonapi-endpoints) according to the location that 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.destroy_workspace_command function, provide the following parameters:



* Provide the workspace ID that you generated in the [Creating a workspace](https://cloud.ibm.com/docs/hpc-openshift?topic=hpc-openshift-creating-workspace&interface=api) task, 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. Run the Python script by using python3 <python-file-name> to destroy the resources that you created in the Schematics workspace in the IBM Cloud.
6. 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 that the resources are deleted 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 destroy the resources.
7.
About Schematics Agents 

Schematics Agents is a [beta feature](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-beta-limitations) that are available for evaluation and testing purposes. It is not intended for production usage. Refer to the list of [limitations for Agents](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-beta-limitationssc-agent-beta-limitation) in the beta release.

The IBM Cloud® Schematics Agents extends Schematics ability to reach your cloud infrastructure. Integrate the Schematics Agents running in your private network to the IBM Cloud Schematics service to provision, configure, and operate your private or on-premises cloud cluster resources without any time, network, or software restrictions. The Schematics Agents runtime uses Terraform, Terraform CLI v1.0.11, Terraform CLI v1.1.5, and Micro-services. For more information about the Agents utilities, see [Schematics runtime development tools](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-utilities).



 Usage of an Agent 

The following are the primary drivers to create the IBM Cloud Schematics Agents.



* Use [Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-learn-about-schematics) and [IBM Cloud Satellite®](https://cloud.ibm.com/docs/satellite?topic=satellite-getting-started) to deploy and configure hybrid cloud resources such as private cloud resources, private data center resources, and other public cloud resources.
"values_url": "https://us-east.schematics.cloud.ibm.com/v1/workspaces/us-east.workspace.teststagews-sleepy12.a92d1471/template_data/ff819de7-e084-4c/values",
"values": "",
"values_metadata":
{
"default": "hello",
"description": "A sample_var to pass to the template.",
"name": "sample_var",
"type": "string"
},
{
"default": "0",
"description": "How long our local-exec will take a nap.",
"name": "sleepy_time",
"type": "string"
}
],
"variablestore":
{
"name": "sample_var",
"secure": false,
"value": "THIS IS IBM CLOUD TERRAFORM CLI DEMO",
"type": "",
"description": "Description of sample_var"
},
{
"name": "sleepy_time",
"secure": false,
"value": "40",
"type": "string",
"description": ""
}
],
"has_githubtoken": false
}
],
"runtime_data":
{
"id": "ff819de7-e084-4c",
"engine_name": "terraform",
"engine_version": "v1.0.11",
ibmcloud schematics kms enable -l US -s byok -g Default -pn Key-Protect-south -pc crn:v1:bluemix:public:kms:us-south:lalalalal -pe https://private.us-south.kms.cloud.ibm.com





 ibmcloud schematics kms info 

Retrieve the KMS on the API endpoint that you have your KYOK, or BYOK. For example, if you use an API endpoint for a geography, such as North America, only that are created in us-south or us-east are retrieved. Note that you need to enable kms instances in your account to run info command-line.

Syntax

ibmcloud schematics kms info --location LOCATION_NAME [--output OUTPUT]

Command options



Schematics KMS information flags

 Flag Required / Optional Description 

 --location or -l Required Set the Schematics location name. Supported values are US, or EU. 
 --output or -o Optional Returns the command-line output in JSON format. Currently only JSON file format is supported. 
 --json or -j Deprecated Prints the output in the JSON format. 



Example

ibmcloud schematics kms info -l US







 General commands 

Use these general commands to find help and version information for the IBM Cloud Schematics command-line plug-in.



 ibmcloud schematics help 

View the supported IBM Cloud Schematics command-line commands.

Syntax

ibmcloud schematics help [command]

Command options



Schematics help flags

 Flag Required / Optional Description 

 --help or -h Required Lists the supported commands. 
 command Optional Specify the name of the command to fetch the command details. 



Example

ibmcloud schematics help





 ibmcloud schematics version 

List the versions of all supported open source projects in Schematics, such as the IBM Cloud Provider Plug-in for Terraform, Ansible, Helm, and Kubernetes that are used to run Schematics Actions on IBM Cloud resources.

Syntax
This is followed by a list of modules containing the [module definitions](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-modules-schema) that deploy the layers and components of the infrastructure.

Resource dependencies between modules are defined by interpolation of module input and output values. In the basic-cos-storage module definition above, the input resource_group_id specifies the interpolated value $module.basic-resource-group.outputs.resource_group_id, which creates a dependency on the resource_group_id output value from the module basic-resource-group.

The IaC best practice of modular architectures implemented by Schematics Blueprints builds on [IBM module authoring guidelines](https://terraform-ibm-modules.github.io/documentation//implementation-guidelines). These guidelines support composition though well defined module input and output definitions that are compatible across modules. The IBM Cloud reusable Terraform modules in the [terraform-ibm-modules](https://github.com/terraform-ibm-modules) GitHub repo and the Terraform registry adhere to these guidelines to support composition.





 Template inputs 

All variables required by a blueprint template must be defined in the [inputs](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-inputs) section. Values can be statically defined in the template. If the value is omitted, it is assumed that the input is satisfied by a user defined input value from the blueprint configuration. Refer to the section [Customizing environments with inputs](https://cloud.ibm.com/docs/schematics?topic=schematics-define-blueprintsdefine-templates-input) for guidance on defining inputs.

Template inputs follow the same type convention as Terraform HCL. The supported types are the same as the [Terraform variable types](https://developer.hashicorp.com/terraform/language/expressions/types). If the type is omitted the default is string.
Apply your Terraform template in IBM Cloud. When you apply your Terraform template, all the IBM Cloud resources that are specified in the template are created in your IBM Cloud account.

This process takes a minute to complete. During this process, you cannot make any changes to your workspace.

ibmcloud schematics apply --id <workspace_ID>

Sample example output

Do you really want to perform this action? [y/N]> y

Activity ID 5676e3752a0a84565667666533b4345

OK
4. Review the logs of your workspace. See step 2 to view the logs with the workspace ID or activity ID.
5. Verify that the IBM Cloud resources are successfully created in your IBM Cloud.

ibmcloud schematics workspace get --id <WORKSPACE_ID>

Alternatively, through the IBM Cloud dashboard, you can view the status of the workspace. From the IBM Cloud, select Navigation Menu -> Schematics -> workspaces -> Resources to observe the apply state of the resources in your workspace.
6. Command to view the logs, and analyze the state of the workspace and resources creation.

ibmcloud schematics logs --id mytest1_cluster-62183a6b-fbed-43

You can view the output from your working directory, or from the IBM Cloud dashboard workspace jobs status.







 What's next? 

Great job! You successfully provisioned a VPC cluster by using IBM Cloud Schematics. You can now learn how to configure the cluster parameters to attach the key management services and load balancer. For more information about key management services and IBM Cloud Kubernetes worker pool, see [Key Management services](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-cliks_kms_enable) and [IBM Cloud Kubernetes worker pool](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-clics_alb_create).
[Schematics Blueprints feature overview](https://cloud.ibm.com/docs-content/v1/content/ba89e173287b28d1453d2a327d8a1f74ae2f1662/schematics//images/new/bp-features.svg)

Schematics Blueprints feature overview

Schematics Blueprints complements Terraform with IaC based environment management capabilities:



* [Modular composition](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-terraform): Build infrastructure architectures from an eco-system of reusable IBM Cloud automation modules written in Terraform
* [Scalability](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-scaling): Scale environments by linking discrete modular environments as the layers and components of large and complex application architectures using dependencies.
* [Reusability](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-reuse): Share and reuse templates and modules across environments, pipelines and teams
* [Lifecycle](https://cloud.ibm.com/docs/schematics?topic=schematics-work-with-blueprints): Manage environments cradle-to-grave, from initial creation, through maintenance and ops to final decommissioning.



* Future: scheduled ops, drift detection, cost estimation, policy compliance









 Next steps 

So far you have learned a little about Schematics Blueprints. The following are some next steps to explore.



* [Working with blueprints and environments](https://cloud.ibm.com/docs/schematics?topic=schematics-work-with-blueprints) to understand how to use blueprints to manage the lifecycle of deploying and managing cloud environments.
template_repo_request_model['url'] = 'https://github.com/IBM-Cloud/hpc-cluster-lsf'

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_v0.14.11'],
location="us-south",
resource_group="Default",
tags=[""]
).get_result()

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





 Example Python response 

The Python response is a generic example. Versioning and deployment values are subject to change due to frequent code updates.

INFO:root:Started Creating Schematic Workspace
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 1086
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 HTTP/1.1" 201 1974
INFO:root:Completed Creating Schematic Workspace
{
"id": "us-south.workspace.Sample-Schematic-API-workspace.341cedd5",
"name": "Sample Schematic API workspace",
"value": "n {n internal = 800n external = 83009n protocol = "tcp"n }n ] ! ! ! ",
"description": "",
"name": "docker_ports",
"type": "list(object({n internal = numbern external = numbern protocol = stringn }))",
"use_default":true
},
Example ibmcloud schematics workspace update --id myworkspace-a1aa1a1a-a11a-11 --file myfile.json --json
<-- </section "id="section-syntax_of_variablestore" "> --><-- </section "id="section-schematics-workspace-update" "> --><-- <section "id="section-schematics-workspace-upload" "> --> ibmcloud schematics workspace upload Provide your Terraform template by uploading a tape archive file (.tar) to your Schematics Workspace. Initial support for files up to 4MB in size.Before you begin, make sure that you created your workspace]ibmcloud workspace new] without a link to a GitHub or GitLab repository.Syntax ibmcloud schematics workspace upload --id WORKSPACE_ID --file FILE_NAME --template TEMPLATE_ID --output OUTPUT]--json] ! ! !
[Blueprint templates, modules and inputs define environment](https://cloud.ibm.com/docs-content/v1/content/ba89e173287b28d1453d2a327d8a1f74ae2f1662/schematics//images/new/bp-overview.svg)

Blueprint templates, modules and inputs define environment

As shown, a blueprint template determines the infrastructure architecture, specifying the modules required for the implementation, the infrastructure topology and relationships between modules. Inputs customize the template for the target deployment. Blueprint operations build up the infrastructure by deploying the smaller modular environments defined by the template. Blueprints linking the module environments into the whole, by the sharing and passing of resource dependency data between modules.

A blueprint environment and the cloud resources to be deployed are defined by three versioned elements:



1. A reusable blueprint template to represent the reference infrastructure architecture, the IaC automation modules to be used and the cloud resources that are to be deployed.
2. Versioned blueprint inputs to customize a blueprint template for the specific environment to be deployed.
3. Reusable modules written in Terraform to implement the infrastructure architecture and deploy the desired cloud resources.





 Creating templates, inputs and configuration 

Blueprint environments can be created from reusable user or IBM authored blueprint templates. New templates can be authored to address specific application requirements. Either by creating a new template from scratch, or by modifying existing templates.

Templates are [reusable across multiple environments](https://cloud.ibm.com/docs/schematics?topic=schematics-define-blueprintsdefine-templates-input), with the customizable input values maintained separately from the template as [inputs](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termsbpi1). In cookie cutter fashion, several environments can be created from the same blueprint template.
: For more information, see [Stop an apply job](https://cloud.ibm.com/apidocs/schematics/schematicsdelete-workspace-activity) API.







 May 2021 

Review the release notes for May 2021.



 26 May 2021 

Version constraints support in IBM Cloud Schematics
: Specifying version constraints for Terraform and Ansible. For more information, see [specifying version constraints in Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-version-constraints).

Troubleshooting guide support
: For more information about the debugging Schematics apply errors, see [Why do timeout failures result in tainted IBM Cloud resources?](https://cloud.ibm.com/docs/schematics?topic=schematics-server-errors), [Why am I getting 5xx HTTP errors?]/docs/schematics?topic=schematics-server-errors), [Why can't Schematics find the resource group?](https://cloud.ibm.com/docs/schematics?topic=schematics-rg-not-found), and [How can I find the root cause of why Schematics apply is failing?](https://cloud.ibm.com/docs/schematics?topic=schematics-nullresource-errors)

Schematics supports sample solutions
: Sample solutions by using Terraform templates and modules to set up the infrastructure. For more information, see [Sample solutions for IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-sol-overview).







 April 2021 

Review the release notes for April 2021.



 14 April 2021 

Ansible support in IBM Cloud Schematics is now generally available
: Use Schematics Actions to run your Ansible playbooks in IBM Cloud, and automate the configuration, operation, and management of cloud resources, or deploy multitiered app workloads.