How to save a design as a template

You can save a design as a private or public template.

1. How to save a design as a private template

1.1. Use case

You can design an app and save your app as a private template. The private template will be available for all users of the same project to reuse. This function is useful if you want to design a premade template and share it with your team or organization.

1.2. How to

  • Go to Save application option / Click on Save as template.

_images/private_template1.png

Figure 1. Save as template button

  • Input information for your template: Template name (e.g., M̀y template), version (0.1.0), Designed by (any name you like), and description.

_images/private_template2.png

Figure 2. Input template name "My template"

  • The template My template is now visible in the Section Private templates. All users in the same project can see this template.

_images/private_template3.png

Figure 3. Private template Section

  • Click on the template My template. Now you can quick deploy, design using this template, or to delete it.

_images/private_template4.png

Figure 4. Manage a template

1.3. Permissions

  • A private template is visible to a project.

  • IAM users with the Tenant Guest role can view the template and Design using this template.

  • IAM users with the Tenant Administrator role can Design using this template, Quick Deploy and Delete the private template.

IAM user role

Design using this template

Quick Deploy

Delete

Tenant Guest

yes

no

no

Tenant Administrator

yes

yes

yes

2. How to save a design as a public template

2.1. Use case

  • A cloud engineer designs an application and saves it as a public template so that all users from all organization domains can re-design or quick deploy it.

2.2. How to

We will provide a button to export a private template as a public template later. For the moment you can create a pull request in our public repository as follows:

  1. Design an application and click Download topology. The application topology will be downloaded as a zip file.

_images/public-template.png

Figure 5. Manage template option

  1. Clone this repository

  2. Create a new folder (e.g., my_template) inside the templates folder.

  3. Exact the zip file to the folder my_template.

  4. Open the file topology.yml and update the template with your information. For example:

metadata:
  template_name: My Template
  template_version: 0.1.0
  template_author: Dr. Vo
  # Optional link to a document how to use the template
  template_documentation: "https://github.com/opentelekomcloud-blueprints/tosca-service-catalogs/blob/main/README.md"
  # Optional images you want to display in the slide, prefer 1920x1200
  template_images:
    - /images/thumbnail.jpg
    - /images/image1.png
    - /images/image2.png

description: >
  This is my template description.

  1. Push change to your clone repository.

  2. Create a pull request to our repository so we can review your template and publish your template. It will be visible in the Public templates Section for everyone to quick deploy and to design using this template.

last updated: 2025-09-04 08:28 UTC - commit: ea2af029f81a6df4720ad91ba61c8a4cd5533be5