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: src/current/v25.2/configure-cockroachdb-kubernetes-operator.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,10 @@ docs_area: deploy
9
9
10
10
This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage.
11
11
12
+
{{site.data.alerts.callout_info}}
13
+
The CockroachDB operator is in [Preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %}).
14
+
{{site.data.alerts.end}}
15
+
12
16
On a production cluster, the resources you allocate to CockroachDB should be proportionate to your machine types and workload. Cockroach Labs recommends that you determine and set these values before deploying the cluster, but you can also update the values on a running cluster.
Copy file name to clipboardExpand all lines: src/current/v25.2/deploy-cockroachdb-with-kubernetes.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ docs_area:
11
11
12
12
This page shows you how to start and stop a secure 3-node CockroachDB cluster in a single [Kubernetes](http://kubernetes.io/) cluster. You can use any of the following approaches:
The CockroachDB Kubernetes Operator is also available on platforms such as [Red Hat OpenShift]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes-openshift.md %}) and [IBM Cloud Pak for Data](https://www.ibm.com/products/cloud-pak-for-data).
@@ -36,7 +36,7 @@ This page shows you how to start and stop a secure 3-node CockroachDB cluster in
36
36
Choose how you want to deploy and maintain the CockroachDB cluster.
37
37
38
38
{{site.data.alerts.callout_info}}
39
-
The [CockroachDB Kubernetes Operator](https://github.com/cockroachdb/cockroach-operator) eases CockroachDB cluster creation and management on a single Kubernetes cluster.
39
+
The [Public Kubernetes operator](https://github.com/cockroachdb/cockroach-operator) eases CockroachDB cluster creation and management on a single Kubernetes cluster.
40
40
41
41
The Operator does not provision or apply an Enterprise license key. To use CockroachDB with the Operator, [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) in the SQL shell.
Copy file name to clipboardExpand all lines: src/current/v25.2/kubernetes-operator-overview.md
+35-1Lines changed: 35 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,4 +8,38 @@ docs_area: deploy
8
8
key: operate-cockroachdb-kubernetes-operator.html
9
9
---
10
10
11
-
Placeholder content introducing the new operator and comparing it to existing k8s deployments.
11
+
The CockroachDB operator is a fully-featured [Kubernetes operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) that allows you to deploy and manage CockroachDB self-hosted clusters.
12
+
13
+
{{site.data.alerts.callout_info}}
14
+
The CockroachDB operator is in [Preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %}).
15
+
{{site.data.alerts.end}}
16
+
17
+
With the CockroachDB operator, you can deploy CockroachDB clusters across multiple regions with separate operator instances per region. Using [Helm](https://helm.sh/), set configurations that manage the operator and CockroachDB nodes across regions.
18
+
19
+
## CockroachDB operator
20
+
21
+
This section describes how to:
22
+
23
+
-[Deploy a CockroachDB cluster using the CockroachDB operator]({% link {{page.version.version}}/deploy-cockroachdb-with-kubernetes-operator.md %}).
24
+
- Migrate from an existing CockroachDB Kubernetes deployment using [Helm]({% link {{page.version.version}}/migrate-cockroachdb-kubernetes-helm.md %}) or the [public operator]({% link {{page.version.version}}/migrate-cockroachdb-kubernetes-operator.md %}).
25
+
- Operate a CockroachDB cluster:
26
+
27
+
-[Manage pod scheduling]({% link {{page.version.version}}/schedule-cockroachdb-kubernetes-operator.md %}).
28
+
-[Manage cluster resources]({% link {{page.version.version}}/configure-cockroachdb-kubernetes-operator.md %}).
29
+
-[Manage certificates]({% link {{page.version.version}}/secure-cockroachdb-kubernetes-operator.md %}).
30
+
-[Scale a cluster]({% link {{page.version.version}}/scale-cockroachdb-kubernetes-operator.md %}).
31
+
-[Monitor a cluster]({% link {{page.version.version}}/monitor-cockroachdb-kubernetes-operator.md %}).
32
+
-[Upgrade a cluster]({% link {{page.version.version}}/upgrade-cockroachdb-kubernetes-operator.md %}).
33
+
-[Improve cluster performance]({% link {{page.version.version}}/kubernetes-operator-performance.md %}).
34
+
35
+
## Kubernetes terminology
36
+
37
+
Before starting, review some basic Kubernetes terminology. Note that CockroachDB [nodes]({% link {{ page.version.version }}/architecture/glossary.md %}#cockroachdb-architecture-terms) are distinct from Kubernetes "nodes" or "worker nodes".
38
+
39
+
Feature | Description
40
+
--------|------------
41
+
[node](https://kubernetes.io/docs/concepts/architecture/nodes/) | A physical or virtual machine. In the [deployment guide]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes-operator.md %}), you'll create instances and join them as worker nodes into a single Kubernetes cluster.
42
+
[pod](http://kubernetes.io/docs/user-guide/pods/) | A pod is a group of one of more Docker containers. In the [deployment guide]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes-operator.md %}), each pod will run on a separate Kubernetes worker node and include one Docker container running a single CockroachDB node, reflecting our [topology recommendations]({% link {{ page.version.version }}/recommended-production-settings.md %}#topology).
43
+
[operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) | An operator is an extension to Kubernetes that uses custom resources to efficiently manage specific applications. The CockroachDB operator includes two custom resource definitions, `cockroachdb` to manage a CockroachDB pod and `operator` to manage the operator pod itself. Unlike the older [public operator](https://github.com/cockroachdb/cockroach-operator), the CockroachDB operator does not use StatefulSets and is designed to simplify multi-region deployments.
44
+
[persistent volume](http://kubernetes.io/docs/user-guide/persistent-volumes/) | A persistent volume is a piece of networked storage (Persistent Disk on GCE, Elastic Block Store on AWS) mounted into a pod. The lifetime of a persistent volume is decoupled from the lifetime of the pod that's using it, ensuring that each CockroachDB node binds back to the same storage on restart.<br><br>The [deployment guide]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes-operator.md %}) assumes that dynamic volume provisioning is available. When that is not the case, [persistent volume claims](http://kubernetes.io/docs/user-guide/persistent-volumes/#persistentvolumeclaims) need to be created manually.
45
+
[RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) | RBAC, or Role-Based Access Control, is the system Kubernetes uses to manage permissions within the cluster. In order to take an action (e.g., `get` or `create`) on an API resource (e.g., a `pod`), the client must have a `Role` that allows it to do so. The [deployment guide]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes-operator.md %}) creates the RBAC resources necessary for CockroachDB to create and access certificates.
Copy file name to clipboardExpand all lines: src/current/v25.2/kubernetes-operator-performance.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,10 @@ docs_area: deploy
7
7
8
8
Kubernetes provides many useful abstractions for deploying and operating distributed systems, but some of the abstractions come with a performance overhead and an increase in underlying system complexity. This page outlines potential bottlenecks when running CockroachDB in Kubernetes and how to optimize performance.
9
9
10
+
{{site.data.alerts.callout_info}}
11
+
The CockroachDB operator is in [Preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %}).
12
+
{{site.data.alerts.end}}
13
+
10
14
## Before you begin
11
15
12
16
Before you focus on optimizing a Kubernetes-orchestrated CockroachDB cluster:
Copy file name to clipboardExpand all lines: src/current/v25.2/monitor-cockroachdb-kubernetes-operator.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,10 @@ docs_area: deploy
8
8
9
9
Despite CockroachDB's various [built-in safeguards against failure](architecture/replication-layer.html), it is critical to actively monitor the overall health and performance of a cluster running in production and to create alerting rules that promptly send notifications when there are events that require investigation or intervention.
10
10
11
+
{{site.data.alerts.callout_info}}
12
+
The CockroachDB operator is in [Preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %}).
13
+
{{site.data.alerts.end}}
14
+
11
15
## Configure Prometheus
12
16
13
17
Every node of a CockroachDB cluster exports granular timeseries metrics formatted for easy integration with [Prometheus](https://prometheus.io/), an open source tool for storing, aggregating, and querying timeseries data. This section shows you how to orchestrate Prometheus as part of your Kubernetes cluster and pull these metrics into Prometheus for external monitoring.
Copy file name to clipboardExpand all lines: src/current/v25.2/schedule-cockroachdb-kubernetes-operator.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,10 @@ docs_area: deploy
9
9
10
10
This page describes how to configure pod scheduling settings. These settings control how CockroachDB pods should be identified or scheduled onto worker nodes, which are then proxied to the Kubernetes scheduler.
11
11
12
+
{{site.data.alerts.callout_info}}
13
+
The CockroachDB operator is in [Preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %}).
14
+
{{site.data.alerts.end}}
15
+
12
16
## Node selectors
13
17
14
18
A pod with a *node selector* will be scheduled onto a worker node that has matching [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/), or key-value pairs.
0 commit comments