API Reference
This is a generated API documentation.
appcat.vshn.io/v1
Condition
Field | Description |
---|---|
|
Type of condition. |
|
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 is the last time the condition transitioned from one status to another. |
|
Reason contains a programmatic identifier indicating the reason for the condition’s last transition. |
|
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.
Field | Description |
---|---|
|
Name of the referent. More info: kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
NamespacedName
NamespacedName describes an object reference by its name and namespace
Field | Description |
---|---|
|
|
|
ObjectBucket
ObjectBucket is the API for creating S3 buckets.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
ObjectBucketParameters
ObjectBucketParameters are the configurable fields of a ObjectBucket.
Field | Description |
---|---|
|
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 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.
Field | Description |
---|---|
|
|
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
XObjectBucket
XObjectBucket represents the internal composite of this claim
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XObjectBucketSpec
XObjectBucketSpec defines the desired state of a ObjectBucket.
Field | Description |
---|---|
|
|
|
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 for doing daily backups, in UTC. Format: "hh:mm:ss". |
ExoscaleDBaaSMaintenanceScheduleSpec
Field | Description |
---|---|
|
DayOfWeek specifies at which weekday the maintenance is held place. Allowed values are [monday, tuesday, wednesday, thursday, friday, saturday, sunday, never] |
|
TimeOfDay for installing updates in UTC. Format: "hh:mm:ss". |
ExoscaleDBaaSNetworkSpec
Field | Description |
---|---|
|
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 |
ExoscaleDBaaSServiceSpec
Field | Description |
---|---|
|
Zone is the datacenter identifier in which the instance runs in. |
ExoscaleDBaaSSizeSpec
Field | Description |
---|---|
|
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 |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a ExoscaleKafka. |
ExoscaleKafkaDBaaSSizeSpec
Field | Description |
---|---|
|
Plan is the name of the resource plan that defines the compute resources. |
ExoscaleKafkaParameters
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 is the datacenter identifier in which the instance runs in. |
|
KafkaSettings contains additional Kafka settings. |
|
Version contains the minor version for Kafka. Currently only "3.4" is supported. Leave it empty to always get the latest supported version. |
ExoscaleKafkaSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a ExoscaleKafka. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
ExoscaleMySQL
ExoscaleMySQL is the API for creating MySQL on Exoscale.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a ExoscaleMySQL. |
ExoscaleMySQLParameters
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 is the datacenter identifier in which the instance runs in. |
|
MajorVersion contains the major version for MySQL. Currently only "8" is supported. Leave it empty to always get the latest supported version. |
|
MySQLSettings contains additional MySQL settings. |
ExoscaleMySQLSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a ExoscaleMySQL. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
ExoscaleOpenSearch
ExoscaleOpenSearch is the api for creating OpenSearch on Exoscale
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
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 is the datacenter identifier in which the instance runs in. |
|
MajorVersion contains the version for OpenSearch. Currently only "2" and "1" is supported. Leave it empty to always get the latest supported version. |
|
OpenSearchSettings contains additional OpenSearch settings. |
ExoscaleOpenSearchSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a ExoscaleOpenSearch. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
ExoscalePostgreSQL
ExoscalePostgreSQL is the API for creating PostgreSQL on Exoscale.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
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 is the datacenter identifier in which the instance runs in. |
|
MajorVersion contains the major version for PostgreSQL. Currently only "14" is supported. Leave it empty to always get the latest supported version. |
|
PGSettings contains additional PostgreSQL settings. |
ExoscalePostgreSQLSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a ExoscalePostgreSQL. |
|
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 |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a ExoscaleRedis. |
ExoscaleRedisParameters
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 is the datacenter identifier in which the instance runs in. |
|
RedisSettings contains additional Redis settings. |
ExoscaleRedisSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a ExoscaleRedis. |
|
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.
Field | Description |
---|---|
|
|
|
K8upRestoreSpec
K8upRestoreSpec contains restore specific parameters.
Field | Description |
---|---|
|
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 is the name of the specific backup you want to restore. |
K8upRetentionPolicy
K8upRetentionPolicy describes the retention configuration for a K8up backup.
Field | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
VSHNDBaaSMaintenanceScheduleSpec
VSHNDBaaSMaintenanceScheduleSpec contains settings to control the maintenance of an instance.
Field | Description |
---|---|
|
DayOfWeek specifies at which weekday the maintenance is held place. Allowed values are [monday, tuesday, wednesday, thursday, friday, saturday, sunday] |
|
TimeOfDay for installing updates in UTC. Format: "hh:mm:ss". |
VSHNDBaaSNetworkSpec
VSHNDBaaSNetworkSpec contains any network related settings.
Field | Description |
---|---|
|
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 |
|
ServiceType defines the type of the service. Possible enum values: - |
VSHNDBaaSPostgresExtension
VSHNDBaaSPostgresExtension contains the name of a single extension.
Field | Description |
---|---|
|
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 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.
Field | Description |
---|---|
|
CPU defines the amount of Kubernetes CPUs for an instance. |
|
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 defines the amount of Kubernetes CPUs for an instance. |
|
Memory defines the amount of memory in units of bytes for an instance. |
|
Requests defines CPU and memory requests for an instance |
|
Disk defines the amount of disk space for an instance. |
|
Plan is the name of the resource plan that defines the compute resources. |
VSHNPostgreSQLBackup
Field | Description |
---|---|
|
|
|
|
|
DeletionProtection will protect the instance from being deleted for the given retention time. This is enabled by default. |
|
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 specifies if the instance should use encrypted storage for the instance. |
VSHNPostgreSQLList
VSHNPostgreSQLList defines a list of VSHNPostgreSQL
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
VSHNPostgreSQLMonitoring
VSHNPostgreSQLMonitoring contains settings to configure monitoring aspects of PostgreSQL
Field | Description |
---|---|
|
AlertmanagerConfigRef contains the name of the AlertmanagerConfig that should be copied over to the namespace of the PostgreSQL instance. |
|
AlertmanagerConfigSecretRef contains the name of the secret that is used in the referenced AlertmanagerConfig |
|
AlertmanagerConfigSpecTemplate takes an AlertmanagerConfigSpec object. This takes precedence over the AlertmanagerConfigRef. |
|
Email necessary to send alerts via email |
VSHNPostgreSQLParameters
VSHNPostgreSQLParameters are the configurable fields of a VSHNPostgreSQL.
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 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 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 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 is the name of the specific backup you want to restore. |
|
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 contains supported version of PostgreSQL. Multiple versions are supported. The latest version "15" is the default version. |
|
PGSettings contains additional PostgreSQL settings. |
|
Extensions allow to enable/disable any of the supported |
|
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.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNPostgreSQL. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
|
ResourceRef contains a reference to the composite. |
|
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 indicates the type of the UpdateStrategy. Default is OnRestart. Possible enum values: - |
VSHNRedis
VSHNRedis is the API for creating Redis clusters.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a VSHNRedis. |
VSHNRedisList
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
VSHNRedisParameters
VSHNRedisParameters are the configurable fields of a VSHNRedis.
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 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
Field | Description |
---|---|
|
Version contains supported version of Redis. Multiple versions are supported. The latest version "7.0" is the default version. |
|
RedisSettings contains additional Redis settings. |
VSHNRedisSizeSpec
VSHNRedisSizeSpec contains settings to control the sizing of a service.
Field | Description |
---|---|
|
CPURequests defines the requests amount of Kubernetes CPUs for an instance. |
|
CPULimits defines the limits amount of Kubernetes CPUs for an instance. |
|
MemoryRequests defines the requests amount of memory in units of bytes for an instance. |
|
MemoryLimits defines the limits amount of memory in units of bytes for an instance. |
|
Disk defines the amount of disk space for an instance. |
|
Plan is the name of the resource plan that defines the compute resources. |
VSHNRedisSpec
VSHNRedisSpec defines the desired state of a VSHNRedis.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNRedis. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
VSHNRedisTLSSpec
VSHNRedisTLSSpec contains settings to control tls traffic of a service.
Field | Description |
---|---|
|
TLSEnabled enables TLS traffic for the service |
|
TLSAuthClients enables client authentication requirement |
XVSHNPostgreSQL
XVSHNPostgreSQL represents the internal composite of this claim
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a VSHNPostgreSQL. |
XVSHNPostgreSQL
XVSHNPostgreSQL represents the internal composite of this claim
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a VSHNPostgreSQL. |
XVSHNPostgreSQLList
XVSHNPostgreSQLList represents a list of composites
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|