API Reference

This API reference is automatically generated from the custom resource definitions, which in turn are generated using cuelang files. To update this documentation, update the description fields generated via Cue.

Packages:

infra.yaook.cloud/v1

Resource Types:

AMQPServer

Name

Type

Description

Required

spec

object

true

status

object

false

AMQPServer.spec

Name

Type

Description

Required

backendCAIssuerRef

object

true

frontendIssuerRef

object

true

imageRef

string

true

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

true

imagePullSecrets

[]object

References to image pull secrets which should be included in all Pods spawned directly or indirectly by this resource.

false

implementation

enum

Enum: RabbitMQ
Default: RabbitMQ

false

policies

map[string]map[string]object

false

rabbitmqConfig

map[string]int or string

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

Resource limits for containers spawned by the AMQPServer

false

serviceMonitor

object

Configure the ServiceMonitor objects created by the operator.

false

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

false

AMQPServer.spec.backendCAIssuerRef

Name

Type

Description

Required

name

string

true

AMQPServer.spec.frontendIssuerRef

Name

Type

Description

Required

name

string

true

AMQPServer.spec.imagePullSecrets[index]

Name

Type

Description

Required

name

string

true

AMQPServer.spec.policies[key][key]

Name

Type

Description

Required

applyto

string

true

definition

object

true

pattern

string

true

priority

integer

true

AMQPServer.spec.resources

Resource limits for containers spawned by the AMQPServer

Name

Type

Description

Required

rabbitmq

object

Define resource requests/limits for the RabbitMQ container

false

AMQPServer.spec.resources.rabbitmq

Define resource requests/limits for the RabbitMQ container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

AMQPServer.spec.resources.rabbitmq.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

AMQPServer.spec.resources.rabbitmq.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

AMQPServer.spec.serviceMonitor

Configure the ServiceMonitor objects created by the operator.

Name

Type

Description

Required

additionalLabels

map[string]string

Additional labels to set on the ServiceMonitor metadata.

false

AMQPServer.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

replicas

integer

false

updatedGeneration

integer

false

AMQPServer.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

AMQPUser

Name

Type

Description

Required

spec

object

true

status

object

false

AMQPUser.spec

Name

Type

Description

Required

passwordSecretKeyRef

object

true

serverRef

object

true

user

string

true

AMQPUser.spec.passwordSecretKeyRef

Name

Type

Description

Required

name

string

true

key

string

Key within the Secret to extract

Default: password

false

AMQPUser.spec.serverRef

Name

Type

Description

Required

name

string

true

AMQPUser.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

updatedGeneration

integer

false

AMQPUser.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

MemcachedService

Name

Type

Description

Required

spec

object

true

status

object

false

MemcachedService.spec

Name

Type

Description

Required

imageRef

string

true

caCertificates

[]string

CA Certificates that should be added to all services can be placed here. CAs that issue certificates to the service are automatically added and do not need to be specified.

false

connections

integer

Default: 1024

false

imagePullSecrets

[]object

References to image pull secrets which should be included in all Pods spawned directly or indirectly by this resource.

false

issuerRef

object

false

memory

integer

Default: 512

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

serviceMonitor

object

Configure the ServiceMonitor objects created by the operator.

false

MemcachedService.spec.imagePullSecrets[index]

Name

Type

Description

Required

name

string

true

MemcachedService.spec.issuerRef

Name

Type

Description

Required

name

string

true

MemcachedService.spec.resources

Name

Type

Description

Required

memcached

object

Define resource requests/limits for the container

false

memcached-exporter

object

Define resource requests/limits for the container

false

service-reload

object

Define resource requests/limits for the container

false

ssl-terminator

object

Define resource requests/limits for the container

false

MemcachedService.spec.resources.memcached

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MemcachedService.spec.resources.memcached.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MemcachedService.spec.resources.memcached.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MemcachedService.spec.resources.memcached-exporter

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MemcachedService.spec.resources.memcached-exporter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MemcachedService.spec.resources.memcached-exporter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MemcachedService.spec.resources.service-reload

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MemcachedService.spec.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MemcachedService.spec.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MemcachedService.spec.resources.ssl-terminator

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MemcachedService.spec.resources.ssl-terminator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MemcachedService.spec.resources.ssl-terminator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MemcachedService.spec.serviceMonitor

Configure the ServiceMonitor objects created by the operator.

Name

Type

Description

Required

additionalLabels

map[string]string

Additional labels to set on the ServiceMonitor metadata.

false

MemcachedService.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

replicas

integer

false

updatedGeneration

integer

false

MemcachedService.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

MySQLService

Name

Type

Description

Required

spec

object

true

status

object

false

MySQLService.spec

Name

Type

Description

Required

backendCAIssuerRef

object

true

backup

object

Backup configuration

true

database

string

true

frontendIssuerRef

object

true

proxy

object

true

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

true

targetRelease

enum

The release to deploy. Changing this will trigger an upgrade.

Enum: 10.2, 10.3, 10.4, 10.5, 10.6

true

caCertificates

[]string

CA Certificates that should be added to all services can be placed here. CAs that issue certificates to the service are automatically added and do not need to be specified.

false

imagePullSecrets

[]object

References to image pull secrets which should be included in all Pods spawned directly or indirectly by this resource.

false

implementation

enum

Enum: MariaDB
Default: MariaDB

false

mysqlConfig

object

Additional MySQL configuration. This is more detailed than typical configuration snippets because of the special optimizer_switch config option.

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

serviceMonitor

object

Configure the ServiceMonitor objects created by the operator.

false

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

false

MySQLService.spec.backendCAIssuerRef

Name

Type

Description

Required

name

string

true

MySQLService.spec.backup

Backup configuration

Name

Type

Description

Required

schedule

string

Schedule in which to create backups. The schedule is given in standard cron notation.

Default: 0 0 * * *

true

mysqldump

boolean

Default: false

false

targets

object

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

false

MySQLService.spec.backup.targets

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

Name

Type

Description

Required

s3

object

Send backups into an S3 bucket.

false

MySQLService.spec.backup.targets.s3

Send backups into an S3 bucket.

Name

Type

Description

Required

bucket

string

Name of the bucket to store data into

true

credentialRef

object

Reference a Secret for the S3 credentials

true

endpoint

string

URL to the S3 service

true

addressingStyle

string

Default: virtual

false

filePrefix

string

Prefix to add to the file name before storing it in the bucket

false

MySQLService.spec.backup.targets.s3.credentialRef

Reference a Secret for the S3 credentials

Name

Type

Description

Required

name

string

true

MySQLService.spec.frontendIssuerRef

Name

Type

Description

Required

name

string

true

MySQLService.spec.proxy

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 1

false

resources

object

false

timeoutClient

integer

Default: 60

false

MySQLService.spec.proxy.resources

Name

Type

Description

Required

create-ca-bundle

object

Define resource requests/limits for the container

false

haproxy

object

Define resource requests/limits for the container

false

service-reload

object

Define resource requests/limits for the container

false

MySQLService.spec.proxy.resources.create-ca-bundle

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MySQLService.spec.proxy.resources.create-ca-bundle.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MySQLService.spec.proxy.resources.create-ca-bundle.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MySQLService.spec.proxy.resources.haproxy

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MySQLService.spec.proxy.resources.haproxy.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MySQLService.spec.proxy.resources.haproxy.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MySQLService.spec.proxy.resources.service-reload

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MySQLService.spec.proxy.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MySQLService.spec.proxy.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MySQLService.spec.imagePullSecrets[index]

Name

Type

Description

Required

name

string

true

MySQLService.spec.mysqlConfig

Additional MySQL configuration. This is more detailed than typical configuration snippets because of the special optimizer_switch config option.

Name

Type

Description

Required

client-server

object

Configuration options for the client-server section.

false

galera

object

Configuration options for the galera section.

false

mysqld

object

Configuration options for the mysqld section.

false

sst

object

Configuration options for the sst section.

false

MySQLService.spec.mysqlConfig.mysqld

Configuration options for the mysqld section.

Name

Type

Description

Required

optimizer_switch

map[string]boolean

Boolean flags for individual optimizer switches. See MariaDB upstream configuration for details.

false

MySQLService.spec.resources

Name

Type

Description

Required

backup-creator

object

Define resource requests/limits for the container

false

backup-shifter

object

Define resource requests/limits for the container

false

mariadb-galera

object

Define resource requests/limits for the container

false

mysqld-exporter

object

Define resource requests/limits for the container

false

MySQLService.spec.resources.backup-creator

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MySQLService.spec.resources.backup-creator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MySQLService.spec.resources.backup-creator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MySQLService.spec.resources.backup-shifter

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MySQLService.spec.resources.backup-shifter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MySQLService.spec.resources.backup-shifter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MySQLService.spec.resources.mariadb-galera

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MySQLService.spec.resources.mariadb-galera.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MySQLService.spec.resources.mariadb-galera.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MySQLService.spec.resources.mysqld-exporter

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

MySQLService.spec.resources.mysqld-exporter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

MySQLService.spec.resources.mysqld-exporter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

MySQLService.spec.serviceMonitor

Configure the ServiceMonitor objects created by the operator.

Name

Type

Description

Required

additionalLabels

map[string]string

Additional labels to set on the ServiceMonitor metadata.

false

MySQLService.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

installedRelease

string

The last successfully deployed release.

false

nextRelease

string

The next release to roll out. This differs from installedRelease during upgrades and from targetRelease during multi-step upgrades.

false

replicas

integer

false

updatedGeneration

integer

false

MySQLService.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

MySQLUser

Name

Type

Description

Required

spec

object

true

status

object

false

MySQLUser.spec

Name

Type

Description

Required

passwordSecretKeyRef

object

true

serviceRef

object

true

user

string

true

databasePrivileges

[]string

Default: [ALL PRIVILEGES]

false

globalPrivileges

[]string

Default: []

false

MySQLUser.spec.passwordSecretKeyRef

Name

Type

Description

Required

name

string

true

key

string

Key within the Secret to extract

Default: password

false

MySQLUser.spec.serviceRef

Name

Type

Description

Required

name

string

true

MySQLUser.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

updatedGeneration

integer

false

MySQLUser.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

OVSDBService

Name

Type

Description

Required

spec

object

true

status

object

false

OVSDBService.spec

Name

Type

Description

Required

backup

object

Backup configuration

true

dbSchema

enum

Enum: northbound, southbound

true

imageRef

string

true

issuerRef

object

true

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

true

caCertificates

[]string

CA Certificates that should be added to all services can be placed here. CAs that issue certificates to the service are automatically added and do not need to be specified.

false

imagePullSecrets

[]object

References to image pull secrets which should be included in all Pods spawned directly or indirectly by this resource.

false

inactivityProbeMs

integer

Time in milliseconds till ovsdb server see connection as inactive

false

ovnRelay

object

Information, if and how many ovn-relays should be created.

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

scrapeIntervalMs

integer

Time in milliseconds the metrics of the ovsdb server are scraped

false

serviceMonitor

object

Configure the ServiceMonitor objects created by the operator.

false

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

false

OVSDBService.spec.backup

Backup configuration

Name

Type

Description

Required

schedule

string

Schedule in which to create backups. The schedule is given in standard cron notation.

Default: 0 0 * * *

true

targets

object

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

false

OVSDBService.spec.backup.targets

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

Name

Type

Description

Required

s3

object

Send backups into an S3 bucket.

false

OVSDBService.spec.backup.targets.s3

Send backups into an S3 bucket.

Name

Type

Description

Required

bucket

string

Name of the bucket to store data into

true

credentialRef

object

Reference a Secret for the S3 credentials

true

endpoint

string

URL to the S3 service

true

addressingStyle

string

Default: virtual

false

filePrefix

string

Prefix to add to the file name before storing it in the bucket

false

OVSDBService.spec.backup.targets.s3.credentialRef

Reference a Secret for the S3 credentials

Name

Type

Description

Required

name

string

true

OVSDBService.spec.issuerRef

Name

Type

Description

Required

name

string

true

OVSDBService.spec.imagePullSecrets[index]

Name

Type

Description

Required

name

string

true

OVSDBService.spec.ovnRelay

Information, if and how many ovn-relays should be created.

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

OVSDBService.spec.ovnRelay.resources

Name

Type

Description

Required

ovn-relay

object

Define resource requests/limits for the container

false

service-reload’

object

Define resource requests/limits for the container

false

ssl-terminator

object

Define resource requests/limits for the container

false

OVSDBService.spec.ovnRelay.resources.ovn-relay

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

OVSDBService.spec.ovnRelay.resources.ovn-relay.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

OVSDBService.spec.ovnRelay.resources.ovn-relay.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

OVSDBService.spec.ovnRelay.resources.service-reload’

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

OVSDBService.spec.ovnRelay.resources.service-reload’.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

OVSDBService.spec.ovnRelay.resources.service-reload’.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

OVSDBService.spec.ovnRelay.resources.ssl-terminator

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

OVSDBService.spec.ovnRelay.resources.ssl-terminator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

OVSDBService.spec.ovnRelay.resources.ssl-terminator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

OVSDBService.spec.resources

Name

Type

Description

Required

backup-creator

object

Define resource requests/limits for the container

false

backup-shifter

object

Define resource requests/limits for the container

false

ovsdb

object

Define resource requests/limits for the container

false

service-reload’

object

Define resource requests/limits for the container

false

setup-ovsdb

object

Define resource requests/limits for the container

false

ssl-terminator

object

Define resource requests/limits for the container

false

OVSDBService.spec.resources.backup-creator

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

OVSDBService.spec.resources.backup-creator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

OVSDBService.spec.resources.backup-creator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

OVSDBService.spec.resources.backup-shifter

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

OVSDBService.spec.resources.backup-shifter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

OVSDBService.spec.resources.backup-shifter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

OVSDBService.spec.resources.ovsdb

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

OVSDBService.spec.resources.ovsdb.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

OVSDBService.spec.resources.ovsdb.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

OVSDBService.spec.resources.service-reload’

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

OVSDBService.spec.resources.service-reload’.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

OVSDBService.spec.resources.service-reload’.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

OVSDBService.spec.resources.setup-ovsdb

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

OVSDBService.spec.resources.setup-ovsdb.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

OVSDBService.spec.resources.setup-ovsdb.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

OVSDBService.spec.resources.ssl-terminator

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

OVSDBService.spec.resources.ssl-terminator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

OVSDBService.spec.resources.ssl-terminator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

OVSDBService.spec.serviceMonitor

Configure the ServiceMonitor objects created by the operator.

Name

Type

Description

Required

additionalLabels

map[string]string

Additional labels to set on the ServiceMonitor metadata.

false

OVSDBService.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

dbSchema

string

false

updatedGeneration

integer

false

OVSDBService.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

yaook.cloud/v1

Resource Types:

BarbicanDeployment

Name

Type

Description

Required

spec

object

true

status

object

false

BarbicanDeployment.spec

Name

Type

Description

Required

api

object

Configure the Barbican API deployment

true

barbicanConfig

map[string]object

Barbican OpenStack config. The keys of this object are the configuration file sections, the values are objects whose keys correspond to config keys within that section.

true

database

object

Configure the database deployment

true

issuerRef

object

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

true

keystoneListener

object

Configure the Barbican Keystone listener deployment

true

keystoneRef

object

Keystone deployment to link this service to

true

memcached

object

Memcached deployment configuration

true

messageQueue

object

Configure the RabbitMQ instance.

true

region

object

Configure the Region to use for this OpenStack service.

true

targetRelease

enum

The release to deploy. Changing this will trigger an upgrade.

Enum: train, yoga

true

barbicanSecrets

[]object

List of secrets to inject into the service configuration.

false

caCertificates

[]string

CA Certificates that should be added to all services can be placed here. CAs that issue certificates to the service are automatically added and do not need to be specified.

false

imagePullSecrets

[]object

References to image pull secrets which should be included in all Pods spawned directly or indirectly by this resource.

false

jobResources

object

Resource limits for Job Pod containers spawned by the Operator

false

policy

object

OpenStack policy to merge with the default policy

false

serviceMonitor

object

Configure the ServiceMonitor objects created by the operator.

false

BarbicanDeployment.spec.api

Configure the Barbican API deployment

Name

Type

Description

Required

ingress

object

Ingress configuration

true

internal

object

Optional override for the internal API endpoint. Normally, the internal API endpoint uses the Kubernetes service. By configuring an Ingress here, that Ingress is used instead.

false

publishEndpoint

boolean

Publish it to Keystone endpoints as well

Default: true

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

BarbicanDeployment.spec.api.ingress

Ingress configuration

Name

Type

Description

Required

fqdn

string

The outer fully-qualified domain name of the Ingress

true

port

integer

Port number under which the Ingress is available. This is required to be set to generate the full URL e.g. for KeystoneEndpoints

true

externalCertificateSecretRef

object

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

false

ingressClassName

string

Class of the Ingress to use

Default: nginx

false

BarbicanDeployment.spec.api.ingress.externalCertificateSecretRef

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

Name

Type

Description

Required

name

string

true

BarbicanDeployment.spec.api.internal

Optional override for the internal API endpoint. Normally, the internal API endpoint uses the Kubernetes service. By configuring an Ingress here, that Ingress is used instead.

Name

Type

Description

Required

ingress

object

Ingress configuration

true

BarbicanDeployment.spec.api.internal.ingress

Ingress configuration

Name

Type

Description

Required

fqdn

string

The outer fully-qualified domain name of the Ingress

true

port

integer

Port number under which the Ingress is available. This is required to be set to generate the full URL e.g. for KeystoneEndpoints

true

externalCertificateSecretRef

object

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

false

ingressClassName

string

Class of the Ingress to use

Default: nginx

false

BarbicanDeployment.spec.api.internal.ingress.externalCertificateSecretRef

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

Name

Type

Description

Required

name

string

true

BarbicanDeployment.spec.api.resources

Name

Type

Description

Required

barbican-api

object

Define resource requests/limits for the container

false

barbican-worker

object

Define resource requests/limits for the container

false

service-reload

object

Define resource requests/limits for the container

false

service-reload-external

object

Define resource requests/limits for the container

false

service-reload-internal

object

Define resource requests/limits for the container

false

ssl-terminator

object

Define resource requests/limits for the container

false

ssl-terminator-external

object

Define resource requests/limits for the container

false

ssl-terminator-internal

object

Define resource requests/limits for the container

false

BarbicanDeployment.spec.api.resources.barbican-api

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.api.resources.barbican-api.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.api.resources.barbican-api.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.api.resources.barbican-worker

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.api.resources.barbican-worker.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.api.resources.barbican-worker.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.api.resources.service-reload

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.api.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.api.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.api.resources.service-reload-external

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.api.resources.service-reload-external.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.api.resources.service-reload-external.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.api.resources.service-reload-internal

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.api.resources.service-reload-internal.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.api.resources.service-reload-internal.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.api.resources.ssl-terminator

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.api.resources.ssl-terminator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.api.resources.ssl-terminator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.api.resources.ssl-terminator-external

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.api.resources.ssl-terminator-external.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.api.resources.ssl-terminator-external.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.api.resources.ssl-terminator-internal

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.api.resources.ssl-terminator-internal.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.api.resources.ssl-terminator-internal.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.database

Configure the database deployment

Name

Type

Description

Required

backup

object

Configure automated database backups

true

proxy

object

Configure the proxy deployment, which brokers traffic to the database

true

mysqlConfig

object

Additional MySQL configuration. This is more detailed than typical configuration snippets because of the special optimizer_switch config option.

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

false

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

false

BarbicanDeployment.spec.database.backup

Configure automated database backups

Name

Type

Description

Required

schedule

string

Schedule in which to create backups. The schedule is given in standard cron notation.

Default: 0 0 * * *

true

mysqldump

boolean

Execute a plain mysqldump in addition to the standard backup.

Default: false

false

targets

object

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

false

BarbicanDeployment.spec.database.backup.targets

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

Name

Type

Description

Required

s3

object

Send backups into an S3 bucket.

false

BarbicanDeployment.spec.database.backup.targets.s3

Send backups into an S3 bucket.

Name

Type

Description

Required

bucket

string

Name of the bucket to store data into

true

credentialRef

object

Reference a Secret for the S3 credentials

true

endpoint

string

URL to the S3 service

true

addressingStyle

string

Default: virtual

false

filePrefix

string

Prefix to add to the file name before storing it in the bucket

false

BarbicanDeployment.spec.database.backup.targets.s3.credentialRef

Reference a Secret for the S3 credentials

Name

Type

Description

Required

name

string

true

BarbicanDeployment.spec.database.proxy

Configure the proxy deployment, which brokers traffic to the database

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 2

false

resources

object

Configure resource requests/limits for containers related to the database proxy.

false

BarbicanDeployment.spec.database.proxy.resources

Configure resource requests/limits for containers related to the database proxy.

Name

Type

Description

Required

create-ca-bundle

object

Define resource requests/limits for the create-ca-bundle container

false

haproxy

object

Define resource requests/limits for the haproxy container

false

service-reload

object

Define resource requests/limits for the service-reload container

false

BarbicanDeployment.spec.database.proxy.resources.create-ca-bundle

Define resource requests/limits for the create-ca-bundle container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.database.proxy.resources.create-ca-bundle.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.database.proxy.resources.create-ca-bundle.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.database.proxy.resources.haproxy

Define resource requests/limits for the haproxy container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.database.proxy.resources.haproxy.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.database.proxy.resources.haproxy.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.database.proxy.resources.service-reload

Define resource requests/limits for the service-reload container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.database.proxy.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.database.proxy.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.database.mysqlConfig

Additional MySQL configuration. This is more detailed than typical configuration snippets because of the special optimizer_switch config option.

Name

Type

Description

Required

client-server

object

Configuration options for the client-server section.

false

galera

object

Configuration options for the galera section.

false

mysqld

object

Configuration options for the mysqld section.

false

sst

object

Configuration options for the sst section.

false

BarbicanDeployment.spec.database.mysqlConfig.mysqld

Configuration options for the mysqld section.

Name

Type

Description

Required

optimizer_switch

map[string]boolean

Boolean flags for individual optimizer switches. See MariaDB upstream configuration for details.

false

BarbicanDeployment.spec.database.resources

Name

Type

Description

Required

backup-creator

object

Define resource requests/limits for the backup-creator container

false

backup-shifter

object

Define resource requests/limits for the backup-shifter container

false

mariadb-galera

object

Define resource requests/limits for the mariadb-galera container

false

mysqld-exporter

object

Define resource requests/limits for the mysqld-exporter container

false

BarbicanDeployment.spec.database.resources.backup-creator

Define resource requests/limits for the backup-creator container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.database.resources.backup-creator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.database.resources.backup-creator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.database.resources.backup-shifter

Define resource requests/limits for the backup-shifter container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.database.resources.backup-shifter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.database.resources.backup-shifter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.database.resources.mariadb-galera

Define resource requests/limits for the mariadb-galera container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.database.resources.mariadb-galera.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.database.resources.mariadb-galera.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.database.resources.mysqld-exporter

Define resource requests/limits for the mysqld-exporter container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.database.resources.mysqld-exporter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.database.resources.mysqld-exporter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.issuerRef

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

Name

Type

Description

Required

name

string

Name of the cert-manager Issuer object

Default: ca-issuer

false

BarbicanDeployment.spec.keystoneListener

Configure the Barbican Keystone listener deployment

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

BarbicanDeployment.spec.keystoneListener.resources

Name

Type

Description

Required

barbican-keystone-listener

object

Define resource requests/limits for the container

false

BarbicanDeployment.spec.keystoneListener.resources.barbican-keystone-listener

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.keystoneListener.resources.barbican-keystone-listener.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.keystoneListener.resources.barbican-keystone-listener.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.keystoneRef

Keystone deployment to link this service to

Name

Type

Description

Required

name

string

true

kind

enum

Specify the kind of Keystone deployment to reference

Enum: KeystoneDeployment, ExternalKeystoneDeployment
Default: KeystoneDeployment

false

BarbicanDeployment.spec.memcached

Memcached deployment configuration

Name

Type

Description

Required

connections

integer

Maximum number of parallel connections

Default: 1024

false

memory

integer

Maximum memory used for the cache

Default: 512

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

BarbicanDeployment.spec.memcached.resources

Name

Type

Description

Required

memcached

object

Define resource requests/limits for the memcached container

false

BarbicanDeployment.spec.memcached.resources.memcached

Define resource requests/limits for the memcached container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.memcached.resources.memcached.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.memcached.resources.memcached.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.messageQueue

Configure the RabbitMQ instance.

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

false

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

false

BarbicanDeployment.spec.messageQueue.resources

Name

Type

Description

Required

rabbitmq

object

Define resource requests/limits for the RabbitMQ container

false

BarbicanDeployment.spec.messageQueue.resources.rabbitmq

Define resource requests/limits for the RabbitMQ container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.messageQueue.resources.rabbitmq.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.messageQueue.resources.rabbitmq.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.region

Configure the Region to use for this OpenStack service.

Name

Type

Description

Required

name

string

Name of the OpenStack region to connect with and to set up the own endpoints in.

Default: RegionOne

false

parent

string

false

BarbicanDeployment.spec.barbicanSecrets[index]

A single secret injection configuration. This causes the operator to read the referenced Secret, extract the individual data entries and put them into the corresponding configuration paths, according to the items.

Name

Type

Description

Required

items

[]object

Assignment of Secret keys to configuration keys

true

secretName

string

Name of the Kubernetes Secret to read

true

BarbicanDeployment.spec.barbicanSecrets[index].items[index]

Name

Type

Description

Required

key

string

Key name in the Secret

true

path

string

Path inside the configuration to put the value in. Path must be in the form of /section/key. For example, to put a value into the debug key in the DEFAULT section, you would use /DEFAULT/debug.

true

BarbicanDeployment.spec.imagePullSecrets[index]

Name

Type

Description

Required

name

string

true

BarbicanDeployment.spec.jobResources

Resource limits for Job Pod containers spawned by the Operator

Name

Type

Description

Required

barbican-db-sync-job

object

Define resource requests/limits for the container

false

BarbicanDeployment.spec.jobResources.barbican-db-sync-job

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

BarbicanDeployment.spec.jobResources.barbican-db-sync-job.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

BarbicanDeployment.spec.jobResources.barbican-db-sync-job.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

BarbicanDeployment.spec.serviceMonitor

Configure the ServiceMonitor objects created by the operator.

Name

Type

Description

Required

additionalLabels

map[string]string

Additional labels to set on the ServiceMonitor metadata.

false

BarbicanDeployment.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

installedRelease

string

The last successfully deployed release.

false

nextRelease

string

The next release to roll out. This differs from installedRelease during upgrades and from targetRelease during multi-step upgrades.

false

updatedGeneration

integer

false

BarbicanDeployment.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

CeilometerDeployment

Name

Type

Description

Required

spec

object

true

status

object

false

CeilometerDeployment.spec

Name

Type

Description

Required

ceilometerCompute

object

true

ceilometerConfig

map[string]object

The keys of this object are the configuration file sections, the values are objects whose keys correspond to config keys within that section.

true

central

object

true

issuerRef

object

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

true

keystoneRef

object

Keystone deployment to link this service to

true

memcached

object

Memcached deployment configuration

true

messageQueue

object

Configure the RabbitMQ instance.

true

notification

object

true

targetRelease

enum

The release to deploy. Changing this will trigger an upgrade.

Enum: queens, train, yoga

true

additionalHosts

[]object

false

caCertificates

[]string

CA Certificates that should be added to all services can be placed here. CAs that issue certificates to the service are automatically added and do not need to be specified.

false

ceilometerEventDefinitions

[]object

false

ceilometerEventPipeline

object

false

ceilometerPipeline

object

false

ceilometerPolling

[]object

false

ceilometerSecrets

[]object

List of secrets to inject into the service configuration.

false

imagePullSecrets

[]object

References to image pull secrets which should be included in all Pods spawned directly or indirectly by this resource.

false

jobResources

object

false

pankoConfig

[]object

List of secrets to inject into the service configuration.

false

skip_gnocchi_bootstrap

boolean

Default: false

false

CeilometerDeployment.spec.ceilometerCompute

Name

Type

Description

Required

configTemplates

[]object

Label-selected configuration templates. This is a list of objects, each describing a piece of configuration.

true

enabled

boolean

Deploy ceilometer-agent-compute

Default: true

false

resources

object

false

CeilometerDeployment.spec.ceilometerCompute.configTemplates[index]

A single configuration template snippet. This is applied to nodes based on the nodeSelectors.

Configuration options are merged intelligently, generally using cuelang semantics. That means that conflicting values will always cause an InvalidConfiguration error during rollout.

Name

Type

Description

Required

nodeSelectors

[]object

List of node selectors, used to select the nodes to which the configuration applies. Each node selector selects a group of nodes; the groups are OR’ed together.

true

ceilometerComputeConfig

map[string]object

The keys of this object are the configuration file sections, the values are objects whose keys correspond to config keys within that section.

false

CeilometerDeployment.spec.ceilometerCompute.configTemplates[index].nodeSelectors[index]

A single node selector.

Name

Type

Description

Required

matchLabels

map[string]string

Label keys and values all of which nodes must have to match the node selector.

true

CeilometerDeployment.spec.ceilometerCompute.resources

Name

Type

Description

Required

ceilometer-compute-agent

object

Define resource requests/limits for the container

false

CeilometerDeployment.spec.ceilometerCompute.resources.ceilometer-compute-agent

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CeilometerDeployment.spec.ceilometerCompute.resources.ceilometer-compute-agent.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CeilometerDeployment.spec.ceilometerCompute.resources.ceilometer-compute-agent.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CeilometerDeployment.spec.central

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 1

false

resources

object

false

CeilometerDeployment.spec.central.resources

Name

Type

Description

Required

ceilometer-agent-central

object

Define resource requests/limits for the container

false

CeilometerDeployment.spec.central.resources.ceilometer-agent-central

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CeilometerDeployment.spec.central.resources.ceilometer-agent-central.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CeilometerDeployment.spec.central.resources.ceilometer-agent-central.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CeilometerDeployment.spec.issuerRef

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

Name

Type

Description

Required

name

string

Name of the cert-manager Issuer object

Default: ca-issuer

false

CeilometerDeployment.spec.keystoneRef

Keystone deployment to link this service to

Name

Type

Description

Required

name

string

true

kind

enum

Specify the kind of Keystone deployment to reference

Enum: KeystoneDeployment, ExternalKeystoneDeployment
Default: KeystoneDeployment

false

CeilometerDeployment.spec.memcached

Memcached deployment configuration

Name

Type

Description

Required

connections

integer

Maximum number of parallel connections

Default: 1024

false

memory

integer

Maximum memory used for the cache

Default: 512

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

CeilometerDeployment.spec.memcached.resources

Name

Type

Description

Required

memcached

object

Define resource requests/limits for the memcached container

false

CeilometerDeployment.spec.memcached.resources.memcached

Define resource requests/limits for the memcached container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CeilometerDeployment.spec.memcached.resources.memcached.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CeilometerDeployment.spec.memcached.resources.memcached.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CeilometerDeployment.spec.messageQueue

Configure the RabbitMQ instance.

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

false

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

false

CeilometerDeployment.spec.messageQueue.resources

Name

Type

Description

Required

rabbitmq

object

Define resource requests/limits for the RabbitMQ container

false

CeilometerDeployment.spec.messageQueue.resources.rabbitmq

Define resource requests/limits for the RabbitMQ container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CeilometerDeployment.spec.messageQueue.resources.rabbitmq.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CeilometerDeployment.spec.messageQueue.resources.rabbitmq.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CeilometerDeployment.spec.notification

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 1

false

resources

object

false

CeilometerDeployment.spec.notification.resources

Name

Type

Description

Required

ceilometer-agent-notification

object

Define resource requests/limits for the container

false

CeilometerDeployment.spec.notification.resources.ceilometer-agent-notification

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CeilometerDeployment.spec.notification.resources.ceilometer-agent-notification.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CeilometerDeployment.spec.notification.resources.ceilometer-agent-notification.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CeilometerDeployment.spec.additionalHosts[index]

Name

Type

Description

Required

hostnames

[]string

true

ip

string

true

CeilometerDeployment.spec.ceilometerEventDefinitions[index]

Name

Type

Description

Required

event_type

[]string

true

traits

map[string]object

true

CeilometerDeployment.spec.ceilometerPolling[index]

Name

Type

Description

Required

interval

integer

true

meters

[]string

true

name

string

true

discovery

[]string

false

resources

[]string

false

CeilometerDeployment.spec.ceilometerSecrets[index]

A single secret injection configuration. This causes the operator to read the referenced Secret, extract the individual data entries and put them into the corresponding configuration paths, according to the items.

Name

Type

Description

Required

items

[]object

Assignment of Secret keys to configuration keys

true

secretName

string

Name of the Kubernetes Secret to read

true

CeilometerDeployment.spec.ceilometerSecrets[index].items[index]

Name

Type

Description

Required

key

string

Key name in the Secret

true

path

string

Path inside the configuration to put the value in. Path must be in the form of /section/key. For example, to put a value into the debug key in the DEFAULT section, you would use /DEFAULT/debug.

true

CeilometerDeployment.spec.imagePullSecrets[index]

Name

Type

Description

Required

name

string

true

CeilometerDeployment.spec.jobResources

Name

Type

Description

Required

ceilometer-upgrade-job

object

Define resource requests/limits for the container

false

CeilometerDeployment.spec.jobResources.ceilometer-upgrade-job

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CeilometerDeployment.spec.jobResources.ceilometer-upgrade-job.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CeilometerDeployment.spec.jobResources.ceilometer-upgrade-job.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CeilometerDeployment.spec.pankoConfig[index]

A single secret injection configuration. This causes the operator to read the referenced Secret, extract the individual data entries and put them into the corresponding configuration paths, according to the items.

Name

Type

Description

Required

items

[]object

Assignment of Secret keys to configuration keys

true

secretName

string

Name of the Kubernetes Secret to read

true

CeilometerDeployment.spec.pankoConfig[index].items[index]

Name

Type

Description

Required

key

string

Key name in the Secret

true

path

string

Path inside the configuration to put the value in. Path must be in the form of /section/key. For example, to put a value into the debug key in the DEFAULT section, you would use /DEFAULT/debug.

true

CeilometerDeployment.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

installedRelease

string

The last successfully deployed release.

false

nextRelease

string

The next release to roll out. This differs from installedRelease during upgrades and from targetRelease during multi-step upgrades.

false

updatedGeneration

integer

false

CeilometerDeployment.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

CinderDeployment

Name

Type

Description

Required

spec

object

true

status

object

false

CinderDeployment.spec

Name

Type

Description

Required

api

object

Cinder API deployment configuration

true

backends

map[string]object

Cinder-volume services (‘backends’) to deploy. Each key is a backend/cinder-volume service; the specific backend which is used is determined by the value.

true

backup

map[string]object

Cinder-backup services to deploy. Each key is a cinder-backup service.

true

cinderConfig

map[string]object

Cinder OpenStack config. The keys of this object are the configuration file sections, the values are objects whose keys correspond to config keys within that section.

true

database

object

Configure the database deployment

true

databaseCleanup

object

Configuration of a periodic database cleanup job, using cinder-manage.

true

issuerRef

object

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

true

keystoneRef

object

Keystone deployment to link this service to

true

memcached

object

Memcached deployment configuration

true

messageQueue

object

Configure the RabbitMQ instance.

true

region

object

Configure the Region to use for this OpenStack service.

true

scheduler

object

Cinder Scheduler deployment configuration

true

targetRelease

enum

The release to deploy. Changing this will trigger an upgrade.

Enum: queens, rocky, stein, train, ussuri, victoria, wallaby, xena, yoga

true

caCertificates

[]string

CA Certificates that should be added to all services can be placed here. CAs that issue certificates to the service are automatically added and do not need to be specified.

false

cinderSecrets

[]object

List of secrets to inject into the service configuration.

false

conversionVolume

object

false

ids

object

false

imagePullSecrets

[]object

References to image pull secrets which should be included in all Pods spawned directly or indirectly by this resource.

false

jobResources

object

Resource limits for Job Pod containers spawned by the Operator

false

policy

object

OpenStack policy to merge with the default policy

false

serviceMonitor

object

Configure the ServiceMonitor objects created by the operator.

false

CinderDeployment.spec.api

Cinder API deployment configuration

Name

Type

Description

Required

ingress

object

Ingress configuration

true

internal

object

Optional override for the internal API endpoint. Normally, the internal API endpoint uses the Kubernetes service. By configuring an Ingress here, that Ingress is used instead.

false

publishEndpoint

boolean

Publish it to Keystone endpoints as well

Default: true

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

Resource requests/limits for containers related to the Cinder API.

false

CinderDeployment.spec.api.ingress

Ingress configuration

Name

Type

Description

Required

fqdn

string

The outer fully-qualified domain name of the Ingress

true

port

integer

Port number under which the Ingress is available. This is required to be set to generate the full URL e.g. for KeystoneEndpoints

true

externalCertificateSecretRef

object

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

false

ingressClassName

string

Class of the Ingress to use

Default: nginx

false

CinderDeployment.spec.api.ingress.externalCertificateSecretRef

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

Name

Type

Description

Required

name

string

true

CinderDeployment.spec.api.internal

Optional override for the internal API endpoint. Normally, the internal API endpoint uses the Kubernetes service. By configuring an Ingress here, that Ingress is used instead.

Name

Type

Description

Required

ingress

object

Ingress configuration

true

CinderDeployment.spec.api.internal.ingress

Ingress configuration

Name

Type

Description

Required

fqdn

string

The outer fully-qualified domain name of the Ingress

true

port

integer

Port number under which the Ingress is available. This is required to be set to generate the full URL e.g. for KeystoneEndpoints

true

externalCertificateSecretRef

object

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

false

ingressClassName

string

Class of the Ingress to use

Default: nginx

false

CinderDeployment.spec.api.internal.ingress.externalCertificateSecretRef

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

Name

Type

Description

Required

name

string

true

CinderDeployment.spec.api.resources

Resource requests/limits for containers related to the Cinder API.

Name

Type

Description

Required

cinder-api

object

Define resource requests/limits for the container

false

service-reload

object

Define resource requests/limits for the container

false

service-reload-external

object

Define resource requests/limits for the container

false

service-reload-internal

object

Define resource requests/limits for the container

false

ssl-terminator

object

Define resource requests/limits for the container

false

ssl-terminator-external

object

Define resource requests/limits for the container

false

ssl-terminator-internal

object

Define resource requests/limits for the container

false

CinderDeployment.spec.api.resources.cinder-api

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.api.resources.cinder-api.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.api.resources.cinder-api.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.api.resources.service-reload

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.api.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.api.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.api.resources.service-reload-external

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.api.resources.service-reload-external.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.api.resources.service-reload-external.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.api.resources.service-reload-internal

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.api.resources.service-reload-internal.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.api.resources.service-reload-internal.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.api.resources.ssl-terminator

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.api.resources.ssl-terminator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.api.resources.ssl-terminator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.api.resources.ssl-terminator-external

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.api.resources.ssl-terminator-external.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.api.resources.ssl-terminator-external.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.api.resources.ssl-terminator-internal

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.api.resources.ssl-terminator-internal.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.api.resources.ssl-terminator-internal.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.backends[key]

Cinder-volume service (‘backend’) configuration. Exactly one of rbd and netapp must be set in order for the configuration to be valid, as that determines the type of backend which is used.

Name

Type

Description

Required

volume

object

Configure the cinder-volume deployment for this backend.

true

cinderSecrets

[]object

List of secrets to inject into the service configuration.

false

netapp

object

false

rbd

object

Ceph RBD backend

false

CinderDeployment.spec.backends[key].volume

Configure the cinder-volume deployment for this backend.

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 1
Minimum: 0
Maximum: 1

false

resources

object

Resource requests/limits for the containers related to cinder-volume.

false

CinderDeployment.spec.backends[key].volume.resources

Resource requests/limits for the containers related to cinder-volume.

Name

Type

Description

Required

cinder-volume

object

Define resource requests/limits for the container

false

CinderDeployment.spec.backends[key].volume.resources.cinder-volume

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.backends[key].volume.resources.cinder-volume.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.backends[key].volume.resources.cinder-volume.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.backends[key].cinderSecrets[index]

A single secret injection configuration. This causes the operator to read the referenced Secret, extract the individual data entries and put them into the corresponding configuration paths, according to the items.

Name

Type

Description

Required

items

[]object

Assignment of Secret keys to configuration keys

true

secretName

string

Name of the Kubernetes Secret to read

true

CinderDeployment.spec.backends[key].cinderSecrets[index].items[index]

Name

Type

Description

Required

key

string

Key name in the Secret

true

path

string

Path inside the configuration to put the value in. Path must be in the form of /section/key. For example, to put a value into the debug key in the DEFAULT section, you would use /DEFAULT/debug.

true

CinderDeployment.spec.backends[key].netapp

Name

Type

Description

Required

login

string

Username to use for logging into the netapp

true

passwordReference

string

Reference to a secret containing the password for the netapp login.

true

server

string

FQDN of the netapp management api.

true

shares

[]string

A list of all shares that this backend exports

true

vserver

string

The vserver of the netapp to use for this backend

true

backendConfig

map[string]string

Extra configuration values to add to the Cinder configuration section for this backend. For global configuration, use the spec.cinderConfig field instead.

false

copyoffloadConfigMap

object

Reference to a configmap containing the copyoffload binary from netapp. Since this binary is proprietary we can not distribute it with yaook and you need to manually download it and put it into a configmap.

false

CinderDeployment.spec.backends[key].netapp.copyoffloadConfigMap

Reference to a configmap containing the copyoffload binary from netapp. Since this binary is proprietary we can not distribute it with yaook and you need to manually download it and put it into a configmap.

Name

Type

Description

Required

name

string

true

CinderDeployment.spec.backends[key].rbd

Ceph RBD backend

Name

Type

Description

Required

keyringReference

string

Name of the Kubernetes secret containing the Ceph keyring to use. The secret must be in kubernetes.io/rook format.

true

keyringUsername

string

RADOS username to use for authentication.

true

backendConfig

map[string]JSON

Extra configuration values to add to the Cinder configuration section for this backend. For global configuration, use the spec.cinderConfig field instead.

false

cephConfig

map[string]JSON

Additional configuration to add to the ceph configuration for this client. This cannot be used for global ceph configuration. Most common use is to add a mon_host key here in order to define where to find the mons.

false

CinderDeployment.spec.backup[key]

Cinder-backup service deployment configuration.

Name

Type

Description

Required

cinderConfig

map[string]object

Cinder Backup OpenStack config. The keys of this object are the configuration file sections, the values are objects whose keys correspond to config keys within that section.

true

cinderSecrets

[]object

List of secrets to inject into the service configuration.

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

Resource requests/limits for containers related to the Cinder Backup service.

false

terminationGracePeriod

integer

Default: 3600

false

CinderDeployment.spec.backup[key].cinderSecrets[index]

A single secret injection configuration. This causes the operator to read the referenced Secret, extract the individual data entries and put them into the corresponding configuration paths, according to the items.

Name

Type

Description

Required

items

[]object

Assignment of Secret keys to configuration keys

true

secretName

string

Name of the Kubernetes Secret to read

true

CinderDeployment.spec.backup[key].cinderSecrets[index].items[index]

Name

Type

Description

Required

key

string

Key name in the Secret

true

path

string

Path inside the configuration to put the value in. Path must be in the form of /section/key. For example, to put a value into the debug key in the DEFAULT section, you would use /DEFAULT/debug.

true

CinderDeployment.spec.backup[key].resources

Resource requests/limits for containers related to the Cinder Backup service.

Name

Type

Description

Required

cinder-backup

object

Define resource requests/limits for the container

false

CinderDeployment.spec.backup[key].resources.cinder-backup

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.backup[key].resources.cinder-backup.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.backup[key].resources.cinder-backup.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.database

Configure the database deployment

Name

Type

Description

Required

backup

object

Configure automated database backups

true

proxy

object

Configure the proxy deployment, which brokers traffic to the database

true

mysqlConfig

object

Additional MySQL configuration. This is more detailed than typical configuration snippets because of the special optimizer_switch config option.

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

false

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

false

CinderDeployment.spec.database.backup

Configure automated database backups

Name

Type

Description

Required

schedule

string

Schedule in which to create backups. The schedule is given in standard cron notation.

Default: 0 0 * * *

true

mysqldump

boolean

Execute a plain mysqldump in addition to the standard backup.

Default: false

false

targets

object

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

false

CinderDeployment.spec.database.backup.targets

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

Name

Type

Description

Required

s3

object

Send backups into an S3 bucket.

false

CinderDeployment.spec.database.backup.targets.s3

Send backups into an S3 bucket.

Name

Type

Description

Required

bucket

string

Name of the bucket to store data into

true

credentialRef

object

Reference a Secret for the S3 credentials

true

endpoint

string

URL to the S3 service

true

addressingStyle

string

Default: virtual

false

filePrefix

string

Prefix to add to the file name before storing it in the bucket

false

CinderDeployment.spec.database.backup.targets.s3.credentialRef

Reference a Secret for the S3 credentials

Name

Type

Description

Required

name

string

true

CinderDeployment.spec.database.proxy

Configure the proxy deployment, which brokers traffic to the database

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 2

false

resources

object

Configure resource requests/limits for containers related to the database proxy.

false

CinderDeployment.spec.database.proxy.resources

Configure resource requests/limits for containers related to the database proxy.

Name

Type

Description

Required

create-ca-bundle

object

Define resource requests/limits for the create-ca-bundle container

false

haproxy

object

Define resource requests/limits for the haproxy container

false

service-reload

object

Define resource requests/limits for the service-reload container

false

CinderDeployment.spec.database.proxy.resources.create-ca-bundle

Define resource requests/limits for the create-ca-bundle container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.database.proxy.resources.create-ca-bundle.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.database.proxy.resources.create-ca-bundle.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.database.proxy.resources.haproxy

Define resource requests/limits for the haproxy container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.database.proxy.resources.haproxy.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.database.proxy.resources.haproxy.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.database.proxy.resources.service-reload

Define resource requests/limits for the service-reload container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.database.proxy.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.database.proxy.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.database.mysqlConfig

Additional MySQL configuration. This is more detailed than typical configuration snippets because of the special optimizer_switch config option.

Name

Type

Description

Required

client-server

object

Configuration options for the client-server section.

false

galera

object

Configuration options for the galera section.

false

mysqld

object

Configuration options for the mysqld section.

false

sst

object

Configuration options for the sst section.

false

CinderDeployment.spec.database.mysqlConfig.mysqld

Configuration options for the mysqld section.

Name

Type

Description

Required

optimizer_switch

map[string]boolean

Boolean flags for individual optimizer switches. See MariaDB upstream configuration for details.

false

CinderDeployment.spec.database.resources

Name

Type

Description

Required

backup-creator

object

Define resource requests/limits for the backup-creator container

false

backup-shifter

object

Define resource requests/limits for the backup-shifter container

false

mariadb-galera

object

Define resource requests/limits for the mariadb-galera container

false

mysqld-exporter

object

Define resource requests/limits for the mysqld-exporter container

false

CinderDeployment.spec.database.resources.backup-creator

Define resource requests/limits for the backup-creator container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.database.resources.backup-creator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.database.resources.backup-creator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.database.resources.backup-shifter

Define resource requests/limits for the backup-shifter container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.database.resources.backup-shifter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.database.resources.backup-shifter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.database.resources.mariadb-galera

Define resource requests/limits for the mariadb-galera container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.database.resources.mariadb-galera.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.database.resources.mariadb-galera.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.database.resources.mysqld-exporter

Define resource requests/limits for the mysqld-exporter container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.database.resources.mysqld-exporter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.database.resources.mysqld-exporter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.databaseCleanup

Configuration of a periodic database cleanup job, using cinder-manage.

Name

Type

Description

Required

deletionTimeRange

integer

Deleted database rows older than this number of days will be removed.

Default: 60

true

schedule

string

The schedule is given in standard cron notation.

Default: 0 0 * * *

true

CinderDeployment.spec.issuerRef

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

Name

Type

Description

Required

name

string

Name of the cert-manager Issuer object

Default: ca-issuer

false

CinderDeployment.spec.keystoneRef

Keystone deployment to link this service to

Name

Type

Description

Required

name

string

true

kind

enum

Specify the kind of Keystone deployment to reference

Enum: KeystoneDeployment, ExternalKeystoneDeployment
Default: KeystoneDeployment

false

CinderDeployment.spec.memcached

Memcached deployment configuration

Name

Type

Description

Required

connections

integer

Maximum number of parallel connections

Default: 1024

false

memory

integer

Maximum memory used for the cache

Default: 512

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

CinderDeployment.spec.memcached.resources

Name

Type

Description

Required

memcached

object

Define resource requests/limits for the memcached container

false

CinderDeployment.spec.memcached.resources.memcached

Define resource requests/limits for the memcached container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.memcached.resources.memcached.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.memcached.resources.memcached.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.messageQueue

Configure the RabbitMQ instance.

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

false

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

false

CinderDeployment.spec.messageQueue.resources

Name

Type

Description

Required

rabbitmq

object

Define resource requests/limits for the RabbitMQ container

false

CinderDeployment.spec.messageQueue.resources.rabbitmq

Define resource requests/limits for the RabbitMQ container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.messageQueue.resources.rabbitmq.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.messageQueue.resources.rabbitmq.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.region

Configure the Region to use for this OpenStack service.

Name

Type

Description

Required

name

string

Name of the OpenStack region to connect with and to set up the own endpoints in.

Default: RegionOne

false

parent

string

false

CinderDeployment.spec.scheduler

Cinder Scheduler deployment configuration

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

Resource requests/limits for containers related to the Cinder Scheduler.

false

CinderDeployment.spec.scheduler.resources

Resource requests/limits for containers related to the Cinder Scheduler.

Name

Type

Description

Required

cinder-scheduler

object

Define resource requests/limits for the container

false

CinderDeployment.spec.scheduler.resources.cinder-scheduler

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.scheduler.resources.cinder-scheduler.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.scheduler.resources.cinder-scheduler.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.cinderSecrets[index]

A single secret injection configuration. This causes the operator to read the referenced Secret, extract the individual data entries and put them into the corresponding configuration paths, according to the items.

Name

Type

Description

Required

items

[]object

Assignment of Secret keys to configuration keys

true

secretName

string

Name of the Kubernetes Secret to read

true

CinderDeployment.spec.cinderSecrets[index].items[index]

Name

Type

Description

Required

key

string

Key name in the Secret

true

path

string

Path inside the configuration to put the value in. Path must be in the form of /section/key. For example, to put a value into the debug key in the DEFAULT section, you would use /DEFAULT/debug.

true

CinderDeployment.spec.conversionVolume

Name

Type

Description

Required

emptyDir

object

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

true

CinderDeployment.spec.conversionVolume.emptyDir

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name

Type

Description

Required

medium

string

What type of storage medium should back this directory.

Default: :code:``

false

sizeLimit

string

Total amount of local storage required for this EmptyDir volume.

false

CinderDeployment.spec.ids

Name

Type

Description

Required

gid

integer

false

uid

integer

false

CinderDeployment.spec.imagePullSecrets[index]

Name

Type

Description

Required

name

string

true

CinderDeployment.spec.jobResources

Resource limits for Job Pod containers spawned by the Operator

Name

Type

Description

Required

cinder-db-cleanup-cronjob

object

Define resource requests/limits for the container

false

cinder-db-sync-job

object

Define resource requests/limits for the container

false

cinder-db-upgrade-post-job

object

Define resource requests/limits for the container

false

cinder-db-upgrade-pre-job

object

Define resource requests/limits for the container

false

CinderDeployment.spec.jobResources.cinder-db-cleanup-cronjob

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.jobResources.cinder-db-cleanup-cronjob.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.jobResources.cinder-db-cleanup-cronjob.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.jobResources.cinder-db-sync-job

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.jobResources.cinder-db-sync-job.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.jobResources.cinder-db-sync-job.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.jobResources.cinder-db-upgrade-post-job

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.jobResources.cinder-db-upgrade-post-job.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.jobResources.cinder-db-upgrade-post-job.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.jobResources.cinder-db-upgrade-pre-job

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

CinderDeployment.spec.jobResources.cinder-db-upgrade-pre-job.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

CinderDeployment.spec.jobResources.cinder-db-upgrade-pre-job.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

CinderDeployment.spec.serviceMonitor

Configure the ServiceMonitor objects created by the operator.

Name

Type

Description

Required

additionalLabels

map[string]string

Additional labels to set on the ServiceMonitor metadata.

false

CinderDeployment.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

installedRelease

string

The last successfully deployed release.

false

nextRelease

string

The next release to roll out. This differs from installedRelease during upgrades and from targetRelease during multi-step upgrades.

false

updatedGeneration

integer

false

CinderDeployment.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

GlanceDeployment

Name

Type

Description

Required

spec

object

true

status

object

false

GlanceDeployment.spec

Name

Type

Description

Required

api

object

true

backends

object

true

database

object

Configure the database deployment

true

glanceConfig

map[string]object

The keys of this object are the configuration file sections, the values are objects whose keys correspond to config keys within that section.

true

issuerRef

object

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

true

keystoneRef

object

Keystone deployment to link this service to

true

memcached

object

Memcached deployment configuration

true

region

object

Configure the Region to use for this OpenStack service.

true

targetRelease

enum

The release to deploy. Changing this will trigger an upgrade.

Enum: train, ussuri, victoria, wallaby, xena, yoga, zed, 2023.1

true

caCertificates

[]string

CA Certificates that should be added to all services can be placed here. CAs that issue certificates to the service are automatically added and do not need to be specified.

false

glanceSecrets

[]object

List of secrets to inject into the service configuration.

false

imagePullSecrets

[]object

References to image pull secrets which should be included in all Pods spawned directly or indirectly by this resource.

false

jobResources

object

false

policy

object

OpenStack policy to merge with the default policy

false

serviceMonitor

object

Configure the ServiceMonitor objects created by the operator.

false

GlanceDeployment.spec.api

Name

Type

Description

Required

ingress

object

Ingress configuration

true

internal

object

Optional override for the internal API endpoint. Normally, the internal API endpoint uses the Kubernetes service. By configuring an Ingress here, that Ingress is used instead.

false

publishEndpoint

boolean

Publish it to Keystone endpoints as well

Default: true

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

GlanceDeployment.spec.api.ingress

Ingress configuration

Name

Type

Description

Required

fqdn

string

The outer fully-qualified domain name of the Ingress

true

port

integer

Port number under which the Ingress is available. This is required to be set to generate the full URL e.g. for KeystoneEndpoints

true

externalCertificateSecretRef

object

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

false

ingressClassName

string

Class of the Ingress to use

Default: nginx

false

GlanceDeployment.spec.api.ingress.externalCertificateSecretRef

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

Name

Type

Description

Required

name

string

true

GlanceDeployment.spec.api.internal

Optional override for the internal API endpoint. Normally, the internal API endpoint uses the Kubernetes service. By configuring an Ingress here, that Ingress is used instead.

Name

Type

Description

Required

ingress

object

Ingress configuration

true

GlanceDeployment.spec.api.internal.ingress

Ingress configuration

Name

Type

Description

Required

fqdn

string

The outer fully-qualified domain name of the Ingress

true

port

integer

Port number under which the Ingress is available. This is required to be set to generate the full URL e.g. for KeystoneEndpoints

true

externalCertificateSecretRef

object

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

false

ingressClassName

string

Class of the Ingress to use

Default: nginx

false

GlanceDeployment.spec.api.internal.ingress.externalCertificateSecretRef

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

Name

Type

Description

Required

name

string

true

GlanceDeployment.spec.api.resources

Name

Type

Description

Required

glance-api

object

Define resource requests/limits for the container

false

service-reload

object

Define resource requests/limits for the container

false

service-reload-external

object

Define resource requests/limits for the container

false

service-reload-internal

object

Define resource requests/limits for the container

false

ssl-terminator

object

Define resource requests/limits for the container

false

ssl-terminator-external

object

Define resource requests/limits for the container

false

ssl-terminator-internal

object

Define resource requests/limits for the container

false

GlanceDeployment.spec.api.resources.glance-api

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.api.resources.glance-api.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.api.resources.glance-api.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.api.resources.service-reload

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.api.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.api.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.api.resources.service-reload-external

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.api.resources.service-reload-external.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.api.resources.service-reload-external.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.api.resources.service-reload-internal

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.api.resources.service-reload-internal.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.api.resources.service-reload-internal.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.api.resources.ssl-terminator

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.api.resources.ssl-terminator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.api.resources.ssl-terminator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.api.resources.ssl-terminator-external

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.api.resources.ssl-terminator-external.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.api.resources.ssl-terminator-external.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.api.resources.ssl-terminator-internal

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.api.resources.ssl-terminator-internal.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.api.resources.ssl-terminator-internal.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.backends

Name

Type

Description

Required

ceph

object

false

file

object

false

s3

object

false

GlanceDeployment.spec.backends.ceph

Name

Type

Description

Required

keyringPoolname

string

true

keyringReference

string

true

keyringUsername

string

true

cephConfig

map[string]object

The keys of this object are the configuration file sections, the values are objects whose keys correspond to config keys within that section.

false

GlanceDeployment.spec.backends.file

Name

Type

Description

Required

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

true

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

true

GlanceDeployment.spec.backends.s3

Name

Type

Description

Required

bucket

string

true

credentialRef

object

true

endpoint

string

true

addressingStyle

enum

Enum: virtual, path, auto
Default: virtual

false

GlanceDeployment.spec.backends.s3.credentialRef

Name

Type

Description

Required

name

string

true

GlanceDeployment.spec.database

Configure the database deployment

Name

Type

Description

Required

backup

object

Configure automated database backups

true

proxy

object

Configure the proxy deployment, which brokers traffic to the database

true

mysqlConfig

object

Additional MySQL configuration. This is more detailed than typical configuration snippets because of the special optimizer_switch config option.

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

false

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

false

GlanceDeployment.spec.database.backup

Configure automated database backups

Name

Type

Description

Required

schedule

string

Schedule in which to create backups. The schedule is given in standard cron notation.

Default: 0 0 * * *

true

mysqldump

boolean

Execute a plain mysqldump in addition to the standard backup.

Default: false

false

targets

object

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

false

GlanceDeployment.spec.database.backup.targets

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

Name

Type

Description

Required

s3

object

Send backups into an S3 bucket.

false

GlanceDeployment.spec.database.backup.targets.s3

Send backups into an S3 bucket.

Name

Type

Description

Required

bucket

string

Name of the bucket to store data into

true

credentialRef

object

Reference a Secret for the S3 credentials

true

endpoint

string

URL to the S3 service

true

addressingStyle

string

Default: virtual

false

filePrefix

string

Prefix to add to the file name before storing it in the bucket

false

GlanceDeployment.spec.database.backup.targets.s3.credentialRef

Reference a Secret for the S3 credentials

Name

Type

Description

Required

name

string

true

GlanceDeployment.spec.database.proxy

Configure the proxy deployment, which brokers traffic to the database

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 2

false

resources

object

Configure resource requests/limits for containers related to the database proxy.

false

GlanceDeployment.spec.database.proxy.resources

Configure resource requests/limits for containers related to the database proxy.

Name

Type

Description

Required

create-ca-bundle

object

Define resource requests/limits for the create-ca-bundle container

false

haproxy

object

Define resource requests/limits for the haproxy container

false

service-reload

object

Define resource requests/limits for the service-reload container

false

GlanceDeployment.spec.database.proxy.resources.create-ca-bundle

Define resource requests/limits for the create-ca-bundle container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.database.proxy.resources.create-ca-bundle.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.database.proxy.resources.create-ca-bundle.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.database.proxy.resources.haproxy

Define resource requests/limits for the haproxy container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.database.proxy.resources.haproxy.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.database.proxy.resources.haproxy.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.database.proxy.resources.service-reload

Define resource requests/limits for the service-reload container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.database.proxy.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.database.proxy.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.database.mysqlConfig

Additional MySQL configuration. This is more detailed than typical configuration snippets because of the special optimizer_switch config option.

Name

Type

Description

Required

client-server

object

Configuration options for the client-server section.

false

galera

object

Configuration options for the galera section.

false

mysqld

object

Configuration options for the mysqld section.

false

sst

object

Configuration options for the sst section.

false

GlanceDeployment.spec.database.mysqlConfig.mysqld

Configuration options for the mysqld section.

Name

Type

Description

Required

optimizer_switch

map[string]boolean

Boolean flags for individual optimizer switches. See MariaDB upstream configuration for details.

false

GlanceDeployment.spec.database.resources

Name

Type

Description

Required

backup-creator

object

Define resource requests/limits for the backup-creator container

false

backup-shifter

object

Define resource requests/limits for the backup-shifter container

false

mariadb-galera

object

Define resource requests/limits for the mariadb-galera container

false

mysqld-exporter

object

Define resource requests/limits for the mysqld-exporter container

false

GlanceDeployment.spec.database.resources.backup-creator

Define resource requests/limits for the backup-creator container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.database.resources.backup-creator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.database.resources.backup-creator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.database.resources.backup-shifter

Define resource requests/limits for the backup-shifter container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.database.resources.backup-shifter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.database.resources.backup-shifter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.database.resources.mariadb-galera

Define resource requests/limits for the mariadb-galera container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.database.resources.mariadb-galera.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.database.resources.mariadb-galera.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.database.resources.mysqld-exporter

Define resource requests/limits for the mysqld-exporter container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.database.resources.mysqld-exporter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.database.resources.mysqld-exporter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.issuerRef

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

Name

Type

Description

Required

name

string

Name of the cert-manager Issuer object

Default: ca-issuer

false

GlanceDeployment.spec.keystoneRef

Keystone deployment to link this service to

Name

Type

Description

Required

name

string

true

kind

enum

Specify the kind of Keystone deployment to reference

Enum: KeystoneDeployment, ExternalKeystoneDeployment
Default: KeystoneDeployment

false

GlanceDeployment.spec.memcached

Memcached deployment configuration

Name

Type

Description

Required

connections

integer

Maximum number of parallel connections

Default: 1024

false

memory

integer

Maximum memory used for the cache

Default: 512

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

GlanceDeployment.spec.memcached.resources

Name

Type

Description

Required

memcached

object

Define resource requests/limits for the memcached container

false

GlanceDeployment.spec.memcached.resources.memcached

Define resource requests/limits for the memcached container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.memcached.resources.memcached.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.memcached.resources.memcached.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.region

Configure the Region to use for this OpenStack service.

Name

Type

Description

Required

name

string

Name of the OpenStack region to connect with and to set up the own endpoints in.

Default: RegionOne

false

parent

string

false

GlanceDeployment.spec.glanceSecrets[index]

A single secret injection configuration. This causes the operator to read the referenced Secret, extract the individual data entries and put them into the corresponding configuration paths, according to the items.

Name

Type

Description

Required

items

[]object

Assignment of Secret keys to configuration keys

true

secretName

string

Name of the Kubernetes Secret to read

true

GlanceDeployment.spec.glanceSecrets[index].items[index]

Name

Type

Description

Required

key

string

Key name in the Secret

true

path

string

Path inside the configuration to put the value in. Path must be in the form of /section/key. For example, to put a value into the debug key in the DEFAULT section, you would use /DEFAULT/debug.

true

GlanceDeployment.spec.imagePullSecrets[index]

Name

Type

Description

Required

name

string

true

GlanceDeployment.spec.jobResources

Name

Type

Description

Required

glance-db-load-metadefs-job

object

Define resource requests/limits for the container

false

glance-db-sync-job

object

Define resource requests/limits for the container

false

glance-db-upgrade-post-job

object

Define resource requests/limits for the container

false

glance-db-upgrade-pre-job

object

Define resource requests/limits for the container

false

GlanceDeployment.spec.jobResources.glance-db-load-metadefs-job

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.jobResources.glance-db-load-metadefs-job.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.jobResources.glance-db-load-metadefs-job.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.jobResources.glance-db-sync-job

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.jobResources.glance-db-sync-job.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.jobResources.glance-db-sync-job.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.jobResources.glance-db-upgrade-post-job

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.jobResources.glance-db-upgrade-post-job.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.jobResources.glance-db-upgrade-post-job.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.jobResources.glance-db-upgrade-pre-job

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GlanceDeployment.spec.jobResources.glance-db-upgrade-pre-job.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GlanceDeployment.spec.jobResources.glance-db-upgrade-pre-job.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GlanceDeployment.spec.serviceMonitor

Configure the ServiceMonitor objects created by the operator.

Name

Type

Description

Required

additionalLabels

map[string]string

Additional labels to set on the ServiceMonitor metadata.

false

GlanceDeployment.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

installedRelease

string

The last successfully deployed release.

false

nextRelease

string

The next release to roll out. This differs from installedRelease during upgrades and from targetRelease during multi-step upgrades.

false

updatedGeneration

integer

false

GlanceDeployment.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

GnocchiDeployment

Name

Type

Description

Required

spec

object

true

status

object

false

GnocchiDeployment.spec

Name

Type

Description

Required

api

object

true

backends

object

true

database

object

Configure the database deployment

true

gnocchiConfig

map[string]object

The keys of this object are the configuration file sections, the values are objects whose keys correspond to config keys within that section.

true

issuerRef

object

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

true

keystoneRef

object

Keystone deployment to link this service to

true

memcached

object

Memcached deployment configuration

true

metricd

object

true

region

object

Configure the Region to use for this OpenStack service.

true

targetRelease

enum

The release to deploy. Changing this will trigger an upgrade.

Enum: queens, train

true

caCertificates

[]string

CA Certificates that should be added to all services can be placed here. CAs that issue certificates to the service are automatically added and do not need to be specified.

false

imagePullSecrets

[]object

References to image pull secrets which should be included in all Pods spawned directly or indirectly by this resource.

false

jobResources

object

false

policy

object

OpenStack policy to merge with the default policy

false

serviceMonitor

object

Configure the ServiceMonitor objects created by the operator.

false

GnocchiDeployment.spec.api

Name

Type

Description

Required

ingress

object

Ingress configuration

true

internal

object

Optional override for the internal API endpoint. Normally, the internal API endpoint uses the Kubernetes service. By configuring an Ingress here, that Ingress is used instead.

false

publishEndpoint

boolean

Publish it to Keystone endpoints as well

Default: true

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

GnocchiDeployment.spec.api.ingress

Ingress configuration

Name

Type

Description

Required

fqdn

string

The outer fully-qualified domain name of the Ingress

true

port

integer

Port number under which the Ingress is available. This is required to be set to generate the full URL e.g. for KeystoneEndpoints

true

externalCertificateSecretRef

object

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

false

ingressClassName

string

Class of the Ingress to use

Default: nginx

false

GnocchiDeployment.spec.api.ingress.externalCertificateSecretRef

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

Name

Type

Description

Required

name

string

true

GnocchiDeployment.spec.api.internal

Optional override for the internal API endpoint. Normally, the internal API endpoint uses the Kubernetes service. By configuring an Ingress here, that Ingress is used instead.

Name

Type

Description

Required

ingress

object

Ingress configuration

true

GnocchiDeployment.spec.api.internal.ingress

Ingress configuration

Name

Type

Description

Required

fqdn

string

The outer fully-qualified domain name of the Ingress

true

port

integer

Port number under which the Ingress is available. This is required to be set to generate the full URL e.g. for KeystoneEndpoints

true

externalCertificateSecretRef

object

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

false

ingressClassName

string

Class of the Ingress to use

Default: nginx

false

GnocchiDeployment.spec.api.internal.ingress.externalCertificateSecretRef

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

Name

Type

Description

Required

name

string

true

GnocchiDeployment.spec.api.resources

Name

Type

Description

Required

gnocchi-api

object

Define resource requests/limits for the container

false

service-reload

object

Define resource requests/limits for the container

false

service-reload-external

object

Define resource requests/limits for the container

false

service-reload-internal

object

Define resource requests/limits for the container

false

ssl-terminator

object

Define resource requests/limits for the container

false

ssl-terminator-external

object

Define resource requests/limits for the container

false

ssl-terminator-internal

object

Define resource requests/limits for the container

false

GnocchiDeployment.spec.api.resources.gnocchi-api

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.api.resources.gnocchi-api.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.api.resources.gnocchi-api.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.api.resources.service-reload

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.api.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.api.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.api.resources.service-reload-external

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.api.resources.service-reload-external.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.api.resources.service-reload-external.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.api.resources.service-reload-internal

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.api.resources.service-reload-internal.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.api.resources.service-reload-internal.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.api.resources.ssl-terminator

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.api.resources.ssl-terminator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.api.resources.ssl-terminator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.api.resources.ssl-terminator-external

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.api.resources.ssl-terminator-external.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.api.resources.ssl-terminator-external.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.api.resources.ssl-terminator-internal

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.api.resources.ssl-terminator-internal.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.api.resources.ssl-terminator-internal.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.backends

Name

Type

Description

Required

ceph

object

false

s3

object

false

GnocchiDeployment.spec.backends.ceph

Name

Type

Description

Required

keyringReference

string

true

keyringUsername

string

true

cephConfig

map[string]object

The keys of this object are the configuration file sections, the values are objects whose keys correspond to config keys within that section.

false

GnocchiDeployment.spec.backends.s3

Name

Type

Description

Required

bucketPrefix

string

true

credentialRef

object

true

endpoint

string

true

GnocchiDeployment.spec.backends.s3.credentialRef

Name

Type

Description

Required

name

string

true

GnocchiDeployment.spec.database

Configure the database deployment

Name

Type

Description

Required

backup

object

Configure automated database backups

true

proxy

object

Configure the proxy deployment, which brokers traffic to the database

true

mysqlConfig

object

Additional MySQL configuration. This is more detailed than typical configuration snippets because of the special optimizer_switch config option.

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

storageClassName

string

Storage class name. If unset, the cluster-wide default storage class will be used. If that storage class is not set or does not work, the deployment will be broken. Changing storage classes after the initial rollout requires manual intervention.

false

storageSize

string

Size to request for the PVC. Changing the size after the initial rollout requires manual intervention.

Default: 8Gi

false

GnocchiDeployment.spec.database.backup

Configure automated database backups

Name

Type

Description

Required

schedule

string

Schedule in which to create backups. The schedule is given in standard cron notation.

Default: 0 0 * * *

true

mysqldump

boolean

Execute a plain mysqldump in addition to the standard backup.

Default: false

false

targets

object

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

false

GnocchiDeployment.spec.database.backup.targets

Configure zero or more targets to save the backups to. If no targets are configured, backups will only be stored within the pod and are gone when the pod is deleted.

Name

Type

Description

Required

s3

object

Send backups into an S3 bucket.

false

GnocchiDeployment.spec.database.backup.targets.s3

Send backups into an S3 bucket.

Name

Type

Description

Required

bucket

string

Name of the bucket to store data into

true

credentialRef

object

Reference a Secret for the S3 credentials

true

endpoint

string

URL to the S3 service

true

addressingStyle

string

Default: virtual

false

filePrefix

string

Prefix to add to the file name before storing it in the bucket

false

GnocchiDeployment.spec.database.backup.targets.s3.credentialRef

Reference a Secret for the S3 credentials

Name

Type

Description

Required

name

string

true

GnocchiDeployment.spec.database.proxy

Configure the proxy deployment, which brokers traffic to the database

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 2

false

resources

object

Configure resource requests/limits for containers related to the database proxy.

false

GnocchiDeployment.spec.database.proxy.resources

Configure resource requests/limits for containers related to the database proxy.

Name

Type

Description

Required

create-ca-bundle

object

Define resource requests/limits for the create-ca-bundle container

false

haproxy

object

Define resource requests/limits for the haproxy container

false

service-reload

object

Define resource requests/limits for the service-reload container

false

GnocchiDeployment.spec.database.proxy.resources.create-ca-bundle

Define resource requests/limits for the create-ca-bundle container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.database.proxy.resources.create-ca-bundle.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.database.proxy.resources.create-ca-bundle.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.database.proxy.resources.haproxy

Define resource requests/limits for the haproxy container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.database.proxy.resources.haproxy.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.database.proxy.resources.haproxy.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.database.proxy.resources.service-reload

Define resource requests/limits for the service-reload container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.database.proxy.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.database.proxy.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.database.mysqlConfig

Additional MySQL configuration. This is more detailed than typical configuration snippets because of the special optimizer_switch config option.

Name

Type

Description

Required

client-server

object

Configuration options for the client-server section.

false

galera

object

Configuration options for the galera section.

false

mysqld

object

Configuration options for the mysqld section.

false

sst

object

Configuration options for the sst section.

false

GnocchiDeployment.spec.database.mysqlConfig.mysqld

Configuration options for the mysqld section.

Name

Type

Description

Required

optimizer_switch

map[string]boolean

Boolean flags for individual optimizer switches. See MariaDB upstream configuration for details.

false

GnocchiDeployment.spec.database.resources

Name

Type

Description

Required

backup-creator

object

Define resource requests/limits for the backup-creator container

false

backup-shifter

object

Define resource requests/limits for the backup-shifter container

false

mariadb-galera

object

Define resource requests/limits for the mariadb-galera container

false

mysqld-exporter

object

Define resource requests/limits for the mysqld-exporter container

false

GnocchiDeployment.spec.database.resources.backup-creator

Define resource requests/limits for the backup-creator container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.database.resources.backup-creator.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.database.resources.backup-creator.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.database.resources.backup-shifter

Define resource requests/limits for the backup-shifter container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.database.resources.backup-shifter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.database.resources.backup-shifter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.database.resources.mariadb-galera

Define resource requests/limits for the mariadb-galera container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.database.resources.mariadb-galera.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.database.resources.mariadb-galera.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.database.resources.mysqld-exporter

Define resource requests/limits for the mysqld-exporter container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.database.resources.mysqld-exporter.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.database.resources.mysqld-exporter.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.issuerRef

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

Name

Type

Description

Required

name

string

Name of the cert-manager Issuer object

Default: ca-issuer

false

GnocchiDeployment.spec.keystoneRef

Keystone deployment to link this service to

Name

Type

Description

Required

name

string

true

kind

enum

Specify the kind of Keystone deployment to reference

Enum: KeystoneDeployment, ExternalKeystoneDeployment
Default: KeystoneDeployment

false

GnocchiDeployment.spec.memcached

Memcached deployment configuration

Name

Type

Description

Required

connections

integer

Maximum number of parallel connections

Default: 1024

false

memory

integer

Maximum memory used for the cache

Default: 512

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

GnocchiDeployment.spec.memcached.resources

Name

Type

Description

Required

memcached

object

Define resource requests/limits for the memcached container

false

GnocchiDeployment.spec.memcached.resources.memcached

Define resource requests/limits for the memcached container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.memcached.resources.memcached.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.memcached.resources.memcached.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.metricd

Name

Type

Description

Required

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

GnocchiDeployment.spec.metricd.resources

Name

Type

Description

Required

gnocchi-metricd

object

Define resource requests/limits for the container

false

GnocchiDeployment.spec.metricd.resources.gnocchi-metricd

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.metricd.resources.gnocchi-metricd.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.metricd.resources.gnocchi-metricd.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.region

Configure the Region to use for this OpenStack service.

Name

Type

Description

Required

name

string

Name of the OpenStack region to connect with and to set up the own endpoints in.

Default: RegionOne

false

parent

string

false

GnocchiDeployment.spec.imagePullSecrets[index]

Name

Type

Description

Required

name

string

true

GnocchiDeployment.spec.jobResources

Name

Type

Description

Required

gnocchi-upgrade-job

object

Define resource requests/limits for the container

false

GnocchiDeployment.spec.jobResources.gnocchi-upgrade-job

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

GnocchiDeployment.spec.jobResources.gnocchi-upgrade-job.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

GnocchiDeployment.spec.jobResources.gnocchi-upgrade-job.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

GnocchiDeployment.spec.serviceMonitor

Configure the ServiceMonitor objects created by the operator.

Name

Type

Description

Required

additionalLabels

map[string]string

Additional labels to set on the ServiceMonitor metadata.

false

GnocchiDeployment.status

Name

Type

Description

Required

conditions

[]object

true

observedGeneration

integer

true

phase

enum

Enum: Created, Updating, WaitingForDependency, Updated, BackingOff, InvalidConfiguration

true

installedRelease

string

The last successfully deployed release.

false

nextRelease

string

The next release to roll out. This differs from installedRelease during upgrades and from targetRelease during multi-step upgrades.

false

updatedGeneration

integer

false

GnocchiDeployment.status.conditions[index]

Name

Type

Description

Required

lastTransitionTime

string

true

lastUpdateTime

string

true

message

string

true

reason

string

true

status

string

true

type

enum

Enum: Converged, GarbageCollected

true

HeatDeployment

Name

Type

Description

Required

spec

object

true

status

object

false

HeatDeployment.spec

Name

Type

Description

Required

api

object

true

apiCfn

object

true

database

object

Configure the database deployment

true

engine

object

true

heatConfig

map[string]object

The keys of this object are the configuration file sections, the values are objects whose keys correspond to config keys within that section.

true

issuerRef

object

Reference an issuer for the certificates used internally by YAOOK (and, by default, also for external services unless overridden).

true

keystoneRef

object

Keystone deployment to link this service to

true

memcached

object

Memcached deployment configuration

true

messageQueue

object

Configure the RabbitMQ instance.

true

region

object

Configure the Region to use for this OpenStack service.

true

targetRelease

enum

The release to deploy. Changing this will trigger an upgrade.

Enum: train

true

caCertificates

[]string

CA Certificates that should be added to all services can be placed here. CAs that issue certificates to the service are automatically added and do not need to be specified.

false

heatSecrets

[]object

List of secrets to inject into the service configuration.

false

imagePullSecrets

[]object

References to image pull secrets which should be included in all Pods spawned directly or indirectly by this resource.

false

jobResources

object

false

policy

object

OpenStack policy to merge with the default policy

false

serviceMonitor

object

Configure the ServiceMonitor objects created by the operator.

false

HeatDeployment.spec.api

Name

Type

Description

Required

ingress

object

Ingress configuration

true

internal

object

Optional override for the internal API endpoint. Normally, the internal API endpoint uses the Kubernetes service. By configuring an Ingress here, that Ingress is used instead.

false

publishEndpoint

boolean

Publish it to Keystone endpoints as well

Default: true

false

replicas

integer

Number of replicas for the service

Default: 3

false

resources

object

false

HeatDeployment.spec.api.ingress

Ingress configuration

Name

Type

Description

Required

fqdn

string

The outer fully-qualified domain name of the Ingress

true

port

integer

Port number under which the Ingress is available. This is required to be set to generate the full URL e.g. for KeystoneEndpoints

true

externalCertificateSecretRef

object

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

false

ingressClassName

string

Class of the Ingress to use

Default: nginx

false

HeatDeployment.spec.api.ingress.externalCertificateSecretRef

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

Name

Type

Description

Required

name

string

true

HeatDeployment.spec.api.internal

Optional override for the internal API endpoint. Normally, the internal API endpoint uses the Kubernetes service. By configuring an Ingress here, that Ingress is used instead.

Name

Type

Description

Required

ingress

object

Ingress configuration

true

HeatDeployment.spec.api.internal.ingress

Ingress configuration

Name

Type

Description

Required

fqdn

string

The outer fully-qualified domain name of the Ingress

true

port

integer

Port number under which the Ingress is available. This is required to be set to generate the full URL e.g. for KeystoneEndpoints

true

externalCertificateSecretRef

object

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

false

ingressClassName

string

Class of the Ingress to use

Default: nginx

false

HeatDeployment.spec.api.internal.ingress.externalCertificateSecretRef

Reference to a Kubernetes TLS Secret containing the TLS certificate and keys to use for this endpoint. If unset, a certificate will be generated using the Issuer configured via issuerRef at the top level.

Name

Type

Description

Required

name

string

true

HeatDeployment.spec.api.resources

Name

Type

Description

Required

heat-api

object

Define resource requests/limits for the container

false

service-reload

object

Define resource requests/limits for the container

false

service-reload-external

object

Define resource requests/limits for the container

false

service-reload-internal

object

Define resource requests/limits for the container

false

ssl-terminator

object

Define resource requests/limits for the container

false

ssl-terminator-external

object

Define resource requests/limits for the container

false

ssl-terminator-internal

object

Define resource requests/limits for the container

false

HeatDeployment.spec.api.resources.heat-api

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

HeatDeployment.spec.api.resources.heat-api.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

HeatDeployment.spec.api.resources.heat-api.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

HeatDeployment.spec.api.resources.service-reload

Define resource requests/limits for the container

Name

Type

Description

Required

limits

object

Define resource limits for the container

false

requests

object

Define resource requests for the container

false

HeatDeployment.spec.api.resources.service-reload.limits

Define resource limits for the container

Name

Type

Description

Required

cpu

string

CPU time limit for the container

false

memory

string

Memory limit for the container

false

HeatDeployment.spec.api.resources.service-reload.requests

Define resource requests for the container

Name

Type

Description

Required

cpu

string

CPU time request for the container

false

memory

string

Memory request for the container

false

HeatDeployment.spec.api.resources.service-reload-external

Define resource requests/limits for the container

Name

Type

Description

Required