Skip to content

ESCLOUD-985: Support scheduling constraints #857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

ESCLOUD-985: Support scheduling constraints #857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 57 additions & 34 deletions docs/server/kubernetes-operator/getting-started/resource-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,37 +13,60 @@ This resource type is used to define a database deployment.

### API

| Field | Required | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| `replicas` _integer_ | Yes | Number of nodes in a database cluster (1 or 3) |
| `image` _string_ | Yes | KurrentDB container image URL |
| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | No | Database container resource limits and requests |
| `storage` _[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimspec-v1-core)_ | Yes | Persistent volume claim settings for the underlying data volume |
| `network` _[KurrentDbNetwork](#kurrentdbnetwork)_ | Yes | Defines the network configuration to use with the database |
| `configuration` _yaml_ | No | Additional configuration to use with the database |
| `sourceBackup` _string_ | No | Backup name to restore a cluster from |
| `security` _[KurrentDbSecurity](#kurrentdbecurity)_ | No | Security configuration to use for the database. This is optional, if not specified the cluster will be created without security enabled. |
| `licenseSecret` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secret-v1-core)_ | No | A secret that contains the Enterprise license for the database |

#### KurrentDbNetwork

| Field | Required | Description |
|------------------------------------------------------------------|----------|--------------------------------------------------------------------------------|
| `domain` _string_ | Yes | Domain used for external DNS e.g. advertised address exposed in the gossip state |
| `loadBalancer` _[KurrentDbLoadBalancer](#kurrentdbloadbalancer)_ | Yes | Defines a load balancer to use with the database |

#### KurrentDbLoadBalancer

| Field | Required | Description |
|---------------------|----------|----------------------------------------------------------------|
| `enabled` _boolean_ | Yes | Determines if a load balancer should be deployed for each node |
| `allowedIps` _string array_ | No | List of IP ranges allowed by the load balancer (default will allow all access) |

#### KurrentDbSecurity
| Field | Required | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------|
| `replicas` _integer_ | Yes | Number of nodes in a database cluster (1 or 3) |
| `image` _string_ | Yes | KurrentDB container image URL |
| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | No | Database container resource limits and requests |
| `storage` _[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimspec-v1-core)_ | Yes | Persistent volume claim settings for the underlying data volume |
| `network` _[KurrentDBNetwork](#kurrentdbnetwork)_ | Yes | Defines the network configuration to use with the database |
| `configuration` _yaml_ | No | Additional configuration to use with the database |
| `sourceBackup` _string_ | No | Backup name to restore a cluster from |
| `security` _[KurrentDBSecurity](#kurrentdbecurity)_ | No | Security configuration to use for the database. This is optional, if not specified the cluster will be created without security enabled. |
| `licenseSecret` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secret-v1-core)_ | No | A secret that contains the Enterprise license for the database |
| `constraints` _[KurrentDBConstraints](#kurrentdbconstraints)_ | No | Scheduling constraints for the Kurrent DB pod. |
| `readOnlyReplias` _[KurrentDBReadOnlyReplicasSpec](#kurrentdbreadonlyreplicasspec)_ | No | Read-only replica configuration the Kurrent DB Cluster. |

#### KurrentDBReadOnlyReplicasSpec

Other than `replicas`, each of the fields in `KurrentDBReadOnlyReplicasSpec` default to the corresponding values from the main KurrentDBSpec.

| Field | Required | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------|
| `replicas` _integer_ | No | Number of read-only replicas in the cluster. Defaults to zero. |
| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | No | Database container resource limits and requests. |
| `storage` _[PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimspec-v1-core)_ | No | Persistent volume claim settings for the underlying data volume. |
| `configuration` _yaml_ | No | Additional configuration to use with the database. |
| `constraints` _[KurrentDBConstraints](#kurrentdbconstraints)_ | No | Scheduling constraints for the Kurrent DB pod. |

#### KurrentDBConstraints

| Field | Required | Description |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------|
| `nodeSelector` _yaml_ | No | Identifies nodes that the Kurrent DB may consider during scheduling. |
| `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#affinity-v1-core)_ | No | The node affinity, pod affinity, and pod anti-affinity for scheduling the Kurrent DB pod. |
| `Tolerations` _list of [Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)_ | No | The tolerations for scheduling the Kurrent DB pod. |
| `TopologySpreadConstraints` _list of [TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#topologyspreadconstraint-v1-core)_ | No | The topology spread constraints for scheduling the Kurrent DB pod. |

#### KurrentDBNetwork

| Field | Required | Description |
|------------------------------------------------------------------|----------|----------------------------------------------------------------------------------|
| `domain` _string_ | Yes | Domain used for external DNS e.g. advertised address exposed in the gossip state |
| `loadBalancer` _[KurrentDBLoadBalancer](#kurrentdbloadbalancer)_ | Yes | Defines a load balancer to use with the database |

#### KurrentDBLoadBalancer

| Field | Required | Description |
|------------------------------|----------|--------------------------------------------------------------------------------|
| `enabled` _boolean_ | Yes | Determines if a load balancer should be deployed for each node |
| `allowedIps` _string array_ | No | List of IP ranges allowed by the load balancer (default will allow all access) |

#### KurrentDBSecurity

| Field | Required | Description |
|------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------|
| `certificateSubjectName` _string_ | No | Subject name used in the TLS certificate (this maps directly to the database property `CertificateSubjectName`) |
| `certificateSubjectName` _string_ | No | Subject name used in the TLS certificate (this maps directly to the database property `CertificateSubjectName`) |
| `certificateReservedNodeCommonName` _string_ | No | Common name for the TLS certificate (this maps directly to the database property `CertificateReservedNodeCommonName`) |
| `certificateAuthoritySecret` _[CertificateSecret](#certificatesecret)_ | No | Secret containing the CA TLS certificate |
| `certificateSecret` _[CertificateSecret](#certificatesecret)_ | Yes | Secret containing the TLS certificate to use |
Expand All @@ -59,16 +82,16 @@ This resource type is used to define a database deployment.

## KurrentDBBackup

This resource type is used to define a backup for an existing database deployment.
This resource type is used to define a backup for an existing database deployment.

:::important
Resources of this type must be created within the same namespace as the target database cluster to backup.
:::

### API

| Field | Required | Description |
|------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `clusterName` _string_ | Yes | Name of the source database cluster |
| `nodeName` _string_ | No | Specific node name within the database cluster to use as the backup. If this is not specified, the leader will be picked as the source. |
| `volumeSnapshotClassName` _string_ | Yes | The name of the underlying volume snapshot class to use. |
| Field | Required | Description |
|------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `clusterName` _string_ | Yes | Name of the source database cluster |
| `nodeName` _string_ | No | Specific node name within the database cluster to use as the backup. If this is not specified, the leader will be picked as the source. |
| `volumeSnapshotClassName` _string_ | Yes | The name of the underlying volume snapshot class to use. |
Loading
Loading