vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Optional: If you want to set up a journal device or KVDB devices, enter the device details in the Advanced Options field. Choose from the following options for journal devices.



* Enter j;auto to allow Portworx to automatically create a 3 GB partition on one of your block storage devices to use for the journal.
* Enter j;</device/path> to use a specific device for the journal. For example, enter j;/dev/vde to use the disk located at /dev/vde. To find the path of the device that you want to use for the journal, log in to a worker node and run lsblk.
* Enter kvdb_dev;<device path> to specify the device where you want to store internal KVDB data. For example, kvdb_dev;/dev/vdd. To find the path of the device that you want to use, log in to a worker node and run lsblk. To use a specific device for KVDB data, you must have an available storage device of 3GB or on at least 3 worker nodes. The devices must also and on the same path on each worker node. For example: /dev/vdd.





2. Click Create to start the Portworx installation in your cluster. This process might take a few minutes to complete. The service details page opens with instructions for how to verify your Portworx installation, create a persistent volume claim (PVC), and mount the PVC to an app.
3. From the [IBM Cloud resource list](https://cloud.ibm.com/resources), find the Portworx service that you created.
4. Review the Status column to see if the installation succeeded or failed. The status might take a few minutes to update.
5. If the Status changes to Provision failure, follow the [instructions](https://cloud.ibm.com/docs/containers?topic=containers-debug-portworx) to start troubleshooting why your installation failed.
6.
How to fix it 

Manually set up your cluster to back up the internal registry to an IBM Cloud Object Storage bucket.



1. Make sure that the API key for the region and resource group is set and that you have the [required permissions to create a cluster](https://cloud.ibm.com/docs/openshift?topic=openshift-access_referencecluster_create_permissions).
2. If corporate network policies prevent access from your local system to public endpoints via proxies or firewalls, [allow access to the IBM Cloud Object Storage subdomain](https://cloud.ibm.com/docs/openshift?topic=openshift-vpc-firewallopenshift-registry).
3. Identify the IBM Cloud Object Storage instance to use. You can create an instance or use an existing one.



* [Create a standard IBM Cloud Object Storage service, at least one bucket, and HMAC service credentials](https://cloud.ibm.com/docs/openshift?topic=openshift-storage-cos-understandcreate_cos_service).
* To use an existing instance, make sure that you and the API key that is set for the region have permissions to the instance.



4. Create a cluster with your IBM Cloud Object Storage instance ID. For more information, see the [CLI reference](https://cloud.ibm.com/docs/openshift?topic=openshift-kubernetes-service-clicli_cluster-create-vpc-gen2).

ibmcloud oc cluster create vpc-gen2 --name NAME --zone ZONE --vpc-id VPC_ID --subnet-id VPC_SUBNET_ID --flavor WORKER_FLAVOR --cos-instance COS_CRN --workers 3
5. Verify that the internal registry images are backed up to IBM Cloud Object Storage.



1.
Ask your account owner to [set up the API key](https://cloud.ibm.com/docs/containers?topic=containers-access-creds) with the required permissions.
15. Complete the Resource details to customize the unique cluster name and any [tags](https://cloud.ibm.com/docs/account?topic=account-tag) that you want to use to organize your IBM Cloud resources, such as the team or billing department.
16. Enable any integrations that you want to include on your cluster.

Some integrations are automatically enabled if you have an existing platform instance of that integration. In this case, you cannot disable the integration. If you want to use an integration and you have only an existing application instance of that integration, the integration is disabled by default and you must manually enable it.



Activity tracking

Enable the [activity tracking](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-getting-started) option. From the drop down menu under Instance, choose an existing instance or Create a new instance. If you choose Create a new instance, the details of the new instance are shown. The new instance is created when the cluster is created. If you disable this integration and want to enable it later, see [Getting started with Activity Tracker](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-getting-startedgs_step2).
Logging

Enable the [logging](https://cloud.ibm.com/docs/log-analysis?topic=log-analysis-getting-started) option. From the drop down Platform instance menu, choose a platform instance. From the drop down Application instance, choose an existing application instance or choose Create a new instance. If you choose Create a new instance, the details of the new instance are shown. The new instance is created when the cluster is created. If you disable this integration and want to enable it later, see [Logging for clusters](https://cloud.ibm.com/docs/containers?topic=containers-health&interface=ui).
Monitoring
Now that you completed your Terraform on IBM Cloud setup, you can go ahead and add the code to create your IBM Cloud Kubernetes Service or Red Hat OpenShift on IBM Cloud cluster.





 Step 2: Create a single zone cluster 

Create a classic IBM Cloud Kubernetes Service or Red Hat OpenShift on IBM Cloud cluster by using Terraform on IBM Cloud.



1. Create an Terraform on IBM Cloud configuration file for your single zone cluster. The following example creates a single zone cluster in the dal10 zone with a default worker pool that consists of 3 worker nodes that are connected to a private and public VLAN in dal10.

Example for an IBM Cloud Kubernetes Service cluster

data ibm_resource_group "resource_group" {
name = "default"
}
resource ibm_container_cluster "tfcluster" {
name = "tfclusterdoc"
datacenter = "dal10"
machine_type = "b3c.4x16"
hardware = "shared"
public_vlan_id = "2234945"
private_vlan_id = "2234947"

kube_version = "1.21.9"

default_pool_size = 3

public_service_endpoint = "true"
private_service_endpoint = "true"

resource_group_id = data.ibm_resource_group.resource_group.id
}
Show more

For more information, about the description of ibm_container_cluster argument reference such as public_vlan_id, private_vlan_id, kube_version values, refer to [registry documentation of ibm_container_cluster](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/container_clusterargument-reference).

Example for an Red Hat OpenShift on IBM Cloud cluster

data "ibm_resource_group" "resource_group" {
name = "default"
}

resource "ibm_container_cluster" "tfcluster" {
name = "tfcluster"
datacenter = "dal10"
IBM Cloud Schematics provides powerful tools to automate your cloud infrastructure provisioning and management process, the configuration and operation of your cloud resources, and the deployment of your app workloads.

To do so, Schematics uses open source projects, such as Terraform, Ansible, Red Hat OpenShift, Operators, and Helm, and delivers these capabilities to you as a managed service. Rather than installing each open source project on your system, and learn the API or CLI. You can declare the tasks that you want to run in IBM Cloud and watch Schematics run these tasks for you.

For more information about how Schematics Works, see [About IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-learn-about-schematics).
* What is Infrastructure as Code?

Infrastructure as Code (IaC) helps you codify your cloud environment so that you can automate the provisioning and management of your resources in the cloud. Rather than manually provisioning and configuring infrastructure resources or by using scripts to adjust your cloud environment, you use a high-level scripting language to specify your resource and its configuration. Then, you use tools like Terraform to provision the resource in the cloud by using its API. Your infrastructure code is treated the same way as your app code so that you can apply DevOps core practices such as version control, testing, and continuous monitoring.
* What am I charged for when I use Schematics?

IBM Cloud Schematics Workspaces are provided to you at no cost. However, when you decide to apply your Terraform template in IBM Cloud by clicking Apply plan from the workspace details page or running the ibmcloud schematics apply command, you are charged for the IBM Cloud resources that are described in your Terraform template. Review available service plans and pricing information for each resource that you are about to create. Some services come with a limit per IBM Cloud account. If you are about to reach the service limit for your account, the resource is not provisioned until you increase the service quota, or remove existing services first.

The Schematics ibmcloud terraform command usage displays warning and deprecation message as Alias Terraform are deprecated.
Software deployments with Schematics



1. Choose a template: The [IBM software solutions catalog](https://cloud.ibm.com/catalogsoftware) offers a wide variety of infrastructure and software templates that you can choose from. These templates help to quickly install software, such as IBM Cloud Paks, IBM® WebSphere Application Server for IBM Cloud®, or Kibana and Grafana into the target service of your choice.
2. Configure your workspace and target: When you choose one of the provided templates, you must select the target where you want to install the template. Depending on the template that you choose, the target can be an IBM Cloud Kubernetes Service cluster, a Red Hat OpenShift on IBM Cloud cluster, or a classic or Virtual Servers for VPC. Because Schematics is used to install the software, you must configure the workspace that is automatically created for you.
3. Run the template: When you run the template, Schematics uses the built-in Terraform, Ansible, Helm, OpenShift Operator, or Cloud Pak capabilities to install your software or spin up infrastructure resources. You can use your workspace to monitor the progress of your template execution.







 Next steps 



* Explore blueprint samples by using Schematics [tutorials](https://cloud.ibm.com/docs/schematics?topic=schematics-provisioning-terraform-template).
* Click [here](https://cloud.ibm.com/docs/schematics?topic=schematics-how-it-works) to revisit the Schematics use cases.
General 

Answers to common questions about the IBM Cloud Schematics are classified into following section.



 What is IBM Cloud Schematics and how does it work? 

IBM Cloud Schematics provides powerful tools to automate your cloud infrastructure provisioning and management process, the configuration and operation of your cloud resources, and the deployment of your app workloads.

To do so, Schematics uses open source projects, such as Terraform, Ansible, Red Hat OpenShift, Operators, and Helm, and delivers these capabilities to you as a managed service. Rather than installing each open source project on your system, and learn the API or CLI. You can declare the tasks that you want to run in IBM Cloud and watch Schematics run these tasks for you.

For more information about how Schematics Works, see [About IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-learn-about-schematics).





 What is Infrastructure as Code? 

Infrastructure as Code (IaC) helps you codify your cloud environment so that you can automate the provisioning and management of your resources in the cloud. Rather than manually provisioning and configuring infrastructure resources or by using scripts to adjust your cloud environment, you use a high-level scripting language to specify your resource and its configuration. Then, you use tools like Terraform to provision the resource in the cloud by using its API. Your infrastructure code is treated the same way as your app code so that you can apply DevOps core practices such as version control, testing, and continuous monitoring.





 What am I charged for when I use Schematics? 

IBM Cloud Schematics Workspaces are provided to you at no cost. However, when you decide to apply your Terraform template in IBM Cloud by clicking Apply plan from the workspace details page or running the ibmcloud schematics apply command, you are charged for the IBM Cloud resources that are described in your Terraform template. Review available service plans and pricing information for each resource that you are about to create. Some services come with a limit per IBM Cloud account.
Setting up continuous deployment with Schematics and DevOps toolchain 



 Description 

In this tutorial, you can learn to use your credentials and an API key to use a Terraform template of IBM Cloud® Object Storage in the Schematics Workspace. Then, you also learn to automate the continuous deployment by using DevOps delivery pipeline. As part of the tutorial, you use ibm_cos_bucket Terraform template example.

The ibm_cos_bucket example creates an instance of IBM Cloud Object Storage, IBM Cloud® Activity Tracker, and IBM Cloud® Monitoring.

Costs are incurred based on your resource usage. For more information about the pricing, see [Pricing](https://cloud.ibm.com/docs/billing-usage?topic=billing-usage-charges). About the support and help, see [Schematics help](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-help).





 Objectives 

In this tutorial, you can:



* Explore an IBM provided Terraform template to create an IBM Cloud Object Storage instance that binds with the IBM resource instance, and IBM resource group.
* Learn how to create an IBM Cloud Schematics Workspace.
* Learn to automate continuous deployment of a resource by using IBM Cloud Schematics and DevOps toolchain.
* Review the IBM Cloud resources that you create.







 Time needed 

1 hour





 Audience 

This tutorial is intended for the developer and system administrators who want to learn how to use Terraform templates to create. And automate the continuous deployment of resource by using IBM Cloud Schematics and DevOps toolchain.





 Prerequisites 

About IBM Cloud Schematics

[IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-getting-started) is an IBM Cloud automation tool. It provides simplified provisioning, orchestrating Infrastructure as Code (IaC), templates, and managing IBM Cloud resources in your IBM Cloud environment by using various resources tools such as Terraform, Helm.
Browse the [IBM software solutions catalog](https://cloud.ibm.com/catalogsoftware) and choose among a wide range of software and infrastructure templates that you can use to set up cloud resources, and to install IBM and Third party software in your IBM Cloud Kubernetes Service cluster, Red Hat OpenShift on IBM Cloud cluster, or a classic or Virtual Servers for VPC.

Software templates are installed by using the built-in Terraform, Ansible, Helm, Red Hat OpenShift on IBM Cloud Operator, and Cloud Pak capabilities in Schematics. When you choose to install one of the provided templates, you create a Schematics Workspaces and choose the target service or host where you want run the installation. You can review which of the integrated technologies in Schematics is used to install your template.

You can also create your own software and infrastructure templates and import them in to your own private catalog in IBM Cloud. For more information, see [Adding products to a private catalog](https://cloud.ibm.com/docs/account?topic=account-create-private-catalog)

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

Zoom

![Software deployments with Schematics](https://cloud.ibm.com/docs-content/v1/content/ba89e173287b28d1453d2a327d8a1f74ae2f1662/schematics/images/software_flow.png)

Figure 3. Software deployments with Schematics



1. Choose a template: The [IBM software solutions catalog](https://cloud.ibm.com/catalogsoftware) offers a wide variety of infrastructure and software templates that you can choose from. These templates help to quickly install software, such as IBM Cloud Paks, IBM® WebSphere Application Server for IBM Cloud®, or Kibana and Grafana into the target service of your choice.
2.
Prerequisites 

About IBM Cloud Schematics

[IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-getting-started) is an IBM Cloud automation tool. It provides simplified provisioning, orchestrating Infrastructure as Code (IaC), templates, and managing IBM Cloud resources in your IBM Cloud environment by using various resources tools such as Terraform, Helm. IaC helps you codify your cloud environment to automate the provisioning, speeds deployment, and managing your resources. The infrastructure is treated the same way as your app code, so that you can automate the DevOps core practices such as version control, testing, continuous integration, and deployment.

About DevOps toolchain

A DevOps toolchain is a set of tools that automates the tasks of developing and deploying your app. A toolchain is a set of tool integrations that support development, deployment, and operations tasks. The collective power of a toolchain is greater than the sum of its individual tool integrations.

For the information, see [DevOps toolchain](https://cloud.ibm.com/docs/apps?topic=apps-devops-toolchains). The Schematics option enables the continuous delivery of your infrastructure configurations as well with IBM Cloud toolchain.

Complete the following prerequisites for the tutorial:



* If you do not have IBM Cloud account, create an IBM Cloud account, and pay as you use. For more information about managing IBM Cloud account, see [Managing IBM Cloud account](https://cloud.ibm.com/registration).
* Install the [IBM Cloud CLI](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cliinstall-schematics-cli) and the [Schematics CLI plug-in](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cliinstall-schematics-plugin).
* [What am I charged for when I use Schematics?](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faqcharges)
* [Does IBM Cloud Schematics support multiple Terraform provider versions?](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faqprovider-versions)
* [How do I generate IAM access token, if client ID bx is used?](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faqcreateworkspace-generate-tokens)
* [How do I rectify 'Failed to clone Git repository, might not find remote ref refs/heads/master (most likely invalid branch name is passed)'?](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faqtemplate-errors)
* [Can I increase the timeout for null-exec and remote-exec resource?](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faqtimeout-null-resource)
* [How can I save user-defined files that are generated by the Terraform modules and use them across multiple Terraform plan, apply, destroy, refresh, or import commands?](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faqpersist-file)
* [How do I identify the best way to synchronize a deleted resource with the Terraform state?](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faqsync-delresource-terraform)
* [How do I overcome the request exceeds the Cluster resource quota of '100' for the account in any region?](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faqclusterquota-warn-faq)
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.



 Deploying blueprints 

Deploying a blueprint environment using a blueprint template and input values is a two-step operation. The two-step process ensures controlled application of change first to the stored blueprint configuration, then to the cloud resources. In a future release a plan step will be added to allow preview of all resource changes before deploying.



1. Create the blueprint configuration in Schematics: This first step creates and saves a blueprint configuration in Schematics. The configuration specifies the blueprint template used to create the reference architecture and the inputs that will we used. Schematics retrieves the user specified blueprint template from its Git repo, input values and performs validation. The automation modules defined in the template are imported from their source repositories. The required Schematics linked modules are initialized to manage deployment of the IaC modules and creation of cloud resources in the next step.
2. Apply the blueprint configuration: Schematics runs the IaC module automation code in dependency order to create the environment and cloud resources. This step runs a Terraform Apply operation for each module to create the resources as specified by the blueprint template.



The deployment steps are illustrated in the diagram.

Zoom

![blueprint deployment](https://cloud.ibm.com/docs-content/v1/content/ba89e173287b28d1453d2a327d8a1f74ae2f1662/schematics//images/new/sc-bp-deploy.svg)

blueprint deployment



1. Prepare the configuration for the blueprint.
To provision or modify IBM Cloud, see the [ibmcloud schematics plan](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-plan) command.

IBM Cloud Schematics supports 50 API requests per minute, per host, and per customer. The region can be us-east, us-south, eu-gb, or eu-de region. You need to wait before calling the command again. Ensure the location and the url endpoint are pointing to the same region when you create or update workspaces and actions. For more information about location and endpoint, see [Where is my information stored?](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.