Nopeus Config (nopeus.yaml)
main file structure
| Attribute | Description | Type | Required | Default |
|---|---|---|---|---|
| name | The stack deployment name. Will appear on the k8s and helm deployment names. | string | no | nopeus |
| vendor | The cloud vendor that will be used to deploy your applications. | string one of: - aws | yes | - |
| environments | Deployment environments setup. | key/value pair key - the name of the environment value - type EnvironmentConfig | no | prod: |
| services | Define your cloud application layer microservices. | key/value pair key - the name of the application value - type Service | yes (at least one service) | - |
| storage | Define the storage setup for your applications | Storage | no | null |
type EnvironmentConfig
| Attribute | Description | Type | Required | Default |
|---|
type Service
| Attribute | Description | Type | Required | Default |
|---|---|---|---|---|
| image | The application docker image to deploy to the cluster | string | yes | - |
| version | The image version to deploy | string | no | latest |
| environment | Additional environment variables to pass to the cluster. For sensitive information, use the ${VAR_NAME} format to read values from the machine environment variables. | key/value pair key - the name of the variable value - the value of the environment variables | no | {} |
| health_url | The endpoint for the application health_check | string | no | /status |
| replicas | The number of application replicas to deploy | uint | no | autoscale |
| ingress | Define the ingress params for the API gateway | Ingress | no | private service |
type Ingress
| Attribute | Description | Type | Required | Default |
|---|---|---|---|---|
| paths | A list of paths to redirect to the service | IngressPath | yes | - |
| Attribute | Description | Type | Required | Default |
|---|---|---|---|---|
| path | The path prefix to that exposes the service | string | yes | - |
| strip | Should the path prefix be forwarded to the application or not | boolean | no | false |
| hosts | The host names for the service | string | yes | - |
type Storage
| Attribute | Description | Type | Required | Default |
|---|---|---|---|---|
| database | Define k8s database installation. | DatabaseStorage | yes | - |
| Attribute | Description | Type | Required | Default |
|---|---|---|---|---|
| Name | The application name within kubernetes | string | yes | - |
| type | The database type to deploy. | string one of: - postgres | yes | - |
| version | The specific version of the database to deploy | string | no | latest |