vania-janet/multiturn-rag-retrieval-data huggingface dataset:
The IBM Cloud Provider plug-in for Terraform on IBM Cloud uses these configuration files to provision a VPC in your IBM Cloud account.





 Schematics deployment 

You use the Schematics user interface on IBM Cloud® and enter the [GitHub repository for S/4HANA Schematics](https://github.com/ibm-cloud/sap-s4hana/tree/main/schematics).

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



* Enter Workspace information.
* Enter the Github path.
* Modify the parameters in the Schematics interface.







 Catalog Tile deployment 

When you use the Catalog Tile for deployment, you:



* Select the SAP S/4HANA tile from the catalog
* Enter information for your workspace. The Catalog Tile creates a Schematics workspace for you.
* Modify the parameters for your bastion server, personal credential information, and other parameters specific to your solution.







 SAP Kits 

For each IBM Cloud region, IBM allocates temporary storage on a dedicated Jump host. It is your responsibility to download the necessary SAP and DB kits to your Deployment Server. All files archives are decompressed by Ansible during the automation deployment process. For more information, see the readme file.





 Support - Schematics and Terraform 

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.





 Support - Catalog Tile 

The Catalog Tile offering is IBM Cloud supported. For more information, see [Getting help and support from IBM Cloud or SAP](https://cloud.ibm.com/docs/sap?topic=sap-help-support&interface=ui).

If client issues are identified with SAP software, then SAP Support will assist client.
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.



 Blueprints 

Answers to common questions about working with blueprints are classified under the following sections.



 What are the Git repositories that are supported by Blueprints? 



Supported Git repositories

 Repository <br> Template <br>Public repo Template <br>Private repo Module <br>Public repo Module <br>private repo Comment <br> 

 GitHub Yes Git token Yes Git token 
 GitLab Yes Git token Yes Git token 
 IBM GitLab Yes Git token Yes Git token IAM token planned Dec 2022 
 Terraform.io No No Yes NA 







 Are variable operators and functions supported in blueprint templates? 

The 1.0.0 release of the Blueprints schema supports a minimal set of variable operators. It is intentionally simple. The values passed between inputs and outputs are passed as is. Functions and variable operators are not supported in this release.

A future release intends to implement functions and operators.





 How are blueprint module dependencies and execution order determined? 

Dependencies between blueprint modules are created using the value references between module inputs and outputs. Similar to Terraform, a DAG (Directed Acyclic Graph) is generated from the dependencies and relationships to determine execution order. Dependencies are created using '$module' references.





 How do I edit and validate blueprint templates? 

Blueprint templates can be edited in any editor or IDE. Follow the instructions on how to use and configure VSCode to [edit templates and input files](https://cloud.ibm.com/docs/schematics?topic=schematics-edit-blueprints).
Managing IBM Cloud resources with workspaces 

Deploy, modify, and remove IBM Cloud® resources by changing the infrastructure code in your Terraform template and by using IBM Cloud Schematics to apply the template in your IBM Cloud account.

When do I use IBM Cloud Schematics versus the individual resource dashboards?
With IBM Cloud Schematics, you can run your infrastructure code in IBM Cloud to manage the lifecycle of IBM Cloud resources. After you provision a resource, you use the dashboard of the individual resource to work and interact with your resource. For example, if you provision a virtual server instance in a Virtual Private Cloud (VPC) with IBM Cloud Schematics, you use the VPC console, API, or command-line to stop, reboot, and power on your virtual server instance. However to remove the virtual server instance, you use IBM Cloud Schematics.

What happens if I manually added, or removed a resource from the service dashboard directly?
When you provision resources with IBM Cloud Schematics, the state of your resources is stored in a local IBM Cloud Schematics state file. This state file is the single source of truth for IBM Cloud Schematics to determine what resources are provisioned in your IBM Cloud account. If you manually add a resource without IBM Cloud Schematics, this resource is not stored in the IBM Cloud Schematics state file, and as a consequence cannot be managed with IBM Cloud Schematics.

When you manually remove a resource that you provisioned with IBM Cloud Schematics, the state file is not updated automatically and becomes out of sync. When you create your next Terraform execution plan or apply a new template version, Schematics verifies that the IBM Cloud resources in the state file exist in your IBM Cloud account with the state that is captured in your state file. If the resource is not found, the state file is updated and the Terraform execution plan is changed accordingly.

To keep your IBM Cloud Schematics state file and the IBM Cloud resources in your account in sync, use IBM Cloud Schematics to provision, or remove your resources.



 Deploying your resources 

Run your infrastructure code to provision, or modify your IBM Cloud resources with Schematics.

Before you begin:
For more information, see the [Schematics Compliance page](https://www.ibm.com/cloud/compliance) for links to the certificates. The following descriptions on the Schematics compliance page cover the Schematics service and respective certifications:



* IBM Cloud Services (PaaS and SaaS) certified cloud product listing
* IBM Cloud Services (PaaS and SaaS) certificate - ISO 27001
* IBM Cloud Services (PaaS and SaaS) certificate - ISO 27017
* IBM Cloud Services (PaaS and SaaS) certificate - ISO 27018
* IBM Cloud Services (PaaS and SaaS) certificate - ISO 27701







 SOC 2 Type 2 Certification 

IBM provides a Service Organization Controls (SOC) two Type 2 report for Schematics. The reports evaluate IBM's operational controls according to the criteria set by the American Institute of Certified Public Accountants (AICPA) Trust Services Principles. The Trust Services Principles define adequate control systems and establish industry standards for service providers such as IBM Cloud to safeguard their clients data and information.

You can request an SOC 2 Type 2 report from the Client portal or contact your sales representative. Alternatively, you can open a support ticket with [IBM Cloud Support](https://www.ibm.com/cloud/support).
One tool is the [IBM Cloud Design Decision Tool](https://github.com/ibm-cloud-architecture/infrastructure-design-decision-tool), which helps you compare infrastructure designs so you can build the best IBM Cloud solution to suit your needs.

After you've planned and designed your infrastructure, use the cost estimator [Click Cost estimator icon then click Review summary] to see how much your infrastructure will cost before placing your order. You can access it by clicking the Cost Estimator icon in the console menu bar.

The IT ops admin journey steps you through the various stages of planning, building, and managing your environment. The journey contains links to the compute, storage, and networking options offered by IBM Cloud, and information on the IBM Cloud Platform as a Service and Software as a Service.

IBM Cloud offers you a strong support network that includes forums and wikis [Click the Support menu option, then find the Ask the community link or Create a case link in the Need more help? section], as well as support specialists to answer your questions. As a member of the IBM Cloud IT operations administrator family, you have the support of designers, developers, and other IT ops admins who share the same ideas and risks as you do.

Know that you have the support of IBM Cloud, too. Once again, welcome.





 Cloud service models 

Three types of cloud service models exist: Infrastructure as a Service (IaaS), Platform as a Service (PaaS), and Software as a Service (SaaS). Figure 1 explains who does what within each service model. For more information, see [IaaS, PaaS, and SaaS - IBM Cloud service models](https://www.ibm.com/cloud/learn/iaas-paas-saas)![External link icon](https://cloud.ibm.com/docs-content/v1/content/8aa0853d34cf2349f1d2db8e5c61e6422a580169/icons/launch-glyph.svg).

Zoom

![Cloud service models.]
: IBM Cloud Schematics supports and releases Ansible beta version for the IBMers. For more information, see [about Ansible](https://cloud.ibm.com/docs/schematics?topic=schematics-getting-started-ansible) and watch [video about Ansible](https://www.youtube.com/watch?v=fHO1X93e4WA).

Beta
: The open beta release of Ansible support is now available in IBM Cloud Schematics to IBM users. Contact your IBM Cloud Schematics Technical Offering Manager [Carl Swanson](mailto:swansoca@us.ibm.com), if you are interested in getting early access to this beta offering.







 November 2020 

Review the release notes for November 2020.



 25 November 2020 

Terraform v0.13 support
: IBM Cloud Schematics now supports Terraform v0.13. You can now choose to run your infrastructure code with Terraform version 0.11 or 0.12 or 0.13. With Terraform version 0.13, the syntax for configuration files changed. Make sure that you use the syntax that is compatible with the Terraform version that you want to use.







 October 2020 

Review the release notes for October 2020.



 16 October 2020 

Monitoring
: IBM Cloud Schematics now supports monitoring Schematics services by using IBM Cloud Monitoring. For more information about the monitoring Schematics Workspaces, see [Monitoring Schematics instances](https://cloud.ibm.com/docs/schematics?topic=schematics-monitoring-instances).

Files and resources for your workspace actions
: IBM Cloud Schematics now performs the vulnerability check of the files and resources that are added for the first time to your repository.

Creating a deploy to IBM Cloud Schematics link
: IBM Cloud Schematics now supports an efficient way to share your Git repository so that other people can experiment to create workspace by using Schematics without affecting your original code.
Yes, Schematics supports to download the Terraform modules template from the private repository. For more information, see [Supporting to download modules from private remote host](https://cloud.ibm.com/docs/schematics?topic=schematics-download-modules-pvt-git).
* Can I edit all the variables in a workspace?

You can edit only one variable at a time from Schematics console. From the command line you can edit all the variables of the workspace in the JSON format by using [ibmcloud schematics workspace update](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-workspace-update) command.
* How do I import keys when importing KMS resources?

Yes, you can set or manage the keys by using ibm_kms_key as shown in the sample code block. For more information, see [ibm_kms_key](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/kms_keyimport).

resource "ibm_resource_instance" "kms_instance" {
name = "instance-name"
service = "kms"
plan = "tiered-pricing"
location = "us-south"
}
resource "ibm_kms_key" "test" {
instance_id = ibm_resource_instance.kms_instance.guid
key_name = "key-name"
standard_key = false
force_delete =true
}
resource "ibm_cos_bucket" "smart-us-south" {
bucket_name = "atest-bucket"
resource_instance_id = "cos-instance-id"
region_location = "us-south"
storage_class = "smart"
key_protect = ibm_kms_key.test.id
}
* Can you enable the TRACE to help DEBUG Schematics API while running workspace list command?
Schematics IaC offerings 

Schematics builds on open-source Ansible and Terraform to provide a powerful set of IaC tools as a service to program your cloud infrastructure. With Schematics you can use this rich set of IaC automation capabilities to build stacks of cloud resources, manage their lifecycle, manage changes in their configurations, deploy your app workloads, and perform day-2 operations.

The four core Schematics offerings are:



 Schematics Blueprints 

Schematics Blueprints brings [infrastructure as code (IaC) practices](https://cloud.ibm.com/docs/schematics?topic=schematics-infrastructure-as-code) to the creation and lifecycle management of large-scale cloud environments. Blueprints takes large environments from their initial creation, through maintenance and ops to final decommissioning and clean up of all allocated resources.

It enables users to define and deploy cloud environments using modules of reusable and well-defined [Terraform](https://www.terraform.io) automation code. For more information about Blueprints and its features, see [Schematics Blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-intro).





 Schematics Workspaces 

With Schematics Workspaces, use Terraform to automate the [provisioning and configuration management](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-open-projects) of your IBM Cloud resources, and rapidly build, duplicate, and scale complex, multitiered cloud environments. For more information, see [Schematics Workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-workspaces).





 Schematics Actions 

With Schematics Actions, use Ansible playbooks to perform complex day-2 operations on your cloud resources, cloud environment, and app workloads.
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.



 Scaling environments 

As infrastructures scale, and resources number in the hundreds if not thousands, best practice is to break large Terraform configurations into smaller deployable units. Schematics Blueprints enables application environments to continue to scale with an orchestration framework. The Blueprints automation framework allows large environments to be created from (smaller) linked environments and managed as a single unit.

Compared to working with large monolithic IAC configurations, building and managing environments composed from smaller discrete linked environments has several benefits:



* It is safer to perform changes. Changes are localized to a single environment that can be deployed and updated independently
* The blast-radius of a change is reduced. Thus limiting the impact of unintended changes or failures.
* Smaller changes are easier to reason with and understand the impact
* Execution time is reduced as changes can be targeted to individual environments.
* Reuse of IaC code is easier as functionality can be separated from its configuration into reusable components



The two approaches commonly employed of breaking large architectures down into smaller units to improve the scaling and management are:



* Linking environments (workspaces) using Terraform remote-state data sources.
* Using an orchestration framework like the open-source [Terragrunt](https://terragrunt.gruntwork.io/){: external) tool to manage the deployment and dependency management of linked Terraform workspaces.



Schematics Blueprints takes the orchestration approach to scaling environments. This builds on the IaC best practice of modular architectures and the reusable modules in the IBM Cloud module library. The benefits and challenges of these two approaches to scaling are discussed in the following sections.



 Remote state data sources
Depending on how your Terraform templates and Git repositories are structured, you might need to make changes so that you can successfully use IBM Cloud Schematics.



* Provider block declaration: Because IBM Cloud Schematics is integrated with IBM Cloud® Identity and Access Management, your IBM Cloud API key is automatically retrieved for all IAM-enabled resources and you don't have to provide this information in the provider block. However, the API key is not retrieved for classic infrastructure and IBM Cloud Foundry resources. For more information, see [Configuring the provider block](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-configconfigure-provider).
* Terraform command-line and IBM Cloud provider plug-in: To use IBM Cloud Schematics, you don't need to install the Terraform command-line or the IBM Cloud Provider Plug-in for Terraform. If you want to automate the provisioning of resources, try out the [IBM Cloud Schematics command-line plug-in](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cli) instead.









 Setting up a continuous delivery toolchain for your workspace 

Connect your source repository to a continuous delivery pipeline in IBM Cloud to automatically generate a Terraform execution plan and run your Terraform code in IBM Cloud whenever you update your Terraform configuration files.



1. If you do not have a Continuous Delivery service instance in your account yet, create one.



1. From the IBM Cloud catalog, open the [Continuous Delivery service](https://cloud.ibm.com/catalog/services/continuous-delivery).
2. Select the IBM Cloud region where you want to create the service.
3. Select a pricing plan.
4. Enter a name for your service instance, select a resource group, and enter any tags that you want to associate with your service instance.
5. Click Create to create the service instance in your account.



2. From the [workspace dashboard](https://cloud.ibm.com/schematics/workspaces), select a workspace.
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



[Deploy a Node.js Express app by using IBM Cloud Schematics](https://cloud.ibm.com/docs/apps?topic=apps-tutorial-node-webapp)Deploy a Node.js Express app by using IBM Cloud Schematics

In this tutorial, you learn how to create and deploy a scalable Node.js Express 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



[Deploy a Java Spring app by using IBM Cloud Schematics](https://cloud.ibm.com/docs/apps?topic=apps-tutorial-spring-webapp)Deploy a Java Spring app by using IBM Cloud Schematics

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.
Blueprint template YAML schema 

This document is the reference of the YAML schema that is used to describe the blueprint template YAML file.

Blueprint templates are written in YAML with a minimum of syntax that specify the automation modules to be used, their versions, source libraries, and relationships for passing resource dependency data between modules. Template editing and schema validation is supported in [VSCode with the YAML language extension](https://cloud.ibm.com/docs/schematics?topic=schematics-edit-blueprints).

A blueprint template consists of two sections. A global section contains a default name and description for the environment, and settings related to the whole template. Also it defines the inputs the template requires, and any outputs it returns. This is followed by a modules section containing the module definitions. Resource dependencies are created between modules by interpolation of module input and output values.

Refer to the section [Understanding blueprint templates and configuration](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templates) for an overview of the template structure.

Each template file has a global preface:

name: dev-blueprint
type: "blueprint"
schema_version: "1.0"
description: "Project to provision Application Service."
tags:
- "blueprint:trial_dev"
inputs:
- name: resource_group
type: string
- name: region
type: string
- name: api_key
type: string
outputs:
- name: service-url
value: $module.bp-vsi-vpc-app.outputs.app_url
settings:
- name: TF_VERSION
value: 1.0
Show more



 Global preface 

Following are the supporting parameters that can be used to configure a template



 name 

Type: string

Required: true

An identifier for this blueprint template. The name given to a blueprint environment is defined at create time.





 type 

Type: string

Required: true
When you create your next Terraform execution plan or apply a new template version, Schematics verifies that the IBM Cloud resources in the state file exist in your IBM Cloud account with the state that is captured in your state file. If the resource is not found, the state file is updated and the Terraform execution plan is changed accordingly.

To keep your IBM Cloud Schematics state file and the IBM Cloud resources in your account in sync, use IBM Cloud Schematics to provision, or remove your resources.



 Deploying your resources 

Run your infrastructure code to provision, or modify your IBM Cloud resources with Schematics.

Before you begin:



* [Create a workspace from your GitHub repository or upload a tape archive file (.tar)](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-create-wks&interface=uicreate-wks-ui) that hosts your Terraform template.
* Make sure that you have the required [permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access) to deploy the resources in IBM Cloud.



To deploy your resources:



1. From the [workspace dashboard](https://cloud.ibm.com/schematics/workspaces), select the workspace that points to the Terraform template that you want to apply.
2. Select the Settings tab.
3. In the Summary section, click Pull latest to get the latest version of your Terraform template from the linked GitHub source repository. If you provided your Terraform template by uploading a tape archive file (.tar), you must use the [ibmcloud schematics workspace upload](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-workspace-upload) command to provide a new version of your template.
4. Optional: Review the variables that you set for your workspace. The values of your variables are used every time that you reference the variable in your Terraform template. Make sure that your variables use the correct values.