Environment manifest
Below is a list of all configuration attributes for an environment manifest.
apiVersion*
required
| Type |
Example |
Description |
| string |
v1alpha1 |
Defines the version of the schema. |
kind*
required
| Type |
Example |
Description |
| string |
Environment |
Defines the kind of the schema. |
name*
required
| Type |
Regex |
Example |
Description |
| string |
[a-z]+(-[a-z]+){0,2} |
tuuturu-production |
Defines the name of the environment. |
email*
required
| Type |
Example |
Description |
| string |
xctl@example.com |
Defines the email associated with the environment. Currently, only used for registering SSL certificates with Let's Encrypt. |
spec
provider*
| Type |
Example |
Description |
| string |
linode |
Defines the cloud provider to use for the environment |
domain*
| Type |
Example |
Description |
| string |
tuuturu.org |
Defines the associated domain for the environment. Xctl will attempt to add a wildcard record to this domain pointing it to the node balancer. |
plugins
nginxIngressController
| Type |
Default |
Helm |
Description |
| boolean |
true |
chart |
Handles traffic into the environment |
cert-manager
| Type |
Default |
Helm |
Description |
| boolean |
true |
chart |
Generates SSL certificates on demand |
grafana
| Type |
Default |
Helm |
Description |
| boolean |
true |
chart |
Visualises metrics, logs, traces |
prometheus
| Type |
Default |
Helm |
Description |
| boolean |
true |
chart |
Stores and exposes metrics data |
loki
| Type |
Default |
Helm |
Description |
| boolean |
true |
chart |
Stores and exposes log data |
promtail
| Type |
Default |
Helm |
Description |
| boolean |
true |
chart |
Scrapes logs and pushes them to Loki |