API Reference

This is a generated API documentation.

appcat.vshn.io/v1

Resource Types

BucketDeletionPolicy (string)

BucketDeletionPolicy determines how buckets should be deleted when a Bucket is deleted.

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

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.

bucketDeletionPolicy BucketDeletionPolicy

BucketDeletionPolicy determines how buckets should be deleted when Bucket is deleted. DeleteIfEmpty only deletes the bucket if the bucket is empty. DeleteAll recursively deletes all objects in the bucket and then removes it.

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.

compositionRef CompositionReference

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 SecretReference

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

publishConnectionDetailsTo PublishConnectionDetailsTo

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

providerConfigRef Reference

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

managementPolicies ManagementPolicies

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

deletionPolicy DeletionPolicy

DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223

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.

Field Description

schedule string

K8upRestoreSpec

K8upRestoreSpec 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.

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.

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

VSHNDBaaSServiceLevel (string)

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.

VSHNKeycloak

VSHNKeycloak is the API for creating keycloak instances.

Appears In:
Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNKeycloak

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a VSHNKeycloak.

VSHNKeycloakCustomizationImage

Field Description

image string

Path to a valid image

imagePullSecretRef SecretReference

Reference to an imagePullSecret

VSHNKeycloakList

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNKeycloakList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNKeycloak array

VSHNKeycloakParameters

VSHNKeycloakParameters are the configurable fields of a VSHNKeycloak.

Field Description

Service contains keycloak 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.

VSHNKeycloakServiceSpec

VSHNKeycloakServiceSpec contains keycloak DBaaS specific properties

Field Description

fqdn string

FQDN contains the FQDN which will be used for the ingress. If it’s not set, no ingress will be deployed. This also enables strict hostname checking for this FQDN.

relativePath string

RelativePath on which Keycloak will listen.

version string

Version contains supported version of keycloak. Multiple versions are supported. The latest version 23 is the default version.

serviceLevel VSHNDBaaSServiceLevel

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

postgreSQLParameters VSHNPostgreSQLParameters

PostgreSQLParameters can be used to set any supported setting in the underlying PostgreSQL instance.

customizationImage VSHNKeycloakCustomizationImage

CustomizationImage can be used to provide an image with custom themes and providers. The themes need to be be placed in the /themes directory of the custom image. the providers need to be placed in the /providers directory of the custom image.

VSHNKeycloakSpec

VSHNKeycloakSpec defines the desired state of a VSHNKeycloak.

Appears In:
Field Description

Parameters are the configurable fields of a VSHNKeycloak.

writeConnectionSecretToRef LocalObjectReference

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

VSHNKeycloakStatus

VSHNKeycloakStatus reflects the observed state of a VSHNKeycloak.

Appears In:
Field Description

instanceNamespace string

InstanceNamespace contains the name of the namespace where the instance resides

schedules VSHNScheduleStatus

Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec.

VSHNKeycloakTLSSpec

VSHNKeycloakTLSSpec contains settings to control tls traffic of a service.

Field Description

enabled boolean

TLSEnabled enables TLS traffic for the service

authClients boolean

TLSAuthClients enables client authentication requirement

VSHNMariaDB

VSHNMariaDB is the API for creating MariaDB instances.

Appears In:
Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNMariaDB

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a VSHNMariaDB.

VSHNMariaDBList

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNMariaDBList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNMariaDB array

VSHNMariaDBParameters

VSHNMariaDBParameters are the configurable fields of a VSHNMariaDB.

Field Description

Service contains MariaDB 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.

storageClass string

StorageClass configures the storageClass to use for the PVC used by MariaDB.

Maintenance contains settings to control the maintenance of an instance.

VSHNMariaDBServiceSpec

VSHNMariaDBServiceSpec contains MariaDB DBaaS specific properties

Appears In:
Field Description

version string

Version contains supported version of MariaDB. Multiple versions are supported. The latest version "11.2" is the default version.

mariadbSettings string

MariadbSettings contains additional MariaDB settings.

serviceLevel VSHNDBaaSServiceLevel

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

VSHNMariaDBSpec

VSHNMariaDBSpec defines the desired state of a VSHNMariaDB.

Appears In:
Field Description

Parameters are the configurable fields of a VSHNMariaDB.

writeConnectionSecretToRef LocalObjectReference

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

VSHNMariaDBStatus

VSHNMariaDBStatus reflects the observed state of a VSHNMariaDB.

Appears In:
Field Description

namespaceConditions Condition array

selfSignedIssuerConditions Condition array

localCAConditions Condition array

caCertificateConditions Condition array

serverCertificateConditions Condition array

clientCertificateConditions Condition array

instanceNamespace string

InstanceNamespace contains the name of the namespace where the instance resides

schedules VSHNScheduleStatus

Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec.

VSHNMariaDBTLSSpec

VSHNMariaDBTLSSpec 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

VSHNMinio

VSHNMinio is the API for creating Minio instances.

Appears In:
Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNMinio

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a VSHNMinio.

VSHNMinioList

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNMinioList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNMinio array

VSHNMinioParameters

VSHNMinioParameters are the configurable fields of a VSHNMinio.

Field Description

Size contains settings to control the sizing 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.

instances integer

Instances configures the number of Minio instances for the cluster. Each instance contains one Minio server.

storageClass string

StorageClass configures the storageClass to use for the PVC used by MinIO.

Service contains the Minio specific configurations

Maintenance contains settings to control the maintenance of an instance.

VSHNMinioServiceSpec

VSHNMinioServiceSpec contains Redis DBaaS specific properties

Appears In:
Field Description

mode string

Mode configures the mode of MinIO. Valid values are "distributed" and "standalone".

VSHNMinioSpec

VSHNMinioSpec defines the desired state of a VSHNMinio.

Appears In:
Field Description

parameters VSHNMinioParameters

Parameters are the configurable fields of a VSHNMinio.

writeConnectionSecretToRef LocalObjectReference

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

VSHNMinioStatus

VSHNMinioStatus reflects the observed state of a VSHNMinio.

Appears In:
Field Description

namespaceConditions Condition array

MinioConditions contains the status conditions of the backing object.

instanceNamespace string

InstanceNamespace contains the name of the namespace where the instance resides

schedules VSHNScheduleStatus

Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec.

VSHNMonitoring

VSHNMonitoring contains settings to configure monitoring aspects of databases managed by VSHN

Field Description

alertmanagerConfigRef string

AlertmanagerConfigRef contains the name of the AlertmanagerConfig that should be copied over to the namespace of the 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

VSHNPostgreSQL

VSHNPostgreSQL is the API for creating Postgresql clusters.

Appears In:
Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNPostgreSQL

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

Spec defines the desired state of a VSHNPostgreSQL.

VSHNPostgreSQLEncryption (struct{Enabled bool "json:\"enabled,omitempty\""})

VSHNPostgreSQLEncryption contains storage encryption specific parameters

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 VSHNPostgreSQL array

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 VSHNMonitoring

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 (struct{Mode string "json:\"mode,omitempty\""})

VSHNPostgreSQLSpec

VSHNPostgreSQLSpec defines the desired state of a VSHNPostgreSQL.

Appears In:
Field Description

Parameters are the configurable fields of a VSHNPostgreSQL.

writeConnectionSecretToRef SecretReference

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

publishConnectionDetailsTo PublishConnectionDetailsTo

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

providerConfigRef Reference

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

managementPolicies ManagementPolicies

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

deletionPolicy DeletionPolicy

DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223

VSHNPostgreSQLStatus

VSHNPostgreSQLStatus reflects the observed state of a VSHNPostgreSQL.

Appears In:
Field Description

instanceNamespace string

InstanceNamespace contains the name of the namespace where the instance resides

postgresqlConditions Condition array

PostgreSQLConditions contains the status conditions of the backing object.

namespaceConditions Condition array

profileConditions Condition array

pgconfigConditions Condition array

pgclusterConditions Condition array

secretConditions Condition array

objectBucketConditions Condition array

objectBackupConfigConditions Condition array

networkPolicyConditions Condition array

localCAConditions Condition array

certificateConditions Condition array

isEOL boolean

IsEOL indicates if this instance is using an EOL version of PostgreSQL.

schedules VSHNScheduleStatus

Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec.

VSHNPostgreSQLUpdateStrategy (struct{Type string "json:\"type,omitempty\""})

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

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.

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.

monitoring VSHNMonitoring

Monitoring contains settings to control monitoring.

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.

serviceLevel VSHNDBaaSServiceLevel

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

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.

VSHNRedisStatus

VSHNRedisStatus reflects the observed state of a VSHNRedis.

Appears In:
Field Description

namespaceConditions Condition array

RedisConditions contains the status conditions of the backing object.

selfSignedIssuerConditions Condition array

localCAConditions Condition array

caCertificateConditions Condition array

serverCertificateConditions Condition array

clientCertificateConditions Condition array

instanceNamespace string

InstanceNamespace contains the name of the namespace where the instance resides

schedules VSHNScheduleStatus

Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec.

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

VSHNScheduleStatus

Field Description

Maintenance keeps track of the maintenance schedule.

backup string

Backup keeps track of the backup schedule.

VSHNSizeSpec

VSHNSizeSpec 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.

XVSHNKeycloak

XVSHNKeycloak represents the internal composite of this claim

Appears In:
Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNKeycloak

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

XVSHNKeycloakList

XVSHNKeycloakList represents a list of composites

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNKeycloakList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items XVSHNKeycloak array

XVSHNKeycloakSpec

XVSHNKeycloakSpec defines the desired state of a VSHNKeycloak.

Appears In:
Field Description

Parameters are the configurable fields of a VSHNKeycloak.

writeConnectionSecretToRef SecretReference

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

publishConnectionDetailsTo PublishConnectionDetailsTo

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

providerConfigRef Reference

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

managementPolicies ManagementPolicies

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

deletionPolicy DeletionPolicy

DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223

XVSHNMariaDB

XVSHNMariaDB represents the internal composite of this claim

Appears In:
Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNMariaDB

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

XVSHNMariaDBList

XVSHNMariaDBList represents a list of composites

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNMariaDBList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items XVSHNMariaDB array

XVSHNMariaDBSpec

XVSHNMariaDBSpec defines the desired state of a VSHNMariaDB.

Appears In:
Field Description

Parameters are the configurable fields of a VSHNMariaDB.

writeConnectionSecretToRef SecretReference

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

publishConnectionDetailsTo PublishConnectionDetailsTo

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

providerConfigRef Reference

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

managementPolicies ManagementPolicies

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

deletionPolicy DeletionPolicy

DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223

XVSHNMinio

XVSHNMinios represents the internal composite of this claim

Appears In:
Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNMinio

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

XVSHNMinioList

XVSHNMiniosList represents a list of composites

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNMinioList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items XVSHNMinio array

XVSHNMinioSpec

XVSHNMinioSpec defines the desired state of a VSHNMinio.

Appears In:
Field Description

parameters VSHNMinioParameters

Parameters are the configurable fields of a VSHNMinio.

writeConnectionSecretToRef SecretReference

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

publishConnectionDetailsTo PublishConnectionDetailsTo

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

providerConfigRef Reference

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

managementPolicies ManagementPolicies

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

deletionPolicy DeletionPolicy

DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223

XVSHNPostgreSQL

XVSHNPostgreSQL represents the internal composite of this claim

Appears In:
Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNPostgreSQL

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

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

XVSHNPostgreSQLSpec

Appears In:
Field Description

Parameters are the configurable fields of a VSHNPostgreSQL.

writeConnectionSecretToRef SecretReference

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

publishConnectionDetailsTo PublishConnectionDetailsTo

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

providerConfigRef Reference

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

managementPolicies ManagementPolicies

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

deletionPolicy DeletionPolicy

DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223

XVSHNRedis

XVSHNRedis represents the internal composite of this claim

Appears In:
Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNRedis

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

XVSHNRedisList

XVSHNRedisList represents a list of composites

Field Description

apiVersion string

vshn.appcat.vshn.io/v1

kind string

XVSHNRedisList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items XVSHNRedis array

XVSHNRedisSpec

XVSHNRedisSpec defines the desired state of a VSHNRedis.

Appears In:
Field Description

parameters VSHNRedisParameters

Parameters are the configurable fields of a VSHNRedis.

writeConnectionSecretToRef SecretReference

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

publishConnectionDetailsTo PublishConnectionDetailsTo

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

providerConfigRef Reference

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

managementPolicies ManagementPolicies

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

deletionPolicy DeletionPolicy

DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223