vania-janet/multiturn-rag-retrieval-data huggingface dataset:
When you are ready, apply your Terraform template by clicking Apply plan. This action equals the terraform apply command. After you click the button, IBM Cloud Schematics starts provisioning, modifying, or deleting your IBM Cloud resources based on what actions were identified in the execution plan. Depending on the type and number of resources that you want to provision or modify, this process might take couple of minutes, or even up to hours to complete. During this time, you cannot make changes to your workspace. After all updates are applied, the state of your IBM Cloud resources is stored in a Terraform state file that IBM Cloud Schematics uses to determine what resources exist in your IBM Cloud account.

If you want to stop applying your Terraform template, you can use the Stop button. Note that all resources that are already created are not removed. If a resource is currently provisioning, Schematics waits for the provisioning to complete, and then stops the creation, update, or deletion of any other resources in your Terraform template.
9. Review the log file to ensure that no errors occurred during the provisioning, modification, or deletion process.
10. From the navigation, select Resources to find a summary of IBM Cloud resources that are available in your IBM Cloud account.







 Updating your resources 

To update IBM Cloud resources, you must first change the infrastructure code in your Terraform template before you can run your code in IBM Cloud Schematics.

What changes can I make to my resources?
You can choose to add, modify, or remove infrastructure code in your Terraform template in GitHub, or update variable values from the workspace dashboard in IBM Cloud Schematics.

Depending on how you change the configuration of existing resources, IBM Cloud Schematics might not be able to update your resource. Instead, IBM Cloud Schematics might decide to apply the change, the resource must be removed, and a new resource must be created. If your resource must be removed, make sure that you do not interrupt a working environment, or delete data.

When I change my configuration file in GitHub, is my change automatically available in the next execution plan?
Installing the IBM Cloud Schematics command-line plug-in 

Install the IBM Cloud Schematics plug-in to automate cloud operations, configuration management, and infrastructure deployments.



1. Install the IBM Cloud command-line plug-in for Schematics.

ibmcloud plugin install schematics
2. Verify that the IBM Cloud Schematics command-line plug-in is installed successfully. The plug-in is listed as schematics.

ibmcloud plugin list

Example output:

Listing installed plug-ins...

Plugin Name Version Status Private endpoints supported
schematics 1.12.9 true
3. Verify that you can use the Schematics command-line plug-in by listing all supported commands. The command prefix to work with the Schematics command-line plug-in is ibmcloud schematics.

ibmcloud schematics help

Example output:

NAME:
ibmcloud schematics -

USAGE:
ibmcloud schematics command [arguments...] [command options]

COMMANDS:
action, ac Create and manage Schematics actions. Action let you define the source control repository that contains your playbook yamls etc. and pass environment-specific variables.
agent, ag [Beta] Agents extends Schematics ability to reach your private, or on-premises infrastructure. Integrate Schematics Agent running in your private network to the IBM Cloud Schematics service to provision, configure, and operate your private or on-premise cloud resources. Visit https://cloud.ibm.com/docs/schematics?topic=schematics-agents-intro to learn more.
agents, ags [Deprecated] Agents extends Schematics ability to reach your private, or on-premises, infrastructure.
apply Apply a plan to an workspace to deploy the latest version of your configuration.
blueprint, bp Deploy and manage large scale environments using reusable blueprint templates.
destroy Destroy resources in an existing workspace. This action cannot be reversed.
inventory, iv Create and manage Schematics Inventories.
mytest1_cluster mytest1_cluster-62183a6b-fbed-43 ACTIVE False

OK







 Step 3: Planning and applying the Terraform template 

Create a Schematics execution plan. The execution plan shows the IBM Cloud resources that must be added, modified, or removed to achieve the state that is described in your Terraform template.

Your workspace must be in an Active state to perform a Schematics plan action. For more information about the workspace state, see [workspace states](https://cloud.ibm.com/docs/schematics?topic=schematics-wks-statestates-overview).

During the creation of the Terraform execution plan, you are not allowed to make any changes to your workspace.



1. Execute the Schematics plan command. This command prompts for kube_version, run ibmcloud ks versions command to list the supported Kubernetes version to provision. The plan command gives back an activity ID.

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

Sample example output

Activity ID 3886e3752a0a83b04732b6666533b464

OK

The activity ID is used to retrieve the logs of the execution plan.
2. Review the execution plan to view the IBM Cloud resources. To retrieve the logs with the activity ID use the generated activity ID from step 1.

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

You can view the output from your working directory, or from the IBM Cloud dashboard to view the workspace status.
3. 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?
: The Schematics [command-line plug-in v1.12.3](https://cloud.ibm.com/docs/schematics?topic=schematics-cli_version-releases) released.







 June 2022 

Review the release notes for June 2022.



 23 June 2022 

Enhanced FAQ documentation
: Schematics FAQ documentation content, is now enhanced by grouping the FAQs based on the Schematics objects, such as,



* [Actions FAQ](https://cloud.ibm.com/docs/schematics?topic=schematics-actions-faq)
* [General FAQ](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faq)
* [Workspaces FAQ](https://cloud.ibm.com/docs/schematics?topic=schematics-workspaces-faq)







 15 June 2022 

Enhance Schematics getting started section
: Enhanced Schematics documentation to explain about the [Using open source](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-open-projects) tools, and [Schematics use cases](https://cloud.ibm.com/docs/schematics?topic=schematics-how-it-works)







 May 2022 

Review the release notes for May 2022.



 12 May 2022 

Enhance documentation with the security and compliance section
Blueprint create fails with an invalid blueprint template: unable to find file error 

 What’s happening 

When you create the configuration, the create fails before the config is created with an error that the template, or input files cannot be found.

 Why it’s happening 

When you create the configuration, Schematics attempts to download the input files, and template from the Git repositories that are specified on the create and validate the YAML schema. The repository was located, but the template or input files cannot be found.

Sample error

FAILED
Could not create the blueprint. Please verify that your request is correct. If the problem persists, contact IBM Cloud support.

Invalid blueprint templates. Error - Unable to find basic-blueprint1.yaml in the target repo

 How to fix it 

Check that the template file and input files that are identified in the error message exist in the target repository and are correctly specified on the config create.

Rerun the create operation with the correct file name.





 Blueprint create fails with the requested resource group as invalid 

 What’s happening 

When you create the configuration, the create fails before the config is created with an error that the requested resource group ID is invalid or needed permissions.

 Why it’s happening 

On creation, blueprints are assigned to the Schematics management resource group passed on the create. If the group is invalid or the user does not have the correct Schematics IAM permissions for the group the create operation will fail.

Sample error

FAILED
Could not create the blueprint. Please verify that your request is correct. If the problem persists, contact IBM Cloud support.

The requested resource group id is invalid or required permissions for performing the action are not present on resource group. Please check the resource group ID and permissions.

 How to fix it 

Check that the resource group that is specified on the --resource_group option is valid and that the user has the correct Schematics [IAM permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-accessblueprint-permissions) to create blueprints.
* [Transit Gateway templates](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templatetransit-gwy-snippet)
* [VPC infrastructure templates (Gen 2 compute)](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templatevpc-gen2-snippet)







 Solution templates 



 Kubernetes and Red Hat OpenShift on IBM Cloud 

In the Workspace details page, click Next button to view the Create button active to create Schematics workspace.



Kubernetes and Red Hat OpenShift on IBM Cloud Terraform templates to provision resource using Schematics workspace

 Template Description Provision 

 [Kubernetes cluster on VPC](https://github.com/Cloud-Schematics/multizone-iks-on-vpc-cluster) Provision of a Kubernetes cluster on an existing VPC network, with private application load balancers. ![Auto deployment button](https://cloud.ibm.com/docs-content/v1/content/4cd6263f39a034d265ddb4b0a5e6d50c55d13ee8/ibm-cloud-provider-for-terraform/images/autodeploy_button.png)[Deploy to IBM Cloud](https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/Cloud-Schematics/multizone-iks-on-vpc-cluster&terraform_version=terraform_v0.12) <br> 
 [Red Hat OpenShift on IBM Cloud cluster on classic infrastructure](https://github.com/Cloud-Schematics/openshift-cluster) Provision of a simple Red Hat OpenShift cluster on Classic infrastructure. !
* UI
* CLI
* API





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-limitations) in the beta release.



 Installing Schematics Agent 

The [Schematics Agents](https://cloud.ibm.com/docs/schematics?topic=schematics-agents-intro) are deployed in your IBM Cloud® account and configured to connect to your Schematics service instance. You can follow these steps to use the included deployment automation to provision the required Kubernetes cluster and to install an Agent in that cluster.

The block diagram represents the Schematics Agent set up flow that you can provision, deploy, connect, and use.

Zoom

![Schematics Agents set up](https://cloud.ibm.com/docs-content/v1/content/ba89e173287b28d1453d2a327d8a1f74ae2f1662/schematics/images/agents-setup-latest.svg)

Schematics Agents set up

Following are the estimated time to complete the Schematics Agents set up.



1. Provisioning the Agent infrastructure (estimated time 45 - 90 minutes)
2. Deploying the Agent services (estimated time 15 - 30 minutes)
3. Connecting the Agent to Schematics (estimated time 15 - 20 minutes)
4. Using the Agent to run your IaC automation (estimated time 15 - 20 minutes)





 Prerequisites 

Before you begin, complete the following prerequisites.



* You must have an [IBM Cloud Pay-As-You-Go or Subscription](https://cloud.ibm.com/registration) account to proceed.
Each of the templates provides guidance specific to the underlying IBM Cloud technology used in one of the [reference architectures](https://cloud.ibm.com/docs/overview?topic=overview-what-is-fscloudframework-reference-architectures). They are referred to as "templates" because they allow you to assess how well your solution meets each of the control requirements. A completed CIO template is a requirement for any ecosystem partner seeking to be Financial Services Validated.





 Reference architectures and deployment guidance 

[Reference architectures](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-reference-architecture-overview) have been defined which can be used as a basis for meeting the security and regulatory requirements defined by the controls. The reference architectures each center on specific IBM Cloud technologies, including:



* [IBM Cloud® Virtual Private Cloud reference architecture](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-about), with options for using one or both of:



* [IBM Cloud® Virtual Servers for Virtual Private Cloud](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-detailed-vsi)
* [Red Hat® OpenShift® on IBM Cloud®](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-detailed-openshift)



* [IBM Cloud Satellite® reference architecture](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-satellite-architecture-about)
* [IBM Cloud® for VMware® Regulated Workloads reference architecture](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vmware-overview)
Support - Terraform and Schematics 

There are no warranties of any kind, and there is no service or technical support available for these materials from IBM®. As a recommended practice, review carefully any materials that you download from this site before using them on a live system.

Though the materials provided herein are not supported by the IBM Service organization, your comments are welcomed by the developers, who reserve the right to revise, re-adapt or remove the materials at any time. To report a problem, or provide suggestions or comments, open a GitHub issue.





 Before you begin 

Before you use the scripts in the bastion CLI or Schematics:



* Set up your account to access the VPC. Make sure that your account is [upgraded to a paid account](https://cloud.ibm.com/docs/account?topic=account-accountfaqschangeacct).
* If you have not already, create a bastion server to store the SAP kits. For more information, see [Automate SAP bastion server - SAP media storage repository](https://cloud.ibm.com/docs/sap?topic=sap-sap-bastion-server). You need the floating IP from your bastion server for deployment.
* Download the SAP kits from the SAP Portal to your Deployment Server. Make note of the download locations. Ansible decompresses the files. For more information, see the readme file, in the respective GitHub repository for Schematics and Terraform and on the About page for the Catalog Tile.
* [Create or retrieve an IBM Cloud API key](https://cloud.ibm.com/docs/account?topic=account-userapikey&interface=uicreate_user_key). The API key is used to authenticate with the IBM Cloud platform and to determine your permissions for IBM Cloud services.
* [Create or retrieve your SSH key ID](https://cloud.ibm.com/docs/ssh-keys?topic=ssh-keys-getting-started-tutorial). You need the 40-digit UUID for the SSH key, not the SSH key name.
* [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





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



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



* Onboarding Terraform templates to private catalog
* Sample templates to deploy into IBM Cloud
* Support WinRM in command line
* Documentation lists the Command-line version change log history





* [September 2021](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotessept30-2021)



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



* Inventory target feature support in Schematics Actions API
* Bastion host enhancement in Schematics Actions API
* Schematics Actions API enhancement to support bastion host connection with non-root user
* IBM Cloud Schematics job queue process
* Schematics Actions APIs enhances the credentials parameter
* Schematics introduces compact flag in the workspace create and update API
* Importance of location and URL endpoint in workspace creation





* [August 2021](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesaug-2021)
* [ibmcloud schematics workspace get with Agent](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-agent-wks-get)





[CLI version history](https://cloud.ibm.com/docs/schematics?topic=schematics-cli_version-releasescli_version-releases)





 API reference 

[IBM Cloud Schematics API](https://cloud.ibm.com/apidocs/schematics)





 Blueprint template reference 

[Blueprint template YAML schema](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-template-schema-yaml)



* [Global preface](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-parameters)



* [name](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-name)
* [type](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-type)
* [schema_version](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-schema-version)
* [description](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-description)
* [tags](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-tags)
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-liberty/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-liberty/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.



 Displaying blueprints 



 Displaying blueprints using the UI 

You can follow these steps to list the blueprints in your account using IBM Cloud console.



1. From the [Blueprints dashboard](https://cloud.ibm.com/schematics/blueprints). Click your blueprint name to view the blueprint details.
2. Click Overview to view the blueprint summary, that includes Modules status, Variables summary, Blueprint Details and Recent Job runs of your blueprint.



* Optional: From Modules status section, Click View details to view the module details.
* Optional: From Variables summary section, Click View details to view the variable summary.



3. Click Modules tab to see the list of modules and their current status.



* Optional: Click Show details to view the module details.
* Optional: Click Name to go to the modules Workspace page.



4. Click Resources tab to view the list of resources provisioned status by the blueprint.
5. Click Variables tab to view your Inputs and Outputs variables and values. Optional: you can edit the input variables and click Save variables.
6. Click Jobs history tab view the job logs of the blueprint and module activities.
7. Click Settings tab to view the configuration settings of the blueprint.







 Displaying blueprints using the CLI 

To list the blueprints available in your account with the CLI, use the ibmcloud schematics blueprint list command. This command requires no arguments. It is region specific and will only list blueprints in the selected CLI region.
* [Uninstalling the IBM Cloud Schematics command-line plug-in](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cliuninstall-schematics-plugin)



[Setting up the API](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-apisetup-api)



* [Working with the Schematics API](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-apics_api)
* [Refreshing IBM Cloud IAM access tokens and obtaining new tokens with the API](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-apiapi_refresh)







 Managing Blueprints 

[Understanding blueprint templates and configuration](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templatesblueprint-templates)



* [Blueprint configuration](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templatesblueprint-temp-config)
* [Blueprint template overview](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templatestemplate-overview)



* [Blueprint template YAML file](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templatesblueprint-yaml-file)
* [Template inputs](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templatesblueprint-input-statements)
* [Template outputs](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templatesblueprint-output)