VSHN Services

The parent key for all of the following parameters is appcat.services.vshn.

If you enable any of the VSHN service, make sure that the necessary providers are deployed. Either by enabling it in appcat.providers or separately from this component.

`enabled`

type	bool
default	`false`

If VSHN services should be available at all. When set to false no VSHN services will be deployed, even if a specific service was enabled.

`secretNamespace`

type	string
default	`${crossplane:namespace}`

In which namespace an XR’s connection secret is written to.

Defaults to the crossplane namespace.

`emailAlerting`

type

dict

Configuration options for email alerting trough an SMTP service. Here you can configure the smtp host as well as the credentails required to send out alerts via any SMTP mail relay.

`emailAlerting.enabled

type: bool
default: false

If e-mail the alerting feature is enabled.

`emailAlerting.smtpHost`

type: string
default: 'smtp.eu.mailgun.org:465'

Hostname to be used for sending out email alerts

`emailAlerting.smtpUsername`

type: string
default: 'myuser@example.com'

The Username for the mail relay server

`emailAlerting.smtpPassword`

type: string
default: ?{vaultkv:shared/shared/mailgun/smtp_password}

The Password for the mail relay server.

`emailAlerting.smtpFromAddress`

type: string
default: 'myuser@example.com'

The email address used in the FROM header for sending out the alerts.

`emailAlerting.secretNamespace`

type: string
default: 'syn-appcat'

The namespace where the secret that contains the password for the smtp relay server will be placed in

`emailAlerting.secretName`

type: string
default: 'mailgun-smtp-secret'

The name of the secret that contains the password for the smtp relay server.

`postgres`

type

dict

Configuration option for VSHN PostgreSQL. You have to option to enable or disable it through the enabled parameter and can set the secretNamespace and providerSecretNamespace.

It’s enabled by default and use the top level defined namespaces for secretNamespace and providerSecretNamespace.

`postgres.enableNetworkPolicy`

type: bool
default: true

Whether to enable NetworkPolicy in the PostgreSQL instance namespace. This allows to establish connections from claim’s namespace to the PostgreSQL instance.

`postgres.bucket_region`

type: string
default: ''

Bucket region, required for xObjectBucket and PostreSQL managed by VSHN backup, should be cloud specific.

Examples

Cloudscale
- 'lpg'
Exoscale
- 'ch-gva-2'

`postgres.bucket_endpoint`

type: string
default: ''

Bucket endpoint, required for xObjectBucket and PostreSQL managed by VSHN backup, should be cloud specific.

Examples

Cloudscale
- 'https://objects.lpg.cloudscale.ch'
Exoscale
- 'https://sos-ch-gva-2.exo.io'

`postgres.plans`

type: dict

A dict of plans for PostgreSQL by VSHN.

The key is the name of the plan. You can configure the CPU request through size.cpu, memory through size.memory, and disk size through size.disk. You can also set a node selector through scheduling.nodeSelector.

There is also the option to specify a note in note, which will be added to the description of the field in the CRD.

Examples

plans:
  standard-2:
    size:
      cpu: "400m"
      memory: "1728Mi"
      disk: 20Gi
  standard-4:
    size:
      cpu: "900m"
      memory: "3776Mi"
      disk: 40Gi
  standard-8:
    enabled: false
  plus-4:
    size: ${appcat:services:vshn:postgres:plans:standard-4:size}
    scheduling:
      nodeSelector:
        appuio.io/node-class: "plus" (1)
    note: "Will be scheduled on APPUiO Cloud plus nodes"

1	See Node Classes

`postgres.defaultPlan`

type: string
default: standard-2

The default plan used for PostgreSQL by VSHN, if the service user doesn’t specify a plan.

`redis`

type

dict

Configuration option for VSHN Redis. You have to option to enable or disable it through the enabled parameter and can set the secretNamespace and providerSecretNamespace.

It’s enabled by default and use the top level defined namespaces for secretNamespace and providerSecretNamespace.

`redis.enableNetworkPolicy`

type: bool
default: true

Whether to enable NetworkPolicy in the Redis instance namespace. This allows to establish connections from claim’s namespace to the Redis instance.

`redis.bucket_region`

type: bool
default: lpg

What region the backup buckets should use.

`redis.plans`

type: dict

A dict of plans for Redis by VSHN.

There is also the option to specify a note in note, which will be added to the description of the field in the CRD.

Examples

plans:
  standard-2:
    size:
      cpu: "500m"
      memory: "2Gi"
      disk: 16Gi
  standard-4:
    size:
      cpu: "1"
      memory: "4Gi"
      disk: 16Gi
  standard-8:
    enabled: false
  plus-4:
    size: ${appcat:services:vshn:redis:plans:standard-4:size}
    scheduling:
      nodeSelector:
        appuio.io/node-class: "plus" (1)
    note: "Will be scheduled on APPUiO Cloud plus nodes"

1	See Node Classes

`redis.defaultPlan`

type: string
default: standard-1

The default plan used for Redis by VSHN, if the service user doesn’t specify a plan.

minio

type

dict

Configuration option for VSHN Minio. You have to option to enable or disable it through the enabled parameter and can set the secretNamespace and providerSecretNamespace.

It’s disabled by default and use the top level defined namespaces for secretNamespace and providerSecretNamespace.

instances

type

array

Array of minio instances to deploy to a given cluster.

Examples

instances:
  - name: my-minio
    namespace: default
    spec:
      parameters:
        service:
          mode: standalone
        size:
          disk: 1Gi
      writeConnectionSecretToRef:
        name: my-minio-creds