Skip to content

Commit 530e917

Browse files
authored
DEV-866 operator v1.4 docs (#922)
1 parent af1f8fa commit 530e917

File tree

21 files changed

+1755
-20
lines changed

21 files changed

+1755
-20
lines changed

docs/server/kubernetes-operator/v1.0.0/operations/database-deployment.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -380,11 +380,7 @@ kubectl apply -f cluster.yaml
380380
## Three Node Secure Cluster (using LetsEncrypt)
381381

382382
Using LetsEncrypt, or any publicly trusted certificate, in an operator-managed KurrentDB cluster
383-
is not supported.
384-
385-
The recommended workaround is to combine [self-signed certificates within the cluster](
386-
#three-node-secure-cluster-using-self-signed-certificates) with an Ingress that does TLS
387-
termination using the LetsEncrypt certificate.
383+
is not supported in v1.0.0; please upgrade to v1.4.0.
388384

389385
## Viewing Deployments
390386

docs/server/kubernetes-operator/v1.1.0/operations/database-deployment.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -445,11 +445,7 @@ kubectl apply -f cluster.yaml
445445
## Three Node Secure Cluster (using LetsEncrypt)
446446

447447
Using LetsEncrypt, or any publicly trusted certificate, in an operator-managed KurrentDB cluster
448-
is not supported.
449-
450-
The recommended workaround is to combine [self-signed certificates within the cluster](
451-
#three-node-secure-cluster-using-self-signed-certificates) with an Ingress that does TLS
452-
termination using the LetsEncrypt certificate.
448+
is not supported in v1.0.0; please upgrade to v1.4.0.
453449

454450
## Deploying With Scheduling Constraints
455451

docs/server/kubernetes-operator/v1.2.0/operations/database-deployment.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -445,11 +445,7 @@ kubectl apply -f cluster.yaml
445445
## Three Node Secure Cluster (using LetsEncrypt)
446446

447447
Using LetsEncrypt, or any publicly trusted certificate, in an operator-managed KurrentDB cluster
448-
is not supported.
449-
450-
The recommended workaround is to combine [self-signed certificates within the cluster](
451-
#three-node-secure-cluster-using-self-signed-certificates) with an Ingress that does TLS
452-
termination using the LetsEncrypt certificate.
448+
is not supported in v1.0.0; please upgrade to v1.4.0.
453449

454450
## Deploying With Scheduling Constraints
455451

docs/server/kubernetes-operator/v1.3.1/operations/database-deployment.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -441,11 +441,7 @@ kubectl apply -f cluster.yaml
441441
## Three Node Secure Cluster (using LetsEncrypt)
442442

443443
Using LetsEncrypt, or any publicly trusted certificate, in an operator-managed KurrentDB cluster
444-
is not supported.
445-
446-
The recommended workaround is to combine [self-signed certificates within the cluster](
447-
#three-node-secure-cluster-using-self-signed-certificates) with an Ingress that does TLS
448-
termination using the LetsEncrypt certificate.
444+
is not supported in v1.0.0; please upgrade to v1.4.0.
449445

450446
## Deploying With Scheduling Constraints
451447

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
# title is for breadcrumb and sidebar nav
3+
title: Kubernetes Operator v1.4.0
4+
order: 1
5+
---
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
order: 1
3+
dir:
4+
text: "Getting started"
5+
link: true
6+
order: 1
7+
---
8+
9+
<CloudBanner />
10+
11+
---
12+
Welcome to the **KurrentDB Kubernetes Operator** guide. In this guide, we’ll refer to the KurrentDB Kubernetes Operator simply as “the Operator.” Use the Operator to simplify backup, scaling, and upgrades of KurrentDB clusters on Kubernetes.
13+
14+
:::important
15+
The Operator is an Enterprise-only feature, please [contact us](https://www.kurrent.io/contact) for more information.
16+
:::
17+
18+
## Why run KurrentDB on Kubernetes?
19+
20+
Kubernetes is the modern enterprise standard for deploying containerized applications at scale. The Operator streamlines deployment and management of KurrentDB clusters.
21+
22+
## Features
23+
24+
* Deploy single-node or multi-node clusters
25+
* Back up and restore clusters
26+
* Automate backups with a schedule and retention policies
27+
* Perform rolling upgrades and update configurations
28+
29+
### New in 1.4.0
30+
31+
* Support configurable traffic strategies for each of server-server and client-server traffic. This
32+
enables the use of LetsEncrypt certificates without creating Ingresses, for example. See
33+
[Traffic Strategies][ts] for details.
34+
* Support backup scheduling and retention policies. There is a new [KurrentDBBackupSchedule][bs]
35+
CRD with a CronJob-like syntax. There are also two mechanisms for configuring retention policies:
36+
a `.keep` count on `KurrentDBBackupSchedule`, and a new `.ttl` on `KurrentDBBackup`.
37+
* Support standalone read-only replicas pointed at a remote cluster. This enables advanced
38+
topologies like a having your quorum nodes in one region and a read-only replica in a distant
39+
region. See [Deploying Standalone Read-Only Replicas][ror] for an example.
40+
* Support template strings in some extra metadata for child resources of the `KurrentDB` object.
41+
This allows, for example, to annotate each of the automatically created LoadBalancers with unique
42+
external-dns annotations. See [KurrentDBExtraMetadataSpec][em] for details.
43+
44+
[ts]: ../operations/advanced-networking.md#traffic-strategy-options
45+
[bs]: resource-types.md#kurrentdbbackupschedulespec
46+
[ror]: ../operations/database-deployment.md#deploying-standalone-read-only-replicas
47+
[em]: resource-types.md#kurrentdbextrametadataspec
48+
49+
## Supported KurrentDB Versions
50+
51+
The Operator supports running the following major versions of KurrentDB:
52+
- v25.x
53+
- v24.x
54+
- v23.10+
55+
56+
## Supported Hardware Architectures
57+
58+
The Operator is packaged for the following hardware architectures:
59+
- x86\_64
60+
- arm64
61+
62+
## Technical Support
63+
64+
For support questions, please [contact us](https://www.kurrent.io/contact).
65+
66+
## First Steps
67+
68+
Ready to install? Head over to the [installation](installation.md) section.
144 KB
Loading
324 KB
Loading
182 KB
Loading
148 KB
Loading

0 commit comments

Comments
 (0)