push-config-example

An example to push configuration with CI/CD

Guide

1. Generate API key

• Switch to your desired team
• In Dashboard > API section, click "Issue API key"
• Scopes:
  • configuration:write is always required
  • Then, for each resource type that you want to manage, select its write scope, e.g. cronjob:write
• Note the key in a secure place, the UI only shows it once

2. Write the configuration

• The recommended file name is crystade.yml
• Have a look at crystade.yml

3. Set up workflow

• Endpoint: POST https://integration.crystade.com/configuration
• Header: Authorization: Bearer {API token}
• Header: Content-Type: application/yaml
• Body: the configuration in YAML

3.1. Via script

• NOTE: Keep your secret secure (e.g. using .env)
• Have a look at push.sh and push.bat (for Windows). You need to create .env at the same directory as the script file

TOKEN=your_api_token

3.2. GitHub Actions

• NOTE: Use GitHub built-in secrets vault for API keys
• Have a look at .github/workflows/push.yml

3.3. Other CI/CD systems

• Push configuration is compatible to any CI/CD systems such as GitLab, Jenkins, etc

4. Monitor the changes

• After a successful push, in Crystade Web UI, you can observe new managed resources (readonly)

Contact

Feel free to email us at [email protected] for support