vania-janet/multiturn-rag-retrieval-data huggingface dataset:
[Destroy action state](https://cloud.ibm.com/docs-content/v1/content/ba89e173287b28d1453d2a327d8a1f74ae2f1662/schematics/images/destroyworkspace.png) The destroy job performs when your workspace is in an inactive, active or failed state. From these state, the destroy job connects to parse the template from your source repository and workspace gets into in progress unlocked state. From state if you destroy, resource reaches failed state. 







 Creating an auto deployment to the IBM Cloud Schematics 

IBM Cloud Schematics now supports an efficient way to share your Git repository in a cloned copy of the code in a new Git repository to deploy to IBM Cloud without affecting your original code. For more information about deploy to IBM Cloud, see [automating the deployment to the Schematics](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-create_deploy_to_schematics).





 Reviewing the Schematics job details 

Use the Schematics job page in the console to find the history of all Schematics activities, such as downloading your template, plan, apply, and to see the logs of the jobs. The jobs are created when you run your templates. You can also see the count of the resources that are in plan, or apply jobs that are in added, modified, or destroyed status. For more information about job queue process, see [Execution process of the Schematics job queue](https://cloud.ibm.com/docs/schematics?topic=schematics-job-queue-processabout-job-queue).

In the job log you can see a message such as:



* Activity triggered. Waiting for the logs. This means the job is in pending status and yet to be processed.
* Your job was submitted and is in queue, at position x out of y. Here x is the position of your job in the pending queue and y is a total pending jobs.
You add these tasks to an Ansible playbook and store the playbook in a GitHub, GitLab, or Bitbucket repository to ensure source control and enable collaboration, review, and auditing in your organization. If you are not familiar with Ansible, you can use one of the [IBM provided playbooks](https://github.com/Cloud-Schematics), or browse the [Ansible Galaxy library](https://galaxy.ansible.com/).
2. Create a Schematics action: When you create a Schematics action, you point your action to the repository that stores your Ansible playbook. Then, you select the cloud resources where you want to run the tasks that are defined in your Ansible playbook. To protect your cloud resources, you can further set up a bastion host in front of your target hosts that proxies all Ansible SSH connections to the target hosts.
3. Run your action: When you are ready to configure your cloud resources, you can run your action. Schematics uses the built-in Ansible capabilities to connect to your target hosts via SSH, and execute the tasks that are defined in your Ansible playbook. You can monitor the progress by reviewing the logs.







 Software deployments with IBM-provided templates 

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.
Prometheus remote write cost is based on metric ingestion. The price is calculated the same as for metrics collected using the agent with IBM Cloud Monitoring.





 Graduated Tier - Sysdig Secure + Monitor 

The Graduated Tier - Sysdig Secure + Monitor service plan includes both IBM Cloud Monitoring and [IBM Cloud Security and Compliance Center Workload Protection functionality.](https://cloud.ibm.com/docs/workload-protection).

The Graduated Tier - Sysdig Secure + Monitor service plan is billed based on the number of hosts that you monitor, the number of containers, the number of API calls, and the number of time series collected.

The following table outlines the cost per host by agent mode and what is included in the price:



Table 5. Cost per host for Graduated Tier - Sysdig Secure and Monitor service plan

 Agent mode Cost per host Default infrastructure metrics (CPU, memory, disk, and network) Includes up to 1K time-series (Prometheus, JMX, appchecks, StatsD) Monitoring of 50 containers 1M API calls Secure features 

 Agent for orchestrated environments $94 ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring//images/checkmark-icon.svg) ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring//images/checkmark-icon.svg) ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring//images/checkmark-icon.svg) !
Since Terraform 1.0, Schematics Workspaces can be updated to more recent 1.x releases, via a simple change to the Workspace version. To update from 0.x releases refer to section [Upgrading the Terraform template version 0.x](https://cloud.ibm.com/docs/schematics?topic=schematics-migrating-terraform-versionterraform-version-upgrade0x)

Schematics supports Terraform_v1.x and plans to make releases available 30-45 days after general availability. It is recommended that Terraform templates use a version range constraint, such as, >, >=, or > for the required_version parameter in the versions.tf of Terraform template, that allows upgrade for minor and patch releases. This allows Schematics to automatically adopt the latest patch or minor release of Terraform version as set by the Workspace version.

terraform {
required_version = "> 1.1"
}



 Updating the Workspace Terraform 1.x version 

The in use version of Terraform for a Workspace can be updated via the Schematics Workspace [Update API](https://cloud.ibm.com/apidocs/schematics/schematicsreplace-workspace).

The workspace terraform version parameter is of the form terraform_v1.1 or terraform_v1.2



1. Select the workspace to be updated and verify that it is in Normal state and that a Plan operation does not generate any proposed resource changes. Save the workspace_id and note the region the workspace is hosted in. This is the prefix to the workspace_id.
2. Update the Workspace terraform version using the IBM Cloud CLI:



* Login to the IBM Cloud CLI with ibmcloud login
* Set the CLI target region with ibmcloud target -r <region> to be the same as the workspace you are updating.
* Generate an IAM oauth token to use with the Schematics API, with the command ibmcloud iam oauth-tokens.
A resource inventory can be defined by using a static inventory file, or dynamically retrieve to your target IBM Cloud resources from Schematics Workspaces in your IBM Cloud account.







 Jobs 

A job maintains a record of the execution of tasks or operations for Schematics Workspaces, Actions, Blueprints, Agents and resources. You can see these job records appearing in the context of action, Blueprint, and workspace. The job record describes the status of the Job, inputs used to run the job, outputs produced by the job and the console logs.





 Templates or Modules 

Automation code written for provisioning and configuring a cloud infrastructure by using Terraform, Ansible, Helm, Operators, and so on., in the IaC language.
You can use Schematics to run the automation templates by using workspaces or Actions.

Modules are reusable IaC automation code that can be used to assemble an automation template





 Workspaces 

A platform to build the infrastructure, provision resources, and deploy applications with the support to multiple environments. It has feasibility, or privilege to access by using Git private or public repositories with a secured access token.



 Schematics Workspaces 

A platform to build the infrastructure, provision resources and deploy applications with support to multiple environments. It has feasibility, or privilege to access by using Git private or public repositories with a secured access token.





 Jobs 

The status of the provisioned resource is in inactive, progress, active, or failed results of the Schematics object by running create, plan, or apply commands.





 Resources 

Maps to the provisioned Terraform resources within the infrastructure.





 Readme file 

Refers to the demonstration of an example template with steps to prerequisites, provision resources with limitations, and steps to run the Terraform template with support of IBM Cloud Schematics.





 Settings 

Common area to edit values of the variables so that new Terraform template can be generated or re-imply with new changes.





 Workspace 

A platform to build the infrastructure by using open source tools such as Terraform, Ansible, Helm, Open Shift cloud to manage various cloud infrastructure resources.
The tasks of working with a blueprint over its lifecycle can be grouped under four headings, [defining blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-define-blueprints), [deploying blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-deploy-blueprints), [maintaining blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-update-op-blueprints), and [deleting blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-delete-blueprints). See the section [working with blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-work-with-blueprints) for more details.







 Catalog 

A collection of automation templates that can be ordered from IBM Cloud. You can onboard your Terraform automation to the IBM Cloud catalog, and share the catalog of templates in a controlled manner with your team by using IAM permissions and policies.

IBM Cloud catalog already supports a collection of IBM owned and Third party developed automation in the catalog. The automation is used to provision infrastructure and softwares by using Helm charts, Kubernetes Operators, OVA images, Cloudpak automation. Schematics Workspaces are used to run these automation.|





 Inventories 

A collection of cloud resources that are used as target for running the Ansible playbooks, modules, or roles.



 Resource inventory 

A resource inventory can be defined by using a static inventory file, or dynamically retrieve to your target IBM Cloud resources from Schematics Workspaces in your IBM Cloud account.







 Jobs 

A job maintains a record of the execution of tasks or operations for Schematics Workspaces, Actions, Blueprints, Agents and resources. You can see these job records appearing in the context of action, Blueprint, and workspace. The job record describes the status of the Job, inputs used to run the job, outputs produced by the job and the console logs.
ibmcloud schematics logs --id WORKSPACE_ID [--act-id ACTION_ID]

Command options



Schematics logs flags

 Flag Required / Optional Description 

 --id or -i Required The unique identifier of the workspace for which you want to retrieve Terraform log files. To find the ID of a workspace, run ibmcloud schematics workspace list command. 
 --act-id or -1 Optional The ID of an action for which you want to retrieve Terraform logs. To find a list of action IDs, run ibmcloud schematics workspace action --id WORKSPACE_ID command. 



Example

ibmcloud schematics logs --id myworkspace-a1aa1a1a-a11a-11 --act-id 9876543121abc1234cdst





 ibmcloud schematics output 

Retrieve a list of Terraform output values. You define output values in your Terraform template to include information that you want to make accessible for other Terraform templates.

Syntax

ibmcloud schematics output --id WORKSPACE_ID[--output OUTPUT]

Command options



Schematics output flags

 Flag Required / Optional Description 

 --id or -i Required The unique identifier of the workspace for which you want to list Terraform output values. To find the ID of your workspace, run ibmcloud schematics workspace list command. 
 --output or -o Optional Returns the command-line output in JSON format. Currently only JSON file format is supported. 
 --json or -j Deprecated Prints the output in the JSON format. 



Example

ibmcloud schematics output --id myworkspace3_2-31cf7130-d0c4-4d





 ibmcloud schematics plan 

Scan the Terraform template in your source repository and compare this template against the IBM Cloud resources that are already deployed.
Module version selection is determined at the template layer.
* Templates: Templates are written to address a range deployments for a specific architecture and application. It is an opinionated implementation of an application architecture out of reusable modules. Templates support external customization of infrastructure scaling, deployment region, application components, network and security configuration. They are semantically versioned and maintained through update of module versions.



* User customizable inputs are externalized for configuration as inputs. Default template input values allow for use with minimal user configuration.
* Versioning is defined by Git release tags and branches.
* Template version selection is managed by Git release tags specified at blueprint config create time.



* Inputs: Inputs customize a template for a target environment: dev, stage, prod or regions. They provide configuration for scaling, region and networking and so on. Blueprints' supports two layers of input customization. Versioned input files for controlled change of environment specific configuration and un-versioned dynamic (override) inputs.



* Versioned input files. These provide versioned control over environment configuration parameters in production and regulated environments. Versioned input files are optional and for less regulated development environments all parameters can be configured by dynamic (override) inputs.



* Versioning is defined by Git release tags and branches.
* Input file version selection is managed by Git release tags specified at blueprint config create time.



* Dynamic (override) inputs. Typically sensitive input values, like API or SSH keys that should not be maintained in a version control system. In unregulated or development environments, all inputs can be supplied as dynamic inputs.





Selection of template and input file versions is defined on initial creation of the blueprint config for the environment in Schematics. Review the section on [blueprint versioning](https://cloud.ibm.com/docs/schematics?topic=schematics-blueprint-versioning). The omission of template and input file version information at config create time allows for a ‘relaxed’ usage mode. Where any changes to the template or input files are automatically pulled in if Schematics detects a change in the source repository.
curl -X DELETE https://schematics.cloud.ibm.com/v2/jobs/{job_id}?signal=interrupt -H "Authorization: <iam_token>"
3. Use the example to force-stop the running job.

Example

curl -X DELETE https://schematics.cloud.ibm.com/v1/workspaces/<wks_id>/actions/{job_id}?signal=force-stop -H "Authorization: <iam_token>"
4. Use the example to terminate the running job.

Example

curl -X DELETE https://schematics.cloud.ibm.com/v1/workspaces/<wks_id>/actions/{job_id}?signal=terminate -H "Authorization: <iam_token>"

For more information about stopping the running job, see [Stop and delete the running Job](https://cloud.ibm.com/apidocs/schematics/schematicsdelete-workspace-activity) API.









 Reviewing the Schematics job details 

Use the Schematics job page in the console to find the history of all Schematics activities, such as downloading your template, plan, apply, and to see the logs of the jobs. The jobs are created when you run your templates. You can also see the count of the resources that are in plan, or apply jobs that are in added, modified, or destroyed status. For more information about job queue process, see [Execution process of the Schematics job queue](https://cloud.ibm.com/docs/schematics?topic=schematics-job-queue-processabout-job-queue).

In the job log you can see a message such as:



* Activity triggered. Waiting for the logs. This means the job is in pending status and yet to be processed.
* Your job was submitted and is in queue, at position x out of y. Here x is the position of your job in the pending queue and y is a total pending jobs.
Instead, you [declare your variables](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-configconfigure-variables) in the Terraform configuration files, and enter the values for your variables when you create a workspace. You can later change the values of your variables by updating the variables from your workspace details page.





 Is Terraform remote state supported in Schematics? 

You can access workspace state information from other workspaces by using the Schematics ibm_schematics_output data source that works similar to the remote_state data source in native Terraform. When you use the remote_state Terraform data source, you must configure a Terraform remote backend to connect to your Terraform workspaces. With the ibm_schematics_output data source, you automatically have access to the built-in Schematics backend and can access workspace information directly.

For more information about how to use this data source, see [Managing cross-workspace state access with Terraform](https://cloud.ibm.com/docs/schematics?topic=schematics-remote-state).





 Why is my local-exec and remote-exec provisioner in IBM Cloud Schematics fails? 

The [time out](https://cloud.ibm.com/docs/schematics?topic=schematics-job-queue-processjob-queue-timeout) is set for local-exec and remote-exec users by using IBM Cloud Schematics Workspace. You need to ensure the execution completes within 30 minutes. Otherwise, execution times out automatically and the apply state fails.







 What is the use of refresh token header? 

If the destroyresource flag is set to true, refresh token header configuration is required to delete all the IBM Cloud resources, and the Schematics Workspace. Following are the uses of refresh token header:
The provider config is defined by an injectors block in the template module definition. This block defines the .tf files that contain the additional config statements. It also defines the specification of the additional Terraform language constructs that will be injected into the Terraform working directory.

The two files ibm_tft_provider_override.tf and ibm_tft_versions_override.tf contain the additional injected config parameters.



 Templating Terraform language statements 

Schematics blueprint templates use [mustache templates](https://mustache.github.io/) to create Terraform language statements. These are injected as .tf files in the Terraform working directory at run time. The templates are retrieved from the Git repo defined in the injectors block. Provider injection examples are provided in the [Cloud-Schematics/tf-templates](https://github.com/Cloud-Schematics/tf-templates) GitHub repo.

The repo folder contains the files to be injected, which contain the mustache templates. The ibm folder contains the two template files for injecting and configuring the IBM Cloud provider and setting the provider_version to be used.



* tf_ibm_provider_override.tft
* tf_ibm_versions_override.tft







 Configuring provider injection 

To configure provider injection, an injectors block is added to the template module definition. See the [module.injectors](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-template-schema-yamlbp-modules-injector) for the syntax for the injectors block. An example is shown below.

modules:
  - name: accounts
     module_type 
    ....
     injectors:
      - tft_git_url: "https://github.com/Cloud-Schematics/tf-templates"
        tft_name: "ibm"
        injection_type: override
Performance optimization - Parallel job execution for plan and apply Concurrent module jobs planned for 2023 release 
 Performance optimization - Plan and Apply only run against changed modules Planned for 2023 release 
 Blueprint operations are only supported by using the IBM Cloud CLI plug-in. UI support planned for December 2022 Delivered Dec 2022 
 The Terraform Plan (all) operation for blueprint template. Support planned for December 2022 
 Run operations are performed as a single operation against all modules (plan + apply). A future 2023 release will support single module operations 
 Created Cloud resources tagged with blueprint, catalog and workspace IDs. Planned for December 2022 Delivered Dec 2022 
 Only one input file is supported per blueprint configuration. Multiple input files planned for a 2023 release 
 Cloud resources that are created on deploy, cannot be left in place when an environment is deleted. At this time all resources must be destroyed to delete a blueprint. 
 The Delete CLI command returns immediately at start of execution and does not wait for successful completion. 
 Operations must not be directly run against linked Schematics modules (workspaces) by using the workspace commands or UI. Operations must be run by using blueprint commands. 
 Blueprint configuration validation command. Support planned for November 2022 VScode language extension delivered in November 2022 
 Cost Estimation in CLI and UI Planned for 2023 release 
 Only blueprint templates and modules in GitHub are formally supported. Testing is not complete for GitLab and other repositories. Planned November 2022 Delivered November 2022 
 Only blueprint templates and modules in public repositories are formally supported. Testing is not complete for private repositories using Git tokens. Planned in November 2022 Delivered November 2022 
 Templates and modules in IBM private Gitlab using IAM token support Planned in December 2022 







 Beta release known issues 



Beta release known issues

 Issue Resolved Date 

 apply, destroy, and deletes return the generic message fullfilment_success on successful completion. 
 JSON output option not supported on commands. 







 Joining public slack channel 



 Steps to join public slack