Skip to content

Latest commit

 

History

History
421 lines (354 loc) · 16.3 KB

sc-blueprint-update.md

File metadata and controls

421 lines (354 loc) · 16.3 KB
Raw
copyright lastupdated keywords subcollection
years
2017, 2022
2022-11-05
blueprint config update, update blueprint, blueprint
schematics

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

{{site.data.keyword.bpshort}} Blueprints is a Beta feature that is available for evaluation and testing purposes. It is not intended for production usage. Refer to the list of limitations for the Beta release. {: beta}

Update a blueprint configuration

{: #update-blueprint}

Cloud environments are not static. User infrastructure requirements change and the {{site.data.keyword.cloud}} platform is constantly evolving. Without maintenance and updates of the blueprint templates, inputs and modules, a deployed environment loses currency, compliance, and will cease to be manageable through {{site.data.keyword.bpshort}} automation.   {: shortdesc}

After the deploy lifecycle stage of a cloud environment, the environment will continue to evolve through managed change that is implemented as updates to the blueprint template, automation modules and inputs. See updating blueprints to understand more about the process of updating blueprint environments and the steps required to run regular updates.

Update process

{: #update-blueprint-process}

Updating a deployed blueprint environment and cloud resources is a two-step process, Update, and Apply. The first step updates the blueprint configuration in {{site.data.keyword.bpshort}} with the intended changes to the blueprint template, IaC module code, and inputs. The second blueprint run apply step runs the automation module code to deploy the changes in the blueprint configuration.
{: shortdesc} 

Updating a blueprint environment uses the capabilities of Terraform to update deployed cloud resources. The Terraform config and inputs for a module are updated by the blueprint config update operation. From the updated configuration, Terraform determines the changes that must be run against the existing deployed resources and runs the needed resource updates, deletions, or creates.

Update supports modification of:

  • Blueprint template YAML file
  • Blueprint input file
  • Additional inputs  

Run the ibmcloud schematics blueprint config update command to refresh the blueprint configuration that is stored by {{site.data.keyword.bpshort}} with updates to the blueprint template and IaC code in the module source repositories.

Explicit and relaxed versioning

{: #update-blueprint-versioning}

Blueprints supports two update approaches for changes to templates and modules. Either a relaxed 'development' mode where the current version of a template or module is always pulled, or a 'production' mode where an explicit version is specified.

Relaxed versioning

{: #update-blueprint-relaxed}

In some development environments, or where IaC code and blueprint templates are being developed, versioning of IaC definitions is not needed.

Blueprints defaults to always pull the current template, inputs, or modules on an update operation if no versioning is specified. Alternatively template and module statements can use the git_release option latest. When latest is in effect, {{site.data.keyword.bpshort}} identifies if the blueprint template, or module Git repositories are updated, and runs a pull latest to update the blueprint configuration.

ibmcloud schematics blueprint config update -id <blueprint_ID> 

{: pre}

Explicit versioning

{: #update-blueprint-strict}

If explicit blueprint versioning is used with Git release tags for each blueprint template release, the blueprint configuration is only updated if a new release tag is specified on the Update operation.  

ibmcloud schematics blueprint config update --id <blueprint_ID> --bp-git-release x.y.z 

{: pre}

Update the input file source and push a new release to its Git source repository. 

If explicit input file version is used with release tags for each input file release, the blueprint configuration must be updated in {{site.data.keyword.bpshort}} with the new input file release tag.  

ibmcloud schematics blueprint config update --id <blueprint_ID> --input-git-release x.y.z  

{: pre} 

Record the blueprint ID that needs to be updated. To list the blueprint IDs, run listing blueprints command. {: note}

Updating a blueprint from the CLI

{: #update-blueprint-cli} {: cli}

Run the ibmcloud schematics blueprint config update command to refresh the blueprint configuration with the changes. It updates the blueprint and workspaces with the updated input values. {: shortdesc} 

For all the blueprint commands, syntax, and option flag details, see blueprints commands. {: important}

Syntax

ibmcloud schematics blueprint config update --id BLUEPRINT_ID [--file CONFIG_FILE_PATH] [--input INPUT_VARIABLES_LIST] [--github-token GITHUB_TOKEN]

{: pre}

Example

ibmcloud schematics blueprint config update -name Blueprint_Basic -resource-group default -bp-git-url https://github.com/Cloud-Schematics/blueprint-basic-example -bp-git-branch main -bp-git-file basic-blueprint.yaml -input-git-url https://github.com/Cloud-Schematics/blueprint-basic-example -input-git-branch main -input-git-file basic-input.yaml -inputs provision_rg=true,resource_group_name=mynewrgdemo

{: pre}

On successful completion the config update returns update_success. For more information, see Update command and refer the specified example.

ibmcloud schematics blueprint config update --id Blueprint_Basic.eaB.5cd9 --inputs resource_group_name=basic-rg-demo-pre

{: pre}

Verifying blueprint config update

{: #verify-update}

Verify that the blueprint config is updated successfully. When you update the config from the CLI, the command displays the details of the linked workspaces to be updated. And continuously updates the status of the progress of the {{site.data.keyword.bpshort}} jobs initializes the workspaces. The command returns on completion.

Update blueprint  blueprint

Modules to be updated
SNO   Module Type   Name                   Updates   
1     Workspace     basic-resource-group   Updating   
2     Workspace     basic-cos-storage      NA   
      
Blueprint job running us-east.JOB.Blueprint_Basic.e4081308

Waiting:0    Draft:0    Connecting:0    In Progress:0    Inactive:0    Active:0    Failed:0   

Module Type   Name                   Status           Job ID   
Blueprint     blueprint              UPDATE_SUCCESS   us-east.JOB.Blueprint_Basic.e4081308   
Workspace     basic-resource-group   INACTIVE            
Workspace     basic-cos-storage      INACTIVE            
              
Blueprint ID Blueprint_Basic.eaB.5cd9 update_success at 2022-08-15 13:19:27
OK

{: screen}

On successful completion the config update returns update_success.

For more information, see troubleshooting section.

Updating a blueprint environment from the UI

{: #update-blueprint-ui} {: ui}

Currently, you can update the blueprint config from CLI by using the config update to update the blueprint configuration and then run the Apply command to deploy the changes.

Verify blueprint config update from the UI

{: #verify-bp-update-ui}

  1. Click your blueprint that is listed in the {{site.data.keyword.cloud_notm}} console{: external} to view the results of the update operation.
  2. Click Overview tab to see the blueprint summary, including Modules, Variables, Details. The Recent Job runs must show the summary details of the blueprint config update job.
  3. Click Modules tab to see the status of the resource modules.
  4. Click Jobs history tab view the result of the blueprint config update job and operations that are set against the resource modules.
  5. Click Settings tab to view the summary of the updated blueprint.

For more information, see troubleshooting section.

Updating a blueprint from the API

{: #update-blueprint-api} {: api}

Follow the steps to retrieve your IAM access token and authenticate with {{site.data.keyword.bplong_notm}} by using the API. For more information, see Update a blueprint by using API.

Blueprint update API runs blueprint config update API, to perform the changes in configuration by using blueprint operations. {: important}

To list the blueprint ID, run get all the blueprint instances command.

Example:

PUT /v2/blueprints/Blueprint-Basic-Test.eaB.bbb9/ HTTP/1.1
Host: schematics.cloud.ibm.com
Content-Type: application/json
Authorization: Bearer <auth_token>
refresh_token: <refresh_token>

{
    "name": "Blueprint Basic Test",
    "schema_version": "1.0.0",
    "source": {
        "source_type": "git_hub",
        "git": {
            "git_repo_url": "https://github.com/Cloud-Schematics/blueprint-basic-example",
            "git_repo_folder": "basic-blueprint.yaml",
            "git_branch": "master"
        }
    },
    "config": [
        {
            "source": {
                "source_type": "git_hub",
                "git": {
                    "git_repo_url": "https://github.com/Cloud-Schematics/blueprint-basic-example",
                    "git_repo_folder": "basic-input.yaml",
                    "git_branch": "master"
                }
            }
        }
    ],
    "inputs": [
        {
            "name": "provision_rg",
            "value": "false"
        },
        {
            "name": "resource_group_name",
            "value": "myrg4"
        },
        {
            "name": "cos_instance_name",
            "value": "myrg4"
        }
    ],
    "description": "Deploys a simple two module blueprint Updated",
    "resource_group": "Default"
}

{: codeblock}

Verify blueprint config create from the API

{: #verify-bp-update-api}

Verify that the blueprint update is success as shown in the output. {: shortdesc}

Output:

{
    "name": "Blueprint Basic Test",
    "source": {
        "source_type": "git_hub",
        "git": {
            "git_repo_url": "https://github.com/Cloud-Schematics/blueprint-basic-example",
            "git_repo_folder": "basic-blueprint.yaml"
        },
        "catalog": {},
        "cos_bucket": {}
    },
    "config": [
        {
            "source": {
                "source_type": "git_hub",
                "git": {
                    "git_repo_url": "https://github.com/Cloud-Schematics/blueprint-basic-example",
                    "git_repo_folder": "basic-input.yaml",
                    "git_branch": "master"
                },
                "catalog": {},
                "cos_bucket": {}
            },
            "inputs": [
                {
                    "name": "resource_group_name",
                    "value": "myrg4"
                },
                {
                    "name": "provision_rg",
                    "value": "true"
                },
                {
                    "name": "cos_instance_name",
                    "value": "myrg4"
                },
                {
                    "name": "cos_storage_plan",
                    "value": "standard"
                }
            ]
        }
    ],
    "description": "Deploys a simple two module blueprint Updated",
    "resource_group": "aac37f57b20142dba1a435c70aeb12df",
    "location": "us-south",
    "inputs": [
        {
            "name": "resource_group_name",
            "metadata": {}
        },
        {
            "name": "provision_rg",
            "metadata": {}
        },
        {
            "name": "cos_instance_name",
            "metadata": {}
        },
        {
            "name": "cos_storage_plan",
            "metadata": {}
        }
    ],
    "settings": [
        {
            "name": "TF_VERSION",
            "value": "1.0",
            "metadata": {}
        }
    ],
    "outputs": [
        {
            "name": "cos_id",
            "value": "$module.basic-cos-storage.outputs.cos_id",
            "metadata": {}
        }
    ],
    "modules": [
        {
            "module_type": "terraform",
            "name": "basic-resource-group",
            "source": {
                "source_type": "git_hub",
                "git": {
                    "git_repo_url": "https://github.com/Cloud-Schematics/blueprint-example-modules/tree/main/IBM-ResourceGroup",
                    "git_branch": "main"
                },
                "catalog": {},
                "cos_bucket": {}
            },
            "created_at": "0001-01-01T00:00:00Z",
            "updated_at": "0001-01-01T00:00:00Z",
            "inputs": [
                {
                    "name": "name",
                    "value": "$blueprint.resource_group_name"
                },
                {
                    "name": "provision",
                    "value": "$blueprint.provision_rg"
                }
            ],
            "outputs": [
                {
                    "name": "resource_group_id"
                },
                {
                    "name": "resource_group_name"
                }
            ],
            "last_job": {
                "job_status": "job_failed"
            },
            "deleted": "false"
        },
        {
            "module_type": "terraform",
            "name": "basic-cos-storage",
            "layer": "DB",
            "source": {
                "source_type": "git_hub",
                "git": {
                    "git_repo_url": "https://github.com/Cloud-Schematics/blueprint-example-modules/tree/main/IBM-Storage",
                    "git_branch": "main"
                },
                "catalog": {},
                "cos_bucket": {}
            },
            "created_at": "0001-01-01T00:00:00Z",
            "updated_at": "0001-01-01T00:00:00Z",
            "inputs": [
                {
                    "name": "cos_instance_name",
                    "value": "$blueprint.cos_instance_name"
                },
                {
                    "name": "cos_single_site_loc",
                    "value": "ams03"
                },
                {
                    "name": "cos_storage_plan",
                    "value": "$blueprint.cos_storage_plan"
                },
                {
                    "name": "resource_group_id",
                    "value": "$module.basic-resource-group.outputs.resource_group_id"
                }
            ],
            "outputs": [
                {
                    "name": "cos_crn"
                },
                {
                    "name": "cos_id"
                }
            ],
            "last_job": {
                "job_status": "job_failed"
            },
            "deleted": "false"
        }
    ],
    "flow": {},
    "blueprint_ID": "Blueprint-Basic-Test.eaB.bbb9",
    "account": "1f7277194bb748cdb1d35fd8fb85a7cb",
    "created_at": "2022-09-15T07:04:09.725355429Z",
    "created_by": "[email protected]",
    "updated_at": "2022-09-15T10:13:05.108885567Z",
    "updated_by": "[email protected]",
    "sys_lock": {
        "sys_locked_at": "0001-01-01T00:00:00Z"
    },
    "user_state": {
        "state": "Environment_Create_Init",
        "set_at": "0001-01-01T00:00:00Z"
    },
    "state": {}
}

{: screen}

For more information, see troubleshooting section.

Next steps

{: #bp-update-nextsteps}

After updating the blueprint configuration in {{site.data.keyword.bpshort}}, the next step is to apply the changes.