Multi-Tenant Product Setup (Preferred)
At this stage we presume that the Before you begin is covered and all required resources exist.
1. Create your platform.yaml
To start, you should clone the Yalla repository:
git clone https://dev.azure.com/DevOps-SRE/_git/yalla
cd yalla
git switch -c <product_named_branch>
Create a platform.yaml file. This file is used to define the metadata and deployment
flow for your platform.
Copy the example below into a file located in multitenant/<platform name>/platform.yaml
in the Yalla repository where <platform name> is the name of your platform.
Replace the name, description, and SNOW PKG with the relevant values for your platform.
You can leave the deployment flow as it is.
platform:
name: example
description: Yalla tenant for example product
snowpkg: SPKG0000000
deployment_flow:
- phase: 1
env_name: "staging"
- phase: 2
env_name: "production"
Next, commit your changes and push the changes to yalla remote. Then, create a pull request to
merge your changes into main.
Protecting your platform from external modifications
All changes to the Yalla repository require at least one peer review as a best practice. Additionally, you can setup access management in your
platform.yamlto protect your platform from edits outside of your team.
Want to understand more about platform.yaml and the hierarchy of files in the Yalla repo?
Read this document. There are also plenty of existing examples in the repo, such as Accelerate.
At this point, Yalla will begin setting up your clusters and onboarding to tools like Grafana.