Infrastructure Configuration
A how-to guide to create your infrastructure configuration through the Developer Platform.
Before Getting Started
Please do the following before creating your infrastructure configuration.
- Ensure you are a member of the Infrastructure Config repository , if not, please reach out to Team Spectre to be added.
- Enable GPG signing and verification for all of your commits within the Clarity repository.
- Create a ticket on Team Spectre’s backlog which Team Spectre will use to review your configuration.
Writing your Infrastructure Configuration
- Create a branch from the Infrastructure Config repository named ‘feature/SPECT-ticket number’.
-
Add your cluster and application into config/products.yml . In the products.yml you will define your
key,name, andidfor your cluster and application. -
Add your cluster and application(s) into all features they will be required, NDT is mandatory.
The feature is your topology of what will be installed where.
-
Create a folder within config/clusters named your cluster key defined in products.yml. Then create an apps folder, a resources folder and a cluster.yml within the cluster folder created.
The cluster.yml file will include theresourceswithin the cluster,networkRules,networkSecurityGroupRules, andtags. -
Create a yaml file for each of the apps required with the name of your application key defined in products.yml. The app file will enable you to define your
appSettings,networkRules, andtags. -
Create a yaml file for each of the resources required for your cluster. If a resource file (e.g. storageaccount.yml) is not created within your resources folder but is specified within your cluster, the config/defaults/1.0 settings will be used.
Cluster Dependency: If apps and resources from Cluster A want to talk to apps or resources in Cluster B, Cluster B has a dependency on Cluster A.Tip: Copy the yaml files from config/defaults/1.0 settings.
If you have cluster dependencies you will need to add RBAC to your resource yaml files.
Next Steps
Once you have written the configuration, please submit the PR for review and Team Spectre will work with you to provision your infrastructure.
FAQ
-
How can I add tenant/environment specific configuration?
This will all be done through the Developer Platform's Application Configuration repository. Documentation for this will be coming soon. -
What if there's configuration I'm unable to do with the Developer Platform?