> ## Documentation Index
> The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt
> Use these files to discover more information as needed.

# IBM Cloud Schematics docs

Explore the capabilities of IBM Cloud Schematics. You can get started with deploying platform services by using Schematics Workspaces, and automating cloud operations with Schematics actions. Learn more about how Schematics works and the benefits of using the service. 

## Get started

- [Getting started with IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-getting-started&format=markdown)
- [What is Schematics?](https://cloud.ibm.com/docs/schematics?topic=schematics-learn-about-schematics&format=markdown)
- [What is Infrastructure as Code?](https://cloud.ibm.com/docs/schematics?topic=schematics-infrastructure-as-code&format=markdown)
- [Choosing your IaC tool  ](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-open-projects&format=markdown)
- [Understanding Schematics use cases ](https://cloud.ibm.com/docs/schematics?topic=schematics-how-it-works&format=markdown)
- [Schematics architecture](https://cloud.ibm.com/docs/schematics?topic=schematics-compute-isolation&format=markdown)
- [Best practices for securing the Schematics objects](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-secure-objects&format=markdown)
- [Release notes](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotes&format=markdown)

## Tutorials

- Getting started
   - [Using workspaces to deploy infrastructure and cloud services](https://cloud.ibm.com/docs/schematics?topic=schematics-get-started-terraform&format=markdown)
   - [Using actions to perform configuration management ](https://cloud.ibm.com/docs/schematics?topic=schematics-getting-started-ansible&format=markdown)
   - [Software deployment in IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-get-started-software&format=markdown)
- [Creating an IBM Cloud Kubernetes Service cluster on VPC infrastructure](https://cloud.ibm.com/docs/schematics?topic=schematics-provisioning-terraform-template&format=markdown)
- [Setting up continuous deployment with Schematics and a DevOps toolchain](https://cloud.ibm.com/docs/schematics?topic=schematics-workspace-continuous-deployment&format=markdown)
- [Importing Schematics templates into the IBM Cloud catalog](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalog&format=markdown)
- [Deploying a VPC environment with bastion host on IBM Cloud](https://developer.ibm.com/articles/secure-vpc-access-with-a-bastion-host-and-terraform/)
- [Deploying a multitiered VPC with bastion host on IBM Cloud](https://github.com/Cloud-Schematics/multitier-vpc-bastion-host/blob/master/README.md)

## How to

- Configuring the CLI and API
   - [Setting up the API](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-api&format=markdown)
   - [Setting up the CLI](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cli&format=markdown)
- Working with Ansible
   - [Schematics actions](https://cloud.ibm.com/docs/schematics?topic=schematics-sc-actions&format=markdown)
   - [Creating Ansible roles and galaxy](https://cloud.ibm.com/docs/schematics?topic=schematics-ansible-roles-galaxy&format=markdown)
   - [Creating an Ansible playbook](https://cloud.ibm.com/docs/schematics?topic=schematics-create-playbook&format=markdown)
   - [Creating Schematics actions](https://cloud.ibm.com/docs/schematics?topic=schematics-action-working&format=markdown)
   - [Updating a Schematics action](https://cloud.ibm.com/docs/schematics?topic=schematics-action-working-update&format=markdown)
   - [Deleting Schematics action](https://cloud.ibm.com/docs/schematics?topic=schematics-delete-ansible-actions&format=markdown)
   - Managing Ansible
      - [Creating resource inventories for Schematics actions](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setup&format=markdown)
      - [Secure and streamline Ansible automation with Schematics multihost credentials and variables](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-multihost-setup&format=markdown)
      - [Sample Ansible playbook templates for Schematics actions](https://cloud.ibm.com/docs/schematics?topic=schematics-sample_actiontemplates&format=markdown)
      - [Creating an auto deploy button for Schematics actions](https://cloud.ibm.com/docs/schematics?topic=schematics-auto-deploy-url&format=markdown)
      - [Managing Schematics Action state](https://cloud.ibm.com/docs/schematics?topic=schematics-action-state-diagram&format=markdown)
      - [Reviewing actions job](https://cloud.ibm.com/docs/schematics?topic=schematics-action-jobs&format=markdown)
- Working with Extensions
   - [Schematics agents](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-about-intro&format=markdown)
   - [Preparing for agent deployment](https://cloud.ibm.com/docs/schematics?topic=schematics-plan-agent-overview&format=markdown)
   - [Deploying agent prerequisite infrastructure](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-infrastructure-overview&format=markdown)
   - [Deploying agents](https://cloud.ibm.com/docs/schematics?topic=schematics-deploy-agent-overview&format=markdown)
   - [Displaying agents](https://cloud.ibm.com/docs/schematics?topic=schematics-display-agentb1-overview&format=markdown)
   - [Updating agents](https://cloud.ibm.com/docs/schematics?topic=schematics-update-agent-overview&format=markdown)
   - [Deleting an agent](https://cloud.ibm.com/docs/schematics?topic=schematics-delete-agent-overview&format=markdown)
   - Using agents
      - [Working with agent policies](https://cloud.ibm.com/docs/schematics?topic=schematics-policy-manage&format=markdown)
      - [Agent and Kubernetes configuration ](https://cloud.ibm.com/docs/schematics?topic=schematics-configure-k8s-cluster&format=markdown)
      - [Monitoring agent health](https://cloud.ibm.com/docs/schematics?topic=schematics-agentb1-health&format=markdown)
      - [Configuring Schematics agents to use a proxy server](https://cloud.ibm.com/docs/schematics?topic=schematics-proxy-agent-overview&format=markdown)
      - [Configuring Schematics agents to use a private registry](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-registry-overview&format=markdown)
   - [KMS integration for BYOK or KYOK](https://cloud.ibm.com/docs/schematics?topic=schematics-kms-integration&format=markdown)
   - [Integrating Secrets Manager in Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-sm-integration&format=markdown)
- Working with Terraform
   - [Schematics workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-sc-workspaces&format=markdown)
   - [Creating workspaces and importing your Terraform](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-create-wks&format=markdown)
   - [Using environment variables with workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-set-parallelism&format=markdown)
   - [Creating Terraform templates](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-config&format=markdown)
   - [Using Terraform to configure Schematics ](https://cloud.ibm.com/docs/schematics?topic=schematics-terraform-setup&format=markdown)
- Managing Terraform
   - [Planning for using workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-workspaces-plan&format=markdown)
   - [Running a workspace plan](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-plan-wks&format=markdown)
   - [Running a workspace apply](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-deploy-wks&format=markdown)
   - [Updating workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-update-wks&format=markdown)
   - [Displaying workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-display-wks&format=markdown)
   - [Deleting a workspace](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-delete-wks&format=markdown)
   - [Downloading workspace job files](https://cloud.ibm.com/docs/schematics?topic=schematics-job-download&format=markdown)
   - [Stopping or terminating running jobs](https://cloud.ibm.com/docs/schematics?topic=schematics-interrupt-job&format=markdown)
   - [Workspace operational states](https://cloud.ibm.com/docs/schematics?topic=schematics-wks-state&format=markdown)
   - Managing resources
      - [Displaying Terraform managed resources ](https://cloud.ibm.com/docs/schematics?topic=schematics-resource-features&format=markdown)
      - [Deploying resources in a specific region or across multiple regions](https://cloud.ibm.com/docs/schematics?topic=schematics-multi-region-deployment&format=markdown)
      - [Using Terraform templates and modules in the repositories](https://cloud.ibm.com/docs/schematics?topic=schematics-download-modules-pvt-git&format=markdown)
      - [Managing resources with Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-manage-lifecycle&format=markdown)
      - [Detecting drift in workspaces](https://cloud.ibm.com/docs/schematics?topic=schematics-drift-note&format=markdown)
      - [Remote state and cross-workspace access](https://cloud.ibm.com/docs/schematics?topic=schematics-remote-state&format=markdown)
      - [Terraform version support and deprecation lifecycle](https://cloud.ibm.com/docs/schematics?topic=schematics-deprecate-tf-version&format=markdown)
      - [Upgrading to a new Terraform version](https://cloud.ibm.com/docs/schematics?topic=schematics-migrating-terraform-version&format=markdown)
      - [Downloading compact Git repositories](https://cloud.ibm.com/docs/schematics?topic=schematics-compact-download&format=markdown)
   - [Destroying workspace resources](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-destroy-wks&format=markdown)
   - Logging and Monitoring
      - [Activity tracking events for Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-at_events&format=markdown)
      - [Logging for Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-logging&format=markdown)
      - [Monitoring metrics for Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-monitoring&format=markdown)
   - [Estimating infrastructure costs](https://cloud.ibm.com/docs/schematics?topic=schematics-cost-estimation&format=markdown)
   - [Location based access](https://cloud.ibm.com/docs/schematics?topic=schematics-access-ibm-cloud-catalog&format=markdown)
   - [Job execution and queuing ](https://cloud.ibm.com/docs/schematics?topic=schematics-job-queue-process&format=markdown)
   - [Specifying version constraints](https://cloud.ibm.com/docs/schematics?topic=schematics-version-constraints&format=markdown)
   - Enhancing security
      - [Managing user access](https://cloud.ibm.com/docs/schematics?topic=schematics-access&format=markdown)
      - [Protecting Schematics services with context-based restrictions](https://cloud.ibm.com/docs/schematics?topic=schematics-access-control-cbr&format=markdown)
      - [Using private endpoints](https://cloud.ibm.com/docs/schematics?topic=schematics-private-endpoints&format=markdown)
      - [Securing your data with encryption](https://cloud.ibm.com/docs/schematics?topic=schematics-secure-data&format=markdown)
      - [Firewall access - allowed IP addresses](https://cloud.ibm.com/docs/schematics?topic=schematics-allowed-ipaddresses&format=markdown)
      - [Data privacy and governance](https://cloud.ibm.com/docs/schematics?topic=schematics-data-privacy-and-governance&format=markdown)
      - [General Data Protection Regulation (GDPR)](https://cloud.ibm.com/docs/schematics?topic=schematics-general-data-protection-regulation-gdpr&format=markdown)
   - [Deleting Schematics data](https://cloud.ibm.com/docs/schematics?topic=schematics-delete-schematics-data-intro&format=markdown)

## Reference

- [Understanding high availability and disaster recovery for Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-ha-dr&format=markdown)
- [Your responsibilities when using Schematics ](https://cloud.ibm.com/docs/schematics?topic=schematics-sc-responsibilities&format=markdown)
- API reference
   - [IBM Cloud Schematics API](https://cloud.ibm.com/apis/schematics)
- IBM Cloud Schematics CLI
   - [IBM Cloud Schematics CLI](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference&format=markdown)
- Understanding security and compliance
   - [Understanding security with Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-security&format=markdown)
   - [Understanding compliance with Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-compliance&format=markdown)
- [Understanding data portability for Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-data-portability&format=markdown)
- Schematics SDKs
   - [Schematics SDKs](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-sdks&format=markdown)
   - [IBM Cloud Schematics Go SDK](https://github.com/IBM/schematics-go-sdk/blob/main/README.md)
   - [IBM Cloud Schematics Java Admin SDK](https://github.com/IBM/schematics-java-sdk/blob/main/README.md)
   - [IBM Cloud Schematics Node Admin SDK](https://github.com/IBM/schematics-node-sdk/blob/main/README.md)
   - [IBM Cloud Schematics Python Admin SDK](https://github.com/IBM/schematics-python-sdk/blob/main/README.md)
- Ansible
   - [Ansible documentation](https://docs.ansible.com/projects/ansible/latest/index.html)
- [Schematics worker runtime](https://cloud.ibm.com/docs/schematics?topic=schematics-sch-utilities&format=markdown)
- [Service locations and endpoints](https://cloud.ibm.com/docs/schematics?topic=schematics-locations&format=markdown)
- [Adoption considerations](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-limitations&format=markdown)
- [High availability and disaster recovery](https://cloud.ibm.com/docs/schematics?topic=schematics-high-availability&format=markdown)
- [Schematics notices](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-notices&format=markdown)

## Help

- [Getting help and support](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-help&format=markdown)
- FAQs
   - [Ansible](https://cloud.ibm.com/docs/schematics?topic=schematics-actions-faq&format=markdown)
   - [Extensions](https://cloud.ibm.com/docs/schematics?topic=schematics-faqs-agent&format=markdown)
   - [General FAQs](https://cloud.ibm.com/docs/schematics?topic=schematics-general-faq&format=markdown)
   - [Terraform](https://cloud.ibm.com/docs/schematics?topic=schematics-workspaces-faq&format=markdown)
- Troubleshooting
   - Terraform errors
      - [Why do Schematics workspaces create using the API/UI/CLI fails?](https://cloud.ibm.com/docs/schematics?topic=schematics-wks-create-api&format=markdown)
      - [I tried to create a workspace, why did it fail? ](https://cloud.ibm.com/docs/schematics?topic=schematics-wks-failure&format=markdown)
      - [Why does the Terraform script that contains the Kubernetes cluster namespaces fails as connection refused?](https://cloud.ibm.com/docs/schematics?topic=schematics-wks-connection-refuse&format=markdown)
      - [Why is Schematics apply failing?](https://cloud.ibm.com/docs/schematics?topic=schematics-nullresource-errors&format=markdown)
      - [Why do timeout failures cause tainted Cloud resources?](https://cloud.ibm.com/docs/schematics?topic=schematics-tainted-resources&format=markdown)
      - [Why can't Schematics find my resource group?](https://cloud.ibm.com/docs/schematics?topic=schematics-rg-not-found&format=markdown)
      - [Why am I receiving 5xx HTTP errors?](https://cloud.ibm.com/docs/schematics?topic=schematics-server-errors&format=markdown)
   - Troubleshooting Extensions
      - [How can I provide value for the schematics_resource_crn variable?](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-crn-not-found&format=markdown)
      - [Why am I getting a create endpoint gateway error with the wrong number of segments in CRN?](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-endpoint-error&format=markdown)
   - [Troubleshooting Ansible](https://cloud.ibm.com/docs/schematics?topic=schematics-handling-error&format=markdown)
- [Site map](https://cloud.ibm.com/docs/schematics?topic=schematics-sitemap&format=markdown)