GoogleCloudPlatform / cloud-ops-sandbox

Cloud Operations Sandbox is an open source collection of tools that helps practitioners to learn O11y and R9y practices from Google and apply them using Cloud Operations suite of tools.
Apache License 2.0
405 stars 148 forks source link

Setup folder structure to store artifact configurations #1037

Open minherz opened 1 year ago

minherz commented 1 year ago

Description

All Configurations are stored under /configurations folder at the root of the repo. Each Configuration is stored in a dedicated folder. The name of the folder is used as ID of the configuration. The name is validated by regex ^[a-zA-Z_][a-z-A-Z0-9_\-]+$ (letters, numbers, underscore and dash, starting with a letter or underscore with the length greater than 1).

Inside each Configuration the parameters are stored in multiple files per artifact functionality:

Additionally, the folder will has a recipe subfolder /configurations/{ID}/recipes to store o11y recipes (see #1028)

Schemas for these YAML files will be stored in the /provisioning/schemas/configuration folder.

Describe alternatives you've considered

The following options were considered:

Additional context

It is a sub-issue for #1026.

NimJay commented 9 months ago

Commenting since this is in our team's out-of-SLO bucket:

minherz commented 9 months ago

@NimJay I depreoritized it to p3. However, I prefer to keep all relevant issues opened until we decide on the roadmap of the project. Once it is decided I will go to update the milestones and change the issues accordingly.