Create a Workspace Template
With workspace templates, you can standardize workspace configurations across your projects by predefining essential variables, configuration settings, and other workspace options. This helps streamline workspace setup, ensuring consistency and reducing manual configuration efforts.
Prerequisites
Before you begin configuring workspace templates, ensure that you have:
- Appropriate permissions to create templates. Go to RBAC to find out how to set users role-based access control.
- Access to an account or project where the templates will be applied.
Workspace templates allow you to predefine variables and settings that can be reused across multiple workspaces, reducing the need for repetitive setup and ensuring consistent configurations.
When apply a workspace template your will have the option to either Use Template or Copy Template.
The difference between these options is as follows:
- Use Template: When a user selects Use Template, their workspace will continue to reflect any future changes made to the template.
- Copy Template: Selecting Copy Template creates a one-time copy of the template as it is at that moment, without updating if the template changes later.
Configure Workspace Templates
To configure workspace templates and standardize your workspace setups, follow this interactive guide:
- Create workspace templates
- Add variables & edit templates
- Apply templates
- Step-by-step
Follow these steps to:
- Create and review a new workspace template.
- Review and edit an existing workspace template.
- Apply a workspace template to a new workspace.
Create a new workspace template
- In your Account Settings, select Templates from the Account-level resources section.
- Click the New Template dropdown and select Infra Workspace.
- Name your template and provide a suitable version label.
- Select Start.
This will bring you to your templates General tab that contains a typical workspace setup form as describes in the IaCM onboarding guide.
Once you complete your workspace setup:
- Select the Variables tab and add workspace variables (optional).
- Select Save.
- Select YAML from the Visual/YAML toggle option to preview or edit the generated configuration.
Review and edit your existing Workspace Templates
- Select Templates to navigate to the workspace template overview page.
- Either from the breadcrumb menu or via Account settings, then Templates.
- Select your workspace template to review.
- To edit, select Open in Template Studio.
- Update your workspace settings and select Save.
Apply your Workspace Template
- In one of your projects, create a new workspace.
- When prompted, choose one of the following options:
- Start from Scratch to create a workspace without a template.
- Start with Template to apply a pre-configured template.
- Select Start with Template and assign a name to the new workspace, the select Start.
- Search for a template your would like to use and select it.
- Select either Use Template or Copy Template.
The difference between the Use Template and Copy Template buttons is as follows:
- Use Template: When a user selects Use Template, their workspace will continue to reflect any future changes made to the template.
- Copy Template: Selecting Copy Template creates a one-time copy of the template as it is at that moment, without updating if the template changes later.
- Review the applied configuration and variables.
Workspace templates simplify workspace setup and ensure consistent configurations across projects, reducing manual effort and the risk of misconfiguration. By following the steps outlined above, you can create, edit, and apply templates to streamline your workspace management.