API Reference

This is a generated API documentation.

appcat.vshn.io/v1

Resource Types

Condition

Appears In:
Field Description

type string

Type of condition.

observedGeneration integer

ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

lastTransitionTime Time

LastTransitionTime is the last time the condition transitioned from one status to another.

reason string

Reason contains a programmatic identifier indicating the reason for the condition’s last transition.

message string

Message is a human-readable message indicating details about the transition.

LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Appears In:
Field Description

name string

namespace string

NamespacedName

NamespacedName describes an object reference by its name and namespace

Appears In:
Field Description

namespace string

name string

ObjectBucket

ObjectBucket is the API for creating S3 buckets.

Field Description

apiVersion string

appcat.vshn.io/v1

kind string

ObjectBucket

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

ObjectBucketParameters

ObjectBucketParameters are the configurable fields of a ObjectBucket.

Field Description

bucketName string

BucketName is the name of the bucket to create. Cannot be changed after bucket is created. Name must be acceptable by the S3 protocol, which follows RFC 1123. Be aware that S3 providers may require a unique name across the platform or region.

region string

Region is the name of the region where the bucket shall be created. The region must be available in the S3 endpoint.

ObjectBucketSpec

ObjectBucketSpec defines the desired state of a ObjectBucket.

Appears In:
Field Description

writeConnectionSecretToRef LocalObjectReference

WriteConnectionSecretToRef references a secret to which the connection details will be written.

XObjectBucket

XObjectBucket represents the internal composite of this claim

Field Description

apiVersion string

appcat.vshn.io/v1

kind string

XObjectBucket

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

XObjectBucketSpec

XObjectBucketSpec defines the desired state of a ObjectBucket.

Appears In:
Field Description

writeConnectionSecretToRef NamespacedName

WriteConnectionSecretToRef references a secret to which the connection details will be written.

Exoscale Reference

This is a generated API documentation.

exoscale.appcat.vshn.io/v1

ExoscaleDBaaSBackupSpec

Field Description

timeOfDay string

TimeOfDay for doing daily backups, in UTC. Format: "hh:mm:ss".

ExoscaleDBaaSMaintenanceScheduleSpec

Field Description

dayOfWeek string

DayOfWeek specifies at which weekday the maintenance is held place. Allowed values are [monday, tuesday, wednesday, thursday, friday, saturday, sunday, never]

timeOfDay string

TimeOfDay for installing updates in UTC. Format: "hh:mm:ss".

ExoscaleDBaaSNetworkSpec

Field Description

ipFilter string array

IPFilter is a list of allowed IPv4 CIDR ranges that can access the service. If no IP Filter is set, you may not be able to reach the service. A value of 0.0.0.0/0 will open the service to all addresses on the public internet.

ExoscaleDBaaSServiceSpec

Field Description

zone string

Zone is the datacenter identifier in which the instance runs in.

ExoscaleDBaaSSizeSpec

Field Description

plan string

Plan is the name of the resource plan that defines the compute resources.

ExoscaleKafka

ExoscaleKafka is the API for creating Kafka instances on Exoscale.

Field Description

apiVersion string

exoscale.appcat.vshn.io/v1

kind string

ExoscaleKafka

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a ExoscaleKafka.

ExoscaleKafkaDBaaSSizeSpec

Field Description

plan string

Plan is the name of the resource plan that defines the compute resources.

ExoscaleKafkaParameters

Appears In:
Field Description

Service contains Exoscale Kafka DBaaS specific properties

Maintenance contains settings to control the maintenance of an instance.

Size contains settings to control the sizing of a service.

Network contains any network related settings.

ExoscaleKafkaServiceSpec

Field Description

zone string

Zone is the datacenter identifier in which the instance runs in.

kafkaSettings RawExtension

KafkaSettings contains additional Kafka settings.

version string

Version contains the minor version for Kafka. Currently only "3.4" is supported. Leave it empty to always get the latest supported version.

ExoscaleKafkaSpec

Appears In:
Field Description

Parameters are the configurable fields of a ExoscaleKafka.

writeConnectionSecretToRef LocalObjectReference

WriteConnectionSecretToRef references a secret to which the connection details will be written.

ExoscaleMySQL

ExoscaleMySQL is the API for creating MySQL on Exoscale.

Field Description

apiVersion string

exoscale.appcat.vshn.io/v1

kind string

ExoscaleMySQL

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a ExoscaleMySQL.

ExoscaleMySQLParameters

Appears In:
Field Description

Service contains Exoscale MySQL DBaaS specific properties

Maintenance contains settings to control the maintenance of an instance.

Size contains settings to control the sizing of a service.

Network contains any network related settings.

Backup contains settings to control the backups of an instance.

ExoscaleMySQLServiceSpec

Field Description

zone string

Zone is the datacenter identifier in which the instance runs in.

majorVersion string

MajorVersion contains the major version for MySQL. Currently only "8" is supported. Leave it empty to always get the latest supported version.

mysqlSettings RawExtension

MySQLSettings contains additional MySQL settings.

ExoscaleMySQLSpec

Appears In:
Field Description

Parameters are the configurable fields of a ExoscaleMySQL.

writeConnectionSecretToRef LocalObjectReference

WriteConnectionSecretToRef references a secret to which the connection details will be written.

ExoscaleOpenSearch

ExoscaleOpenSearch is the api for creating OpenSearch on Exoscale

Field Description

apiVersion string

exoscale.appcat.vshn.io/v1

kind string

ExoscaleOpenSearch

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of an ExoscaleOpenSearch

ExoscaleOpenSearchParameters

Field Description

Service contains Exoscale OpenSearch DBaaS specific properties

Maintenance contains settings to control the maintenance of an instance.

Size contains settings to control the sizing of a service.

Network contains any network related settings.

Backup contains settings to control the backups of an instance.

ExoscaleOpenSearchServiceSpec

Field Description

zone string

Zone is the datacenter identifier in which the instance runs in.

majorVersion string

MajorVersion contains the version for OpenSearch. Currently only "2" and "1" is supported. Leave it empty to always get the latest supported version.

opensearchSettings RawExtension

OpenSearchSettings contains additional OpenSearch settings.

ExoscaleOpenSearchSpec

Appears In:
Field Description

Parameters are the configurable fields of a ExoscaleOpenSearch.

writeConnectionSecretToRef LocalObjectReference

WriteConnectionSecretToRef references a secret to which the connection details will be written.

ExoscalePostgreSQL

ExoscalePostgreSQL is the API for creating PostgreSQL on Exoscale.

Field Description

apiVersion string

exoscale.appcat.vshn.io/v1

kind string

ExoscalePostgreSQL

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a ExoscalePostgreSQL.

ExoscalePostgreSQLParameters

Field Description

Service contains Exoscale PostgreSQL DBaaS specific properties

Maintenance contains settings to control the maintenance of an instance.

Size contains settings to control the sizing of a service.

Network contains any network related settings.

Backup contains settings to control the backups of an instance.

ExoscalePostgreSQLServiceSpec

Field Description

zone string

Zone is the datacenter identifier in which the instance runs in.

majorVersion string

MajorVersion contains the major version for PostgreSQL. Currently only "14" is supported. Leave it empty to always get the latest supported version.

pgSettings RawExtension

PGSettings contains additional PostgreSQL settings.

ExoscalePostgreSQLSpec

Appears In:
Field Description

Parameters are the configurable fields of a ExoscalePostgreSQL.

writeConnectionSecretToRef LocalObjectReference

WriteConnectionSecretToRef references a secret to which the connection details will be written.

ExoscaleRedis

ExoscaleRedis is the API for creating Redis instances on Exoscale.

Field Description

apiVersion string

exoscale.appcat.vshn.io/v1

kind string

ExoscaleRedis

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a ExoscaleRedis.

ExoscaleRedisParameters

Appears In:
Field Description

Service contains Exoscale Redis DBaaS specific properties

Maintenance contains settings to control the maintenance of an instance.

Size contains settings to control the sizing of a service.

Network contains any network related settings.

ExoscaleRedisServiceSpec

Field Description

zone string

Zone is the datacenter identifier in which the instance runs in.

redisSettings RawExtension

RedisSettings contains additional Redis settings.

ExoscaleRedisSpec

Appears In:
Field Description

Parameters are the configurable fields of a ExoscaleRedis.

writeConnectionSecretToRef LocalObjectReference

WriteConnectionSecretToRef references a secret to which the connection details will be written.

VSHN Reference

This is a generated API documentation.

vshn.appcat.vshn.io/v1

K8upBackupSpec

K8upBackupSpec specifies when a backup for redis should be triggered. It also contains the retention policy for the backup.

Appears In:
Field Description

schedule string

K8upRestoreSpec

K8upRestoreSpec contains restore specific parameters.

Appears In:
Field Description

claimName string

ClaimName specifies the name of the instance you want to restore from. The claim has to be in the same namespace as this new instance.

backupName string

BackupName is the name of the specific backup you want to restore.

K8upRetentionPolicy

K8upRetentionPolicy describes the retention configuration for a K8up backup.

Appears In:
Field Description

keepLast integer

keepHourly integer

keepDaily integer

keepWeekly integer

keepMonthly integer

keepYearly integer

VSHNDBaaSMaintenanceScheduleSpec

VSHNDBaaSMaintenanceScheduleSpec contains settings to control the maintenance of an instance.

Field Description

dayOfWeek string

DayOfWeek specifies at which weekday the maintenance is held place. Allowed values are [monday, tuesday, wednesday, thursday, friday, saturday, sunday]

timeOfDay string

TimeOfDay for installing updates in UTC. Format: "hh:mm:ss".

VSHNDBaaSNetworkSpec

VSHNDBaaSNetworkSpec contains any network related settings.

Field Description

ipFilter string array

IPFilter is a list of allowed IPv4 CIDR ranges that can access the service. If no IP Filter is set, you may not be able to reach the service. A value of 0.0.0.0/0 will open the service to all addresses on the public internet.

serviceType string

ServiceType defines the type of the service. Possible enum values: - "ClusterIP" indicates that the service is only reachable from within the cluster. - "LoadBalancer" indicates that the service is reachable from the public internet via dedicated Ipv4 address.

VSHNDBaaSPostgresExtension

VSHNDBaaSPostgresExtension contains the name of a single extension.

Field Description

name string

Name is the name of the extension to enable. For an extensive list, please consult stackgres.io/doc/latest/intro/extensions/

VSHNDBaaSSchedulingSpec

VSHNDBaaSSchedulingSpec contains settings to control the scheduling of an instance.

Field Description

nodeSelector object (keys:string, values:string)

NodeSelector is a selector which must match a node’s labels for the pod to be scheduled on that node

VSHNDBaaSSizeRequestsSpec

VSHNDBaaSSizeRequestsSpec contains settings to control the resoure requests of a service.

Appears In:
Field Description

cpu string

CPU defines the amount of Kubernetes CPUs for an instance.

memory string

Memory defines the amount of memory in units of bytes for an instance.

VSHNDBaaSSizeSpec

VSHNDBaaSSizeSpec contains settings to control the sizing of a service.

Field Description

cpu string

CPU defines the amount of Kubernetes CPUs for an instance.

memory string

Memory defines the amount of memory in units of bytes for an instance.

Requests defines CPU and memory requests for an instance

disk string

Disk defines the amount of disk space for an instance.

plan string

Plan is the name of the resource plan that defines the compute resources.

VSHNPostgreSQLBackup

Field Description

schedule string

retention integer

deletionProtection boolean

DeletionProtection will protect the instance from being deleted for the given retention time. This is enabled by default.

deletionRetention integer

DeletionRetention specifies in days how long the instance should be kept after deletion. The default is keeping it one week.

VSHNPostgreSQLEncryption

VSHNPostgreSQLEncryption contains storage encryption specific parameters

Field Description

enabled boolean

Enabled specifies if the instance should use encrypted storage for the instance.

VSHNPostgreSQLList

VSHNPostgreSQLList defines a list of VSHNPostgreSQL

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNPostgreSQLList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items XVSHNPostgreSQL array

VSHNPostgreSQLMonitoring

VSHNPostgreSQLMonitoring contains settings to configure monitoring aspects of PostgreSQL

Field Description

alertmanagerConfigRef string

AlertmanagerConfigRef contains the name of the AlertmanagerConfig that should be copied over to the namespace of the PostgreSQL instance.

alertmanagerConfigSecretRef string

AlertmanagerConfigSecretRef contains the name of the secret that is used in the referenced AlertmanagerConfig

alertmanagerConfigTemplate AlertmanagerConfigSpec

AlertmanagerConfigSpecTemplate takes an AlertmanagerConfigSpec object. This takes precedence over the AlertmanagerConfigRef.

email string

Email necessary to send alerts via email

VSHNPostgreSQLParameters

VSHNPostgreSQLParameters are the configurable fields of a VSHNPostgreSQL.

Appears In:
Field Description

Service contains PostgreSQL DBaaS specific properties

Maintenance contains settings to control the maintenance of an instance.

Size contains settings to control the sizing of a service.

Scheduling contains settings to control the scheduling of an instance.

Network contains any network related settings.

Backup contains settings to control the backups of an instance.

Restore contains settings to control the restore of an instance.

Monitoring contains settings to control monitoring.

Encryption contains settings to control the storage encryption of an instance.

UpdateStrategy indicates when updates to the instance spec will be applied.

instances integer

Instances configures the number of PostgreSQL instances for the cluster. Each instance contains one Postgres server. Out of all Postgres servers, one is elected as the primary, the rest remain as read-only replicas.

This section allows to configure Postgres replication mode and HA roles groups. The main replication group is implicit and contains the total number of instances less the sum of all instances in other replication groups.

VSHNPostgreSQLReplicationStrategy

Field Description

mode string

Mode defines the replication mode applied to the whole cluster. Possible values are: "async"(default), "sync", and "strict-sync" "async": When in asynchronous mode the cluster is allowed to lose some committed transactions. When the primary server fails or becomes unavailable for any other reason a sufficiently healthy standby will automatically be promoted to primary. Any transactions that have not been replicated to that standby remain in a “forked timeline” on the primary, and are effectively unrecoverable "sync": When in synchronous mode a standby will not be promoted unless it is certain that the standby contains all transactions that may have returned a successful commit status to client. This means that the system may be unavailable for writes even though some servers are available. "strict-sync": When it is absolutely necessary to guarantee that each write is stored durably on at least two nodes, use the strict synchronous mode. This mode prevents synchronous replication to be switched off on the primary when no synchronous standby candidates are available. As a downside, the primary will not be available for writes, blocking all client write requests until at least one synchronous replica comes up. NOTE: We recommend to always use three intances when setting the mode to "strict-sync".

VSHNPostgreSQLRestore

VSHNPostgreSQLRestore contains restore specific parameters.

Field Description

claimName string

ClaimName specifies the name of the instance you want to restore from. The claim has to be in the same namespace as this new instance.

backupName string

BackupName is the name of the specific backup you want to restore.

recoveryTimeStamp string

RecoveryTimeStamp an ISO 8601 date, that holds UTC date indicating at which point-in-time the database has to be restored. This is optional and if no PIT recovery is required, it can be left empty.

VSHNPostgreSQLServiceSpec

VSHNPostgreSQLServiceSpec contains PostgreSQL DBaaS specific properties

Field Description

majorVersion string

MajorVersion contains supported version of PostgreSQL. Multiple versions are supported. The latest version "15" is the default version.

pgSettings RawExtension

PGSettings contains additional PostgreSQL settings.

extensions VSHNDBaaSPostgresExtension array

Extensions allow to enable/disable any of the supported

serviceLevel VSHNDBaaSServiceLevel

ServiceLevel defines the service level of this service. Either Best Effort or Guaranteed Availability is allowed.

VSHNPostgreSQLSpec

VSHNPostgreSQLSpec defines the desired state of a VSHNPostgreSQL.

Appears In:
Field Description

Parameters are the configurable fields of a VSHNPostgreSQL.

writeConnectionSecretToRef LocalObjectReference

WriteConnectionSecretToRef references a secret to which the connection details will be written.

resourceRef ObjectReference

ResourceRef contains a reference to the composite.

compositeDeletePolicy string

CompositeDeletePolicy defines how the claim should behave if it’s deleted. This field definition will be overwritten by crossplane again, once the XRD is applied to a cluster. It’s added here so it can be marshalled correctly in third party operators or composition functions.

VSHNPostgreSQLUpdateStrategy

VSHNPostgreSQLUpdateStrategy indicates how and when updates to the instance spec will be applied.

Field Description

type string

Type indicates the type of the UpdateStrategy. Default is OnRestart. Possible enum values: - "OnRestart" indicates that the changes to the spec will only be applied once the instance is restarted by other means, most likely during maintenance. - "Immediate" indicates that update will be applied to the instance as soon as the spec changes. Please be aware that this might lead to short downtime.

VSHNRedis

VSHNRedis is the API for creating Redis clusters.

Appears In:
Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNRedis

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a VSHNRedis.

VSHNRedisList

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNRedisList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNRedis array

VSHNRedisParameters

VSHNRedisParameters are the configurable fields of a VSHNRedis.

Appears In:
Field Description

Service contains Redis DBaaS specific properties

Size contains settings to control the sizing of a service.

Scheduling contains settings to control the scheduling of an instance.

TLS contains settings to control tls traffic of a service.

Backup contains settings to control how the instance should get backed up.

restore K8upRestoreSpec

Restore contains settings to control the restore of an instance.

Maintenance contains settings to control the maintenance of an instance.

VSHNRedisServiceSpec

VSHNRedisServiceSpec contains Redis DBaaS specific properties

Appears In:
Field Description

version string

Version contains supported version of Redis. Multiple versions are supported. The latest version "7.0" is the default version.

redisSettings string

RedisSettings contains additional Redis settings.

VSHNRedisSizeSpec

VSHNRedisSizeSpec contains settings to control the sizing of a service.

Appears In:
Field Description

cpuRequests string

CPURequests defines the requests amount of Kubernetes CPUs for an instance.

cpuLimits string

CPULimits defines the limits amount of Kubernetes CPUs for an instance.

memoryRequests string

MemoryRequests defines the requests amount of memory in units of bytes for an instance.

memoryLimits string

MemoryLimits defines the limits amount of memory in units of bytes for an instance.

disk string

Disk defines the amount of disk space for an instance.

plan string

Plan is the name of the resource plan that defines the compute resources.

VSHNRedisSpec

VSHNRedisSpec defines the desired state of a VSHNRedis.

Appears In:
Field Description

parameters VSHNRedisParameters

Parameters are the configurable fields of a VSHNRedis.

writeConnectionSecretToRef LocalObjectReference

WriteConnectionSecretToRef references a secret to which the connection details will be written.

VSHNRedisTLSSpec

VSHNRedisTLSSpec contains settings to control tls traffic of a service.

Appears In:
Field Description

enabled boolean

TLSEnabled enables TLS traffic for the service

authClients boolean

TLSAuthClients enables client authentication requirement

XVSHNPostgreSQL

XVSHNPostgreSQL represents the internal composite of this claim

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNPostgreSQL

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a VSHNPostgreSQL.

XVSHNPostgreSQL

XVSHNPostgreSQL represents the internal composite of this claim

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNPostgreSQL

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a VSHNPostgreSQL.

XVSHNPostgreSQLList

XVSHNPostgreSQLList represents a list of composites

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNPostgreSQLList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items XVSHNPostgreSQL array