Platform Metadata

OpsCtl uses a custom META.yml file, to be located at the root of your Git deployment project codebase to describe all of the project's metadata. It describes multiple things related to platform usage, infrastructure provider and access settings, secrets management, licensing and suport information and application version, domain information and such ...

This further allows OpsCtl to wrap around many third-party tools usage to determine exactly how to interact with your system when it comes to deployment and maintenance options.

A typical project deployment tree structure would be the following:

$ tree -L 1
.
├── META.yml        <- the project metadata file
├── ansible         <- folder with ansible-specifics platform configuration settings
└── terraform       <- folder with terraform-specifics platform configuration settings

Metadata File Generation

The platform metadata file is pure YAML, as described in the following section.

It's generation might be long and complex and that's why OpsCtl comes with an automatic generation utility:

$ opsctl meta -i

will prompt you with an interactive CLI to help you render your first metadata file from template.

Further calls to:

$ opsctl meta

will provide syntax and sanity checks ensuring that whatever you could have edited the file with remains compatible.

Metadata File Format

The following table provides an exhaustive list of all supported YAML fields and parameters: