vania-janet/multiturn-rag-retrieval-data huggingface dataset:
* UI
* CLI
* API





Schematics Blueprints is a [beta feature](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-beta-limitations) that is 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-limitations) for the beta release.



 Apply blueprint config changes to an environment 

Blueprint run apply is the second step to create, or update resources in a blueprint environment. This step runs the IaC automation code for each module. For each module, Schematics runs a Terraform Apply to create or configure the cloud resources defined by the Terraform module code.



 Running a blueprint apply through CLI 

To deploy your blueprint environment through CLI, use the ibmcloud schematics blueprint run apply command.

Before your begin



* Install and log in to the [IBM Cloud CLI](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cliinstall-schematics-cli).



The following command executes a blueprint run apply operation for the environment with the ID eu-de.BLUEPRINT.Blueprint-Basic-Example.21735936

For all the blueprint commands, syntax, and detailed option flags, refer to, [blueprint commands](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceblueprints-cmd).

Syntax

ibmcloud schematics blueprint run apply --id Blueprint_Basic.eaB.5cd9

On successful completion, the apply command returns fullfilment_success.



 Verify blueprint run apply success 

Verify that the blueprint configuration change has been applied successfully. When you apply the configuration from CLI, the command displays the details of the modules being applied, and a continuously updating status of the progress of the Schematics jobs that run the IaC automation code.
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.
* Use Schematics to securely connect and manage hybrid cloud infrastructure by using [Terraform](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-about), [Ansible](https://cloud.ibm.com/docs/schematics?topic=schematics-getting-started-ansible), and other automation tools to perform the deployment, configurations, and the day-2 operations.
* Use to reduce your wait time in a shared Schematics queue to run your automation.
* Use a dedicated infrastructure to run your automation and the ability to scale up or scale down the capacity depending on your automation workloads.
* Use to fine tune the network policies such as [ingress](https://cloud.ibm.com/docs/containers?topic=containers-vpc-kube-policies) or egress rules that are used by Schematics to connect to hybrid cloud infrastructure.
* Use your software, and versions in conjunction with automation engine provided by the Schematics runtime.







 Schematics Agent architecture 

The diagram represents the Schematics Agent architecture, and how it functions in Schematics.

Zoom

![Schematics Agent Architecture](https://cloud.ibm.com/docs-content/v1/content/ba89e173287b28d1453d2a327d8a1f74ae2f1662/schematics/images/new/sc_agentb0_architecture.svg)

Schematics Agent architecture and its components



1.
In this tutorial, you learn how to create and deploy a scalable Java Spring application. This scalable web app offers a one-click option to create an IBM Cloud® Schematics workspace with your choice of preconfigured Terraform templates. The Terraform templates deploy your app to IBM Cloud with options for the deployment target (Kubernetes or Red Hat® OpenShift®) and the DevOps toolchain pipeline structure.

Schematics Red Hat OpenShift on IBM Cloud

+4

Red Hat OpenShift on IBM Cloud,Kubernetes service,Continuous Delivery,Creating apps



* 45 minutes
* 2023-03-09



[Creating an IBM Cloud Satellite environment on AWS by using scripts](https://cloud.ibm.com/docs/apps?topic=apps-tutorial-trysat)Creating an IBM Cloud Satellite environment on AWS by using scripts

This tutorial and set of scripts provide a mostly automated way to set up an IBM Cloud Satellite location and Red Hat OpenShift cluster on Amazon Web Services (AWS). This is not a production-ready solution, but it provides a useful tool for proof-of-concepts, learning, and experimenting.

Schematics Red Hat OpenShift on IBM Cloud

+4

Red Hat OpenShift on IBM Cloud,Kubernetes service,Continuous Delivery,Creating apps



* 1.5 hours
* 2022-02-23



[Reconciling usage for nonsubscription multi-year account invoices](https://cloud.ibm.com/docs/billing-usage?topic=billing-usage-tutorial-reconcile-invoice)Reconciling usage for nonsubscription multi-year account invoices

As an IBM Cloud® customer with a nonsubscription multi-year account, understanding the different invoices that are available to you can help you understand your monthly cost breakdown.

Managing billing and usage



* 15 minutes
* 2022-08-30



[Getting started with the IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started)Getting started with the IBM Cloud CLI
* [26 May 2021](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-may262021)



* Version constraints support in IBM Cloud Schematics
* Troubleshooting guide support
* Schematics supports sample solutions





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



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



* Ansible support in IBM Cloud Schematics is now generally available





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



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



* Terraform v0.14 support





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



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



* Schematics supports the ability to store the user-defined file
* Allowed file extensions in Schematics
* Schematics CLI plug-in and commands support in CLI documentation



* [12 February 2021](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-feb122021)
* Using the Schematics user interface on IBM Cloud - [GitHub repository for IBM Schematics](https://github.com/IBM-Cloud/sap-netweaver-abap-db2-distributed/tree/main/schematics).







 Schematics deployment 

When you run the scripts with the Schematics interface, you:



* Enter Workspace information.
* Enter the GitHub path.
* Modify the parameters in the Schematics interface. They are the same parameters as the input.auto.tfvars file that you use with the CLI.







 Terraform deployment 

You can use Terraform on the bastion server CLI to download and run the scripts that are located in [SAP NetWeaver ABAP Db2 3-tier GitHub repository for Terraform](https://github.com/IBM-Cloud/sap-netweaver-abap-db2-distributed).

To run the Terraform scripts, you modify:



* The input.auto.tfvars file to specify the information for your solution:



* Enter the floating IP and subnet information from the bastion server.
* Enter existing VPC information:



* VPC name
* Security group
* Subnet
* Hostname
* Profile
* Image
* Up to two SSH keys



* You can change the default SAP system configuration settings to match your solution.
* You also specify the location where you downloaded the SAP kits.





The IBM Cloud Provider Plug-in for Terraform on IBM Cloud uses these configuration files to install NW 7.x with Db2 3-tier on the specified VPC in your IBM Cloud account.





 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.
(https://cloud.ibm.com/docs/schematics?topic=schematics-secure-datapi-location).

If you provided your Terraform template by uploading a tape archive file (.tar) and you want to update your template, you must use the [ibmcloud schematics workspace upload](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-workspace-upload) command.

Syntax

ibmcloud schematics workspace update --id WORKSPACE_ID [--file FILE_NAME] [--github-token GITHUB_TOKEN] [--pull-latest] [--output OUTPUT] [--json]

Pull-latest flag is not supported for workspaces created by using templates from IBM Cloud catalogs.

Command options



Schematics Workspaces update flags

 Flag Required / Optional Description 

 --id or -i Required The unique identifier of the workspace for which you want to update the instance or resource. To find the ID of your workspace, run ibmcloud schematics workspace list command. 
 --file or -f Optional The relative path to a JSON file on your local machine that includes the updated parameters for your workspace. For more information about the sample JSON file with the details, see [JSON file update template](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referencejson-file-update-template). 
 --github-token or -g Optional Enter the GitHub token value to access private Git repository. 
 --pull-latest or --pl Optional Pull the latest changes from your GitHub repository into workspace. If this flag is set --file flag is ignored. 
 --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. 





 Update file template in JSON format
* [21 September 2022](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-sept2222)



* The Schematics Job image supports Python v3.8





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



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



* Schematics runtime now supports Ansible v2.9.27



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



* Release Schematics command-line plug-in



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



* Schematics allowed IP address for US, EU Central, and UK South region are updated





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



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



* Release Schematics command-line plug-in



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



* Schematics allowed IP address for US region is updated
Service limitations 

Review the following limitations for IBM Cloud Schematics.



 Differences to native Terraform 

If you used native Terraform before and plan to migrate your Terraform templates to IBM Cloud Schematics, make sure that you understand the differences between the services to adjust your template.



 Do I need to provide an IBM Cloud API key in the provider block? 

The IBM Cloud® API key is essential to authenticate with the IBM Cloud platform, receive the IAM token and IAM refresh token that Schematics requires to work with the resource's API, and to determine the permissions that you were granted. When you use native Terraform, always you must provide the IBM Cloud API key. In Schematics, the IAM token is retrieved for all IAM-enabled resources, including IBM Cloud Kubernetes Service clusters, and VPC infrastructure resources. However, the IAM token is not retrieved for IBM Cloud Foundry and classic infrastructure resources and the API key must be provided in the provider block.

For more information about how to configure the provider block, see [Configuring the provider block](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-configconfigure-provider).





 Can I use my local terraform.tfvars file? 

The terraform.tfvars file is a local variables file that you use to store sensitive information, such as your IBM Cloud API key or classic infrastructure user name when you use native Terraform. This file must be present on your local machine so that Terraform can load the values for your credentials when you initialize the Terraform CLI.

With IBM Cloud Schematics, you do not use a local terraform.tfvars file. Instead, you [declare your variables](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-configconfigure-variables) in the Terraform configuration files, and enter the values for your variables when you create a workspace. You can later change the values of your variables by updating the variables from your workspace details page.





 Is Terraform remote state supported in Schematics?
Deploying IBM Cloud resources in a specific region or across multiple regions 

IBM Cloud® Schematics enables you to deploy resources in any IBM Cloud location or region globally. The region where you save and execute your Schematics workspaces and actions is independent of the region where your IBM Cloud resources are deployed or configured.

IBM Cloud Schematics executes your jobs from your selected Schematics region and remotely access the services to provision resources in the target regions determined by your Terraform templates. It is unaffected by network latency between regions. For example, If you create a workspace in us-south, you can use this workspace to provision services in any supported IBM Cloud region, such as us-east or eu-gb. The location of your workspace determines where your workspace data is stored and where your workspace requests are run. For more information, see [Where is the information stored?](https://cloud.ibm.com/docs/schematics?topic=schematics-secure-datapi-location)



 Deploying services in a specific region 

If all your services can be deployed to the same region, you can specify the region in the provider block of your Terraform template.

If no region is specified in the provider block, Schematics automatically attempts to create your IBM Cloud resources in the us-south region.



1. Open the provider.tf file or the Terraform configuration file that contains the provider block.
2. Specify the region where you want to deploy your services. Make sure that the region that you enter is supported by the service that you want to deploy with Schematics.

provider "ibm" {
region = "<region_name>"
}
3. Check if the service that you want to deploy requires a location parameter to be set in addition to the region parameter. For example, if you use the [ibm_database](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/database) Terraform resource, you must set both the region parameter in the provider block and the location parameter in the ibm_database resource definition.
4.
Understanding Schematics use cases 

Choose among the following use cases to learn how Schematics automates your infrastructure, service, and application stacks in IBM Cloud.



* [Infrastructure deployments with Schematics Workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-how-it-workshow-to-workspaces)
* [Configuration management with Schematics Actions](https://cloud.ibm.com/docs/schematics?topic=schematics-how-it-workshow-to-actions)
* [Software deployments with IBM-provided templates](https://cloud.ibm.com/docs/schematics?topic=schematics-how-it-workshow-to-software)
* [large-scale environments with blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-get-started-blueprints)





 Infrastructure deployment with Schematics Workspaces 

Schematics Workspaces deliver Terraform-as-a-Service capabilities to you so that you can automate the provisioning and management of your IBM Cloud resources, and rapidly build, duplicate, and scale complex, multitiered cloud environments.

To get started with infrastructure deployment in Schematics, see [Getting started tutorial](https://cloud.ibm.com/docs/schematics?topic=schematics-get-started-terraform).

[Terraform](https://www.terraform.io/) is an open source project that lets you specify your cloud infrastructure resources and services by using a high-level scripting language. Your specification is stored in a Terraform configuration file. The complexity of using APIs, provisioning, and managing your cloud resources is removed from the user. The cloud providers create a plug-in for Terraform that contains the information for how to connect to the cloud provider. And what APIs to invoke with a certain cloud resource?
Beta code for Schematics Agents 

The Agent level of code is considered beta code as there will be changes in function and capabilities between now and the General Availability (GA) date.

Although Agent usage has no cost involved during beta, it will have a cost eventually in the GA timeframe. You will be updated in the documentation with the usage and the charges.

Join our beta program, post a question in the [IBM Cloud Schematics users Slack](https://ibm-argonauts.slack.com/archives/CLKR4FE90), and engage with the Schematics team. If you do not have access to this Slack, [request an invitation to this Slack](https://cloud.ibm.com/schematics/slack).

Join the schematics-users slack channel and post a message include the following information.



* Your name
* email address
* Your Company/Organization name
* Your level of experience with cloud automation, specifically regarding Terraform, Ansible, or IBM Cloud Schematics
* Any initial questions or comments



You can come back any time to your created thread to add information, ask questions, or give feedback.



 Beta release limitations for Agent 

There will be multiple beta releases in short window period, this requires the users to update the Agent infrastructure and Agent services in your environment.



Beta release limitations

 Limitation Resolved Date 

 UI capabilities are not final and will be updated throughout the beta process. 
 Support for drift detection is not available in Agents. 
 Support to [store or persist user-defined](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faqpersist-file) files is not available in Agents. 
 Agents supports only Terraform v1.0 or higher Terraform version. 
 Agent customization is not finalized, will be communicated. 
 Support to monitor Agent health is limited in this release. 
 Supports only one Agent in one cluster. 
 Agents can be installed in a freshly provisioned Agent infrastructure, not in any other cluster. 
 Update to Agent settings is not propagated to the Agent service. It requires a redeployment of Agent service using Kubernetes Dashboard. 







 Joining public slack channel
Onboarding your Terraform template 

This tutorial walks you through how to onboard a Terraform template to your private catalog in IBM Cloud®.



 Before you begin 



1. Create your Terraform template. For more information, see [Creating Terraform templates](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-config).
2. Test your Terraform template by running the following commands from the Terraform CLI:



* terraform init
* terraform validate



3. Upload your Terraform template to a GitHub release and create a .tgz file. For more information, see [Upload your Terraform template and readme file to your GitHub repository](https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/tree/mainupload-your-terraform-template-to-a-github-release).

Use the [latest release of the sample Terraform code](https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/tag/v1.0) as an example of how to set up your repository.
4. Verify that you're assigned the correct roles. For Terraform, you need the following IBM Cloud Identity and Access Management (IAM) roles.



* Administrator on all account management services and all IAM services
* Editor on the catalog management service
* Manager service access role for IBM Cloud Schematics
* Operator platform role for VPC Infrastructure
* Editor on the software instance service
* The required permission to complete a specific task









 Step 1: Import your Terraform template 



1. In the IBM Cloud console, click the Navigation Menu icon ![Navigation Menu icon](https://cloud.ibm.com/docs-content/v1/content/ff5860bfede49db3197c4bbba7f7123769bdc068/icons/icon_hamburger.svg) > Partner Center > Sell > My products.
2.
* [Storage](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templatestorage-templates)
* [Classic infrastructure service](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templateclassic-infra-templates)
* [Account management and IAM](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templateaccount-mgt-iam)





 Onboard to IBM Cloud private catalog 

You can click the Onboard to IBM Cloud catalog button to automatically load the following sample Terraform templates into your catalog. To run the automation, click the Create button in Create an action page in the console.

For more information, about how the Ansible based automation is configured to load the template to private catalogs? refer to [Onboard to IBM Catalog readme file](https://github.com/Cloud-Schematics/onboard-to-ibm-catalog/blob/main/README.md).

![onboardtoibmcatalog.png](https://cloud.ibm.com/docs-content/v1/content/4cd6263f39a034d265ddb4b0a5e6d50c55d13ee8/ibm-cloud-provider-for-terraform/images/onboardtoibmcatalog.png)[onboard Terraform template to private catalog](https://cloud.ibm.com/schematics/actions/create?name=myprivatecatalogaction&url=https://github.com/Cloud-Schematics/onboard-to-ibm-catalog)







 Code snippets 

The code snippets provides the templates that you can use to understand how to configure IBM Cloud service. You can also use the snippets as a starting point for your custom templates.