Steps
1
Fork and add a folder
Fork the repository and add one folder named after your template, for example
discord-bot-tickets/, with:2
Validate the manifest
Run the check from the folder. It compares the manifest with the schema and the platform rules and creates nothing:Add the schema line to the top of the manifest for editor help: see the manifest schema. Public templates have a few extra rules, below.
3
Try it as a private template
Create it as a private template in your own account and use it for real; it is the same engine as the public catalog. See Validate and test.
4
Open the pull request
The CI validates the manifest, builds the image if there is a Dockerfile, checks it for file capabilities (a binary with one cannot run on the platform) and checks the declared license.
5
Review
Vertra Cloud runs the template on the platform and reviews the change for security (no miner, hidden telemetry or secret in the code), a license that allows public distribution, and the quality of the README. Fix what is asked and push again.
6
Merge and publish
On merge, the folder at that commit is packaged as a version of the template and published with the Community badge and your name as author. Nobody depends on your account: the code lives with Vertra Cloud, and an image template becomes an image maintained by the platform.
Extra rules for public templates
Template ids are unique across the whole catalog. Write the
README.md in the way a user needs it: what the template creates, what to do after the deploy, and where the data lives. Declare the license of the original software in links.license.
After the merge
- Vertra Cloud maintains the template. Software updates arrive through new versions; people who use the template see New version available and decide when to update.
- A template that is no longer maintained is marked deprecated and leaves the gallery. Apps already created keep running and are told. An image that a template still uses is removed only with notice and a migration path for the people who use it.
Related
Tutorial: private to public
The whole path, from a private template to a pull request.
Best practices
Read it before you open the PR.