vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Troubleshooting 



 Why is IBM Cloud Schematics not able to clone the public GitHub repo? 

Schematics isn't able to clone the public GitHub repository, and you are seeing one of the following error messages:

 What’s happening 



* Fatal, could not download repo, Failed to clone git repository, authentication required (or the git url is incorrect). Problems found with the Repository. Please Rectify and Retry
* Template error: Failed to clone git repository, authentication required (or the git url is incorrect)



 Why it’s happening 

You didn't provide the correct GitHub URL, or you provided a GitHub token, which is not required to clone a public repo. A GitHub access token is only required to access a private repo.

 How to fix it 

Do not provide a GitHub token, and check to see whether the GitHub token was provided in the github_token parameter while creating a workspace by using the [public repo](https://github.com/IBM/ibm-spectrum-scale-ibm-cloud-schematics).





 Why is IBM Cloud Schematics not able to create a workspace? 

 What’s happening 

Schematics isn't able to create a workspace, and you are seeing the following error message: You don't have the required to create a workspace in any resource groups. You must be assigned the manager role on the Schematics service in at least one resource group. Contact your account administrator for access.

 Why it’s happening 

You don't have the required access to create a workspace in any resource groups. You must be assigned the manager role on the Schematics service for the resource group where you want to deploy the cluster resources.

 How to fix it 

Contact your account administrator and get assigned with the manager role on the Schematics service for the resource group where you want to deploy the cluster resources.





 Why is IBM Cloud Schematics not able to provision the cluster and fails with an authorization error? 

 What’s happening
: IBM Cloud Schematics supports command-line workspace and state commands such as [import](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-workspace-import), [show](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-workspace-show), [state move](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-wks_statemv), [state remove](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-wks_staterm), [taint](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-workspace-taint), and [untaint](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-workspace-untaint).





 7 January 2021 

Multiple SDK support
: IBM Cloud Schematics supports Java, Node, Python, and Go SDK for the APIs. For more information, see [Schematics API documentation](https://cloud.ibm.com/apidocs/schematics/schematics?code=go).







 December 2020 

Review the release notes for December 2020.



 9 December 2020 

Ansible beta release
: 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
<br> <br>Resources <br><br><br><br> * ibm_resource_group<br> * ibm_resource_instance<br> * ibm_cos_bucket<br><br><br> [View code snippet](https://github.com/IBM-Cloud/terraform-provider-ibm/tree/master/examples/ibm-cos-bucket) 







 Power Systems templates 



 Name Description and resources Code 

 ibm-power Create an Power Systems Virtual Server instance with a public and a private network that mounts the system volumes. You can also create an SSH key to access the instance. <br> <br>Resources <br><br><br><br> * ibm_pi_key<br> * ibm_pi_network<br> * ibm_pi_volume<br> * ibm_pi_instance<br><br><br> [View code snippet](https://github.com/IBM-Cloud/terraform-provider-ibm/tree/master/examples/ibm-power) 







 Resource Management templates 



 Name Description and resources Code 

 ibm-resource-instance Create an IBM Cloud Object Storage service instance with HMAC credentials, and configure custom timeouts for creating, updating, or deleting the instance. <br> <br>Resources <br><br><br><br> * ibm-resource-instance<br><br><br> [View code snippet](https://github.com/IBM-Cloud/terraform-provider-ibm/tree/master/examples/ibm-resource-instance) 







 Schematics templates 



 Name Description and resources Code 

 ibm-schematics Retrieve the Terraform on IBM Cloud state file and output variables for a Schematics workspace by using a Schematics data source. For more information, about how to use the data source, see [Managing cross-workspace state access with Terraform on IBM Cloud](https://cloud.ibm.com/docs/schematics?topic=schematics-remote-state).
User responsibilities by using IBM Cloud Schematics 

Learn about the responsibilities that you have when you use IBM Cloud Schematics.



High availability for IBM Cloud resources

 Category Responsibilities 

 Resource provisioning and management IBM responsibilities:<br><br><br><br> * Provide a suite of tools to automate resource provisioning and resource management in IBM Cloud, such as the IBM Cloud Schematics console, CLI, and API.<br> * Provide and maintain sample Terraform templates.<br> * Create, update, and manage the Terraform state file (terraform.tfstate) to determine the required actions to achieve the required state that is described in your Terraform template.
* [Templates or Modules](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termssch-terms-template)
* [Workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termssch-terms-workspace)



* [Schematics Workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termswkss1)
* [Jobs](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termswksj1)
* [Resources](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termswksr1)
* [Readme file](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termswksr2)
* [Settings](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termswkss2)
* [Workspace](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-termswksw1)









 Notices and information 

[Notices and information](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-noticesschematics-notices)



* [Creative Commons Attribution 3.0](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-noticesCC-BY-3.0)
* [Creative Commons Attribution 4.0](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-noticesCC-BY-4.0)
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. For more information about deploy to IBM Cloud, see [create deploy to Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-wks-state&interface=uisch-create-deploy-to-schematics).







 September 2020 

Review the release notes for September 2020.



 11 September 2020 

Bitbucket supports private repository
: IBM Cloud Schematics supports private bit bucket repository as a template repository source. All you need to use the URL in this format https://bitbucket.org/<your_user_name>/<repo_name>/src/<branch_name>/<folder_name> and for the URL with branch you need to use in this format https://bitbucket.org/<your_user_name>/<repo_name>/src/<branch_name>. If the workspace name is different from your user name then you need to provide the workspace name in this format. https://<username>@bitbucket.org/<workspace_name>/tf_cloudless_sleepy/src/master.

Support to override the default variable
: IBM Cloud Schematics now supports to override the Terraform default variable store value. For more information about configuring to override the variable, see [workspace update](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-workspace-update).
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.

The second [blueprint apply](https://cloud.ibm.com/docs/schematics?topic=schematics-apply-blueprint&interface=cli) step executes the automation modules in dependency order and runs the module Terraform code to deploy cloud resources.



 Creating a blueprint configuration through the CLI 

Create your blueprint config with the CLI. The Create command requires a name and the Git URL of a blueprint template and other arguments. For a complete listing of options, see [blueprint create](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-blueprint-create) command.

To work with Schematics Blueprints, the [Schematics plug-in](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cliinstall-schematics-plugin) version must be greater than the 1.12.5.

Before you begin:



* Install or update the [Schematics plug-in](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cliinstall-schematics-plugin) version that is greater than the 1.12.5.
* Select the IBM Cloud region that you wish to use to manage your blueprint. Set the region by running [ibmcloud target -r <region>](https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cliibmcloud_target) command.
* [IBM Cloud Activity Tracker](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-getting-started) - Use this service to track any activity for a service so that you can comply with regulatory audit requirements.







 Time required 

30 minutes





 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, make sure that you are assigned the following permissions:



* [To create a private catalog](https://cloud.ibm.com/docs/account?topic=account-create-private-catalogprereq-create) in IBM Cloud.
* [To create a Schematics Workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-accessworkspace-permissions).
* [To create an IBM Cloud Log Analysis instance](https://cloud.ibm.com/docs/log-analysis?topic=log-analysis-iamplatform).
* [To create an IBM Cloud Monitoring instance](https://cloud.ibm.com/docs/monitoring?topic=monitoring-iamiam_platform).
* [To create an IBM Cloud Activity Tracker instance](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-iamplatform).
* Write access to a GitHub repository on github.com. This repository is needed to upload the Terraform template that you want to add as a product to your private catalog.







 Step 1: Prepare your Terraform template for the private catalog 

To upload a Terraform template to a private catalog, you must first compress all your Terraform configuration files to a TGZ file, and upload this file to a GitHub repository to create a release.



1. Download the content of the terraform-ibm-observability sample repository to your local machine.
* 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.



 Destroy a blueprint environment 

When a blueprint environment is no longer required, it can be deleted which will terminate billing for all deployed resources. Deleting a blueprint environment is a two-stage process that first destroys all the associated cloud resources and second deletes the blueprint config in Schematics. See [Deleting blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-delete-blueprint) to understand the process of deleting blueprint environments.

The cloud resources that are created by a blueprint are destroyed by using the blueprint destroy command. The saved blueprint config can then be removed from Schematics. The delete can be performed after all resources are destroyed by using the [blueprint destroy](https://cloud.ibm.com/docs/schematics?topic=schematics-destroy-blueprint&interface=cli) command.

For Terraform based modules, the destroy operation runs a Terraform Destroy command for each module. This removes all cloud resources in reverse dependency order.



 Destroying a blueprint environment using the UI 

You can follow these steps to destroy the Schematics Blueprints by using IBM Cloud console.



1. From the [Blueprints dashboard](https://cloud.ibm.com/schematics/blueprints). Click the name of the blueprint that you want to destroy.
2. Select the Actions drop down list.
3. Select Destroy resources to delete the resources associated with this blueprint.
4.
* [April 2020](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesapril-2020)



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



* Terraform v0.12 support
* New workspace creation flow











 Configuring the CLI and API 

[Setting up the CLI](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-clisetup-cli)



* [Installing the IBM Cloud command-line](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cliinstall-schematics-cli)
* [Installing the IBM Cloud Schematics command-line plug-in](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cliinstall-schematics-plugin)
* [Updating the CLI](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-clischematics-cli-update)
* [Uninstalling the IBM Cloud Schematics command-line plug-in](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cliuninstall-schematics-plugin)



[Setting up the API](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-apisetup-api)



* [Working with the Schematics API](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-apics_api)
Validate that you can deploy the virtual server image to your VPC.



1. From the Validate version page, enter the name of your Schematics workspace, select a resource group, select a Schematics region, and click Next.

In the Tags field, you can enter a name of a specific tag to attach to your virtual server image. Tags provide a way to organize, track usage costs, and manage access to the resources in your account.
2. From the Deployment values section, review your parameter values, and click Next.
3. In the Validate product section, select I have read and agree to the following license agreements.
4. Click Validate.

You can monitor the progress of the validation process by clicking View logs.







 Step 9: Manage compliance 

Controls are safeguards that are used to meet security and compliance requirements. Only controls that are supported by Security and Compliance Center, formatted correctly, and validated by Code Risk Analysis and Security and Compliance Center scans appear in the catalog. For more information, see [Formatting controls in your readme file](https://cloud.ibm.com/docs/sell?topic=sell-sell-format-controls).



 Manage compliance controls 

You can review the controls that were added from your readme file and add additional controls.



1. Click Add controls.
2. Choose a profile.
3. Select the controls that you want to add to your version.
4. Click Add.







 Run Code Risk Analyzer scan 

Scan your source code with Code Risk Analyzer to identify any security vulnerabilities that you need to assess.



1. Click Run scan.
2. Wait for the scan to finish.







 Add Security and Compliance Center scan 

Add the scans that you previously ran in the Security and Compliance Center. Security and Compliance Center scans determine adherence to regulatory controls. For more information, see [Scheduling a scan](https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-schedule-scan).



1. Select the profile that you scanned.
2. Select the Security and Compliance Center scan.
Setting up the API 

You can use the IBM Cloud® Schematics API to automate Schematics capabilities in IBM Cloud. To use the CLI, see [Preparing to use the CLI](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cli).

To find an overview of supported IBM Cloud® Schematics APIs, API endpoints, and required API header and body information, see the [Schematics API documentation](https://cloud.ibm.com/apidocs/schematics).



 Working with the Schematics API 

Learn how to use the IBM Cloud® Schematics API using an Identity and Access Management token to authenticate.

To work with IBM Cloud Schematics API, you must provide an IBM Cloud® Identity and Access Management (IAM) token that is generated with your IBM Cloud credentials. Depending on the way you authenticate with IBM Cloud, you can choose between the following options to automate the creation of your IBM Cloud IAM token.



ID types and options

 Authentication option Description 

 IBM Cloud username and password You can follow the steps in this topic to fully automate the creation of your IBM Cloud IAM access token. If you authenticate with IBM Cloud using [MFA](https://cloud.ibm.com/docs/account?topic=account-types), you cannot fully automate the creation of your IBM Cloud IAM token because MFA requires a manual interaction with your web browser. To fully automate the creation of your IBM Cloud IAM token, you must use an IBM Cloud API key instead. 
 IBM Cloud API key As an alternative to using the IBM Cloud username and password, you can [use IBM Cloud API keys](https://cloud.ibm.com/docs/account?topic=account-userapikeycreate_user_key). IBM Cloud API keys are specific to the IBM Cloud account they are generated for. To access workspaces that were created in a different account other than the one your IBM Cloud API key is based on, you must generate an API key for that account. 





1. Create your IBM Cloud IAM access token.
: IBM Cloud Schematics [command-line plug-in to install](https://cloud.ibm.com/docs/cli?topic=schematics-cli-plugin-schematics-cli-reference), and [view command-line commands](https://cloud.ibm.com/docs/cli?topic=schematics-cli-plugin-schematics-cli-reference) in the CLI documentation.





 12 February 2021 

Ansible open beta release
: IBM Cloud Schematics supports and releases Ansible open beta version for the IBMers and clients. For more information, see [about Ansible](https://cloud.ibm.com/docs/schematics?topic=schematics-getting-started-ansible), watch [video about Ansible](https://www.youtube.com/watch?v=fHO1X93e4WA), and see [IBM Cloud Terraform provider updates and Ansible actions in Schematics](https://www.ibm.com/cloud/blog/announcements/ibm-cloud-terraform-provider-updates-and-closed-beta-of-ansible-actions-in-schematics) blog.







 January 2021 

Review the release notes for January 2021.



 29 January 2021 

Virtual Private Endpoint Gateways support
: IBM Cloud Schematics supports Virtual Private Endpoint Gateways for secure connection. For more information, see [Virtual private endpoint gateways for Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-private-endpointsendpoint-setup).





 20 January 2021 

Terraform commands API support
: IBM Cloud Schematics supports Terraform commands API. For more information, see [Commands API](https://cloud.ibm.com/apidocs/schematics/schematics).

Terraform commands command-line support
: IBM Cloud Schematics supports Terraform command-line commands.
Click one of the following options for the cluster deployment target and toolchain pipeline type. This action takes you to the Deploy to IBM Cloud page where you create a Schematics workspace. Complete the required fields on that page, and then click Next.

The following options use the [simple-helm-toolchain template](https://github.com/open-toolchain/simple-helm-toolchain), which uses a Classic pipeline structure.

[![Deploy to Kubernetes on IBM Cloud](https://cloud.ibm.com/docs-content/v1/content/efbf7b33e3aca029f69f9244bced9dd4d8acb848/apps/images/Deploy_to_kube.svg)](https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/Scalable-web-app-liberty/tree/master/terraform/simple-kube&terraform_version=terraform_v1.3)[![Deploy to OpenShift on IBM Cloud](https://cloud.ibm.com/docs-content/v1/content/efbf7b33e3aca029f69f9244bced9dd4d8acb848/apps/images/Deploy_to_Openshift.svg)](https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/Scalable-web-app-liberty/tree/master/terraform/simple-openshift&terraform_version=terraform_v1.3)

The following options use the [secure-kube-toolchain template](https://github.com/open-toolchain/secure-kube-toolchain), which uses a Tekton pipeline structure.

[!
Sample Ansible playbook templates for Schematics Actions 

Explore the IBM provided Ansible playbooks to run cloud operations on target hosts or to get started with Schematics Actions.

Use the links on the page as follows:



* View GitHub repo: Click the link to open the Git repository where the template is stored. You can review the file structure, the Ansible playbook instructions, and the README file that contains the steps to use the template in Schematics.
* Deploy to IBM Cloud: Button takes you to Create an action page with the GitHub repository URL and the Action name pre-populated.





 Running cloud operations on Virtual Servers for VPC 

Description
: Use ansible-is-instance-actions Ansible playbook to perform Day 2 operations such as start, stop, and restart for IBM Cloud® Virtual Servers for Virtual Private Cloud. To configure and run the Schematics Actions by using the CLI or console, see [readme file](https://github.com/Cloud-Schematics/ansible-is-instance-actions/blob/master/README.md) template file.

Source
: [View on GitHub](https://github.com/Cloud-Schematics/ansible-is-instance-actions)

Deploy
: ![Auto deployment button](https://cloud.ibm.com/media/docs/images/icons/Deploy_to_cloud.svg)


[Deploy to IBM Cloud](https://cloud.ibm.com/schematics/actions/create?name=ansible-is-instance-actions&repository=https://github.com/Cloud-Schematics/ansible-is-instance-actions)







 Provisioning a LAMP stack on Virtual Servers for VPC 

Description
: Use lamp-simple Ansible playbook to deploy the LAMP stack components on Virtual Servers for VPC by following a simple deployment architecture.