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 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.



 Create a blueprint configuration 

Deploying a blueprint environment and cloud resources using a blueprint template is a two-step process. The first step is creating a blueprint configuration in Schematics, the second step deploys this configuration with a blueprint apply operation. See [Deploying blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-deploy-blueprints) for an overview of deploying and change manage in blueprint environments.

The creation of a blueprint config takes as its input the blueprint template YAML and input YAML file that were created during the [defining blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-define-blueprints) lifecycle stage.

The first step in deploying cloud resources is [creating a blueprint configuration](https://cloud.ibm.com/docs/schematics?topic=schematics-create-blueprint-config) in Schematics. This saves the blueprint configuration for future operations. The blueprint config specifies the Git source and release of the blueprint template, input files, and any input values that are used to create cloud resources.

Blueprints creates a blueprint module resource in Schematics for each module definition in the template. Blueprint module resources are initialized with the Terraform module source from the Git repository specified in the module definition, and module inputs.
Sample Terraform templates for IBM Cloud 

Explore the sample IBM Cloud® Terraform templates, and try to execute the templates by using Schematics workspace.

Deploy [Solution templates](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templatesample-templates) by using IBM Cloud service.
Browse [Code snippets](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templatecode-snippets) by IBM Cloud service.



 Sample templates 

Following solution templates allows you to provision resource by using Schematics workspace.



* [Kubernetes and Red Hat OpenShift on IBM Cloud](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templatekubnernetes-openshift)
* [VPC infrastructure](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templatevpc-templates)
* [Observability](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templateobservability-templates)
* [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)
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.



 Defining blueprints 

IBM Cloud® Schematics Blueprints is an Infrastructure as Code (IaC) automation solution for large-scale cloud environments. It utilizes the analogy of building a house from a blueprint drawing. Where a blueprint defines the architecture, layout, major building blocks and customizations to be applied. Return to the [overview](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-introblueprint-overview) section for an introduction to Blueprints.

A blueprint [template](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termsbpb2) determines the architecture and infrastructure topology to be deployed. Reusable Terraform [modules](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termsbpb5) implement the layers and components of an infrastructure architecture from well designed, tested and compliant Terraform code. The definition of an architecture using modules and deployment as linked environments is illustrated.

Zoom

![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.
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.

IBM Cloud Schematics delivers Terraform-as-a-Service so that you can use a high-level scripting language to model the resources that you want in your IBM Cloud environment, and enable Infrastructure as Code (IaC). [Terraform](https://www.terraform.io/) is an open source software that is developed by HashiCorp that enables predictable and consistent resource provisioning to rapidly build complex, multitier cloud environments.

In this tutorial, you follow two easy steps to create a Schematics workspace and apply a Terraform execution plan. When you apply the plan, a Kubernetes or OpenShift cluster is created, and a Java Spring application is deployed to it by using an IBM Cloud DevOps toolchain.

Two types of DevOps toolchain pipeline structures are available with this app:



* Classic pipeline structure
* Tekton "GitSecure" pipeline structure



Both toolchain template options offer a code repository, delivery pipelines, and web IDE.



 Before you begin 



* Set up an [IBM Cloud account](https://cloud.ibm.com/registration). Depending on your IBM Cloud account type, access to certain resources might be limited. Depending on your account plan limits, certain capabilities that are required by some DevOps toolchains might not be available. For more information, see [Setting up your IBM Cloud account](https://cloud.ibm.com/docs/account?topic=account-account-getting-started) and [Upgrading your account](https://cloud.ibm.com/docs/account?topic=account-upgrading-account).







 Step 1: Create a Schematics workspace 



1.
Learning about Schematics 

Schematics is an IBM Cloud service, that delivers [Infrastructure as Code](https://cloud.ibm.com/docs/schematics?topic=schematics-infrastructure-as-code) (IaC) tools as a service. You can use the capabilities of Schematics to consistently deploy and manage your cloud infrastructure environments. From a single pane of glass, you can run end-to-end automation to build one or more stacks of cloud resources, manage their lifecycle, manage changes in their configurations, deploy your app workloads, and perform day-2 operations.



 IaC automation as-a-service 

Building on open-source [Ansible](https://www.ansible.com/), [Terraform](https://www.terraform.io/) and related technologies like Git and Helm, IBM Cloud® Schematics provides a powerful set of [IaC](https://cloud.ibm.com/docs/schematics?topic=schematics-infrastructure-as-code) tools as a service to program your cloud infrastructure.

An IaC approach to infrastructure provisioning and automation improves consistency, speeds deployments, reduces manual errors, and avoids undocumented or ad hoc configuration changes.

With IaC, configuration files define your infrastructure, which also makes it easier to edit, share, and reuse configurations. By codifying your infrastructure, you provision the same environment every time avoiding undocumented, ad hoc configuration changes. Review the section on [IaC best practices](https://cloud.ibm.com/docs/schematics?topic=schematics-infrastructure-as-codeiac-best-practices) to learn more about the core IaC principles and best practices that you can adopt when using Schematics.





 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:
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. Each environment has its own [blueprint configuration](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termsbpb3) and inputs. This separation of template from its runtime configuration allows a single template to be reused many times to deploy a range of environments such as dev, stage, and production with multiple target regions. Each environment being customized with its own input values. See the section [Understanding blueprint templates and configuration](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templates) for more details.

For examples of blueprint templates and inputs, see the [IBM Cloud Schematics repository](https://github.com/orgs/Cloud-Schematics/repositories?q=blueprint). Creation and editing of blueprints can be performed in [VSCode with the YAML language extension](https://cloud.ibm.com/docs/schematics?topic=schematics-edit-blueprints). Refer to the sections [understanding blueprint templates and configurations](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templates) and [blueprint template reference](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yaml) for guidance to the blueprint syntax when creating or modifying a template.

Change in blueprint environments is explicitly managed through version control.
IBM Cloud Schematics Agent beta-1 delivers a simplified agent installation process and policy for agent assignment.. You can review the [beta-1 release](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotes&interface=clischematics-mar2223) documentation and explore.

Schematics Agent are a [beta-1 feature](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-beta1-limitations) that are available for evaluation and testing purposes. It is not intended for production usage.



 Agent 

Answers to common questions about the Agent for IBM Cloud Schematics.



 What are the updates in the agent beta-1 release? 

The following are the features in Agent beta-1 release.



* Improvements to the agent deployment experience through CLI.
* Support to run Ansible playbooks on the agent.
* Dynamic assignment of workspace or action jobs to the agent.







 What are the costs of installing and using Agents? 

The following are the cost break-down for the Schematics Agent.

Pre-requisite: Agent infrastructure



* Cost of VPC infrastructure elements such as, subnet, public gateways.
* Cost of IBM Kubernetes Service (cluster) on VPC, with three-node worker pool.
* Cost of IBM Cloud Object Storage



Agent beta-1 service



* There is no cost involved in running the agent service.
* Post beta, the agent feature may be a priced service.







 Can I install more than one Agent on a cluster? 

You can install only one agent on a Kubernetes cluster on IBM Cloud Kubernetes Service. You can install additional agents on different clusters.

You cannot install more than one agent in a single Kubernetes cluster. You will get a failure with namespace conflict error.





 What type of Schematics jobs can I run in my Agent? 

You can run Schematics Workspace Terraform jobs on an Agent. You can also run Schematics Action jobs, Ansible playbooks on an Agent.
* [Reusing blueprints and pipelines](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-reuse).







 18 November 2022 

Release Schematics command-line plug-in.
: The Schematics [command-line plug-in v1.12.5](https://cloud.ibm.com/docs/schematics?topic=schematics-cli_version-releases) released.





 15 November 2022 

Release Schematics Agents GitHub repository.
: The agent beta releases [Schematics Agents](https://github.com/Cloud-Schematics/schematics-agents/releases) Cloud Schematics GitHub repository with the following fixes:



* Unknown certificate issues during repository cloning.
* Display the complete log information, log enhancements.
* Job status, and other minor bug fixes.







 14 November 2022 

Schematics Blueprints template schema changes.
: Schematics Blueprints templates now support metadata attributes for template variable inputs. This includes type, sensitive, max_length, min_length, and default. Metadata attributes of template inputs take precedence over any attributes specified on module inputs. Module metadata attributes gets depreciated in a future release.





 03 November 2022 

Release Schematics command-line plug-in.
: The Schematics [command-line plug-in v1.12.3](https://cloud.ibm.com/docs/schematics?topic=schematics-cli_version-releases) released.







 September 2022 

Schematics deprecates Python v3.6 and upgrades the Schematics Job image to use Python v3.8 by mid of September 2022. For more information, see [Schematics announcement](https://cloud.ibm.com/status/announcement?component=schematics) tools.

Review the release notes for September 2022.



 21 September 2022 

The Schematics Job image supports Python v3.8
Schematics Workspaces 

Schematics Workspaces delivers Terraform as a service capabilities 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.

[Terraform](https://www.terraform.io) is an open source project that allows you to specify your cloud infrastructure resources and services as code. It applies the concept of [Infrastructure as Code (IaC)](https://cloud.ibm.com/docs/schematics?topic=schematics-infrastructure-as-code), using code to manage and provision infrastructure (networks, virtual machines, load-balancers, clusters, services and connection topology) in a descriptive model instead of manual processes.

With Terraform, configuration files define your infrastructure, which also makes it easier to edit, share, and reuse configurations. By codifying your infrastructure, you provision the same environment every time avoiding undocumented, ad hoc configuration changes.

The blog [Infrastructure as Code: Chef, Ansible, Puppet, or Terraform?](https://www.ibm.com/cloud/blog/chef-ansible-puppet-terraform) provides an overview of several of the most popular open-source IaC tools and summarizes their capabilities and relative strengths.



 Architecture 

Zoom

![Deploying infrastructure and services with Workspaces](https://cloud.ibm.com/docs-content/v1/content/ba89e173287b28d1453d2a327d8a1f74ae2f1662/schematics//images/new/sc-workspaces.svg)

Deploying infrastructure and services with Workspaces

Using your supplied Terraform template (config), Schematics runs the Terraform engine to execute your config.





 Features 

IBM Cloud® provides built in [remote-state](https://cloud.ibm.com/docs/schematics?topic=schematics-remote-state) management for Terraform.
Benefits of using Schematics 

You do not need to install the open source projects on your machine or learn their API and command-line. You need to simply point Schematics to your IaC code repository and let Schematics run the specified tasks.



Schematics benefits

 Benefits Description 

 The open source projects used by Schematics Terraform, Ansible, Helm provisioning engine, and execution platform are tested, maintained, and monitored by IBM. IBM automatically applies the latest security standards and patches to Schematics to ensure reliability and availability of the service. You do not need to manually apply updates to the Schematics platform. 
 All versions are tested by IBM. As new versions of Terraform and Ansible become available, IBM begins with hardening and testing these versions, so that they can be supported in the Schematics platform. For more information, see [when are new Terraform and Ansible versions added to Schematics?](https://cloud.ibm.com/docs/schematics?topic=schematics-actions-faqnew-versions) 
 Schematics is fully integrated with IAM You can use service access roles to control who can access and collaborate on your workspaces and actions, or roll out changes. You can invite IBM Cloud users to your account and leverage IAM access groups to streamline the access assignment process in your organization. As a multi-tenant solution, Schematics creates all resources in your personal account. Resources are not shared or reused by other IBM Cloud tenants. Because Schematics is built on Kubernetes, IAM service access roles are mapped to role-based access controls (RBAC) in Kubernetes to enforce resource isolation within your account. 
 Full IBM support for the open-source tools and plug-ins related to IBM Cloud Schematics is fully integrated into the IBM Cloud support system. If you run into an issue by using the IBM Cloud Provider Plug-in for Terraform or the Ansible modules for IBM Cloud, you can [open an IBM Cloud support case](https://cloud.ibm.com/docs/get-support?topic=get-support-using-avatargetting-support).
: Schematics announces its [beta release](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-beta-limitations) of Schematics Blueprints to deploy large-scale and complex application environments from a reusable building blocks. Check the following content to learn about Schematics Blueprints beta releases.



* [Landing page](https://cloud.ibm.com/docs/schematics) to start your Schematics Blueprints engagement.
* [Getting started](https://cloud.ibm.com/docs/schematics?topic=schematics-getting-started).
* [Use case](https://cloud.ibm.com/docs/schematics?topic=schematics-get-started-blueprints).
* [About Schematics Blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-intro)
* [Understanding blueprint templates](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templates) to configure the right schemas and use blueprint commands to deploy blueprints.
* See [blueprint permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-accessblueprint-permissions) to get access permissions to deploy blueprints.
* Blueprint operations are supported via [CLI](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceblueprints-cmd), [UI](https://cloud.ibm.com/docs/schematics?topic=schematics-create-blueprint-config), and [API](https://cloud.ibm.com/apidocs/schematics/schematicscreate-blueprint).
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 input file YAML Schema 

This document is the reference of the YAML schema used to describe a blueprint input YAML file containing the blueprint input values required by a template.

Blueprint inputs play an important role in the customization of a blueprint template to deploy a target environment: dev, stage, prod or regions. They provide configuration for scaling, region, networking and additional parameters. Review the section on [Blueprint customization](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-reuseblueprint-customization) for more detail on defining and using inputs.

A blueprint input file defines the [input values](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-templatesblueprint-input-statements) required to customize the template to a specific use case. If a value is not defined in the template, it is assumed that the input is satisfied by a user defined input value at blueprint create time. These must be satisfied at create time by an input file (as described here) or dynamic inputs. Review the section on [input precedence order](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-reuseblueprint-input-precedence)

The type of an input variable is defined in the [input block](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-modules-inputs-options) of the template.
For more information, see [Download Schematics Job files](https://cloud.ibm.com/docs/schematics?topic=schematics-job-download).

ResourceQuery attribute deprecated
: ResourceQuery attribute is replaced as [resource_queries](https://cloud.ibm.com/apidocs/schematics/schematicslist-resource-query) in the API.







 October 2021 

Review the release notes for October 2021.



 22 October 2021 

Onboarding Terraform templates to private catalog
: For onboarding multiple Terraform templates into IBM Cloud private catalog, see [Onboard bulk Terraform templates to private catalog](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templateprovider-onboard).

Sample templates to deploy into IBM Cloud
: Install [Terraform sample Terraform templates](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-provider-templatesample-templates) to provision different IBM Cloud services by using Schematics Workspaces.

Support WinRM in command line
: The Schematics supports [Windows Remote Management (WinRM)](https://www.ibm.com/docs/en/license-metric-tool?topic=v-configuring-winrm-hyper-hosts) for Schematics Actions. Added the --inventory-connection-type, --bastion-credential-json, and --credential-json option value to the [create](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-create-action), and [update](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-update-action) commands.

Documentation lists the Command-line version change log history