Skip to content

Commit c7497a9

Browse files
committed
content for v1.4.0
1 parent 3d35286 commit c7497a9

File tree

18 files changed

+661
-393
lines changed

18 files changed

+661
-393
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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
# title is for breadcrumb and sidebar nav
3-
title: Kubernetes Operator v1.3.1
3+
title: Kubernetes Operator v1.4.0
44
order: 1
55
---

docs/server/kubernetes-operator/v1.4.0/getting-started/README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,41 +23,40 @@ Kubernetes is the modern enterprise standard for deploying containerized applica
2323

2424
* Deploy single-node or multi-node clusters
2525
* Back up and restore clusters
26+
* Automate backups with a schedule and retention policies
2627
* Perform rolling upgrades and update configurations
2728

28-
### New in 1.3.1
29-
30-
* Fix/improve support for resizing KurrentDB clusters, including explicitly handling data safety,
31-
minimizing downtime, and allowing the user to cancel a resize operation that is not progressing.
32-
See [Updating Replica Count](../operations/modify-deployments.md#updating-replica-count) for details.
33-
* Support for custom labels and annotations on all child resources (StatefulSets, Pods,
34-
LoadBalancers, etc).
35-
* Allow users to use public certificate authorities like LetsEncrypt without having to manually pass
36-
the publicly trusted cert in a secret.
37-
* Allow manual overrides to the generated ConfigMap that is passed to KurrentDB. Previously, if a
38-
user manually altered the ConfigMap it would get immediately overwritten, whereas now it will
39-
"stick" until the next time the KurrentDB resource is updated.
40-
* Fix a bug affecting the KurrentDBBackup behavior when cluster's fqdnTemplate met certain criteria.
41-
* Fix and clarified the `credentialsSecretName` behavior in the helm chart. It is not normally
42-
required at all, but in previous versions, it was generating warning events with the default
43-
configuration.
44-
* Add a new `crds.keep` value to the helm chart. With the default value of `true`, CRDs installed
45-
by the helm chart will not be deleted by helm, which offers a layer of protection against
46-
accidental data loss. In earlier versions of the helm chart, or with `crds.keep=false`, a
47-
transition from `crds.enabled=true` to `crds.enabled=false` would cause the deletion of the CRDs
48-
and all KurrentDB and KurrentDBBackup objects across the cluster.
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
4948

5049
## Supported KurrentDB Versions
5150

5251
The Operator supports running the following major versions of KurrentDB:
5352
- v25.x
5453
- v24.x
55-
- v23.x
54+
- v23.10+
5655

5756
## Supported Hardware Architectures
5857

5958
The Operator is packaged for the following hardware architectures:
60-
- x86_64
59+
- x86\_64
6160
- arm64
6261

6362
## Technical Support

docs/server/kubernetes-operator/v1.4.0/getting-started/installation.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ helm repo add kurrent-latest \
3737
The Operator uses Custom Resource Definitions (CRDs) to extend Kubernetes. You can install them automatically with Helm or manually.
3838

3939
The following resource types are supported:
40-
- [KurrentDB](resource-types.md#kurrentdb)
41-
- [KurrentDBBackup](resource-types.md#kurrentdbbackup)
40+
- [KurrentDB](resource-types.md#kurrentdbspec)
41+
- [KurrentDBBackup](resource-types.md#kurrentdbbackupspec)
42+
- [KurrentDBBackupSchedules](resource-types.md#kurrentdbbackupschedulesspec)
4243

4344
Since CRDs are managed globally by Kubernetes, special care must be taken to install them.
4445

@@ -52,7 +53,7 @@ If you prefer to install CRDs yourself:
5253

5354
```bash
5455
# Download the kurrentdb-operator Helm chart
55-
helm pull kurrent-latest/kurrentdb-operator --version 1.3.1 --untar
56+
helm pull kurrent-latest/kurrentdb-operator --version 1.4.0 --untar
5657
# Install the CRDs
5758
kubectl apply -f kurrentdb-operator/templates/crds
5859
```
@@ -86,7 +87,7 @@ To deploy the Operator in this mode, run:
8687

8788
```bash
8889
helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
89-
--version 1.3.1 \
90+
--version 1.4.0 \
9091
--namespace kurrent \
9192
--create-namespace \
9293
--set crds.enabled=true \
@@ -121,7 +122,7 @@ To deploy the Operator in this mode, the following command can be used:
121122

122123
```bash
123124
helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
124-
--version 1.3.1 \
125+
--version 1.4.0 \
125126
--namespace kurrent \
126127
--create-namespace \
127128
--set crds.enabled=true \
@@ -160,7 +161,7 @@ The Operator deployment can be updated to adjust which namespaces are watched. F
160161

161162
```bash
162163
helm upgrade kurrentdb-operator kurrent-latest/kurrentdb-operator \
163-
--version 1.3.1 \
164+
--version 1.4.0 \
164165
--namespace kurrent \
165166
--reuse-values \
166167
--set operator.namespaces='{kurrent,foo,bar}'
@@ -204,5 +205,5 @@ helm upgrade kurrentdb-operator kurrentdb-operator-repo/kurrentdb-operator \
204205
Here's what these commands do:
205206
- Refresh the local Helm repository index
206207
- Locate an existing operator installation in namespace `kurrent`
207-
- Select the target upgrade version `{version}` e.g. `1.3.1`
208+
- Select the target upgrade version `{version}` e.g. `1.4.0`
208209
- Perform the upgrade, preserving values that were set during installation

0 commit comments

Comments
 (0)