-
Notifications
You must be signed in to change notification settings - Fork 47
k8s: Add 25.2 beta docs for the Redpanda Operator #1307
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
6fafada
11df35d
c4b0e6e
f9581fc
3bf9a33
2a8785c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
= Try the 25.2 Beta of the Redpanda Operator | ||
:page-beta: true | ||
:description: Deploy the 25.2 beta release of the Redpanda Operator. This version of the Redpanda Operator is cluster scope so a single instance of the Operator can manage multiple Redpanda resources in different namespaces. | ||
|
||
{description} | ||
|
||
This beta version is available for testing and feedback. It is not supported by Redpanda and should not be used in production environments. To give feedback on beta releases, reach out to the Redpanda team in https://redpanda.com/slack[Redpanda Community Slack^]. | ||
|
||
== Prerequisites | ||
|
||
Make sure that your Kubernetes cluster meets the xref:./k-requirements.adoc[requirements]. | ||
|
||
== Install Redpanda Operator v25.2.1-beta1 | ||
|
||
. Make sure that you have permission to install custom resource definitions (CRDs): | ||
+ | ||
```bash | ||
kubectl auth can-i create CustomResourceDefinition --all-namespaces | ||
``` | ||
+ | ||
You should see `yes` in the output. | ||
+ | ||
You need these cluster-level permissions to install glossterm:cert-manager[^] and Redpanda Operator CRDs in the next steps. | ||
|
||
. Install cert-manager: | ||
+ | ||
```bash | ||
helm repo add jetstack https://charts.jetstack.io | ||
helm repo update | ||
helm install cert-manager jetstack/cert-manager \ | ||
--set crds.enabled=true \ | ||
--namespace cert-manager \ | ||
--create-namespace | ||
``` | ||
+ | ||
TLS is enabled by default and cert-manager is used to manage TLS certificates. | ||
|
||
. Deploy the Redpanda Operator. | ||
+ | ||
[,bash,subs="attributes+"] | ||
---- | ||
helm repo add redpanda https://charts.redpanda.com | ||
helm upgrade --install redpanda-controller redpanda/operator \ | ||
--namespace <namespace> \ | ||
--create-namespace \ | ||
--version {operator-beta-tag} \ | ||
--set crds.enabled=true | ||
---- | ||
|
||
. Ensure that the Deployment is successfully rolled out: | ||
+ | ||
```bash | ||
kubectl --namespace <namespace> rollout status --watch deployment/redpanda-controller-operator | ||
``` | ||
+ | ||
[.no-copy] | ||
---- | ||
deployment "redpanda-controller-operator" successfully rolled out | ||
---- | ||
|
||
. Install a xref:reference:k-crd.adoc[Redpanda custom resource] to deploy a Redpanda cluster. | ||
+ | ||
.`redpanda-cluster.yaml` | ||
[,yaml,subs="attributes+"] | ||
---- | ||
apiVersion: cluster.redpanda.com/v1alpha2 | ||
kind: Redpanda | ||
metadata: | ||
name: redpanda | ||
---- | ||
|
||
. If you want to use enterprise features in Redpanda, add the details of a Secret that stores your Enterprise Edition license key. | ||
+ | ||
.`redpanda-cluster.yaml` | ||
[,yaml,subs="attributes+"] | ||
---- | ||
apiVersion: cluster.redpanda.com/v1alpha2 | ||
kind: Redpanda | ||
metadata: | ||
name: redpanda | ||
spec: | ||
clusterSpec: | ||
enterprise: | ||
licenseSecretRef: | ||
name: <secret-name> | ||
key: <secret-key> | ||
---- | ||
+ | ||
For details, see xref:get-started:licensing/add-license-redpanda/kubernetes.adoc[]. | ||
|
||
. Apply the Redpanda resource: | ||
+ | ||
```bash | ||
kubectl apply -f redpanda-cluster.yaml --namespace <namespace> | ||
``` | ||
|
||
. Wait for the Redpanda Operator to deploy the cluster: | ||
+ | ||
```bash | ||
kubectl get redpanda --namespace <namespace> --watch | ||
``` | ||
+ | ||
[.no-copy] | ||
---- | ||
NAME READY STATUS | ||
redpanda True Redpanda reconciliation succeeded | ||
---- | ||
+ | ||
This step may take a few minutes. You can watch for new Pods to make sure that the deployment is progressing: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It should be pretty snappy. Is that not what you've experienced? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It sometimes takes a while for the cluster to be ready. I've waited multiple minutes before. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, for the cluster to be ready. Do you often see the redpanda Pods handing around in a Scheduled but not yet Running state? I've seen two primary sources of latency:
|
||
+ | ||
```bash | ||
kubectl get pod --namespace <namespace> | ||
``` | ||
+ | ||
If it's taking too long, see xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc[Troubleshooting]. | ||
|
||
include::deploy:partial$kubernetes/guides/uninstall.adoc[leveloffset=+1] | ||
|
||
== Next steps | ||
|
||
To give feedback about this beta version, reach out to the Redpanda team in https://redpanda.com/slack[Redpanda Community Slack^]. |
Uh oh!
There was an error while loading. Please reload this page.