Modifying a template instance
You can redeploy an existing instance after selecting the desired template version and modifying the input parameters.
- Go to your Deployed instances > Terraform templates tab.
-
Search for your instance.
Note: You can also use the following search filters:
- Enter the name of the instance in the search instance filter.
- Click the show filter icon to list template instances based on the selected provider.
- You can click the column headings to sort the list.
-
You can select a namespace from the All namespaces drop-down list. The list of template instances in the page changes based on the selected namespace. You can select "All namespaces" to see all the template instances for which you have access.
You can use the pagination drop-down to select the number of records you want to display in a page at a time.
- Click to open a deployed instance.
- Optionally, you can manage resources. For more information, see Modifying virtual machine resources.
- Click Modify tab.
-
In the Modify deployed instance page, optionally, enter the following details:
-
Select a new template version from the drop-down list.
Notes:
- The word "current" next to a version indicates that it is the version with which the instance was deployed. You can verify the same in the Instance details section of the Overview tab.
- A version change can add or remove parameters.
- If you had selected a different template in the Choose template, then the default version of that template is populated here.
- The template version follows
major.minor.patch
convention where:patch
refers to bug fixesmajor
refers to significant changesminor
refers to new features added but existing functionality remains broadly compatible
-
You can even select a different template from the drop-down list. The list includes all templates that are available for all namespaces. Before you change the template itself, ensure that you are aware of its impact.
Notes:
- Even after changing the template, the original template and version details are available in read-only mode for reference.
- The word
current
is added to the currently deployed template. - For the modified instance to apply without any issues, ensure that the newly selected template is compatible with the original template. Otherwise, issues may occur during plan/apply.
-
-
Click Next.
-
In the Edit parameters tab, enter the following details:
-
Select a cloud connection.
-
Terraform engine version - Select the Terraform version from the drop-down list. For information about creating the user defined Terraform versions, see Managing Terraform Versions.
-
If the selected version has Data Types defined, then select values for the associated Data Objects from the drop down list. For the following scenarios, a message is displayed with appropriate information:
- Your template has a invalid Data Type. A link is provided in the message to edit the template.
- The specified data object is not associated with the data type or the data object is invalid. A link is provided in the message to create data objects.
Notes:
- In the Overview tab > Input parameters section, you can view the list of all input parameters using which the instance was deployed earlier.
- If there are no data objects associated with the datatype, then the user interface prompts you to either create a data object or manually enter values in this Edit parameters page.
-
Enter values in Additional options.
Notes
- Whenever you change a parameter value, an undo icon is displayed. Click the icon to undo your changes and revert it to default values.
- The default value for an the existing parameter is the value that was used during the previous deployment. The value used during the previous deployment takes precedence over the value defined in the template.
- Consider the following points whenever you select a different version or a new template:
- If there are new parameters in the selected version or template that do not match with the previously deployed template, then they are displayed with the word "new" in parenthesis.
- The default value for the new parameters are the template values.
- If a new parameter is not available in the selected version, then it is not displayed.
- If a Data Object value is injected for a parameter in the template definition of the selected version, then the appropriate output parameter value is used as the default value.
- If parameters are grouped in the selected template version, then they are displayed as separate collapsible sections. The headings of these sections are displayed in the Edit parameters tab for easy navigation.
- If
immutable
is set to true for a parameter in the selected version, then you cannot edit the default value of the parameter. - If
immutable_after_create
is set to true for a parameter in the selected version, then you can enter a value and deploy it for the first time. You cannot edit it in subsequent plan changes.
-
-
Click Plan changes.
Notes:
- If you perform a resource taint activity at this stage, then the resource marked as tainted is not considered for the current completed plan.
- When you taint a virtual machine resource, Managed services marks only that resource and recreates it during the next plan or apply. It does not recreate all resources on the selected virtual machine based on the template logic. If you want to recreate all associated resources of the virtual machine, then you must identify and individually taint all the required resources.
-
In the Planned changes page, wait for the status to change from In progress to Success. Alternatively, go to the Activity section of the Overview tab to see whether the status of the plan is complete. If the status displays Failure, then it indicates that the redeployment with the modified value can result in failure.
Notes:
- The resources are neither destroyed or created at this stage, but the Log output shows the outcome of your changes beforehand.
- If the plan is in complete state, then you can revisit the modify page of the deployed instance at a later time and apply the changes.
- Verify the Log output to reconfirm your changes. The log also provides information about what happens if the changes are applied. You can always see the log details for all completed activities in the Activity section of the Overview tab.
- Click Apply changes. The instance gets redeployed with your latest modifications. At this stage, the resources are created and destroyed as per your plan.
-
In The Apply changes window, enter "apply" in Confirm changes and click Apply. The redeployment starts and you can see the status in the Overview tab next to the name of the deployed template instance. When the status changes to Ready, it indicates that the redeployment has completed successfully.
Note:
- You need to confirm here because the redeployment of your changes may result in adding, modifying, or destroying the associated resources.
- When you click Apply, the template instance moves to the new version irrespective of success or failure. It is because the apply might destroy some of the resources before the occurrence of failure.
- You can also view the status of the deployment details in the Activity section of the Overview tab. The activity also show the log of plan changes. If the template or version is changed in plan/apply step and changes are applied, then you can see new changes in the Overview tab.