XCluster
TypeXRD
Providerconfiguration-piraeus
Grouppiraeus.livewyer.io
Versionv1alpha1

1apiVersion: piraeus.livewyer.io/v1alpha1

2kind: XCluster

spec
object

(No description available)

cluster
object

(No description available)

apiTLS
object

ApiTLS secures the LINSTOR API. This configures the TLS key and certificate used to secure the LINSTOR API.

object

CAReference configures the CA certificate to use when validating TLS certificates. If not set, the TLS secret is expected to contain a "ca.crt" containing the CA certificate.

key
string
kind
string
name
required
string
optional
boolean
object

CertManager references a cert-manager Issuer or ClusterIssuer. If set, cert-manager.io/Certificate resources will be created, provisioning the secrets referenced in *SecretName using the issuer configured here.

group
string
kind
string
name
required
string
object

Controller controls the deployment of the LINSTOR Controller Deployment.

enabled
boolean
object

CSIController controls the deployment of the CSI Controller Deployment.

enabled
boolean
csiNode
object

CSINode controls the deployment of the CSI Node DaemonSet.

enabled
boolean
object

ExternalController references an external controller. When set, the Operator will skip deploying a LINSTOR Controller and instead use the external cluster to register satellites.

url
required
string
object

HighAvailabilityController controls the deployment of the High Availability Controller DaemonSet.

enabled
boolean
object

InternalTLS secures the connection between LINSTOR Controller and Satellite. This configures the client certificate used when the Controller connects to a Satellite. This only has an effect when the Satellite is configured to for secure connections using LinstorSatellite.spec.internalTLS.

object

CAReference configures the CA certificate to use when validating TLS certificates. If not set, the TLS secret is expected to contain a "ca.crt" containing the CA certificate.

key
string
kind
string
name
required
string
optional
boolean
object

CertManager references a cert-manager Issuer or ClusterIssuer. If set, a Certificate resource will be created, provisioning the secret references in SecretName using the issuer configured here.

group
string
kind
string
name
required
string
object

NodeAffinity selects the nodes on which LINSTOR Satellite will be deployed. See https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

nodeSelectorTerms
required
array

Required. A list of node selector terms. The terms are ORed.

array

A list of node selector requirements by node's labels.

key
required
string
operator
required
string
values
array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

array

A list of node selector requirements by node's fields.

key
required
string
operator
required
string
values
array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

patches
array

Patches is a list of kustomize patches to apply. See https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/patches/ for how to create patches.

options
object
patch
required
string
target
object

Target points to the resources that the patch is applied to

group
string
kind
string
name
string
namespace
string
version
string
array

Properties to apply on the cluster level. Use to create default settings for DRBD that should apply to all resources or to configure some other cluster wide default.

name
required
string
value
string
object

(No description available)

paths
array

Paths configure the network path used when connecting two nodes.

interface
required
string
name
required
string
array

Properties to apply for the node connection. Use to create default settings for DRBD that should apply to all resources connections between a set of cluster nodes.

name
required
string
value
string
array

Selector selects which pair of Satellites the connection should apply to. If not given, the connection will be applied to all connections.

matchLabels
required
array

MatchLabels is a list of match expressions that the node pairs must meet.

key
required
string
op
string
values
array

Values to match on, using the provided Op.

object

(No description available)

object

InternalTLS configures secure communication for the LINSTOR Satellite. If set, the control traffic between LINSTOR Controller and Satellite will be encrypted using mTLS.

object

CAReference configures the CA certificate to use when validating TLS certificates. If not set, the TLS secret is expected to contain a "ca.crt" containing the CA certificate.

key
string
kind
string
name
required
string
optional
boolean
object

CertManager references a cert-manager Issuer or ClusterIssuer. If set, a Certificate resource will be created, provisioning the secret references in SecretName using the issuer configured here.

group
string
kind
string
name
required
string
array

IPFamilies configures the IP Family (IPv4 or IPv6) to use to connect to the LINSTOR Satellite. If set, the control traffic between LINSTOR Controller and Satellite will use only the given IP Family. If not set, the Operator will configure all families found in the Satellites Pods' Status.

object

NodeAffinity selects which LinstorSatellite resources this spec should be applied to. See https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

nodeSelectorTerms
required
array

Required. A list of node selector terms. The terms are ORed.

array

A list of node selector requirements by node's labels.

key
required
string
operator
required
string
values
array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

array

A list of node selector requirements by node's fields.

key
required
string
operator
required
string
values
array

An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

patches
array

Patches is a list of kustomize patches to apply. See https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/patches/ for how to create patches.

options
object
patch
required
string
target
object

Target points to the resources that the patch is applied to

group
string
kind
string
name
string
namespace
string
version
string
array

Properties is a list of properties to set on the node.

object

ExpandFrom can reference multiple resource fields at once. It either sets the property to an aggregate value based on matched resource fields, or expands to multiple properties.

delimiter
string
nodeFieldRef
required
string
name
required
string
optional
boolean
value
string
valueFrom
object

ValueFrom sets the value from an existing resource.

nodeFieldRef
required
string
storagePools
required
array

StoragePools is a list of storage pools to configure on the node.

name
required
string
object

Configuration details for Volume Snapshot Class.

spec
object

Configuration details for chosen storage pool type.

directory
string
array

Properties to set on the storage pool.

object

ExpandFrom can reference multiple resource fields at once. It either sets the property to an aggregate value based on matched resource fields, or expands to multiple properties.

delimiter
string
nodeFieldRef
required
string
name
required
string
optional
boolean
value
string
valueFrom
object

ValueFrom sets the value from an existing resource.

nodeFieldRef
required
string
source
object

(No description available)

array

HostDevices is a list of device paths used to configure the given pool.

thinPool
string
zPool
string
object

Configuration details of storage class for chosen storage pool.

array

AllowedTopologies is a list of topology keys and values that the volume can be accessed from.

array

(No description available)

key
string
operator
string
values
array

(No description available)

type
required
string
status
object

LinstorClusterStatus defines the observed state of LinstorCluster

array

Current LINSTOR Cluster state

lastTransitionTime
required
string
message
required
string
reason
required
string
status
required
string
type
required
string
array

The Storage Pools of the Linstor Cluster.

array

The Volume Snapshot Classes of the Linstor Cluster.

array

The Storage Classes of the Linstor Cluster.