Skip to content

Commit 952c6bf

Browse files
authored
docs: port kubernetes changes to 1.0 (#882)
1 parent 3b43126 commit 952c6bf

File tree

2 files changed

+33
-37
lines changed

2 files changed

+33
-37
lines changed

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

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,28 @@ dir:
99
<CloudBanner />
1010

1111
---
12-
Welcome to the **KurrentDB Kubernetes Operator** guide! For the sake of brevity, further references will use the shorter term of Operator.
13-
14-
This guide aims to:
15-
* Detail key features
16-
* Provide comprehensive instructions for installing and utilizing the Operator
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.
1713

1814
:::important
1915
The Operator is an Enterprise only feature, please [contact us](https://www.kurrent.io/contact) for more information.
2016
:::
2117

22-
## KurrentDB and Kubernetes: The Perfect Match
18+
## Why run KurrentDB on Kubernetes?
2319

24-
Kubernetes is the modern Enterprise standard for deploying containerized applications at scale. The Operator has been purpose built to streamline the deployment and management of KurrentDB.
20+
Kubernetes is the modern enterprise standard for deploying containerized applications at scale. The Operator streamlines deployment and management of KurrentDB clusters.
2521

2622
## Features
2723

28-
* Deployment of single-node and multi-node database clusters
29-
* Backup and restore
30-
* Rolling upgrades and configuration changes
24+
* Deploy single-node or multi-node clusters
25+
* Back up and restore clusters
26+
* Perform rolling upgrades and update configurations
3127

3228
## Supported KurrentDB Versions
3329

3430
The Operator supports running the following major versions of KurrentDB:
35-
- v23
36-
- v24
37-
- v25
31+
- v25.x
32+
- v24.x
33+
- v23.x
3834

3935
## Supported Hardware Architectures
4036

@@ -44,8 +40,8 @@ The Operator is packaged for the following hardware architectures:
4440

4541
## Technical Support
4642

47-
If you have specific questions please [contact us](https://www.kurrent.io/contact).
43+
For support questions, please [contact us](https://www.kurrent.io/contact).
4844

4945
## First Steps
5046

51-
Head over to the [installation](installation.md) section to get rolling!
47+
Ready to install? Head over to the [installation](installation.md) section.

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

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,40 @@ The Operator is an Enterprise only feature, please [contact us](https://www.kurr
1515
To get the best out of this guide, a basic understanding of [Kubernetes concepts](https://kubernetes.io/docs/concepts/) is essential.
1616
:::
1717

18-
Before installing and executing the Operator, the following requirements should be met:
18+
* A Kubernetes cluster running `v1.23.1` or later.
19+
* Permission to create resources, deploy the Operator and install CRDs in the target cluster.
20+
* The following CLI tools installed, on your shell’s `$PATH`, with `$KUBECONFIG` pointing to your cluster:
21+
* kubectl [install guide](https://kubernetes.io/docs/tasks/tools/install-kubectl)
22+
* k9s [install guide](https://k9scli.io/topics/install/)
23+
* Helm 3 CLI [install guide](https://helm.sh/docs/intro/install/)
24+
* A valid Operator license. Please [contact us](https://www.kurrent.io/contact) for more information.
1925

20-
* Access to a Kubernetes cluster with a minimum version of `v1.23.1+`.
21-
* Sufficient permissions to deploy the Operator and Custom Resource Definitions (CRDs).
22-
* The following CLI tools are installed and configured to interact with your Kubernetes cluster. This means the tool must be accessible from your shell's `$PATH`, and your `$KUBECONFIG` environment variable must point to the correct Kubernetes configuration file:
23-
* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl)
24-
* [k9s](https://k9scli.io/topics/install/)
25-
* The [Helm 3 CLI](https://helm.sh/docs/intro/install/) tool is installed and configured to interact with your Kubernetes cluster.
26-
* Operator license (please [contact us](https://www.kurrent.io/contact) for more information).
26+
## Configure Helm Repository
2727

28-
## Helm Repository
29-
30-
The Operator deployment process is managed via Helm. The following Kurrent repository must be configured using the command:
28+
Add the Kurrent Helm repository to your local environment:
3129

3230
```bash
3331
helm repo add kurrent-latest \
3432
'https://packages.kurrent.io/basic/kurrent-latest/helm/charts/'
3533
```
3634

37-
## Custom Resource Definitions (CRDs)
35+
## Install Custom Resource Definitions (CRDs)
36+
37+
The Operator uses Custom Resource Definitions (CRDs) to extend Kubernetes. You can install them automatically with Helm or manually.
3838

39-
The following resource types are supported by the Operator:
39+
The following resource types are supported:
4040
- [KurrentDB](resource-types.md#kurrentdb)
4141
- [KurrentDBBackup](resource-types.md#kurrentdbbackup)
4242

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

4545
### Automatic Install
4646

47-
The recommended approach to install and manage the CRDs is using Helm. Refer to the [Deployment Modes](#deployment-modes) section for more details.
47+
It's recommended to install and manage the CRDs using Helm. See [Deployment Modes](#deployment-modes) for more information.
4848

4949
### Manual Install
5050

51-
If the CRDs must be installed manually, then the following steps can be used:
51+
If you prefer to install CRDs yourself:
5252

5353
```bash
5454
# Download the kurrentdb-operator Helm chart
@@ -64,13 +64,13 @@ customresourcedefinition.apiextensions.k8s.io/kurrentdbs.kubernetes.kurrent.io c
6464

6565
## Deployment Modes
6666

67-
The Operator can be scoped to track Kurrent resources across *all* or *specific* namespaces.
67+
The Operator can be scoped to track Kurrent resources across **all** or **specific** namespaces.
6868

6969
### Cluster-wide
7070

71-
In this mode, the Operator will track Kurrent resources across **all** namespaces. This mode offers the simplest configuration option but the Operator requires a `ClusterRole` (this will be created as part of the installation process).
71+
In cluster-wide mode, the Operator tracks Kurrent resources across **all** namespaces and requires `ClusterRole`. Helm creates the ClusteRole automatically.
7272

73-
To deploy the Operator in this mode, the following command can be used:
73+
To deploy the Operator in this mode, run:
7474

7575
```bash
7676
helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
@@ -82,11 +82,11 @@ helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
8282
--set-file operator.license.file=/path/to/license.lic
8383
```
8484

85-
Here's what the command does:
86-
- Sets the namespace of where the Operator will be deployed i.e. `kurrent` (feel free to change this)
85+
This command:
86+
- Deploys the Operator into the `kurrent` namespace (use `--create-namespace` to create it). Feel free to modify this namespace.
8787
- Creates the namespace (if it already exists, leave out the `--create-namespace` flag)
8888
- Deploys CRDs (this can be skipped by removing `--set crds.enabled=true`)
89-
- Configures the Operator license
89+
- Applys the Operator license
9090
- Deploys a new Helm release called `kurrentdb-operator` in the `kurrent` namespace.
9191

9292
*Expected Output*:
@@ -155,7 +155,7 @@ helm upgrade kurrentdb-operator kurrent-latest/kurrentdb-operator \
155155
```
156156

157157
This will trigger:
158-
- a new `Role` to be created in the `bar` namespace
158+
- a new `Role` to be created in the `bar` namespace
159159
- a rolling restart of the Operator to pick up the new configuration changes
160160

161161
## Deployment Validation

0 commit comments

Comments
 (0)