You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/server/kubernetes-operator/v1.0.0/getting-started/README.md
+11-15Lines changed: 11 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,32 +9,28 @@ dir:
9
9
<CloudBanner />
10
10
11
11
---
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.
17
13
18
14
:::important
19
15
The Operator is an Enterprise only feature, please [contact us](https://www.kurrent.io/contact) for more information.
20
16
:::
21
17
22
-
## KurrentDB and Kubernetes: The Perfect Match
18
+
## Why run KurrentDB on Kubernetes?
23
19
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.
25
21
26
22
## Features
27
23
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
31
27
32
28
## Supported KurrentDB Versions
33
29
34
30
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
38
34
39
35
## Supported Hardware Architectures
40
36
@@ -44,8 +40,8 @@ The Operator is packaged for the following hardware architectures:
44
40
45
41
## Technical Support
46
42
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).
48
44
49
45
## First Steps
50
46
51
-
Head over to the [installation](installation.md) section to get rolling!
47
+
Ready to install? Head over to the [installation](installation.md) section.
* A valid Operator license. Please [contact us](https://www.kurrent.io/contact) for more information.
19
25
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:
Since CRDs are managed globally by Kubernetes, special care must be taken to install them.
44
44
45
45
### Automatic Install
46
46
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.
48
48
49
49
### Manual Install
50
50
51
-
If the CRDs must be installed manually, then the following steps can be used:
51
+
If you prefer to install CRDs yourself:
52
52
53
53
```bash
54
54
# Download the kurrentdb-operator Helm chart
@@ -64,13 +64,13 @@ customresourcedefinition.apiextensions.k8s.io/kurrentdbs.kubernetes.kurrent.io c
64
64
65
65
## Deployment Modes
66
66
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.
68
68
69
69
### Cluster-wide
70
70
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.
72
72
73
-
To deploy the Operator in this mode, the following command can be used:
0 commit comments