Creating a deployment to IBM Cloud Schematics link

The deploy to IBM Cloud® URL is an efficient way for you to enable users to deploy solutions on IBM Cloud from a public Git repository sample configuration. The URL requires minimal configuration and you can insert it anywhere in your documentation that supports markup. When the user clicks the hyper link, they are taken directly to the Schematics workspace setup page and only need to click the create button for workspace creation in Schematics.

The following steps show how to create a URL to deploy to Terraform >=1.0.0, <2.0 template example in IBM Cloud Schematics.

1. Create a template example by using Terraform on IBM Cloud provider and publish in the public Git repository. To create example, see Sample template.

2. Copy the public Git repository URL, for example, https://github.com/IBM-Cloud/terraform-provider-ibm/tree/master/examples/ibm-api-gateway.

3. Use this syntax to auto deploy the Schematics workspace creation in the IBM Cloud.

   Syntax

   https://cloud.ibm.com/schematics/workspaces/create?repository=<template public Git repository example url>&terraform_version=<terraform_v1.x.x>
   

   Example

   https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/terraform-provider-ibm/tree/master/examples/ibm-api-gateway&terraform_version=terraform_v1.0
   

   The URL contains two parameters, first parameter is provided with the workspace name as ibm-api-gateway and second parameter is provided with the Terraform version as terraform_v1.0. For more information, about the parameters refer to this example, https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/terraform-provider-ibm/tree/master/examples/ibm-api-gateway&terraform_version=terraform_v1.0. If you do not provide any parameters or ignore one parameter, the Deploy to IBM Cloud link defaults to the repository's master branch. You can provide the Terraform version parameter that you are using.

4. You can copy, and paste the example URL in the browser to view the IBM Cloud Schematics workspace console with the create button is displayed.

5. Cross-check the parameters in the workspace console and click Create button.

<a href="https://cloud.ibm.com/schematics/workspaces/create?repository=<public Git repository example URL>/<workspace name>&terraform_version=terraform_xx">Deploy to {{site.data.keyword.bplong_notm}} <img src=<image location>></a>

<img src="images/autodeploy_button.png" alt="Deploy to {{site.data.keyword.cloud_notm}}" usemap="#viewgithubimage_map1t">
<map name="viewgithubimage_map1t">
    <area alt="Deploy to {{site.data.keyword.cloud_notm}}" title="Deploy to {{site.data.keyword.cloud_notm}}" href="https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/terraform-provider-ibm/tree/master/examples/ibm-api-gateway&terraform_version=terraform_v1.0" target="_blank" coords="3,1,140,20" shape="rect">
</map>