Getting started with IBM Cloud Schematics

Getting started with IBM Cloud Schematics

What is Schematics?

What is Schematics?

• IaC automation as-a-service

• Schematics IaC offerings

  • Schematics workspaces

  • Schematics actions

  • Schematics agents

• Benefits of using Schematics

What is Infrastructure as Code?

What is Infrastructure as Code?

• Benefits of Infrastructure as Code

• Best Practices

  • Codifying everything in IaC

  • Minimize documentation

  • Testing

  • Modular Infrastructure

  • Declarative versus imperative approaches to IaC

  • Declarative Terraform and lifecycle management

  • Idempotence

  • Immutable

• Next steps

Choosing your IaC tool

Choosing your IaC tool

• What is Provisioning?

• What is Configuration Management?

• How to choose your IaC tool

  • Understanding Schematics features and IaC tools

• Next steps

Understanding Schematics use cases

Understanding Schematics use cases

• Infrastructure deployment with Schematics workspaces

• Configuration management with Schematics actions

• Software deployments with IBM-provided templates

Schematics architecture

Schematics architecture

• Architectural flow

• Workload isolation

  • How are API requests to the service isolated from other API requests?

  • How is the information in IBM Cloudant and IBM Cloud Object Storage isolated from other tenant data?

  • How are cloud resources isolated from other tenants?

Best practices for securing the Schematics objects

Best practices for securing the Schematics objects

• Best practices for creating Terraform Templates or modules in Git repositories

  • What are the best practices that you must follow in developing the Terraform templates and publishing the same in the Git repositories?

  • Can you create tfvars files with the IBM Cloud® provider templates?

  • How can the Terraform developers ensure that the sensitive data is not leaked in the log files?

• Best practices of managing Schematics workspaces

  • What are the best practices that you must follow in creating a workspace for the Terraform template?

  • How can you ensure that the sensitive data used by the Terraform automation do not leak in the logs or outputs?

  • How can you protect the access to workspaces and its data?

  • How does Schematics protect the workspace data through Terraform state file, or log files?

• Best practices of managing Schematics actions

  • What are the best practices that you must follow in creating an action for the Ansible template?

  • How can you protect the access to actions and its data?

  • How does Schematics protect the action data through input credentials state file, or log files?

• Protecting data of Schematics

  • Access protection by using Identity and Access Management

  • Non-repudiation by using Activity tracker

  • Data protection by using KMS

• Next steps

Release notes

Release notes

• August 2025

  • Review the release notes for August 2025.

  • 4 August 2025

    • New Schematics locations

    • Logging and monitoring in Montreal region

    • Release Schematics Agents version

  • 1 August 2025

    • Release Schematics CLI plug-in to update the metadata for subnamespaces and subcommands.

• July 2025

  • Review the release notes for July 2025.

  • 31 July 2025

    • Release Schematics CLI plug-in to support Montreal endpoints

  • 29 July 2025

    • Schematics support Terraform_v1.11.2 and Terraform_v1.12.4

• June 2025

  • Review the release notes for June 2025.

  • 12 June 2025

    • Added an endpoint FAQ

• April 2025

  • Review the release notes for April 2025.

  • 25 April 2025

    • Terraform_v1.10.5 support in Schematics

    • Release Schematics Agents version

  • 08 April 2025

    • New Schematics locations

    • Logging and monitoring in Toronto region

  • 07 April 2025

    • Release Schematics CLI plug-in

• February 2025

  • Review the release notes for February 2025.

  • 28 February 2025

    • Release Schematics Agents version

• January 2025

  • Review the release notes for January 2025.

  • 20 January 2025

    • To securely validate and clone the template from your Git repository URL, you can use the Open reference picker to select your Secrets Manager key reference in the create workspace, update workspace, create action, and update action.

  • 10 January 2025

    • Release Schematics CLI plug-in

  • 08 January 2025

    • Update workspace feature upgrade

    • Schematics enhances the destory feature

    • Schematics get command supports encryption status

• December 2024

  • Review the release notes for December 2024.

  • 18 December 2024

    • Schematics supports region-based access

• November 2024

  • Review the release notes for November 2024.

  • 14 November 2024

    • Schematics in Platform automation UI

• October 2024

  • Review the release notes for October 2024.

  • 30 October 2024

    • Release Schematics Agents version

  • 24 October 2024

    • New Activity Tracker topic

    • Added logging topic

    • New Monitoring metrics topic

• September 2024

  • Review the release notes for September 2024.

  • 23 September 2024

    • Release Schematics Agents version

• August 2024

  • Review the release notes for August 2024.

  • 21 August 2024

    • Terraform_v1.7.5, Terraform_v1.8.5, and Terraform_v1.9.2 support in Schematics

• July 2024

  • Review the release notes for July 2024.

  • 23 July 2024

    • Release Schematics Agents version

  • 8 July 2024

    • Release Schematics CLI plug-in

  • 3 July 2024

    • Update the Schematics Terraform version release plan

• June 2024

  • Review the release notes for June 2024.

  • 11 June 2024

    • Release Schematics CLI plug-in

  • 05 June 2024

    • Terraform_v1.6.6 support in Schematics

• May 2024

  • Review the release notes for May 2024.

  • 31 May 2024

    • Release Schematics CLI plug-in

  • 16 May 2024

    • Enhanced FAQ documentation

• April 2024

  • Review the release notes for April 2024.

  • 19 April 2024

    • Release Schematics CLI plug-in

  • 17 April 2024

    • Announcement of Schematics deprecation of Terraform version

• March 2024

  • Review the release notes for March 2024.

  • 25 March 2024

    • Schematics Agents support Red Hat OpenShift Kubernetes Service

    • Release Schematics Agents version

    • Release Schematics CLI plug-in

  • 08 March 2024

    • Release Schematics CLI plug-in

• February 2024

  • Review the release notes for February 2024.

  • 28 February 2024

    • Deprecate creation of workspace by using the IBM Cloud Provider Plug-in for Terraform v1.2 and v1.3

  • 14 February 2024

    • Release Schematics CLI plug-in

  • 07 February 2024

    • Release Schematics CLI plug-in

• January 2024

  • Review the release notes for January 2024.

  • 24 January 2024

    • Release Schematics CLI plug-in

  • 18 January 2024

    • Release Schematics CLI plug-in

  • 10 January 2024

    • Schematics support for agent is generally available (GA) with full production support.

• October 2023

  • Review the release notes for October 2023.

  • 05 October 2023

    • The Schematics Agent supports private catalog

  • 04 October 2023

    • Release Schematics infrastructure cost estimator

• September 2023

  • Review the release notes for September 2023.

  • 12 September 2023

    • Release Schematics CLI plug-in

    • Release Schematics Agent migration page

• August 2023

  • Review the release notes for August 2023.

  • 28 August 2023

    • Release Schematics Agent migration page

  • 23 August 2023

• May 2023

  • Review the release notes for May 2023.

  • 22 May 2023

    • Release Schematics CLI plug-in

• April 2023

  • Review the release notes for April 2023.

  • 18 April 2023

    • Schematics documentation realigns the workspace documentation

  • 13 April 2023

    • Schematics updates the deprecation of Terraform versions

  • 6 April 2023

    • Release Schematics CLI plug-in

• March 2023

  • Review the release notes for March 2023.

  • 30 March 2023

    • Release configuring Kubernetes cluster for an agent.

    • Enhancement of Schematics worker runtime.

    • IAM allowed IP addresses replaced with context-based restrictions.

    • The terraform.tfstate state file with maximum limit is less than 2 MB.

  • 22 March 2023

    • Schematics Agent beta-1 release.

    • Release Schematics CLI plug-in.

• February 2023

  • Review the release notes for February 2023.

  • 16 February 2023

    • Schematics allowed IP address for US, EU Central, and UK South region are updated

  • 7 February 2023

    • Release Schematics CLI plug-in.

  • 3 February 2023

    • Enhancement in Schematics to protect its services with context-based restrictions

• January 2023

  • Review the release notes for January 2023.

  • 30 January 2023

    • Release Schematics CLI plug-in.

• December 2022

  • Review the release notes for December 2022.

  • 13 December 2022

    • Release Schematics agents GitHub repository.

    • Release Schematics CLI plug-in.

• November 2022

  • Review the release notes for November 2022.

  • 29 November 2022

    • Enhance Schematics documentation

  • 18 November 2022

    • Release Schematics CLI plug-in.

  • 15 November 2022

    • Release Schematics agents GitHub repository.

  • 03 November 2022

    • Release Schematics CLI plug-in.

• September 2022

  • Schematics deprecates Python v3.6 and upgrades the Schematics Job image to use Python v3.8 by mid of September 2022. For more information, see Schematics announcement tools.

  • Review the release notes for September 2022.

  • 21 September 2022

    • The Schematics Job image supports Python v3.8

• August 2022

  • Review the release notes for August 2022.

  • 16 August 2022

    • Schematics runtime now supports Ansible v2.9.27

  • 11 August 2022

    • Release Schematics CLI plug-in

  • 04 August 2022

    • Schematics allowed IP address for US, EU Central, and UK South region are updated

• July 2022

  • Review the release notes for July 2022.

  • 26 July 2022

    • Release Schematics CLI plug-in

  • 20 July 2022

    • Schematics allowed IP address for US region is updated

  • 11 July 2022

    • Schematics agents beta release in production.

    • Release Schematics CLI plug-in

  • 8 July 2022

    • Release Schematics CLI plug-in

• June 2022

  • Review the release notes for June 2022.

  • 23 June 2022

    • Enhanced FAQ documentation

  • 15 June 2022

    • Enhance Schematics getting started section

• May 2022

  • Review the release notes for May 2022.

  • 12 May 2022

    • Enhance documentation with the security and compliance section

    • Documentation enhancement

  • 5 May 2022

    • Release Schematics CLI plug-in

• April 2022

  • Review the release notes for April 2022.

  • 30 April 2022

    • Support detecting drift

    • Support stopping or terminating the running job

    • Support more frequently asked questions (FAQs)

    • Support enhanced Schematics resource view

  • 26 April 2022

    • Release Schematics CLI plug-in

  • 17 April 2022

    • Release Schematics CLI plug-in

  • 18 April 2022

    • Support array of injectable Terraform blocks in create workspace API

    • Release Schematics CLI plug-in

  • 12 April 2022

    • Schematics command-line supports private Schematics endpoint

    • Support .JSON and .tfvars file extension for Schematics plan and apply commands

    • Enhance resources tabular data view for resources.

    • Deprecate and warning message when using ibmcloud terraform command.

    • Release Schematics CLI plug-in

• March 2022

  • Review the release notes for March 2022.

  • 31 March 2022

    • Support deleting Schematics data objects

    • Fixes related to Schematics actions and workspace

    • Get job files API supports plan_json file type

  • 15 March 2022

    • Support __netrc__ environment values in private Git repository

  • 4 March 2022

    • Support Terraform v1.1 in Schematics

    • Release Schematics CLI plug-in

• February 2022

  • Review the release notes for February 2022.

  • 16 February 2022

    • Release Schematics CLI plug-in

    • Supports installer for Linux™ arm64 and Mac OS arm64 libraries

  • 11 February 2022

    • Release Schematics CLI plug-in

• January 2022

  • Review the release notes for January 2022.

  • 31 January 2022

    • Release Schematics CLI plug-in

    • Supports installer for PowerLinux™ and S/390 Linux™

• December 2021

  • Review the release notes for December 2021.

  • 30 December 2021

    • Release Schematics CLI plug-in

• November 2021

  • Review the release notes for November 2021.

  • 30 November 2021

    • Centrally manage access tags for Schematics workspaces in your account

    • Support WinRM in user interface

    • Global catalog settings for Schematics workspaces location

    • About compact download

    • About Schematics Job files

    • ResourceQuery attribute deprecated

• October 2021

  • Review the release notes for October 2021.

  • 22 October 2021

    • Onboarding Terraform templates to private catalog

    • Sample templates to deploy into IBM Cloud

    • Support WinRM in command line

    • The documentation lists the Command-line version change log history

• September 2021

  • Review the release notes for September 2021.

  • 30 September 2021

    • Inventory target feature support in Schematics actions API

    • Bastion host enhancement in Schematics actions API

    • Schematics actions API enhancement to support bastion host connection with non-root user

    • IBM Cloud Schematics job queue process

    • Schematics actions APIs enhances the credentials parameter

    • Schematics introduces a compact flag in the workspace create and update API

    • Importance of location and URL endpoint in workspace creation

• August 2021

  • Review the release notes for August 2021.

  • 27 August 2021

    • Workspace update command enhancement

    • Terraform v1.0 support

    • IBM Cloud Schematics support job queue logs enhancement

  • 11 August 2021

    • IBM Cloud Schematics deprecates older version of Terraform

• July 2021

  • Review the release notes for July 2021.

  • 30 July 2021

    • IBM Cloud Schematics deprecates Terraform v0.11

    • Terraform v0.15 support

    • Ansible v2.9.23 API and command-line support

  • 19 July 2021

    • Support parallelism and other environment variables in IBM Cloud Schematics

• June 2021

  • Review the release notes for June 2021.

  • 30 June 2021

    • Support taint and untaint feature enhancement in IBM Cloud Schematics

    • Documentation support to deploy resources in a specific region or across multiple regions

    • Documentation support to create workspace by using IBM Cloud Schematics resources

    • One-page view to create workspace by using UI, CLI, API, and Terraform switcher documentation

    • Temporarily IBM Cloud Schematics workspaces stop activity API is deactivated

• May 2021

  • Review the release notes for May 2021.

  • 26 May 2021

    • Version constraints support in IBM Cloud Schematics

    • Troubleshooting guide support

    • Schematics supports sample solutions

• April 2021

  • Review the release notes for April 2021.

  • 14 April 2021

    • Ansible support in IBM Cloud Schematics is now generally available

• March 2021

  • Review the release notes for March 2021.

  • 29 March 2021

    • Terraform v0.14 support

• February 2021

  • Review the release notes for February 2021.

  • 25 February 2021

    • Schematics supports the ability to store the user-defined file

    • Allowed file extensions in Schematics

    • Schematics CLI plug-in and commands support in CLI documentation

  • 12 February 2021

    • Ansible open beta release

• January 2021

  • Review the release notes for January 2021.

  • 29 January 2021

    • Virtual Private Endpoint Gateways support

  • 20 January 2021

    • Terraform commands API support

    • Terraform commands command-line support

    • Command-line commands

  • 7 January 2021

    • Multiple SDK support

• December 2020

  • Review the release notes for December 2020.

  • 9 December 2020

    • Ansible beta release

    • Beta

• November 2020

  • Review the release notes for November 2020.

  • 25 November 2020

    • Terraform v0.13 support

• October 2020

  • Review the release notes for October 2020.

  • 16 October 2020

    • Monitoring

    • Files and resources for your workspace actions

    • Creating a deployment to IBM Cloud Schematics link

• September 2020

  • Review the release notes for September 2020.

  • 11 September 2020

    • Bitbucket supports private repository

    • Support to override the default variable

• August 2020

  • Review the release notes for August 2020.

  • 14 August 2020

    • Support for multiple Terraform providers

    • Time out set for local-exec and remote-exec users

    • Bitbucket is used as a template repository source

• July 2020

  • Review the release notes for July 2020.

  • 9 July 2020

    • Stop apply support

    • New Schematics locations

• June 2020

  • Review the release notes for June 2020.

  • 26 June 2020

    • Ansible provisioner support

  • 25 June 2020

    • Version 1.8.0 of the IBM Cloud Provider plug-in available

  • 22 June 2020

    • Upload Terraform templates as TAR files

• May 2020

  • Review the release notes for May 2020.

  • 8 May 2020

    • New EU API endpoint

• April 2020

  • Review the release notes for April 2020.

  • 17 April 2020

    • Terraform v0.12 support

    • New workspace creation flow

Getting started

Using workspaces to deploy infrastructure and cloud services

• Before you begin

• Creating an IBM Cloud Object Storage instance with Schematics

  • Output

• What's next?

Using actions to perform configuration management

• Before you begin

• Starting and stopping Virtual Servers for VPC

• What's next?

Software deployment in IBM Cloud Schematics

• Before you begin

• Setting up and configuring a classic VSI to run PostgreSQL with Schematics

• What's next?

Creating an IBM Cloud Kubernetes Service cluster on VPC infrastructure

Creating an IBM Cloud Kubernetes Service cluster on VPC infrastructure

• Description

• Objectives

• Time required

• Audience

• Prerequisites

• Creating your Schematics workspace

• Creating your IBM Cloud Schematics workspace

• Planning and applying the Terraform template

• What's next?

Setting up continuous deployment with Schematics and a DevOps toolchain

Setting up continuous deployment with Schematics and a DevOps toolchain

• Description

• Objectives

• Time needed

• Audience

• Prerequisites

  • About IBM Cloud Schematics

  • About DevOps toolchain

• Accessing the IBM Cloud and GitHub

• Creating your IBM Cloud Schematics workspace

• Configuring variables

• Automating the continuous deployment process

• Analyzing the pipeline execution process

• Analyzing the Schematics workspace

• What's next?

Importing Schematics templates into the IBM Cloud catalog

Importing Schematics templates into the IBM Cloud catalog

• Objectives

• Time required

• Audience

• Prerequisites

• Prepare your Terraform template for the private catalog

• Creating a release

• Create a private catalog and add your Terraform template as a product

• What's next?

Deploying a VPC environment with bastion host on IBM Cloud

Deploying a VPC environment with bastion host on IBM Cloud

Deploying a multitiered VPC with bastion host on IBM Cloud

Deploying a multitiered VPC with bastion host on IBM Cloud

Configuring the CLI and API

Setting up the API

• Working with the Schematics API

• Refreshing IBM Cloud IAM access tokens and obtaining new tokens with the API

Setting up the CLI

• Installing the IBM Cloud command-line

• Installing the IBM Cloud Schematics command-line plug-in

• Updating the CLI

• Uninstalling the IBM Cloud Schematics command-line plug-in

Working with Ansible

Schematics actions

• Schematics actions overview

• Using Actions

• Next steps

Creating Ansible roles and galaxy

• Creating your own roles in Ansible

• Installing roles from Ansible Galaxy

Working with Ansible

• Creating and running a Schematics action

  • Prerequisites

  • To create an Ansible playbook

• Updating the Schematics actions settings

• Deleting an action

• Action state

  • State diagram flow

• Reviewing actions job details

Creating an Ansible playbook

• Referencing Ansible collections in your playbook

• Preparing your Ansible playbook to run in Schematics

Sample Ansible playbook templates for Schematics actions

• Running cloud operations on Virtual Servers for VPC

• Provisioning a LAMP stack on Virtual Servers for VPC

• Configuring IBM Cloud Databases for PostgreSQL with WAL2JSON plug-in

• Automating app deployments in IBM Cloud Kubernetes Service

• Installing kubectl on Virtual Servers for VPC

Creating an auto deploy button for Schematics actions

• Creating the deployment URL

• Adding the button to a website or page

  • Adding the button in HTML

  • Adding the button in Markdown

• Next steps

Working with Extensions

Schematics agents

• Schematics Agent overview

• Private network configuration when using agents

• Benefits of using agents

• Next steps

Preparing for agent deployment

• Planning agent network access and configuration

• Agent capacity planning

• Next steps

Deploying agent prerequisite infrastructure

• Prerequisites

• Provisioning agent infrastructure using Schematics

  • Expected outcome

• Next steps

Deploying agents

• Before you begin

• Creating an agent definition

• Creating an agent definition through CLI

• Verifying prerequisites for agent deployment through CLI

• Deploying an agent through CLI

• Verifying the agent deployment through CLI

• Creating an agent through API

• Creating an agent through Terraform

• Next steps

Displaying agents

• Displaying the agents through UI

• Displaying the agents through CLI

• Displaying agent configuration through CLI

• Displaying agents through API

• Displaying agents through Terraform

• Next steps

Updating agents

• Before you begin

• Updating an agent definition

• Creating an agent definition through CLI

• Verifying agent update

• Updating an agent through API

• Agents version history

• Next steps

Deleting an agent

• Deleting an agent through UI

• Deleting an agent through CLI

• Deleting an agent through API

• Next steps

Working with Terraform

Schematics workspaces

• Schematics workspace overview

• Features

• Next steps

Creating workspaces and importing your Terraform

• Before you begin

• Creating a workspace using the UI

  • Importing your Terraform template

  • Using Terraform templates in IBM Cloud

• Creating a workspace using the CLI

• Creating a workspace using API

• Creating workspace using Terraform

• Next steps

Using environment variables with workspaces

• Usage

  • Passing TF_CLI_ARGS as env-vars

  • Example setting parallelism or TF_LOGS

• List of Terraform environment variables

Creating Terraform templates

• Configuring the provider block

• Adding Cloud resources to the resource block

  • Referencing resources in other resource blocks

• Managing resources in other account

• Using variable blocks to customize resources

  • Referencing variables

• Providing values to IBM Cloud Schematics for the declared variables

  • Example for list of Strings

  • Example for list of Objects

• Storing your Terraform templates

• Sample Terraform solutions

Using Terraform to configure Schematics

• Example - Creating the Schematics workspaces by using Terraform

• What's next?

Managing Terraform

Planning for using workspaces

• Workspaces and Git repositories

  • How many workspaces does my application environment need?

  • How do I structure my Git repositories to map my workspaces?

  • How can I reuse configuration files across environments and workspaces?

  • How do I control access to my workspaces?

  • What do I need to be aware of when I have a repository that has been previously used with Terraform standalone?

• Setting up a continuous delivery toolchain for your workspace

Running a workspace plan

• Before you begin

• Generate a workspace plan using the UI

  • Verifying workspace plan

• Generate a workspace plan using the CLI

  • Verifying workspace plan execution

• Generate a workspace plan using the API

  • Verifying workspace plan execution

• Generating a workspace plan using Terraform

• Next steps

Running a workspace apply

• Before you begin

• Perform a workspace apply using the UI

  • Verifying workspace apply

• Perform a workspace apply using the CLI

  • Verifying workspace deploy

• Perform the workspace deploy using the API

  • Verifying workspace deploy

• Perform the workspace deploy with Terraform

• Next steps

Updating workspaces

• Before you begin

• Updating a workspace using the UI

  • Verifying workspace update

• Updating a workspace using the CLI

  • Verifying workspace update

• Updating a workspace using the API

  • Verifying workspace update

• Updating a workspace with Terraform

• Next steps

Displaying workspaces

• Before you begin

• Displaying the workspace through UI

  • Verifying workspace display

• Displaying the workspace through CLI

  • Verifying workspace list

• Displaying the workspace list through API

  • verifying workspace update:

• Displaying the workspace list with Terraform

• Next steps

Deleting a workspace

• Before you begin

• Deleting the workspace through UI

  • Verifying workspace delete

• Deleting the workspace through CLI

  • Verifying workspace delete

• Deleting the workspace through API

  • Verifying workspace delete

• Deleting the workspace with Terraform

• Next steps

Downloading workspace job files

• Workspace job execution

• Note

Stopping or terminating running jobs

• Stop job types

• Canceling a job

• Stopping a running job using the UI

• Stopping a running job using the CLI

• Stopping a running job through API

  • Syntax to stop running jobs

• Reviewing the Schematics job details

Workspace operational states

• Workspace state overview

• Workspace state diagram and manipulative job

• Creating an auto deployment to the IBM Cloud Schematics

• Reviewing the Schematics job details

* [Locations where logs are sent to IBM Cloud Logs](/docs/schematics?topic=schematics-logging#la-legacy-locations)

Understanding high availability and disaster recovery for Schematics

Understanding high availability and disaster recovery for Schematics

Your responsibilities when using Schematics

Your responsibilities when using Schematics

• Incident and operations management

• Change management

• Identity and access management

• Security and regulation compliance

• Disaster recovery

API reference

IBM Cloud Schematics API

IBM Cloud Schematics CLI

IBM Cloud Schematics CLI

• Prerequisites

• Actions commands

  • ibmcloud schematics action create

  • ibmcloud schematics action update

  • ibmcloud schematics action get

  • ibmcloud schematics action list

  • ibmcloud schematics action delete

  • ibmcloud schematics action upload

• Actions Job commands

  • ibmcloud schematics job run

  • ibmcloud schematics job update

  • ibmcloud schematics job get

  • ibmcloud schematics job list

  • ibmcloud schematics job logs

  • ibmcloud schematics job delete

• Agents commands

  • ibmcloud schematics agent create

  • ibmcloud schematics agent delete

  • ibmcloud schematics agent deploy

  • ibmcloud schematics agent destroy

  • ibmcloud schematics agent get

  • ibmcloud schematics agent health

  • ibmcloud schematics agent list

  • ibmcloud schematics agent update

  • ibmcloud schematics agent validate

• Agents policy commands

  • ibmcloud schematics policy create

  • ibmcloud schematics policy delete

  • ibmcloud schematics policy get

  • ibmcloud schematics policy list

  • ibmcloud schematics policy update

• Configure BYOK or KYOK commands

  • Prerequisites

  • ibmcloud schematics kms instance ls

  • ibmcloud schematics kms enable

  • ibmcloud schematics kms info

• General commands

  • ibmcloud schematics help

  • ibmcloud schematics version

• Inventory commands

  • ibmcloud schematics inventory create

  • ibmcloud schematics inventory delete

  • ibmcloud schematics inventory get

  • ibmcloud schematics inventory list

  • ibmcloud schematics inventory update

• Inventory resource query commands

  • ibmcloud schematics resource query create

  • ibmcloud schematics resource query delete

  • ibmcloud schematics resource query get

  • ibmcloud schematics resource query list

  • ibmcloud schematics resource query update

• Workspace commands

  • ibmcloud schematics workspace action

  • ibmcloud schematics workspace delete

  • ibmcloud schematics workspace get

  • ibmcloud schematics workspace import

  • ibmcloud schematics workspace list

  • ibmcloud schematics workspace new

  • ibmcloud schematics refresh

  • ibmcloud schematics state list

  • ibmcloud schematics workspace taint

  • ibmcloud schematics workspace untaint

  • ibmcloud schematics workspace update

  • ibmcloud schematics workspace update variables

  • ibmcloud schematics workspace upload

• Workspace job commands

  • ibmcloud schematics apply

  • ibmcloud schematics destroy

  • ibmcloud schematics logs

  • ibmcloud schematics output

  • ibmcloud schematics plan

• Workspace stop commands

  • ibmcloud schematics workspace job stop

• Workspace state file commands

  • ibmcloud schematics state pull

  • ibmcloud schematics workspace state show

  • ibmcloud schematics workspace state mv

  • ibmcloud schematics workspace state rm

• Workspace Terraform commands

  • Terraform commands

• CLI version history

Understanding security and compliance

Understanding security with Schematics

• Secure access control

Understanding compliance with Schematics

• Available goals for IBM Cloud Schematics

• General Data Protection Regulation (GDPR) readiness

• Privacy shield

• International Organization for Standardization (ISO)

• SOC 2 Type 2 Certification

Understanding data portability for Schematics

Understanding data portability for Schematics

• Responsibilities

• Data export procedures

• Exported data formats

• Data ownership

Schematics SDKs

Schematics SDKs

IBM Cloud Schematics Go SDK

IBM Cloud Schematics Java Admin SDK

IBM Cloud Schematics Node Admin SDK

IBM Cloud Schematics Python Admin SDK

Ansible

Ansible documentation

Schematics worker runtime

Schematics worker runtime

• Runtime-terraform-job image

• Runtime-ansible-job image

Service locations and endpoints

Service locations and endpoints

• Where can I create and run Schematics workspaces?

• Where do my Schematics actions run?

• Where is my Schematics and template data stored?

• Where are my Cloud resources provisioned?

Adoption considerations

Adoption considerations

• Differences to native Terraform

  • Do I need to provide an IBM Cloud API key in the provider block?

  • Can I use my local terraform.tfvars file?

  • Is Terraform remote state supported?

  • Why do local-exec and remote-exec provisioner terminate after 30 minutes?

• What is the use of refresh token header?

• Git repo restrictions

• Cost estimate

Schematics notices

Schematics notices

• Creative Commons Attribution 3.0

• Creative Commons Attribution 4.0

• Creative Commons Attribution Share Alike 1.0 Generic

• Creative Commons Attributions Share Alike 2.0 Generic

• Creative Commons Attribution 2.5 Generic

• Creative Commons Attribution Share Alike 3.0 Generic

• Creative Commons Attribution Share Alike 4.0 Generic

Getting help and support

Getting help and support

• Providing support case details

FAQs

Ansible

• Are Classic VSIs supported for use with actions?

• What network configuration is suggested for use with actions?

• Why does the SSH connection fail with static inventory files?

• Why does my action job display a DEPRECATION WARNING message?

• How can I resolve that might not run action error while provisioning WinRM by using Schematics action?

• When are new Terraform and Ansible versions added to Schematics?

• Can I run Ansible playbooks with Schematics?

Extensions

• What are the updates in the GA agent release?

• What are the costs of installing and using agents?

• Is it possible to install more than one Agent on a cluster?

• What Terraform versions are supported with agents?

• Why does workspace execution fail with terraformx.x: executable file not found in $PATH

• What type of jobs can be run in an agent?

• How can I see the Schematics job results and logs for the jobs running on an agent?

• What is the minimum cluster configuration required in Agent release?

• How many workspaces can be assigned to an agent?

• How many jobs can run in parallel on an agent?

• What is the default polling interval for agents?

• Are there execution timeout limits when working with agents?

• What is the difference between agent-location and location flag in agent service?

• Can an agent run workspace jobs that are associated with different resource groups?

• Can an agent work with workspaces and actions belonging to different Schematics regions?

• Is it possible to use an agent to execute jobs for multiple accounts?

• Can an existing workspace run jobs on an agent?

• What IAM permissions is needed to deploy an agent?

• Can I inject self signed or TLS certificates in IBM Cloud Kubernetes Service pod or container trusted CA root certificate store during agent runtime?

• What attributes of workspaces or actions are used to dynamically select a target agent for execution

• How can I enable debug mode in an agent?

• Can I upgrade an agent beta version to an agent General Availability (GA) version?

• Are Schematics Agent the same as Terraform cloud agents?

• Do the agents run on IBM Cloud cloud resources?

• What are the minimum cluster configurations needed to support 30 jobs on the Schematics agent?

• How can a user identify the job is created by an agent?

• Is it possible that a workspace is created by an agent and still do not have a reference in the workspace job log?

• Can Schematics Agent establish a connection with the private Git instance?

• Can Schematics Agent update a connection with the private Git instance?

General FAQs

• What is IBM Cloud Schematics and how does it work?

• What is Infrastructure as Code?

• What is the cost charged for using Schematics?

• How do I save files between operations?

• Job failures due to files removed or missing from workspace, or actions (Ansible) template repos

• Files that are removed using from Terraform, or Ansible template repos

• Is the use of symlinks supported in Git repos?

• Is the use of Git submodules supported in Git repos or TGZ files?

• Is there a rate limit?

• Why are jobs waits in a run queue?

• How do I generate IAM access token, if client ID bx is used?

• How to rectify failed to clone Git repository, might not find remote reference or heads or master most likely invalid branch name is passed?

• Can you increase the timeout for null-exec and remote-exec resource?

• How can I save user-defined files by the Terraform modules and use them across multiple Terraform commands?

• How do I identify the best way to synchronize a deleted resource with the Terraform state?

• How do I overcome the request that exceeds the Cluster resource quota of '100' for the account in any region?

• While creating Red Hat OpenShift or Kubernetes resources, can I tune the 90-minute time out to higher?

• How can I rectify the 403 Error while validating the location in the global catalog account?

• Can I start or stop the Virtual Servers for VPC based on tags and through scheduler or cron job?

• Might I create a worker node in an existing worker node pool?

• Where can I view the list of public and private allowed IP addresses of us-south, us-east, eu-gb, and eu-de regions?

• Can I manually add, or remove a resource from the service dashboard directly?

• What changes can I make to my resources?

• How can I compare the required state of my cloud resources against the actual state of my resources?

• What are the deviations that cannot be detected?

• How must I remove resources with IBM Cloud Schematics?

• What happens if I choose to delete my resource directly from the resource dashboard?

• Does Schematics support ibmcloud terraform command?

• Can I access a private network through Schematics?

• How can I resolve the error message when connecting to Bastion host IP addresses through IBM Cloud Schematics?

• How do I create a cluster by using Terraform on IBM Cloud environment?

• Can I always set Terraform to use the current or default version?

• If I set type: = terraform_v1.4 in the JSON file as shown in the code block, does Terraform version 1.4 continue to use even if Terraform version 2.0 or higher releases?

• Can I specify only the provider version in the version parameter? Or is it mandatory to provide the required_version parameter in the versions.tf file?

• What is the difference between delete and destroy in Schematics?

• Can I delete and destroy operation as one step?

• What is a resource group and how does it help me organize my team?

• What is the benefit of using IAM access group?

• What are the steps to create and restrict the fine-grained and classic personal access tokens (PAT)?

• Can I run the terraform init -backend-config="KEY=VALUE" option through CLI?

• When do you specify the GitHub master or subdirectory branch?

• Can you configure the activeness of the Schematics API call?

• Does Schematics support region-based access?

• Does Workspace and Action support Secrets Manager?

• Why are eval and uname commands being restricted?

• How do eval and uname command restriction affect existing scripts and automation?

• What alternative solutions can replace eval and uname commands?

• Does the change of eval and uname commands impact Terraform execution within Schematics?

• What are the endpoints supported by Schematics?

Terraform

• Does IBM Cloud Schematics support multiple Terraform provider versions?

• How do I update the Terraform version

• How do I pull latest code from a Git repo by using the command line?

• What tools and utilities are used in the runtime?

• How can I fix Git token issues when creating workspaces by using the CLI

• How do I fix authorization issues when creating or updating a workspace?

• How to use Schematics services with a test ID?

• How to limit Git repo folder cloning

• How to delete a workspace when the delete fails?

• What is the best way to deploy a Helm chart by using credentials or secrets?

• How to address job failures that are caused by maintenance activities?

• How do you set the Git release tag?

• Why do I get a 403 error instead of a 404 error when using an invalid workspace ID?

• How can I enable Terraform debug logging

• How can I import Cloud resources into a workspace?

• How can I download Job files?

• How do I set the TF_CLI_ARGS environment variable?

• Can I use private Git repositories for modules?

• Can I edit all the variables in a workspace?

• How do I import keys when importing KMS resources?

• Can you enable the TRACE to help DEBUG Schematics API while running workspace list command?

• How do I resolve errors in listing workspaces?

• How can I use (IBM) GitLab repositories?

• Can IAM access groups be managed in Schematics?

• How do I work with resources in another account?

• What does North America location indicate?

• What ports and IP addresses are used by Schematics?

• When do I use Schematics versus the individual resource dashboards?

• Are changes to Git repos refreshed in Schematics?

• Where is the Terraform state file stored?

• Are resources removed on delete workspace?

• Can I set environment variables for workspaces?

• Does drift detection run automatically?

• How can I initiate drift detection?

• Where can I see the status of a drift detection job?

• Can I interrupt or terminate running jobs?

• How do I correct an Incorrect Location Input error?

• How can I view workspace resources?

• How do I fix the CreateworkspaceWithContext failed Bad request error?

• Are sensitive values in the state file encrypted?

• Why do workspace variables that are defined by using CLI throw 400 errors?

• Can you update the Terraform version (TF_VERSION) using a JSON file?

• Can start with a new Terraform state file on each job run?

• Can I import an existing Terraform state file?

• What is the maximum variable length of characters?

• What is the maximum state file to import?

• How do I fix authentication errors when using the API?

• How to retrieve the Schematics Workspace ID as environment variable?

• How do I rectify 401 errors from the broker call when deleting the Schematics objects?

Troubleshooting