vania-janet/multiturn-rag-retrieval-data huggingface dataset:
The Schematics template helped with the initial creation, but you are in control for subsequent location management actions, such as [attaching more hosts](https://cloud.ibm.com/docs/satellite?topic=satellite-attach-hosts), [creating Satellite clusters](https://cloud.ibm.com/docs/satellite?topic=openshift-satellite-clusters), or [scaling the Satellite location control plane](https://cloud.ibm.com/docs/satellite?topic=satellite-location-sizing). If you [remove](https://cloud.ibm.com/docs/satellite?topic=satellite-host-removelocation-remove-console) your Satellite location, make sure to [remove your workspace in Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-delete-wks), too.





 Manually adding hosts to Satellite in the GCP console 

You can create your Satellite location by using hosts that you added from Google Cloud Platform (GCP).

If you want to use Red Hat CoreOS (RHCOS) hosts in your location, provide your RHCOS image file to your Google account. For more information, see [Creating custom images](https://cloud.google.com/compute/docs/images/create-custom). To find RHCOS images, see the list of [available images](https://mirror.openshift.com/pub/openshift-v4/x86_64/dependencies/rhcos/). Note that you must use at least version 4.9.

All hosts that you want to add must meet the general host requirements, such as the RHEL 7 or 8 packages and networking setup. For more information, see [Host requirements](https://cloud.ibm.com/docs/satellite?topic=satellite-host-reqs).

Before you begin, [create a Satellite location](https://cloud.ibm.com/docs/satellite?topic=satellite-locations).



1.
[CreateWorkspace](https://cloud.ibm.com/docs-content/v1/content/b7b9235ce6abd45b66931867c388cf107d38e15b/cloud-native-journey/kubernetes-on-vpc/images/provision/schematics-create-workspace.png)
3. Schematics can automatically pull terraform code from a GitHub repo. Enter https://github.com/IBM-Cloud/cloud-journey/tree/main/IKS as the repository URL (which represents the VPC architecture depicted above) and select terraform_v1.0. ![CreateWorkspace2](https://cloud.ibm.com/docs-content/v1/content/b7b9235ce6abd45b66931867c388cf107d38e15b/cloud-native-journey/kubernetes-on-vpc/images/provision/schematics-create-workspace2.png)
4. Specify the workspace details values based on your preferences. ![CreateWorkspace3](https://cloud.ibm.com/docs-content/v1/content/b7b9235ce6abd45b66931867c388cf107d38e15b/cloud-native-journey/kubernetes-on-vpc/images/provision/schematics-create-workspace3.png)

As a best practice, do NOT use the "default" resource group. Create a resource group for this network or project provides more flexibility. For additional details see the [Preparing Your IBM Cloud Account](https://cloud.ibm.com/docs/vpc-journey?topic=vpc-journey-vpc-prep-account) page of this deployment journey guide.
5. Validate the information entered and click on Create to retrieve the Terraform code and create the Schematics workspace.







 Configure Terraform Variables 



1.
* Use only the following alphanumeric ASCII characters and the underscore character in values that you add to the type system: A through Z, a through z, 0 through 9.
* The first character in an entity or relation type name must be alphabetical.
* Entity type names cannot be longer than 64 characters.
* Relation type names cannot be longer than 128 characters.



By convention, entity type names are specified in uppercase characters (ORGANIZATION) and relation type names are specified in camel case (employedBy). But, this convention is optional.





 Procedure 



1. Log in as a Knowledge Studio administrator or project manager and open the Assets> Entity Types page.
2. Choose one of the following methods to create a type system:



* Upload an existing type system:



1. On the Entity Types tab, click Upload.

If you previously downloaded a type system from a Knowledge Studio workspace, the type system is downloaded in JSON format. You can upload this type system to jump-start the creation of a workspace. For more information, see [Uploading resources from another workspace](https://cloud.ibm.com/docs/watson-knowledge-studio?topic=watson-knowledge-studio-exportimport).

Regardless of the origin of the type system, the entries in it must meet the naming rules listed earlier.
2. Add, edit, and delete entity types and relation types the same way that you do when you create a type system from scratch.



* Create a type system from scratch:



1. On the Entity Types tab, click Add Entity Type.
2. Specify a descriptive entity type name, keeping in mind that the entity type is a label for annotating important spans of text (mentions) in your domain content. Keep the name short and representative, so human annotators can remember it easily.

You can also optionally define roles and subtypes for the entity type:



* A role helps qualify the entity type in the context in which the mention occurs. For example, the mention Software Engineer might be labeled with the entity type PEOPLE and, in this context, by the role OCCUPATION.
Provisioning IBM Cloud resources with IBM Cloud Schematics and Terraform



1. Codify your IBM Cloud resources. Use Terraform HashiCorp Configuration Language (HCL) or JSON format to specify the IBM Cloud resources that you want to provision in your IBM Cloud environment. If you are not familiar with Terraform, you can select one of the default Terraform templates that Schematics provides to provision the IBM Cloud resources that you want. Terraform templates can be stored in a GitHub, GitLab, or Bitbucket repository to ensure source control and enable collaboration, review, and auditing in your organization. You can save usage information in readme files to make the template shareable and usable across multiple teams. You can also upload tape archive files (.tar) from your local machine to provide the template to Schematics.
2. Create your workspace. You can point your Schematics Workspaces to a GitHub, GitLab, or Bitbucket repository where you store your Terraform template, or provide your template by uploading a .tar file. Workspaces help to organize resources that belong to one IBM Cloud environment. For example, use workspaces to separate your test, staging, and production environment. With IBM Cloud® Identity and Access Management, you can control who has access to your workspaces? and who can run actions on your IBM Cloud resources?
3. Create an execution plan. Based on your configuration, Terraform creates an execution plan and describes the actions that need to be run to get to the state that is described in your Terraform configuration files. To determine the actions, Schematics analyzes the resources that are already provisioned in your IBM Cloud account to give you a preview of whether resources must be added, modified, or removed. You can review the execution plan, change it, or simply execute the plan.
4. Provision your resources. When you are ready to make changes to your cloud environment, you can apply your Terraform configuration files. To run the actions that are specified in your configuration files, Schematics uses the IBM Cloud Provider Plug-in for Terraform.







 Configuration management with Schematics Actions
Before you begin, make sure that you have the correct [IBM Cloud permissions](https://cloud.ibm.com/docs/satellite?topic=satellite-iamiam-roles-usecases) to create locations, including to Satellite and Schematics. To create the template and manage its resources, Satellite automatically creates an IBM Cloud IAM [API key](https://cloud.ibm.com/docs/account?topic=account-manapikey). You can optionally provide the value of an existing API key that has the correct permissions in the same account.

Do not reuse the same name for multiple locations, even after the other location is deleted. If you use the same name 5 times or more within 7 days, you might reach the Let's Encrypt [Duplicate Certificate rate limit](https://cloud.ibm.com/docs/openshift?topic=openshift-cs_rate_limit).



1. In your AWS cloud provider, [set up your account credentials](https://cloud.ibm.com/docs/satellite?topic=satellite-awsinfra-creds-aws).
2. From the [Satellite console](https://cloud.ibm.com/satellite/locations), click Create location.
3. In the Setup section, click Amazon Web Services.
4. In the AWS credentials section, enter the AWS access key ID and AWS secret access key values that you previously created.
5. Click Fetch options from AWS.
6. Review the Satellite location details. If you edited the AWS EC2 instances, you might want to click the Edit pencil icon to change details such as the description, API key, or IBM Cloud multizone region that the location is managed from.
7. In the Summary pane, review the cost estimate.
8. Click Create location. Your location might take about 30 minutes to finish provisioning.
9. Optional: To review the provisioning progress, review the logs in the Schematics workspace that is automatically created for you.



1. Click Manage in Schematics.
For test and evaluation environments, you may skip this topic and go directly to the [Manual Installation using an installation script (manual)](https://access.redhat.com/articles/3630111manual) instructions, and the instructions for [running the installation script](https://cloud.ibm.com/docs/sap?topic=sap-rhos-datahub) for the IBM Cloud specific parameters.



 Before you begin 

Review [Getting started with IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage) for general information on IBM Cloud Object Storage.





 Provisioning Object Storage 

Use the steps in [Provision storage](https://cloud.ibm.com/docs/services/cloud-object-storage/basics?topic=cloud-object-storage-provision) to provision your Object Storage.

The service instance name for the following example is sdh_cos_k8. Choose a name that fits your needs when creating your service instance.
{: note}





 Creating the bucket and the directory 



1. Use the steps under [Creating some buckets to store your data](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storagegs-create-buckets).
2. Choose Regional as your level of resiliency and select the same Location where your Red Hat OpenShift on IBM Cloud cluster is deployed. For this example, the location is eu-de.
3. Select the Storage Class of Standard that will meet your performance needs.

The bucket name in this example is sdh-cos-vora-bucket.
4. Create the directory by uploading an empty folder from your desktop to the bucket. In the console, navigate to your bucket. Select Resource List > Storage > sdh_cos_k8 > sdh-cos-vora-bucket and click Upload.
5. Select the empty folder and name it checkpoints.

The first time you upload, you may be required to install the free tool, Aspera Connect.
--inventories-ini or -y Optional The file path to the resource inventory file where you specified all target hosts. The resource inventory file must be provided in INI format. For more information about how to create a static resource inventory file, see [Creating static inventory files](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupstatic-inv). 
 --resource-query Optional Enter the ID of a resource query that you created. A resource query helps to dynamically build your resource inventory by using the IBM Cloud resources that you created with a Schematics Workspace. To create a resource query, see the ibmcloud schematics resource-query create[command](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-create-rq). To enter multiple resource query IDs, use --resource-query id1 --resource-query id2. 
 --file or -f Optional The path to the JSON file where you specified the resource inventory that you want to create. 
 --output or -o Optional Specify the output format. Only JSON format is supported. 
 --no-prompt Optional Set this flag to create an inventory without an interactive command-line session. 





 Using the payload file 

You can provide a payload file to specify certain parameters for the inventory create command. Then, you pass the file name to the command by using the --file command option.

You need to replace the <...> placeholders with the actual values. For example, "<INVENTORY_NAME>" as "myinventory".

Syntax

{
"name": "<INVENTORY_NAME>",
"description": "<DESCRIPTION",
"location": "<GEOGRAPHY>",
"resource_group": "<RESOURCE_GROUP>",
"resource_queries": [
"<RESOURCE_QUERY_ID>"
]
}

Example

{
"name": "myinventory",
For more information, see the [IBM Cloud Schematics CLI](https://cloud.ibm.com/docs/hpc-spectrum-symphony?topic=schematics-schematics-cli-referenceschematics-plan) reference.







 Next steps 

After you've successfully created a workspace, you can begin [Generating a plan](https://cloud.ibm.com/docs/hpc-spectrum-symphony?topic=hpc-spectrum-symphony-generate-plan&interface=cli) to validate all of the configuration properties.





 Before you begin 

Before you get started, make sure that you've completed the prerequisites found in [Setting up the IBM Cloud Schematics API](https://cloud.ibm.com/docs/hpc-spectrum-symphony?topic=hpc-spectrum-symphony-setting-up-api&interface=api).





 Creating a workspace using the API 



1. To create a workspace by using the IBM Cloud Schematics Python APIs, create a Python file and provide a name of your choice, for example, schematics_create_workspace.py.
2. Copy and paste the [Create a Schematics workspace using Python API](https://cloud.ibm.com/docs/hpc-spectrum-symphony?topic=hpc-spectrum-symphony-creating-workspace&interface=apiexample-request-create) example request to your Python file.
3. Change the following parameters as part of the request:



* Replace your IBM Cloud API key to the authenticator = IAMAuthenticator('<ibm-api-key>') variable.
* Change the API endpoint to the endpoint mentioned in [API endpoints](https://cloud.ibm.com/apidocs/schematics?code=pythonapi-endpoints) according to the location that you want your Schematics workspace to reside, for example, schematics_service.set_service_url('https://us.schematics.cloud.ibm.com').
* Create a Terraform execution plan and apply your Terraform template in IBM Cloud.
* Review the IBM Cloud® resources that you create.







 Time required 

1 hour





 Audience 

This tutorial is intended for developers and system administrators who want to learn how to use Terraform templates to create and manage cloud infrastructure services by using IBM Cloud Schematics.





 Prerequisites 

Before you begin, complete the following prerequisites.



* [Create the IBM Cloud Pay-As-You-Go or Subscription IBM Cloud account](https://cloud.ibm.com/registration).
* [Install the IBM Cloud CLI and the Schematics CLI plug-in](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cli).
* Make sure you set environment variables for [IBMCLOUD_API_KEY](https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_env_var).
* Make sure that you are assigned the Manager service access role in Cloud Identity and Access Management for Schematics to create and work with a Schematics Workspace.
* Make sure that you are assigned the required [permissions](https://cloud.ibm.com/docs/vpc?topic=vpc-iam-getting-started) to create VPC infrastructure resources.
* Follow the [steps](https://cloud.ibm.com/docs/containers?topic=containers-clusterscluster_prepare) to get the required permissions to create an IBM Cloud Kubernetes Service cluster and to prepare your account for your cluster setup.
* Make sure that you have the required permissions to create an instance of [IBM® Key Protect](https://cloud.ibm.com/docs/key-protect?topic=key-protect-manage-access) and [IBM Cloud Object Storage](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-iam).







 Step 1: Creating your Schematics Workspace
[Importing Schematics templates into the IBM Cloud catalog](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogprivate-catalog)



* [Objectives](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogprivate-tut-obj)
* [Time required](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogprivate-timereq)
* [Audience](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogprivate-tut-audience)
* [Prerequisites](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogprivate-prerequisites)
* [Prepare your Terraform template for the private catalog](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogprepare-tf-templates)
* [Creating a release](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogcreate-release)
* [Create a private catalog and add your Terraform template as a product](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogcreate-private-catalog)
* [What's next?](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogprivate_what's_next)







 Deploying a Schematics blueprint using the command line 

[Deploying a Schematics blueprint using the command line](https://cloud.ibm.com/docs/schematics?topic=schematics-deploy-schematics-blueprint-clideploy-schematics-blueprint-cli)
The Terraform engine version is v1.3.
2. Verify the information, and then click Create. The Schematics workspace is created, and the Settings page for the Schematics workspace is displayed.







 Step 2: Apply the Terraform execution plan 



1. In the Variables section of the Schematics Settings page, enter the values for each variable. Required fields are the fields without default values. However, default values can be overridden.
2. Optional. Click Generate plan. This action creates a Terraform execution plan and checks your configuration for syntax errors. On the Schematics Activity page, you can review log files for errors and IBM Cloud resources that must be created, modified, or deleted to achieve the state of the Terraform template.
3. After you enter all the values for the variables and are satisfied with the changes, click Apply plan. This step takes some time to complete (usually 20 - 30 minutes, but it can take longer), due to the creation of a new Kubernetes or OpenShift cluster.
4. Follow the progress of this step by clicking the View log link next to the corresponding step.
5. After the plan is successfully applied, view the URL to the generated IBM Cloud DevOps toolchain. The URL is located near the end of the log file on a line that begins with View the toolchain at:.
6. Copy and paste the URL into a browser search bar to view the newly created toolchain.
7. On the toolchain's Overview page, click ci-pipeline in the Delivery pipelines card.
8. Check the status of your application by choosing one of the following options, depending on whether you ran a Classic or a Tekton pipeline:



1. Classic pipelines: On the Delivery Pipeline page, check the status of the Deploy stage.



* If the status is Stage Passed, click the "Passed" link that is next to the deploy job to open the log file. In the log file, locate the string VIEW THE APPLICATION AT:, and then click the URL.
* If the status is Stage Failed, click the Play icon !
Creating resource inventories for Schematics Actions 

A resource inventory defines a single IBM Cloud resource or a group of resources where you want to run Ansible playbooks, modules, or roles by using Schematics Actions.

You can specify your resource inventory by using a [static inventory file](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupstatic-inv), or [dynamically retrieve](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupdynamic-inv) to your target IBM Cloud resources from Schematics Workspaces that you created.



 Creating static inventory files 

Schematics supports the definition of hosts.ini files where you specify a single target host or a group of target hosts by using their hostname or IP address. You can assign names to a group of target hosts, such as [webserver], and use this name in your Ansible playbook to instruct Schematics where to run the playbook tasks.



1. From the [Schematics inventories dashboard](https://cloud.ibm.com/schematics/inventories). Click Create Inventory.
2. Enter a name for your inventory, verify your location, and select your Resource group where you want to create an inventory.
3. Select the Define manually tab.
4. In the File field, enter the target hosts where you want to run the Ansible playbook. Make sure to specify your hosts in an INI syntax. For a sample syntax, see [File format](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupinv-file-format). Review the [limitations](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setupinv-file-limitation) to ensure that your inventory definition is supported in Schematics.
5. Click Create inventory.
6.
Exported models have the file extension of .sdumodel.

An imported model is intended to be used without any further annotations. If you continue annotating after importing it, the model is overwritten. If you plan to import a model into a new collection, it is a good best practice to create a new collection that contains only 1 document, import the model, then upload the remainder of your documents.





 Best practices for annotating documents 

If you want to save time reprocessing all the files in a large collection, start with a small collection of documents, build your model, and then export it. For more information about importing and exporting models, see [Importing and exporting models](https://cloud.ibm.com/docs/discovery?topic=discovery-sduimport). Create a collection that contains only one document, import the model, and then upload the remainder of the documents.



* Follow all guidelines and use consistent labeling on all documents
* Do not label whitespace
* Use the image labels on images and diagrams
* Do not treat bold, italic, or underlined text differently. Label based on the context, not the style.
* When labeling a document, work from the first page to the last.
* If you incorrectly label an item, choose another label for the item to overwrite the first.
* Pages can be submitted at any time. Ensure that all appropriate labeling is complete before submitting.
* Documents that appear to have text overlaying other text are considered “double overlaid” and cannot be annotated. Report these documents to your administrator.
* Documents that contain multiple columns of text on a single page cannot be annotated. Report these documents to your administrator.
* Consider only labeling footnotes when they appear at the bottom of the page and are referenced in the main body of text in the document.
* Consider labeling notes that appear within sections or lists, for example notes that are explicitly called out as “Notes,” as text.
* When you annotate a table, make sure to select the entire table before you apply the table label.