API Reference

apiVersion string

appcat.vshn.io/v1

kind string

ObjectBucket

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ObjectBucketSpec

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.

security Security

Security defines the security of a service

parameters ObjectBucketParameters

writeConnectionSecretToRef LocalObjectReference

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

compositionRef CompositionReference

apiVersion string

appcat.vshn.io/v1

kind string

XObjectBucket

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec XObjectBucketSpec

parameters ObjectBucketParameters

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

timeOfDay string

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

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

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.

zone string

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

plan string

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

apiVersion string

exoscale.appcat.vshn.io/v1

kind string

ExoscaleKafka

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ExoscaleKafkaSpec

Spec defines the desired state of a ExoscaleKafka.

plan string

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

service ExoscaleKafkaServiceSpec

Service contains Exoscale Kafka DBaaS specific properties

maintenance ExoscaleDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

size ExoscaleKafkaDBaaSSizeSpec

Size contains settings to control the sizing of a service.

network ExoscaleDBaaSNetworkSpec

Network contains any network related settings.

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.8" is supported. Leave it empty to always get the latest supported version.

parameters ExoscaleKafkaParameters

Parameters are the configurable fields of a ExoscaleKafka.

writeConnectionSecretToRef LocalObjectReference

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

apiVersion string

exoscale.appcat.vshn.io/v1

kind string

ExoscaleMySQL

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ExoscaleMySQLSpec

Spec defines the desired state of a ExoscaleMySQL.

service ExoscaleMySQLServiceSpec

Service contains Exoscale MySQL DBaaS specific properties

maintenance ExoscaleDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

size ExoscaleDBaaSSizeSpec

Size contains settings to control the sizing of a service.

network ExoscaleDBaaSNetworkSpec

Network contains any network related settings.

backup ExoscaleDBaaSBackupSpec

Backup contains settings to control the backups of an instance.

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.

parameters ExoscaleMySQLParameters

Parameters are the configurable fields of a ExoscaleMySQL.

writeConnectionSecretToRef LocalObjectReference

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

apiVersion string

exoscale.appcat.vshn.io/v1

kind string

ExoscaleOpenSearch

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ExoscaleOpenSearchSpec

Spec defines the desired state of an ExoscaleOpenSearch

service ExoscaleOpenSearchServiceSpec

Service contains Exoscale OpenSearch DBaaS specific properties

maintenance ExoscaleDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

size ExoscaleDBaaSSizeSpec

Size contains settings to control the sizing of a service.

network ExoscaleDBaaSNetworkSpec

Network contains any network related settings.

backup ExoscaleDBaaSBackupSpec

Backup contains settings to control the backups of an instance.

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.

parameters ExoscaleOpenSearchParameters

Parameters are the configurable fields of a ExoscaleOpenSearch.

writeConnectionSecretToRef LocalObjectReference

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

apiVersion string

exoscale.appcat.vshn.io/v1

kind string

ExoscalePostgreSQL

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ExoscalePostgreSQLSpec

Spec defines the desired state of a ExoscalePostgreSQL.

service ExoscalePostgreSQLServiceSpec

Service contains Exoscale PostgreSQL DBaaS specific properties

maintenance ExoscaleDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

size ExoscaleDBaaSSizeSpec

Size contains settings to control the sizing of a service.

network ExoscaleDBaaSNetworkSpec

Network contains any network related settings.

backup ExoscaleDBaaSBackupSpec

Backup contains settings to control the backups of an instance.

zone string

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

majorVersion string

MajorVersion contains the major version for PostgreSQL. Leave it empty to always get the latest supported version.

pgSettings RawExtension

PGSettings contains additional PostgreSQL settings.

parameters ExoscalePostgreSQLParameters

Parameters are the configurable fields of a ExoscalePostgreSQL.

writeConnectionSecretToRef LocalObjectReference

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

apiVersion string

exoscale.appcat.vshn.io/v1

kind string

ExoscaleRedis

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ExoscaleRedisSpec

Spec defines the desired state of a ExoscaleRedis.

service ExoscaleRedisServiceSpec

Service contains Exoscale Redis DBaaS specific properties

maintenance ExoscaleDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

size ExoscaleDBaaSSizeSpec

Size contains settings to control the sizing of a service.

network ExoscaleDBaaSNetworkSpec

Network contains any network related settings.

zone string

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

redisSettings RawExtension

RedisSettings contains additional Redis settings.

parameters ExoscaleRedisParameters

Parameters are the configurable fields of a ExoscaleRedis.

writeConnectionSecretToRef LocalObjectReference

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

enabled boolean

Enabled enables the Collabora integration. It will autoconfigure the Collabora server URL in Your Nextcloud instance.

fqdn string

FQDN contains the FQDN of the Collabora server. This is used to configure the Collabora server URL in Your Nextcloud instance.

version string

Version defines the Collabora version to use.

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.

schedule string

retention K8upRetentionPolicy

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.

keepLast integer

keepHourly integer

keepDaily integer

keepWeekly integer

keepMonthly integer

keepYearly integer

name string

Name of the referent. More info: kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace string

allowAllNamespaces boolean

AllowAllNamespaces allows the service to be accessible from all namespaces, this supersedes the AllowedNamespaces field

allowedNamespaces string array

AllowedNamespaces defines a list of namespaces from where the service can be reached in the claim namespace

deletionProtection boolean

DeletionProtection blocks the deletion of the instance if it is enabled (enabled by default)

allowedGroups string array

AllowedGroups defines a list of Groups that have limited access to the instance namespace

allowedUsers string array

AllowedUsers defines a list of Users that have limited access to instance namespace.

user string

User specifies the username. If all other fields are left empty then a new database with the same name and all permissions will be created.

database string

Database is the name of the database to create, defaults to user.

privileges string array

Privileges specifies the privileges to grant the user. Please check the database’s docs for available privileges.

writeConnectionSecretToRef SecretReference

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this user should be written. If not specified, a secret with the name $claimname-$username will be created in the namespace where the claim is located.

name string

Name is the exact name of the Secret or ConfigMap in the claim namespace.

type string

Type must be either "secret" or "configMap".

dayOfWeek string

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

timeOfDay TimeOfDay

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

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.

name string

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

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

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.

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNForgejo

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec VSHNForgejoSpec

Spec defines the desired state of a VSHNForgejo.

actions object (keys:string, values:string)

forgejo.org/docs/latest/admin/config-cheat-sheet/#actions-actions

openid object (keys:string, values:string)

forgejo.org/docs/latest/admin/config-cheat-sheet/#openid-openid

service object (keys:string, values:string)

forgejo.org/docs/latest/admin/config-cheat-sheet/#service-service

service.explore object (keys:string, values:string)

forgejo.org/docs/latest/admin/config-cheat-sheet/#service---explore-serviceexplore

mailer object (keys:string, values:string)

forgejo.org/docs/latest/admin/config-cheat-sheet/#mailer-mailer

email.incoming object (keys:string, values:string)

forgejo.org/docs/latest/admin/config-cheat-sheet/#incoming-email-emailincoming

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNForgejoList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNForgejo array

service VSHNForgejoServiceSpec

Service contains Forgejo DBaaS specific properties

size VSHNSizeSpec

Size contains settings to control the sizing of a service.

scheduling VSHNDBaaSSchedulingSpec

Scheduling contains settings to control the scheduling of an instance.

backup K8upBackupSpec

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

maintenance VSHNDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

security Security

Security contains settings to control the security of a service.

monitoring VSHNMonitoring

Monitoring contains settings to control the monitoring of a service.

instances integer

Instances defines the number of instances to run.

adminEmail string

AdminEmail contains the email address of the admin user.

forgejoSettings VSHNForgejoSettings

ForgejoSettings contains user-customizable configuration for Forgejo. Refer to forgejo.org/docs/latest/admin/config-cheat-sheet.

fqdn string array

FQDN contains the FQDNs array, 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.

serviceLevel VSHNDBaaSServiceLevel

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

majorVersion string

Version contains supported version of Forgejo. Multiple versions are supported. Defaults to 11.0.0 if not set.

APP_NAME string

AppName is the application name, used in the page title

config VSHNForgejoConfig

Config contains settings to customize the Forgejo instance with. Not all sections are supported. Invalid fields are ignored by Forgejo.

parameters VSHNForgejoParameters

Parameters are the configurable fields of a VSHNForgejo.

writeConnectionSecretToRef LocalObjectReference

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

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.

conditions Condition array

Conditions of the resource.

observedGeneration integer

ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNKeycloak

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec VSHNKeycloakSpec

Spec defines the desired state of a VSHNKeycloak.

source string

Source file from the customization image

destination string

Destination file in the keycloak instance. The path is relative to /opt/keycloak/.

image string

Path to a valid image

imagePullSecretRef SecretReference

Reference to an imagePullSecret

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNKeycloakList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNKeycloak array

service VSHNKeycloakServiceSpec

Service contains keycloak DBaaS specific properties

size VSHNSizeSpec

Size contains settings to control the sizing of a service.

scheduling VSHNDBaaSSchedulingSpec

Scheduling contains settings to control the scheduling of an instance.

tls VSHNKeycloakTLSSpec

TLS contains settings to control tls traffic of a service.

backup K8upBackupSpec

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

restore VSHNPostgreSQLRestore

Restore contains settings to control the restore of an instance.

maintenance VSHNDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

monitoring VSHNMonitoring

Monitoring contains settings to control monitoring.

security Security

Security defines the security of a service

instances integer

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

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. Default version is 26.

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, providers and other files. Themes and providers are automatically copied and need to be placed in '/themes' and '/providers' respectively. Other custom data will be copied according to the customFiles field.

customFiles VSHNKeycloakCustomFile array

CustomFiles can be used to load custom files or folders into the keycloak instance. The source path will be copied into keycloak using 'cp -R'.

customConfigurationRef string

CustomConfigurationRef can be used to provide a configmap containing configurations for the keycloak instance. The config is a JSON file based on the keycloak export files. The referenced configmap, must have the configuration in a field called keycloak-config.json

customEnvVariablesRef string

CustomEnvVariablesRef can be used to provide custom environment variables from a Secret for the keycloak instance. This field is deprecated, use 'envFrom' instead.

envFrom EnvFromSource

EnvFrom can be used to provide custom environment variables from either a ConfigMap or a Secret for the keycloak instance. The environment variables provided can for example be used in the custom JSON configuration provided in the Configuration field with $(env:<ENV_VAR_NAME>:-<some_default_value>)

customMounts VSHNCustomMount array

CustomMounts is a list of Secrets/ConfigMaps that get observed and copied into the Keycloak instance namespace. Once copied, they will be mounted under /custom/secrets/<name> or /custom/configs/<name>.

parameters VSHNKeycloakParameters

Parameters are the configurable fields of a VSHNKeycloak.

resourceRef TypedReference

ResourceRef tracks the internal composite belonging to this claim

writeConnectionSecretToRef LocalObjectReference

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

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.

conditions Condition array

Conditions of the resource.

observedGeneration integer

ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.

lastConfigHash string

LastConfigHash is the hash of last applied customConfigurationRef.

lastEnvHash string

LastEnvHash is the hash of last applied customEnvVariablesRef.

enabled boolean

TLSEnabled enables TLS traffic for the service

authClients boolean

TLSAuthClients enables client authentication requirement

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNMariaDB

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec VSHNMariaDBSpec

Spec defines the desired state of a VSHNMariaDB.

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNMariaDBList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNMariaDB array

service VSHNMariaDBServiceSpec

Service contains MariaDB DBaaS specific properties

size VSHNSizeSpec

Size contains settings to control the sizing of a service.

scheduling VSHNDBaaSSchedulingSpec

Scheduling contains settings to control the scheduling of an instance.

tls VSHNMariaDBTLSSpec

TLS contains settings to control tls traffic of a service.

backup K8upBackupSpec

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 VSHNDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

monitoring VSHNMonitoring

Monitoring contains settings to control monitoring.

network VSHNDBaaSNetworkSpec

Network contains any network related settings.

security Security

Security defines the security of a service

instances integer

Instances configures the number of MariaDB instances for the cluster. Each instance contains one MariaDB server. These serves will form a Galera cluster. An additional ProxySQL statefulset will be deployed to make failovers as seamless as possible.

version string

Version contains supported version of MariaDB. Multiple versions are supported. The latest version "11.5" 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.

access VSHNAccess array

Access defines additional users and databases for this instance.

parameters VSHNMariaDBParameters

Parameters are the configurable fields of a VSHNMariaDB.

writeConnectionSecretToRef LocalObjectReference

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

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.

currentInstances integer

CurrentInstances tracks the current amount of instances. Mainly used to detect if there was a change in instances

conditions Condition array

Conditions of the resource.

observedGeneration integer

ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.

enabled boolean

TLSEnabled enables TLS traffic for the service

authClients boolean

TLSAuthClients enables client authentication requirement

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNMinio

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec VSHNMinioSpec

Spec defines the desired state of a VSHNMinio.

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNMinioList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNMinio array

size VSHNSizeSpec

Size contains settings to control the sizing of a service.

backup K8upBackupSpec

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 VSHNMinioServiceSpec

Service contains the Minio specific configurations

maintenance VSHNDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

monitoring VSHNMonitoring

Monitoring contains settings to control monitoring.

security Security

Security defines the security of a service

mode string

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

parameters VSHNMinioParameters

Parameters are the configurable fields of a VSHNMinio.

writeConnectionSecretToRef LocalObjectReference

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

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.

conditions Condition array

Conditions of the resource.

observedGeneration integer

ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.

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

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNNextcloud

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec VSHNNextcloudSpec

Spec defines the desired state of a VSHNNextcloud.

schedule string

retention K8upRetentionPolicy

skipMaintenance boolean

SkipMaintenance defines, if setting maintenance mode should be skipped during the backup. Defaults to false Warning: If this is set to true, the maintenance mode will not be enabled during the backup. This might lead to inconsistent backups.

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNNextcloudList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNNextcloud array

service VSHNNextcloudServiceSpec

Service contains nextcloud DBaaS specific properties

size VSHNSizeSpec

Size contains settings to control the sizing of a service.

scheduling VSHNDBaaSSchedulingSpec

Scheduling contains settings to control the scheduling of an instance.

backup VSHNNextcloudBackupSpec

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 VSHNDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

monitoring VSHNMonitoring

Monitoring contains settings to control monitoring.

security Security

Security defines the security of a service

instances integer

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

collabora CollaboraSpec

Collabora contains settings to control the Collabora integration.

fqdn string array

FQDN contains the FQDNs array, 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 Nextcloud will listen.

version string

Version contains supported version of nextcloud. Multiple versions are supported. The latest version 30 is the default version.

serviceLevel VSHNDBaaSServiceLevel

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

useExternalPostgreSQL boolean

UseExternalPostgreSQL defines if the VSHNPostgreSQL database backend should be used. Defaults to true. If set to false, the build-in SQLite database is being used.

existingPGConnectionSecret string

ExistingPGConnectionSecret uses a connection secret from an existing VSHNPostgreSQL instance. It is recommended to use a custom user with a separate database from vshnpostgresql.spec.service.access. This parameter will take precedence over PostgreSQLParameters Changing databases for an existing Nextcloud instance can corrupt the service.

postgreSQLParameters VSHNPostgreSQLParameters

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

parameters VSHNNextcloudParameters

Parameters are the configurable fields of a VSHNNextcloud.

resourceRef TypedReference

ResourceRef tracks the internal composite belonging to this claim

writeConnectionSecretToRef LocalObjectReference

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

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.

conditions Condition array

Conditions of the resource.

observedGeneration integer

ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNPostgreSQL

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec VSHNPostgreSQLSpec

Spec defines the desired state of a VSHNPostgreSQL.

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.

enabled boolean

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

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNPostgreSQLList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNPostgreSQL array

service VSHNPostgreSQLServiceSpec

Service contains PostgreSQL DBaaS specific properties

maintenance VSHNDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

size VSHNSizeSpec

Size contains settings to control the sizing of a service.

scheduling VSHNDBaaSSchedulingSpec

Scheduling contains settings to control the scheduling of an instance.

network VSHNDBaaSNetworkSpec

Network contains any network related settings.

backup VSHNPostgreSQLBackup

Backup contains settings to control the backups of an instance.

restore VSHNPostgreSQLRestore

Restore contains settings to control the restore of an instance.

monitoring VSHNMonitoring

Monitoring contains settings to control monitoring.

encryption VSHNPostgreSQLEncryption

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

updateStrategy VSHNPostgreSQLUpdateStrategy

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.

replication VSHNPostgreSQLReplicationStrategy

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.

security Security

Security defines the security of a service

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.

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.

claimType string

ClaimType specifies the type of the instance you want to restore from.

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.

majorVersion string

MajorVersion contains supported version of PostgreSQL. Multiple versions are supported. The latest version "15" is the default version. Currently it’s impossible to change the version of an existing instance - we’re working on it.

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.

pgBouncerSettings SGPoolingConfigSpecPgBouncerPgbouncerIni

PgBouncerSettings passes additional configuration to the pgBouncer instance.

disablePgBouncer boolean

Disable connection pooling service PgBouncer. All connections will go straight to PostgreSQL instance.

repackEnabled boolean

This is default option if neither repack or vacuum are selected

vacuumEnabled boolean

access VSHNAccess array

Access defines additional users and databases for this instance.

tls VSHNPostgreSQLTLS

TLS settings for the instance.

parameters VSHNPostgreSQLParameters

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

instanceNamespace string

InstanceNamespace contains the name of the namespace where the instance resides

currentVersion string

CurrentVersion contains the current version of PostgreSQL.

previousVersion string

PreviousVersion contains the previous version of PostgreSQL.

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.

conditions Condition array

Conditions of the resource.

observedGeneration integer

ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.

enabled boolean

Enabled specifies if the instance should use TLS for the instance. This change takes effect immediately and does not require a restart of the database.

type string

Type indicates the type of the UpdateStrategy. Default is Immediate. 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.

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNRedis

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec VSHNRedisSpec

Spec defines the desired state of a VSHNRedis.

apiVersion string

vshn.appcat.vshn.io/v1

kind string

VSHNRedisList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items VSHNRedis array

service VSHNRedisServiceSpec

Service contains Redis DBaaS specific properties

size VSHNRedisSizeSpec

Size contains settings to control the sizing of a service.

scheduling VSHNDBaaSSchedulingSpec

Scheduling contains settings to control the scheduling of an instance.

tls VSHNRedisTLSSpec

TLS contains settings to control tls traffic of a service.

backup K8upBackupSpec

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 VSHNDBaaSMaintenanceScheduleSpec

Maintenance contains settings to control the maintenance of an instance.

monitoring VSHNMonitoring

Monitoring contains settings to control monitoring.

security Security

Security defines the security of a service

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.

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.

parameters VSHNRedisParameters

Parameters are the configurable fields of a VSHNRedis.

writeConnectionSecretToRef LocalObjectReference

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

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.

conditions Condition array

Conditions of the resource.

observedGeneration integer

ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.

enabled boolean

TLSEnabled enables TLS traffic for the service

authClients boolean

TLSAuthClients enables client authentication requirement

maintenance VSHNDBaaSMaintenanceScheduleSpec

Maintenance keeps track of the maintenance schedule.

backup string

Backup keeps track of the backup schedule.

conditions Condition array

Conditions of the resource.

observedGeneration integer

ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.