API Reference
This is a generated API documentation.
appcat.vshn.io/v1
BucketDeletionPolicy (string)
BucketDeletionPolicy determines how buckets should be deleted when a Bucket is deleted.
ObjectBucket
ObjectBucket is the API for creating S3 buckets.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
ObjectBucketParameters
ObjectBucketParameters are the configurable fields of a ObjectBucket.
Field | Description |
---|---|
|
BucketName is the name of the bucket to create. Cannot be changed after bucket is created. Name must be acceptable by the S3 protocol, which follows RFC 1123. Be aware that S3 providers may require a unique name across the platform or region. |
|
Region is the name of the region where the bucket shall be created. The region must be available in the S3 endpoint. |
|
BucketDeletionPolicy determines how buckets should be deleted when Bucket is deleted.
|
|
Security defines the security of a service |
ObjectBucketSpec
ObjectBucketSpec defines the desired state of a ObjectBucket.
Field | Description |
---|---|
|
|
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
|
XObjectBucket
XObjectBucket represents the internal composite of this claim
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XObjectBucketSpec
XObjectBucketSpec defines the desired state of a ObjectBucket.
Field | Description |
---|---|
|
|
|
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 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. |
|
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured. |
|
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 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 for doing daily backups, in UTC. Format: "hh:mm:ss". |
ExoscaleDBaaSMaintenanceScheduleSpec
Field | Description |
---|---|
|
DayOfWeek specifies at which weekday the maintenance is held place. Allowed values are [monday, tuesday, wednesday, thursday, friday, saturday, sunday, never] |
|
TimeOfDay for installing updates in UTC. Format: "hh:mm:ss". |
ExoscaleDBaaSNetworkSpec
Field | Description |
---|---|
|
IPFilter is a list of allowed IPv4 CIDR ranges that can access the service.
If no IP Filter is set, you may not be able to reach the service.
A value of |
ExoscaleDBaaSServiceSpec
Field | Description |
---|---|
|
Zone is the datacenter identifier in which the instance runs in. |
ExoscaleDBaaSSizeSpec
Field | Description |
---|---|
|
Plan is the name of the resource plan that defines the compute resources. |
ExoscaleKafka
ExoscaleKafka is the API for creating Kafka instances on Exoscale.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a ExoscaleKafka. |
ExoscaleKafkaDBaaSSizeSpec
Field | Description |
---|---|
|
Plan is the name of the resource plan that defines the compute resources. |
ExoscaleKafkaParameters
Field | Description |
---|---|
|
Service contains Exoscale Kafka DBaaS specific properties |
|
Maintenance contains settings to control the maintenance of an instance. |
Size contains settings to control the sizing of a service. |
|
|
Network contains any network related settings. |
ExoscaleKafkaServiceSpec
Field | Description |
---|---|
|
Zone is the datacenter identifier in which the instance runs in. |
|
KafkaSettings contains additional Kafka settings. |
|
Version contains the minor version for Kafka. Currently only "3.8" is supported. Leave it empty to always get the latest supported version. |
ExoscaleKafkaSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a ExoscaleKafka. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
ExoscaleMySQL
ExoscaleMySQL is the API for creating MySQL on Exoscale.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a ExoscaleMySQL. |
ExoscaleMySQLParameters
Field | Description |
---|---|
|
Service contains Exoscale MySQL DBaaS specific properties |
|
Maintenance contains settings to control the maintenance of an instance. |
Size contains settings to control the sizing of a service. |
|
|
Network contains any network related settings. |
|
Backup contains settings to control the backups of an instance. |
ExoscaleMySQLServiceSpec
Field | Description |
---|---|
|
Zone is the datacenter identifier in which the instance runs in. |
|
MajorVersion contains the major version for MySQL. Currently only "8" is supported. Leave it empty to always get the latest supported version. |
|
MySQLSettings contains additional MySQL settings. |
ExoscaleMySQLSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a ExoscaleMySQL. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
ExoscaleOpenSearch
ExoscaleOpenSearch is the api for creating OpenSearch on Exoscale
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
Spec defines the desired state of an ExoscaleOpenSearch |
ExoscaleOpenSearchParameters
Field | Description |
---|---|
|
Service contains Exoscale OpenSearch DBaaS specific properties |
|
Maintenance contains settings to control the maintenance of an instance. |
Size contains settings to control the sizing of a service. |
|
|
Network contains any network related settings. |
|
Backup contains settings to control the backups of an instance. |
ExoscaleOpenSearchServiceSpec
Field | Description |
---|---|
|
Zone is the datacenter identifier in which the instance runs in. |
|
MajorVersion contains the version for OpenSearch. Currently only "2" and "1" is supported. Leave it empty to always get the latest supported version. |
|
OpenSearchSettings contains additional OpenSearch settings. |
ExoscaleOpenSearchSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a ExoscaleOpenSearch. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
ExoscalePostgreSQL
ExoscalePostgreSQL is the API for creating PostgreSQL on Exoscale.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
Spec defines the desired state of a ExoscalePostgreSQL. |
ExoscalePostgreSQLParameters
Field | Description |
---|---|
|
Service contains Exoscale PostgreSQL DBaaS specific properties |
|
Maintenance contains settings to control the maintenance of an instance. |
Size contains settings to control the sizing of a service. |
|
|
Network contains any network related settings. |
|
Backup contains settings to control the backups of an instance. |
ExoscalePostgreSQLServiceSpec
Field | Description |
---|---|
|
Zone is the datacenter identifier in which the instance runs in. |
|
MajorVersion contains the major version for PostgreSQL. Leave it empty to always get the latest supported version. |
|
PGSettings contains additional PostgreSQL settings. |
ExoscalePostgreSQLSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a ExoscalePostgreSQL. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
ExoscaleRedis
ExoscaleRedis is the API for creating Redis instances on Exoscale.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a ExoscaleRedis. |
ExoscaleRedisParameters
Field | Description |
---|---|
|
Service contains Exoscale Redis DBaaS specific properties |
|
Maintenance contains settings to control the maintenance of an instance. |
Size contains settings to control the sizing of a service. |
|
|
Network contains any network related settings. |
ExoscaleRedisServiceSpec
Field | Description |
---|---|
|
Zone is the datacenter identifier in which the instance runs in. |
|
RedisSettings contains additional Redis settings. |
ExoscaleRedisSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a ExoscaleRedis. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
VSHN Reference
This is a generated API documentation.
vshn.appcat.vshn.io/v1
CollaboraSpec
CollaboraSpec defines the desired state of a Collabora instance.
Field | Description |
---|---|
|
Enabled enables the Collabora integration. It will autoconfigure the Collabora server URL in Your Nextcloud instance. |
|
FQDN contains the FQDN of the Collabora server. This is used to configure the Collabora server URL in Your Nextcloud instance. |
|
Version defines the Collabora version to use. |
Condition
Field | Description |
---|---|
|
Type of condition. |
|
ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
|
LastTransitionTime is the last time the condition transitioned from one status to another. |
|
Reason contains a programmatic identifier indicating the reason for the condition’s last transition. |
|
Message is a human-readable message indicating details about the transition. |
K8upBackupSpec
K8upBackupSpec specifies when a backup for redis should be triggered. It also contains the retention policy for the backup.
Field | Description |
---|---|
|
|
|
K8upRestoreSpec
K8upRestoreSpec contains restore specific parameters.
Field | Description |
---|---|
|
ClaimName specifies the name of the instance you want to restore from. The claim has to be in the same namespace as this new instance. |
|
BackupName is the name of the specific backup you want to restore. |
K8upRetentionPolicy
K8upRetentionPolicy describes the retention configuration for a K8up backup.
Field | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
LocalObjectReference
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Field | Description |
---|---|
|
Name of the referent. More info: kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
Security
Security defines the security of a service
Field | Description |
---|---|
|
AllowAllNamespaces allows the service to be accessible from all namespaces, this supersedes the AllowedNamespaces field |
|
AllowedNamespaces defines a list of namespaces from where the service can be reached in the claim namespace |
|
DeletionProtection blocks the deletion of the instance if it is enabled (enabled by default) |
|
AllowedGroups defines a list of Groups that have limited access to the instance namespace |
|
AllowedUsers defines a list of Users that have limited access to instance namespace. |
VSHNAccess
Field | Description |
---|---|
|
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 is the name of the database to create, defaults to user. |
|
Privileges specifies the privileges to grant the user. Please check the database’s docs for available privileges. |
|
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. |
VSHNCustomMount
VSHNCustomMount defines a Secret or ConfigMap that will be copied into the Keycloak namespace and mounted into the Keycloak pod.
Field | Description |
---|---|
|
Name is the exact name of the Secret or ConfigMap in the claim namespace. |
|
Type must be either "secret" or "configMap". |
VSHNDBaaSMaintenanceScheduleSpec
VSHNDBaaSMaintenanceScheduleSpec contains settings to control the maintenance of an instance.
Field | Description |
---|---|
|
DayOfWeek specifies at which weekday the maintenance is held place. Allowed values are [monday, tuesday, wednesday, thursday, friday, saturday, sunday] |
|
TimeOfDay for installing updates in UTC. Format: "hh:mm:ss". |
VSHNDBaaSNetworkSpec
VSHNDBaaSNetworkSpec contains any network related settings.
Field | Description |
---|---|
|
IPFilter is a list of allowed IPv4 CIDR ranges that can access the service.
If no IP Filter is set, you may not be able to reach the service.
A value of |
|
ServiceType defines the type of the service.
Possible enum values:
- |
VSHNDBaaSPostgresExtension
VSHNDBaaSPostgresExtension contains the name of a single extension.
Field | Description |
---|---|
|
Name is the name of the extension to enable. For an extensive list, please consult stackgres.io/doc/latest/intro/extensions/ |
VSHNDBaaSSchedulingSpec
VSHNDBaaSSchedulingSpec contains settings to control the scheduling of an instance.
Field | Description |
---|---|
|
NodeSelector is a selector which must match a node’s labels for the pod to be scheduled on that node |
VSHNDBaaSSizeRequestsSpec
VSHNDBaaSSizeRequestsSpec contains settings to control the resoure requests of a service.
Field | Description |
---|---|
|
CPU defines the amount of Kubernetes CPUs for an instance. |
|
Memory defines the amount of memory in units of bytes for an instance. |
VSHNForgejo
VSHNForgejo is the API for creating Forgejo instances.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a VSHNForgejo. |
VSHNForgejoConfig
Field | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
VSHNForgejoList
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
VSHNForgejoParameters
VSHNForgejoParameters are the configurable fields of a VSHNForgejo.
Field | Description |
---|---|
|
Service contains Forgejo DBaaS specific properties |
|
Size contains settings to control the sizing of a service. |
|
Scheduling contains settings to control the scheduling of an instance. |
|
Backup contains settings to control how the instance should get backed up. |
|
Maintenance contains settings to control the maintenance of an instance. |
|
Security contains settings to control the security of a service. |
|
Monitoring contains settings to control the monitoring of a service. |
|
Instances defines the number of instances to run. |
VSHNForgejoServiceSpec
VSHNForgejoServiceSpec contains Forgejo DBaaS specific properties
Field | Description |
---|---|
|
AdminEmail contains the email address of the admin user. |
|
ForgejoSettings contains user-customizable configuration for Forgejo. Refer to forgejo.org/docs/latest/admin/config-cheat-sheet. |
|
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 defines the service level of this service. Either Best Effort or Guaranteed Availability is allowed. |
|
Version contains supported version of Forgejo. Multiple versions are supported. Defaults to 11.0.0 if not set. |
VSHNForgejoSettings
VSHNForgejoSettings contains user-customizable configurations for Forgejo
Field | Description |
---|---|
|
AppName is the application name, used in the page title |
|
Config contains settings to customize the Forgejo instance with. Not all sections are supported. Invalid fields are ignored by Forgejo. |
VSHNForgejoSpec
VSHNForgejoSpec defines the desired state of a VSHNForgejo.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNForgejo. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
VSHNForgejoStatus
VSHNForgejoStatus reflects the observed state of a VSHNForgejo.
Field | Description |
---|---|
|
InstanceNamespace contains the name of the namespace where the instance resides |
|
Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec. |
|
Conditions of the resource. |
|
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. |
VSHNKeycloak
VSHNKeycloak is the API for creating keycloak instances.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a VSHNKeycloak. |
VSHNKeycloakCustomFile
VSHNKeycloakCustomFile defines a file that will be copied from the customization image into the Keycloak instance.
Field | Description |
---|---|
|
Source file from the customization image |
|
Destination file in the keycloak instance. The path is relative to /opt/keycloak/. |
VSHNKeycloakCustomizationImage
Field | Description |
---|---|
|
Path to a valid image |
|
Reference to an imagePullSecret |
VSHNKeycloakList
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
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 contains settings to control the restore of an instance. |
|
Maintenance contains settings to control the maintenance of an instance. |
|
Monitoring contains settings to control monitoring. |
|
Security defines the security of a service |
|
Instances configures the number of Keycloak instances for the cluster. Each instance contains one Keycloak server. |
VSHNKeycloakServiceSpec
VSHNKeycloakServiceSpec contains keycloak DBaaS specific properties
Field | Description |
---|---|
|
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 on which Keycloak will listen. |
|
Version contains supported version of keycloak. Multiple versions are supported. Default version is 26. |
|
ServiceLevel defines the service level of this service. Either Best Effort or Guaranteed Availability is allowed. |
|
PostgreSQLParameters can be used to set any supported setting in the underlying PostgreSQL instance. |
|
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 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 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 |
|
CustomEnvVariablesRef can be used to provide custom environment variables from a
provided secret for the keycloak instance. The environment variables provided
can for example be used in the custom JSON configuration provided in the |
|
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>. |
VSHNKeycloakSpec
VSHNKeycloakSpec defines the desired state of a VSHNKeycloak.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNKeycloak. |
|
ResourceRef tracks the internal composite belonging to this claim |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
VSHNKeycloakStatus
VSHNKeycloakStatus reflects the observed state of a VSHNKeycloak.
Field | Description |
---|---|
|
InstanceNamespace contains the name of the namespace where the instance resides |
|
Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec. |
|
Conditions of the resource. |
|
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 is the hash of last applied customConfigurationRef. |
|
LastEnvHash is the hash of last applied customEnvVariablesRef. |
VSHNKeycloakTLSSpec
VSHNKeycloakTLSSpec contains settings to control tls traffic of a service.
Field | Description |
---|---|
|
TLSEnabled enables TLS traffic for the service |
|
TLSAuthClients enables client authentication requirement |
VSHNMariaDB
VSHNMariaDB is the API for creating MariaDB instances.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a VSHNMariaDB. |
VSHNMariaDBList
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
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 contains settings to control the restore of an instance. |
|
StorageClass configures the storageClass to use for the PVC used by MariaDB. |
|
Maintenance contains settings to control the maintenance of an instance. |
|
Monitoring contains settings to control monitoring. |
|
Network contains any network related settings. |
|
Security defines the security of a service |
|
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. |
VSHNMariaDBServiceSpec
VSHNMariaDBServiceSpec contains MariaDB DBaaS specific properties
Field | Description |
---|---|
|
Version contains supported version of MariaDB. Multiple versions are supported. The latest version "11.5" is the default version. |
|
MariadbSettings contains additional MariaDB settings. |
|
ServiceLevel defines the service level of this service. Either Best Effort or Guaranteed Availability is allowed. |
|
Access defines additional users and databases for this instance. |
VSHNMariaDBSpec
VSHNMariaDBSpec defines the desired state of a VSHNMariaDB.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNMariaDB. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
VSHNMariaDBStatus
VSHNMariaDBStatus reflects the observed state of a VSHNMariaDB.
Field | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
InstanceNamespace contains the name of the namespace where the instance resides |
|
Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec. |
|
CurrentInstances tracks the current amount of instances. Mainly used to detect if there was a change in instances |
|
Conditions of the resource. |
|
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. |
VSHNMariaDBTLSSpec
VSHNMariaDBTLSSpec contains settings to control tls traffic of a service.
Field | Description |
---|---|
|
TLSEnabled enables TLS traffic for the service |
|
TLSAuthClients enables client authentication requirement |
VSHNMinio
VSHNMinio is the API for creating Minio instances.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a VSHNMinio. |
VSHNMinioList
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
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 contains settings to control the restore of an instance. |
|
Instances configures the number of Minio instances for the cluster. Each instance contains one Minio server. |
|
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. |
|
Monitoring contains settings to control monitoring. |
|
Security defines the security of a service |
VSHNMinioServiceSpec
VSHNMinioServiceSpec contains Redis DBaaS specific properties
Field | Description |
---|---|
|
Mode configures the mode of MinIO. Valid values are "distributed" and "standalone". |
VSHNMinioSpec
VSHNMinioSpec defines the desired state of a VSHNMinio.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNMinio. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
VSHNMinioStatus
VSHNMinioStatus reflects the observed state of a VSHNMinio.
Field | Description |
---|---|
|
MinioConditions contains the status conditions of the backing object. |
|
InstanceNamespace contains the name of the namespace where the instance resides |
|
Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec. |
|
Conditions of the resource. |
|
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. |
VSHNMonitoring
VSHNMonitoring contains settings to configure monitoring aspects of databases managed by VSHN
Field | Description |
---|---|
|
AlertmanagerConfigRef contains the name of the AlertmanagerConfig that should be copied over to the namespace of the instance. |
|
AlertmanagerConfigSecretRef contains the name of the secret that is used in the referenced AlertmanagerConfig |
|
AlertmanagerConfigSpecTemplate takes an AlertmanagerConfigSpec object. This takes precedence over the AlertmanagerConfigRef. |
|
Email necessary to send alerts via email |
VSHNNextcloud
VSHNNextcloud is the API for creating nextcloud instances.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a VSHNNextcloud. |
VSHNNextcloudBackupSpec
Field | Description |
---|---|
|
|
|
|
|
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. |
VSHNNextcloudList
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
VSHNNextcloudParameters
VSHNNextcloudParameters are the configurable fields of a VSHNNextcloud.
Field | Description |
---|---|
|
Service contains nextcloud DBaaS specific properties |
|
Size contains settings to control the sizing of a service. |
|
Scheduling contains settings to control the scheduling of an instance. |
|
Backup contains settings to control how the instance should get backed up. |
|
Restore contains settings to control the restore of an instance. |
|
Maintenance contains settings to control the maintenance of an instance. |
|
Monitoring contains settings to control monitoring. |
|
Security defines the security of a service |
|
Instances configures the number of Nextcloud instances for the cluster. Each instance contains one Nextcloud server. |
VSHNNextcloudServiceSpec
VSHNNextcloudServiceSpec contains nextcloud DBaaS specific properties
Field | Description |
---|---|
|
Collabora contains settings to control the Collabora integration. |
|
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 on which Nextcloud will listen. |
|
Version contains supported version of nextcloud. Multiple versions are supported. The latest version 30 is the default version. |
|
ServiceLevel defines the service level of this service. Either Best Effort or Guaranteed Availability is allowed. |
|
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 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 can be used to set any supported setting in the underlying PostgreSQL instance. |
VSHNNextcloudSpec
VSHNNextcloudSpec defines the desired state of a VSHNNextcloud.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNNextcloud. |
|
ResourceRef tracks the internal composite belonging to this claim |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
VSHNNextcloudStatus
VSHNNextcloudStatus reflects the observed state of a VSHNNextcloud.
Field | Description |
---|---|
|
InstanceNamespace contains the name of the namespace where the instance resides |
|
Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec. |
|
Conditions of the resource. |
|
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. |
VSHNPostgreSQL
VSHNPostgreSQL is the API for creating Postgresql clusters.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a VSHNPostgreSQL. |
VSHNPostgreSQLBackup
Field | Description |
---|---|
|
|
|
|
|
DeletionProtection will protect the instance from being deleted for the given retention time. This is enabled by default. |
|
DeletionRetention specifies in days how long the instance should be kept after deletion. The default is keeping it one week. |
VSHNPostgreSQLEncryption
VSHNPostgreSQLEncryption contains storage encryption specific parameters
Field | Description |
---|---|
|
Enabled specifies if the instance should use encrypted storage for the instance. |
VSHNPostgreSQLList
VSHNPostgreSQLList defines a list of VSHNPostgreSQL
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
VSHNPostgreSQLParameters
VSHNPostgreSQLParameters are the configurable fields of a VSHNPostgreSQL.
Field | Description |
---|---|
|
Service contains PostgreSQL DBaaS specific properties |
|
Maintenance contains settings to control the maintenance of an instance. |
|
Size contains settings to control the sizing of a service. |
|
Scheduling contains settings to control the scheduling of an instance. |
|
Network contains any network related settings. |
|
Backup contains settings to control the backups of an instance. |
|
Restore contains settings to control the restore of an instance. |
|
Monitoring contains settings to control monitoring. |
|
Encryption contains settings to control the storage encryption of an instance. |
|
UpdateStrategy indicates when updates to the instance spec will be applied. |
|
Instances configures the number of PostgreSQL instances for the cluster. Each instance contains one Postgres server. Out of all Postgres servers, one is elected as the primary, the rest remain as read-only replicas. |
|
This section allows to configure Postgres replication mode and HA roles groups. The main replication group is implicit and contains the total number of instances less the sum of all instances in other replication groups. |
|
Security defines the security of a service |
VSHNPostgreSQLReplicationStrategy
Field | Description | ||
---|---|---|---|
|
Mode defines the replication mode applied to the whole cluster. Possible values are: "async"(default), "sync", and "strict-sync" "async": When in asynchronous mode the cluster is allowed to lose some committed transactions. When the primary server fails or becomes unavailable for any other reason a sufficiently healthy standby will automatically be promoted to primary. Any transactions that have not been replicated to that standby remain in a “forked timeline” on the primary, and are effectively unrecoverable "sync": When in synchronous mode a standby will not be promoted unless it is certain that the standby contains all transactions that may have returned a successful commit status to client. This means that the system may be unavailable for writes even though some servers are available. "strict-sync": When it is absolutely necessary to guarantee that each write is stored durably on at least two nodes, use the strict synchronous mode. This mode prevents synchronous replication to be switched off on the primary when no synchronous standby candidates are available. As a downside, the primary will not be available for writes, blocking all client write requests until at least one synchronous replica comes up.
|
VSHNPostgreSQLRestore
VSHNPostgreSQLRestore contains restore specific parameters.
Field | Description |
---|---|
|
ClaimName specifies the name of the instance you want to restore from. The claim has to be in the same namespace as this new instance. |
|
ClaimType specifies the type of the instance you want to restore from. |
|
BackupName is the name of the specific backup you want to restore. |
|
RecoveryTimeStamp an ISO 8601 date, that holds UTC date indicating at which point-in-time the database has to be restored. This is optional and if no PIT recovery is required, it can be left empty. |
VSHNPostgreSQLServiceSpec
VSHNPostgreSQLServiceSpec contains PostgreSQL DBaaS specific properties
Field | Description |
---|---|
|
MajorVersion contains supported version of PostgreSQL. Multiple versions are supported. The latest version "15" is the default version. Currently it’s impossible to change the version of an existing instance - we’re working on it. |
|
PGSettings contains additional PostgreSQL settings. |
|
Extensions allow to enable/disable any of the supported |
|
ServiceLevel defines the service level of this service. Either Best Effort or Guaranteed Availability is allowed. |
|
PgBouncerSettings passes additional configuration to the pgBouncer instance. |
|
Disable connection pooling service PgBouncer. All connections will go straight to PostgreSQL instance. |
|
This is default option if neither repack or vacuum are selected |
|
|
|
Access defines additional users and databases for this instance. |
TLS settings for the instance. |
VSHNPostgreSQLSpec
VSHNPostgreSQLSpec defines the desired state of a VSHNPostgreSQL.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNPostgreSQL. |
|
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 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. |
|
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured. |
|
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 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.
Field | Description |
---|---|
|
InstanceNamespace contains the name of the namespace where the instance resides |
|
CurrentVersion contains the current version of PostgreSQL. |
|
PreviousVersion contains the previous version of PostgreSQL. |
|
PostgreSQLConditions contains the status conditions of the backing object. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
IsEOL indicates if this instance is using an EOL version of PostgreSQL. |
|
Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec. |
|
Conditions of the resource. |
|
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. |
VSHNPostgreSQLTLS
VSHNPostgreSQLTLS contains TLS specific parameters
Field | Description |
---|---|
|
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. |
VSHNPostgreSQLUpdateStrategy
VSHNPostgreSQLUpdateStrategy indicates how and when updates to the instance spec will be applied.
Field | Description |
---|---|
|
Type indicates the type of the UpdateStrategy. Default is Immediate.
Possible enum values:
- |
VSHNRedis
VSHNRedis is the API for creating Redis clusters.
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec defines the desired state of a VSHNRedis. |
VSHNRedisList
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
VSHNRedisParameters
VSHNRedisParameters are the configurable fields of a VSHNRedis.
Field | Description |
---|---|
|
Service contains Redis DBaaS specific properties |
|
Size contains settings to control the sizing of a service. |
|
Scheduling contains settings to control the scheduling of an instance. |
|
TLS contains settings to control tls traffic of a service. |
|
Backup contains settings to control how the instance should get backed up. |
|
Restore contains settings to control the restore of an instance. |
|
Maintenance contains settings to control the maintenance of an instance. |
|
Monitoring contains settings to control monitoring. |
|
Security defines the security of a service |
VSHNRedisServiceSpec
VSHNRedisServiceSpec contains Redis DBaaS specific properties
Field | Description |
---|---|
|
Version contains supported version of Redis. Multiple versions are supported. The latest version "7.0" is the default version. |
|
RedisSettings contains additional Redis settings. |
|
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.
Field | Description |
---|---|
|
CPURequests defines the requests amount of Kubernetes CPUs for an instance. |
|
CPULimits defines the limits amount of Kubernetes CPUs for an instance. |
|
MemoryRequests defines the requests amount of memory in units of bytes for an instance. |
|
MemoryLimits defines the limits amount of memory in units of bytes for an instance. |
|
Disk defines the amount of disk space for an instance. |
|
Plan is the name of the resource plan that defines the compute resources. |
VSHNRedisSpec
VSHNRedisSpec defines the desired state of a VSHNRedis.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNRedis. |
|
WriteConnectionSecretToRef references a secret to which the connection details will be written. |
VSHNRedisStatus
VSHNRedisStatus reflects the observed state of a VSHNRedis.
Field | Description |
---|---|
|
RedisConditions contains the status conditions of the backing object. |
|
|
|
|
|
|
|
|
|
|
|
InstanceNamespace contains the name of the namespace where the instance resides |
|
Schedules keeps track of random generated schedules, is overwriten by schedules set in the service’s spec. |
|
Conditions of the resource. |
|
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. |
VSHNRedisTLSSpec
VSHNRedisTLSSpec contains settings to control tls traffic of a service.
Field | Description |
---|---|
|
TLSEnabled enables TLS traffic for the service |
|
TLSAuthClients enables client authentication requirement |
VSHNScheduleStatus
Field | Description |
---|---|
|
Maintenance keeps track of the maintenance schedule. |
|
Backup keeps track of the backup schedule. |
|
Conditions of the resource. |
|
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. |
VSHNSizeSpec
VSHNSizeSpec contains settings to control the sizing of a service.
Field | Description |
---|---|
|
CPU defines the amount of Kubernetes CPUs for an instance. |
|
Memory defines the amount of memory in units of bytes for an instance. |
|
Requests defines CPU and memory requests for an instance |
|
Disk defines the amount of disk space for an instance. |
|
Plan is the name of the resource plan that defines the compute resources. |
XVSHNForgejo
XVSHNForgejo represents the internal composite of this claim
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNForgejoList
XVSHNForgejoList represents a list of composites
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNForgejoSpec
XVSHNForgejoSpec defines the desired state of a VSHNForgejo.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNForgejo. |
|
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 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. |
|
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured. |
|
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 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 |
XVSHNKeycloak
XVSHNKeycloak represents the internal composite of this claim
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNKeycloakList
XVSHNKeycloakList represents a list of composites
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNKeycloakSpec
XVSHNKeycloakSpec defines the desired state of a VSHNKeycloak.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNKeycloak. |
|
|
|
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 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. |
|
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured. |
|
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 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
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNMariaDBList
XVSHNMariaDBList represents a list of composites
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNMariaDBSpec
XVSHNMariaDBSpec defines the desired state of a VSHNMariaDB.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNMariaDB. |
|
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 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. |
|
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured. |
|
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 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
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNMinioList
XVSHNMiniosList represents a list of composites
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNMinioSpec
XVSHNMinioSpec defines the desired state of a VSHNMinio.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNMinio. |
|
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 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. |
|
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured. |
|
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 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 |
XVSHNNextcloud
XVSHNNextcloud represents the internal composite of this claim
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNNextcloudList
XVSHNNextcloudList represents a list of composites
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNNextcloudSpec
XVSHNNextcloudSpec defines the desired state of a VSHNNextcloud.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNNextcloud. |
|
|
|
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 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. |
|
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured. |
|
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 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
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNPostgreSQLList
XVSHNPostgreSQLList represents a list of composites
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNPostgreSQLSpec
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNPostgreSQL. |
|
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 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. |
|
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured. |
|
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 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
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNRedisList
XVSHNRedisList represents a list of composites
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
XVSHNRedisSpec
XVSHNRedisSpec defines the desired state of a VSHNRedis.
Field | Description |
---|---|
|
Parameters are the configurable fields of a VSHNRedis. |
|
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 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. |
|
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured. |
|
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 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 |