Skip to content

Latest commit

 

History

History
2586 lines (1274 loc) · 129 KB

sitemap.md

File metadata and controls

2586 lines (1274 loc) · 129 KB
copyright lastupdated keywords subcollection
years
2017, 2025
2025-01-20
schematics
schematics

{{site.data.keyword.attribute-definition-list}}

Site map

{: #sitemap}

Getting started with {{site.data.keyword.bplong_notm}}

{: #sitemap_getting_started_with_}

Getting started with {{site.data.keyword.bplong_notm}}

What is {{site.data.keyword.bpshort}}?

{: #sitemap_what_is_}

What is {{site.data.keyword.bpshort}}?

What is Infrastructure as Code?

{: #sitemap_what_is_infrastructure_as_code}

What is Infrastructure as Code?

Choosing your IaC tool

{: #sitemap_choosing_your_iac_tool}

Choosing your IaC tool

Understanding {{site.data.keyword.bpshort}} use cases

{: #sitemap_understanding_use_cases}

Understanding {{site.data.keyword.bpshort}} use cases

{{site.data.keyword.bpshort}} architecture

{: #sitemap__architecture}

{{site.data.keyword.bpshort}} architecture

Best practices for securing the {{site.data.keyword.bpshort}} objects

{: #sitemap_best_practices_for_securing_the_objects}

Best practices for securing the {{site.data.keyword.bpshort}} objects

Release notes

{: #sitemap_release_notes}

Release notes

  • January 2025

    • Review the release notes for January 2025.

    • 10 January 2025

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 08 January 2025

      • Workspace update variable command feature upgrade

      • {{site.data.keyword.bpshort}} enhances the destory feature

      • {{site.data.keyword.bpshort}} supports encryption status in get commands

  • December 2024

    • Review the release notes for December 2024.

    • 18 December 2024

      • {{site.data.keyword.bpshort}} supports region-based access
  • November 2024

    • Review the release notes for November 2024.

    • 14 November 2024

      • {{site.data.keyword.bpshort}} in Platform automation UI
  • October 2024

    • Review the release notes for October 2024.

    • 30 October 2024

      • Release {{site.data.keyword.bpshort}} Agents version
    • 24 October 2024

      • New {{site.data.keyword.cloudaccesstrailshort}} topic

      • Added logging topic

      • New {{site.data.keyword.monitoringshort}} metrics topic

  • September 2024

    • Review the release notes for September 2024.

    • 23 September 2024

      • Release {{site.data.keyword.bpshort}} 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 {{site.data.keyword.bpshort}}
  • July 2024

    • Review the release notes for July 2024.

    • 23 July 2024

      • Release {{site.data.keyword.bpshort}} Agents version
    • 8 July 2024

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 3 July 2024

      • Update the {{site.data.keyword.bpshort}} Terraform version release plan
  • June 2024

    • Review the release notes for June 2024.

    • 11 June 2024

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 05 June 2024

      • Terraform_v1.6.6 support in {{site.data.keyword.bpshort}}
  • May 2024

    • Review the release notes for May 2024.

    • 31 May 2024

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 16 May 2024

      • Enhanced FAQ documentation
  • April 2024

    • Review the release notes for April 2024.

    • 19 April 2024

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 17 April 2024

      • Announcement of {{site.data.keyword.bpshort}} deprecation of Terraform version
  • March 2024

    • Review the release notes for March 2024.

    • 25 March 2024

      • {{site.data.keyword.bpshort}} Agents supports {{site.data.keyword.redhat_openshift_notm}} {{site.data.keyword.containershort_notm}}

      • Release {{site.data.keyword.bpshort}} Agents version

      • Release {{site.data.keyword.bpshort}} command-line plug-in

    • 08 March 2024

      • Release {{site.data.keyword.bpshort}} command-line plug-in
  • February 2024

    • Review the release notes for February 2024.

    • 28 February 2024

      • Deprecate creation of workspace by using the {{site.data.keyword.terraform-provider_full_notm}} v1.2 and v1.3
    • 14 February 2024

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 07 February 2024

      • Release {{site.data.keyword.bpshort}} command-line plug-in
  • January 2024

    • Review the release notes for January 2024.

    • 24 January 2024

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 18 January 2024

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 10 January 2024

      • {{site.data.keyword.bpshort}} support for agent is generally available (GA) with full production support.
  • October 2023

    • Review the release notes for October 2023.

    • 05 October 2023

      • The {{site.data.keyword.bpshort}} Agent supports private catalog
    • 04 October 2023

      • Release {{site.data.keyword.bpshort}} infrastructure cost estimator
  • September 2023

    • Review the release notes for September 2023.

    • 12 September 2023

      • Release {{site.data.keyword.bpshort}} command-line plug-in

      • Release {{site.data.keyword.bpshort}} Agent migration page

  • August 2023

  • May 2023

    • Review the release notes for May 2023.

    • 22 May 2023

      • Release {{site.data.keyword.bpshort}} command-line plug-in
  • April 2023

    • Review the release notes for April 2023.

    • 18 April 2023

      • {{site.data.keyword.bpshort}} documentation realigns the workspace documentation
    • 13 April 2023

      • {{site.data.keyword.bpshort}} updates the deprecation of Terraform versions
    • 6 April 2023

      • Release {{site.data.keyword.bpshort}} command-line plug-in
  • March 2023

    • Review the release notes for March 2023.

    • 30 March 2023

      • Release configuring Kubernetes cluster for an agent.

      • Enhancement of {{site.data.keyword.bpshort}} 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

      • {{site.data.keyword.bpshort}} Agent beta-1 release.

      • Release {{site.data.keyword.bpshort}} command-line plug-in.

  • February 2023

    • Review the release notes for February 2023.

    • 16 February 2023

      • {{site.data.keyword.bpshort}} allowed IP address for US, EU Central, and UK South region are updated
    • 7 February 2023

      • Release {{site.data.keyword.bpshort}} command-line plug-in.
    • 3 February 2023

      • Enhancement in {{site.data.keyword.bpshort}} to protect its services with context-based restrictions
  • January 2023

    • Review the release notes for January 2023.

    • 30 January 2023

      • Release {{site.data.keyword.bpshort}} command-line plug-in.
  • December 2022

    • Review the release notes for December 2022.

    • 13 December 2022

      • Release {{site.data.keyword.bpshort}} agents GitHub repository.

      • Release {{site.data.keyword.bpshort}} command-line plug-in.

  • November 2022

    • Review the release notes for November 2022.

    • 29 November 2022

      • Enhance {{site.data.keyword.bpshort}} documentation
    • 18 November 2022

      • Release {{site.data.keyword.bpshort}} command-line plug-in.
    • 15 November 2022

      • Release {{site.data.keyword.bpshort}} agents GitHub repository.
    • 03 November 2022

      • Release {{site.data.keyword.bpshort}} command-line plug-in.
  • September 2022

    • {{site.data.keyword.bpshort}} deprecates Python v3.6 and upgrades the {{site.data.keyword.bpshort}} Job image to use Python v3.8 by mid of September 2022. For more information, see {{site.data.keyword.bpshort}} announcement{: external} tools.

    • Review the release notes for September 2022.

    • 21 September 2022

      • The {{site.data.keyword.bpshort}} Job image supports Python v3.8
  • August 2022

    • Review the release notes for August 2022.

    • 16 August 2022

      • {{site.data.keyword.bpshort}} runtime now supports Ansible v2.9.27
    • 11 August 2022

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 04 August 2022

      • {{site.data.keyword.bpshort}} 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 {{site.data.keyword.bpshort}} command-line plug-in
    • 20 July 2022

      • {{site.data.keyword.bpshort}} allowed IP address for US region is updated
    • 11 July 2022

      • {{site.data.keyword.bpshort}} agents beta release in production.

      • Release {{site.data.keyword.bpshort}} command-line plug-in

    • 8 July 2022

      • Release {{site.data.keyword.bpshort}} command-line plug-in
  • June 2022

    • Review the release notes for June 2022.

    • 23 June 2022

      • Enhanced FAQ documentation
    • 15 June 2022

      • Enhance {{site.data.keyword.bpshort}} getting started section
  • May 2022

    • Review the release notes for May 2022.

    • 12 May 2022

      • Enhance documentation with the security and compliance section

      • Enhance documentation with the best practices

    • 5 May 2022

      • Release {{site.data.keyword.bpshort}} command-line 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 {{site.data.keyword.bpshort}} resource view

    • 26 April 2022

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 17 April 2022

      • Release {{site.data.keyword.bpshort}} command-line plug-in
    • 18 April 2022

      • Support array of injectable Terraform blocks in create workspace API

      • Release {{site.data.keyword.bpshort}} command-line plug-in

    • 12 April 2022

      • {{site.data.keyword.bpshort}} command-line supports private {{site.data.keyword.bpshort}} endpoint

      • Support .JSON and .tfvars file extension for {{site.data.keyword.bpshort}} plan and apply commands

      • Enhance resources tabular data view for resources.

      • Deprecate and warning message when using ibmcloud terraform command.

      • Release {{site.data.keyword.bpshort}} command-line plug-in

  • March 2022

    • Review the release notes for March 2022.

    • 31 March 2022

      • Support deleting {{site.data.keyword.bpshort}} data objects

      • Fixes related to {{site.data.keyword.bpshort}} 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 {{site.data.keyword.bpshort}}

      • Release {{site.data.keyword.bpshort}} command-line plug-in

  • February 2022

    • Review the release notes for February 2022.

    • 16 February 2022

      • Release {{site.data.keyword.bpshort}} command-line plug-in

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

    • 11 February 2022

      • Release {{site.data.keyword.bpshort}} command-line plug-in
  • January 2022

    • Review the release notes for January 2022.

    • 31 January 2022

      • Release {{site.data.keyword.bpshort}} command-line plug-in

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

  • December 2021

    • Review the release notes for December 2021.

    • 30 December 2021

      • Release {{site.data.keyword.bpshort}} command-line plug-in
  • November 2021

    • Review the release notes for November 2021.

    • 30 November 2021

      • Centrally manage access tags for {{site.data.keyword.bpshort}} workspaces in your account

      • Support WinRM in user interface

      • Global catalog settings for {{site.data.keyword.bpshort}} workspaces location

      • About compact download

      • About {{site.data.keyword.bpshort}} 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 {{site.data.keyword.cloud_notm}}

      • Support WinRM in command line

      • 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 {{site.data.keyword.bpshort}} actions API

      • Bastion host enhancement in {{site.data.keyword.bpshort}} actions API

      • {{site.data.keyword.bpshort}} actions API enhancement to support bastion host connection with non-root user

      • {{site.data.keyword.bplong_notm}} job queue process

      • {{site.data.keyword.bpshort}} actions APIs enhances the credentials parameter

      • {{site.data.keyword.bpshort}} introduces 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

      • {{site.data.keyword.bplong_notm}} support job queue logs enhancement

    • 11 August 2021

      • {{site.data.keyword.bplong_notm}} deprecates older version of Terraform
  • July 2021

    • Review the release notes for July 2021.

    • 30 July 2021

      • {{site.data.keyword.bplong_notm}} 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 {{site.data.keyword.bplong_notm}}
  • June 2021

    • Review the release notes for June 2021.

    • 30 June 2021

      • Support taint and untaint feature enhancement in {{site.data.keyword.bplong_notm}}

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

      • Documentation support to create workspace by using {{site.data.keyword.bplong_notm}} resources

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

      • Temporarily {{site.data.keyword.bplong_notm}} workspaces stop activity API is deactivated

  • May 2021

    • Review the release notes for May 2021.

    • 26 May 2021

      • Version constraints support in {{site.data.keyword.bplong_notm}}

      • Troubleshooting guide support

      • {{site.data.keyword.bpshort}} supports sample solutions

  • April 2021

    • Review the release notes for April 2021.

    • 14 April 2021

      • Ansible support in {{site.data.keyword.bplong_notm}} 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

      • {{site.data.keyword.bpshort}} supports the ability to store the user-defined file

      • Allowed file extensions in {{site.data.keyword.bpshort}}

      • {{site.data.keyword.bpshort}} 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 deploy to {{site.data.keyword.bplong_notm}} 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 provider

      • 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 {{site.data.keyword.bpshort}} 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 {{site.data.keyword.cloud_notm}} 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

{: #sitemap_getting_started}

Using workspaces to deploy infrastructure and cloud services

Using actions to perform configuration management

Software deployment in {{site.data.keyword.bplong_notm}}

Creating an {{site.data.keyword.containerlong_notm}} cluster on VPC infrastructure

{: #sitemap_creating_an_cluster_on_vpc_infrastructure}

Creating an {{site.data.keyword.containerlong_notm}} cluster on VPC infrastructure

Setting up continuous deployment with {{site.data.keyword.bpshort}} and a DevOps toolchain

{: #sitemap_setting_up_continuous_deployment_with_and_a_devops_toolchain}

Setting up continuous deployment with {{site.data.keyword.bpshort}} and a DevOps toolchain

Importing {{site.data.keyword.bpshort}} templates into the {{site.data.keyword.cloud_notm}} catalog

{: #sitemap_importing_templates_into_the_catalog}

Importing {{site.data.keyword.bpshort}} templates into the {{site.data.keyword.cloud_notm}} catalog

Deploying a VPC environment with bastion host on IBM Cloud

{: #sitemap_deploying-a-vpc-environment-with-bastion-host-on-ibm-cloud}

Deploying a VPC environment with bastion host on IBM Cloud{: external}

Deploying a multitiered VPC with bastion host on IBM Cloud

{: #sitemap_deploying-a-multitiered-vpc-with-bastion-host-on-ibm-cloud}

Deploying a multitiered VPC with bastion host on IBM Cloud{: external}

Configuring the CLI and API

{: #sitemap_configuring_the_cli_and_api}

Setting up the API

Setting up the CLI

Working with Ansible

{: #sitemap_working_with_ansible}

{{site.data.keyword.bpshort}} actions

Creating Ansible roles and galaxy

Working with Ansible

Creating an Ansible playbook

Sample Ansible playbook templates for {{site.data.keyword.bpshort}} actions

Creating an auto deploy button for {{site.data.keyword.bpshort}} actions

Working with Extensions

{: #sitemap_working_with_extensions}

{{site.data.keyword.bpshort}} agents

Preparing for agent deployment

Deploying agent prerequisite infrastructure

Deploying agents

Displaying agents

Updating agents

Deleting an agent

Using agents

{: #sitemap_using_agents}

Working with agent policies

Agent and Kubernetes configuration

Monitoring agent health

Configuring {{site.data.keyword.bpshort}} agents to use a proxy server

Configuring {{site.data.keyword.bpshort}} agents to use a private registry

Creating resource inventories for {{site.data.keyword.bpshort}} actions

KMS integration for BYOK or KYOK

Working with Terraform

{: #sitemap_working_with_terraform}

{{site.data.keyword.bpshort}} workspaces

Creating workspaces and importing your Terraform

Using environment variables with workspaces

Creating Terraform templates

Using Terraform to configure {{site.data.keyword.bpshort}}

Managing Terraform

{: #sitemap_managing_terraform}

Planning for using workspaces

Running a workspace plan

Running a workspace apply

Updating workspaces

Displaying workspaces

Deleting a workspace

Downloading workspace job files

Stopping or terminating running jobs

Workspace operational states

Managing resources

{: #sitemap_managing_resources}

Displaying Terraform managed resources

Deploying resources in a specific region or across multiple regions

Using Terraform templates and modules in the repositories

Managing resources with {{site.data.keyword.bpshort}}

Detecting drift in workspaces

Remote state and cross-workspace access

Terraform version support and deprecation lifecycle

Upgrading to a new Terraform version

Downloading compact Git repositories

Destroying workspace resources

Logging and Monitoring

{: #sitemap_logging_and_monitoring}

Activity tracking events for {{site.data.keyword.bpshort}}

Logging for {{site.data.keyword.bpshort}}

Monitoring metrics for {{site.data.keyword.bpshort}}

Estimating infrastructure costs

Location based access

Job execution and queuing

Specifying version constraints

Enhancing security

{: #sitemap_enhancing_security}

Managing user access

Protecting {{site.data.keyword.bpshort}} services with context-based restrictions

Using private endpoints

Securing your data with encryption

Firewall access - allowed IP addresses

Data privacy and governance

General Data Protection Regulation (GDPR)

Deleting {{site.data.keyword.bpshort}} data

Understanding high availability and disaster recovery for {{site.data.keyword.bpshort}}

{: #sitemap_understanding_high_availability_and_disaster_recovery_for_}

Understanding high availability and disaster recovery for {{site.data.keyword.bpshort}}

Service dependency map

{: #sitemap_service_dependency_map}

Service dependency map

Your responsibilities when using {{site.data.keyword.bpshort}}

{: #sitemap_your_responsibilities_when_using_}

Your responsibilities when using {{site.data.keyword.bpshort}}

API reference

{: #sitemap_api_reference}

IBM Cloud Schematics API{: external}

IBM Cloud Schematics CLI

{: #sitemap_ibm_cloud_schematics_cli}

{{site.data.keyword.bplong_notm}} CLI

Understanding security and compliance

{: #sitemap_understanding_security_and_compliance}

Understanding security with Schematics

Understanding compliance with Schematics

Understanding data portability for {{site.data.keyword.bpshort}}

{: #sitemap_understanding_data_portability_for_}

Understanding data portability for {{site.data.keyword.bpshort}}

Schematics SDKs

{: #sitemap_schematics_sdks}

{{site.data.keyword.bpshort}} SDKs

IBM Cloud Schematics Go SDK{: external}

IBM Cloud Schematics Java Admin SDK{: external}

IBM Cloud Schematics Node Admin SDK{: external}

IBM Cloud Schematics Python Admin SDK{: external}

Ansible

{: #sitemap_ansible}

Ansible documentation{: external}

{{site.data.keyword.bpshort}} worker runtime

{: #sitemap__worker_runtime}

{{site.data.keyword.bpshort}} worker runtime

Service locations and endpoints

{: #sitemap_service_locations_and_endpoints}

Service locations and endpoints

Adoption considerations

{: #sitemap_adoption_considerations}

Adoption considerations

Glossary terms for {{site.data.keyword.bpshort}}

{: #sitemap_glossary_terms_for_}

Glossary terms for {{site.data.keyword.bpshort}}

{{site.data.keyword.bpshort}} notices

{: #sitemap__notices}

{{site.data.keyword.bpshort}} notices

Getting help and support

{: #sitemap_getting_help_and_support}

Getting help and support

FAQs

{: #sitemap_faqs}

Ansible

Extensions

General FAQs

Terraform

Troubleshooting

{: #sitemap_troubleshooting}

Terraform errors

{: #sitemap_terraform_errors}

Why do {{site.data.keyword.bpshort}} workspaces create using the API/UI/CLI fails?

I tried to create a workspace, why did it fail?

Why does the Terraform script that contains the Kubernetes cluster namespaces fails as connection refused?

Why is {{site.data.keyword.bpshort}} apply failing?

Why do timeout failures cause tainted {{site.data.keyword.cloud_notm}} resources?

Why can't {{site.data.keyword.bpshort}} find my resource group?

Why am I receiving 5xx HTTP errors?

Troubleshooting Extensions

{: #sitemap_troubleshooting_extensions}

How can I provide value for the schematics_resource_crn variable?

Why am I getting a create endpoint gateway error with the wrong number of segments in CRN?

Troubleshooting Ansible