diff --git a/.github/crd-config/templates/asciidoctor/operator/type.tpl b/.github/crd-config/templates/asciidoctor/operator/type.tpl index f52644792..f27eec312 100644 --- a/.github/crd-config/templates/asciidoctor/operator/type.tpl +++ b/.github/crd-config/templates/asciidoctor/operator/type.tpl @@ -8,7 +8,7 @@ {{ $type.Doc }} {{ if eq $type.Name "RedpandaClusterSpec" }} -For descriptions and default values, see xref:redpanda-helm-spec.adoc[]. +For descriptions and default values, see xref:k-redpanda-helm-spec.adoc[]. {{ end }} {{ if $type.References -}} diff --git a/.github/workflows/generate-crd.yml b/.github/workflows/generate-crd.yml index 6eed21bae..c65b50e9c 100644 --- a/.github/workflows/generate-crd.yml +++ b/.github/workflows/generate-crd.yml @@ -37,12 +37,12 @@ jobs: # Generate Operator CRD documentation. - name: Generate Operator CRD Docs run: | - crd-ref-docs --source-path=./redpanda/src/go/k8s/api/redpanda/v1alpha1 --max-depth=10 --templates-dir=./redpanda-docs/.github/crd-config/templates/asciidoctor/operator --config=./redpanda-docs/.github/crd-config/config.yaml --renderer=asciidoctor --output-path=./redpanda-docs/modules/reference/pages/crd.adoc + crd-ref-docs --source-path=./redpanda/src/go/k8s/api/redpanda/v1alpha1 --max-depth=10 --templates-dir=./redpanda-docs/.github/crd-config/templates/asciidoctor/operator --config=./redpanda-docs/.github/crd-config/config.yaml --renderer=asciidoctor --output-path=./redpanda-docs/modules/reference/pages/k-crd.adoc # Generate Topic CRD documentation. - name: Generate Operator CRD Docs run: | - crd-ref-docs --source-path=./redpanda/src/go/k8s/api/cluster.redpanda.com/v1alpha1 --max-depth=10 --templates-dir=./redpanda-docs/.github/crd-config/templates/asciidoctor/topic --config=./redpanda-docs/.github/crd-config/config.yaml --renderer=asciidoctor --output-path=./redpanda-docs/modules/reference/pages/topic-crd.adoc + crd-ref-docs --source-path=./redpanda/src/go/k8s/api/cluster.redpanda.com/v1alpha1 --max-depth=10 --templates-dir=./redpanda-docs/.github/crd-config/templates/asciidoctor/topic --config=./redpanda-docs/.github/crd-config/config.yaml --renderer=asciidoctor --output-path=./redpanda-docs/modules/reference/pages/k-topic-crd.adoc # Check for any changes made in the documentation. - name: Check if changes were made diff --git a/.github/workflows/generate-helm-spec.yml b/.github/workflows/generate-helm-spec.yml index e91d0a616..e41b089d5 100644 --- a/.github/workflows/generate-helm-spec.yml +++ b/.github/workflows/generate-helm-spec.yml @@ -52,33 +52,33 @@ jobs: # Convert the generated Markdown Helm documentation to AsciiDoc format using pandoc. - name: Convert Markdown to AsciiDoc run: | - pandoc ./helm-charts/charts/redpanda/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc - pandoc ./helm-charts/charts/console/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc - pandoc ./helm-charts/charts/connectors/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc + pandoc ./helm-charts/charts/redpanda/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc + pandoc ./helm-charts/charts/console/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc + pandoc ./helm-charts/charts/connectors/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc - name: Modify third-level headings format run: | - sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc - sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc - sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc - sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc - sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc - sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc - sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc - sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc - sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc + sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc + sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc + sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc + sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc + sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc + sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc + sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc + sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc + sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc - name: Correct AsciiDoc format run: | # Correct the title format - sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc - sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc - sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc + sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc + sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc + sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc # Correct the description format - sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc - sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc - sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc + sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc + sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc + sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc # Check if any changes were made in the documentation. - name: Check if changes were made diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 2a52a76e8..d3e54bf80 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -42,10 +42,10 @@ * xref:deploy:index.adoc[Deploy] ** xref:deploy:deployment-option/self-hosted/index.adoc[Self-Hosted] *** xref:deploy:deployment-option/self-hosted/kubernetes/index.adoc[Kubernetes] -**** xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-production-deployment.adoc[Overview] -**** xref:deploy:deployment-option/self-hosted/kubernetes/production-workflow.adoc[Deployment Workflow] -**** xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc[Requirements and Recommendations] -**** xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-tune-workers.adoc[Tune Worker Nodes] +**** xref:deploy:deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc[Overview] +**** xref:deploy:deployment-option/self-hosted/kubernetes/k-production-workflow.adoc[Deployment Workflow] +**** xref:deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc[Requirements and Recommendations] +**** xref:deploy:deployment-option/self-hosted/kubernetes/k-tune-workers.adoc[Tune Worker Nodes] **** xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-deploy.adoc[Deploy Redpanda] **** xref:deploy:deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc[Deploy Connectors] **** xref:deploy:deployment-option/self-hosted/kubernetes/k-high-availability.adoc[High Availability] @@ -112,7 +112,7 @@ ** xref:upgrade:rolling-upgrade.adoc[Upgrade Redpanda in Linux] ** xref:upgrade:k-rolling-upgrade.adoc[Upgrade Redpanda in Kubernetes] ** xref:upgrade:k-compatibility.adoc[] -** xref:manage:kubernetes/upgrade-kubernetes.adoc[Upgrade Kubernetes on Worker Nodes Running Redpanda] +** xref:manage:kubernetes/k-upgrade-kubernetes.adoc[Upgrade Kubernetes on Worker Nodes Running Redpanda] ** xref:upgrade:deprecated/index.adoc[Deprecated Features] ** xref:upgrade:migrate/index.adoc[Migrate] *** xref:upgrade:migrate/data-migration.adoc[] @@ -120,49 +120,49 @@ *** xref:upgrade:migrate/kubernetes/operator.adoc[] * xref:manage:index.adoc[Manage] ** xref:manage:kubernetes/index.adoc[Kubernetes] -*** xref:manage:kubernetes/configure-helm-chart.adoc[Customize the Helm Chart] -*** xref:manage:kubernetes/cluster-property-configuration.adoc[Cluster Properties] -*** xref:manage:kubernetes/manage-topics.adoc[Manage Topics] -*** xref:manage:kubernetes/manage-connectors.adoc[Manage Connectors] +*** xref:manage:kubernetes/k-configure-helm-chart.adoc[Customize the Helm Chart] +*** xref:manage:kubernetes/k-cluster-property-configuration.adoc[Cluster Properties] +*** xref:manage:kubernetes/k-manage-topics.adoc[Manage Topics] +*** xref:manage:kubernetes/k-manage-connectors.adoc[Manage Connectors] *** xref:manage:kubernetes/storage/index.adoc[Storage] -**** xref:manage:kubernetes/storage/volume-types.adoc[Volume Types] -**** xref:manage:kubernetes/storage/configure-storage.adoc[Configure Storage] -***** xref:manage:kubernetes/storage/configure-persistent-storage.adoc[PersistentVolume] -***** xref:manage:kubernetes/storage/configure-hostpath.adoc[hostPath] -***** xref:manage:kubernetes/storage/configure-emptydir.adoc[emptyDir] +**** xref:manage:kubernetes/storage/k-volume-types.adoc[Volume Types] +**** xref:manage:kubernetes/storage/k-configure-storage.adoc[Configure Storage] +***** xref:manage:kubernetes/storage/k-persistent-storage.adoc[PersistentVolume] +***** xref:manage:kubernetes/storage/k-hostpath.adoc[hostPath] +***** xref:manage:kubernetes/storage/k-emptydir.adoc[emptyDir] **** xref:manage:kubernetes/tiered-storage-kubernetes/index.adoc[Tiered Storage] -***** xref:manage:kubernetes/storage/tiered-storage.adoc[Tiered Storage] -***** xref:manage:kubernetes/storage/data-archiving.adoc[Data Archiving] -**** xref:manage:kubernetes/storage/resize-persistentvolumes.adoc[Expand PersistentVolumes] -**** xref:manage:kubernetes/storage/delete-persistentvolume.adoc[Delete PersistentVolumes] +***** xref:manage:kubernetes/storage/tiered-storage/k-tiered-storage.adoc[Tiered Storage] +***** xref:manage:kubernetes/storage/tiered-storage/k-data-archiving.adoc[Data Archiving] +**** xref:manage:kubernetes/storage/k-resize-persistentvolumes.adoc[Expand PersistentVolumes] +**** xref:manage:kubernetes/storage/k-delete-persistentvolume.adoc[Delete PersistentVolumes] *** xref:manage:kubernetes/networking/index.adoc[Networking and Connectivity] -**** xref:manage:kubernetes/networking/networking-and-connectivity.adoc[Overview] -**** xref:manage:kubernetes/networking/connect-to-redpanda.adoc[Connect to Redpanda] -**** xref:manage:kubernetes/networking/configure-listeners.adoc[Configure Listeners] +**** xref:manage:kubernetes/networking/k-networking-and-connectivity.adoc[Overview] +**** xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[Connect to Redpanda] +**** xref:manage:kubernetes/networking/k-configure-listeners.adoc[Configure Listeners] **** xref:manage:kubernetes/networking/external/index.adoc[External Access] -***** xref:manage:kubernetes/networking/configure-external-access-nodeport.adoc[Use a NodePort Service] -***** xref:manage:kubernetes/networking/configure-external-access-loadbalancer.adoc[Use LoadBalancer Services] -***** xref:manage:kubernetes/networking/custom-services.adoc[Use Custom Services] +***** xref:manage:kubernetes/networking/external/k-nodeport.adoc[Use a NodePort Service] +***** xref:manage:kubernetes/networking/external/k-loadbalancer.adoc[Use LoadBalancer Services] +***** xref:manage:kubernetes/networking/external/k-custom-services.adoc[Use Custom Services] *** xref:manage:kubernetes/security/index.adoc[Security] **** xref:manage:kubernetes/security/tls/index.adoc[TLS Encryption] -***** xref:manage:kubernetes/security/tls/use-cert-manager.adoc[Use cert-manager] -***** xref:manage:kubernetes/security/tls/use-secrets.adoc[Use Secrets] -**** xref:manage:kubernetes/security/authentication/sasl-kubernetes.adoc[Authentication] -*** xref:manage:kubernetes/kubernetes-rack-awareness.adoc[Rack Awareness] -*** xref:manage:kubernetes/remote-read-replicas.adoc[Remote Read Replicas] -*** xref:manage:kubernetes/manage-resources.adoc[Manage Pod Resources] -*** xref:manage:kubernetes/scale.adoc[Scale] -*** xref:manage:kubernetes/decommission-brokers.adoc[Decommission Brokers] +***** xref:manage:kubernetes/security/tls/k-cert-manager.adoc[Use cert-manager] +***** xref:manage:kubernetes/security/tls/k-secrets.adoc[Use Secrets] +**** xref:manage:kubernetes/security/authentication/k-authentication.adoc[Authentication] +*** xref:manage:kubernetes/k-rack-awareness.adoc[Rack Awareness] +*** xref:manage:kubernetes/k-remote-read-replicas.adoc[Remote Read Replicas] +*** xref:manage:kubernetes/k-manage-resources.adoc[Manage Pod Resources] +*** xref:manage:kubernetes/k-scale-redpanda.adoc[Scale] +*** xref:manage:kubernetes/k-decommission-brokers.adoc[Decommission Brokers] *** xref:manage:kubernetes/k-whole-cluster-restore.adoc[Whole Cluster Restore] *** xref:manage:kubernetes/k-recovery-mode.adoc[Recovery Mode] *** xref:manage:kubernetes/monitoring/index.adoc[Monitor] -**** xref:manage:kubernetes/monitoring/monitor-redpanda.adoc[Redpanda] -**** xref:manage:kubernetes/monitoring/monitor-connectors.adoc[Connectors] +**** xref:manage:kubernetes/monitoring/k-monitor-redpanda.adoc[Redpanda] +**** xref:manage:kubernetes/monitoring/k-monitor-connectors.adoc[Connectors] *** xref:manage:kubernetes/k-rolling-restart.adoc[Rolling Restart] -*** xref:manage:kubernetes/resilience-testing.adoc[Resilience Testing] +*** xref:manage:kubernetes/k-resilience-testing.adoc[Resilience Testing] *** xref:manage:kubernetes/troubleshooting/index.adoc[Troubleshooting] -**** xref:manage:kubernetes/troubleshooting/troubleshoot.adoc[] -**** xref:manage:kubernetes/troubleshooting/diagnostics-bundle.adoc[Diagnostics Bundle] +**** xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc[] +**** xref:manage:kubernetes/troubleshooting/k-diagnostics-bundle.adoc[Diagnostics Bundle] ** xref:manage:cluster-maintenance/index.adoc[Cluster Maintenance] *** xref:manage:cluster-maintenance/cluster-property-configuration.adoc[] *** xref:manage:cluster-maintenance/node-property-configuration.adoc[] @@ -228,14 +228,14 @@ *** xref:api:ROOT:pandaproxy-schema-registry.adoc[] *** xref:api:ROOT:admin-api.adoc[] *** xref:reference:data-transform-api.adoc[] -** xref:reference:kubernetes-index.adoc[Kubernetes] -*** xref:reference:kubernetes-helm-index.adoc[] -**** xref:reference:redpanda-helm-spec.adoc[] -**** xref:reference:console-helm-spec.adoc[] -**** xref:reference:connector-helm-spec.adoc[] -*** xref:reference:kubernetes-crd-index.adoc[] -**** xref:reference:crd.adoc[] -**** xref:reference:topic-crd.adoc[] +** xref:reference:k-index.adoc[Kubernetes] +*** xref:reference:k-helm-index.adoc[] +**** xref:reference:k-redpanda-helm-spec.adoc[] +**** xref:reference:k-console-helm-spec.adoc[] +**** xref:reference:k-connector-helm-spec.adoc[] +*** xref:reference:k-crd-index.adoc[] +**** xref:reference:k-crd.adoc[] +**** xref:reference:k-topic-crd.adoc[] ** xref:reference:monitor-metrics.adoc[Monitoring Metrics] *** xref:reference:public-metrics-reference.adoc[Public Metrics Reference] *** xref:reference:internal-metrics-reference.adoc[Internal Metrics Reference] diff --git a/modules/deploy/pages/deployment-option/cloud/managed-connectors/monitor-connectors.adoc b/modules/deploy/pages/deployment-option/cloud/managed-connectors/monitor-connectors.adoc index 3e2e7fdf7..d68ac8fe1 100644 --- a/modules/deploy/pages/deployment-option/cloud/managed-connectors/monitor-connectors.adoc +++ b/modules/deploy/pages/deployment-option/cloud/managed-connectors/monitor-connectors.adoc @@ -1,6 +1,6 @@ = Monitor Connectors :description: Use metrics to monitor the health of your Redpanda managed connectors. -:page-context-links: [{"name": "Cloud", "to": "deploy:deployment-option/cloud/managed-connectors/monitor-connectors.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/monitoring/monitor-connectors.adoc" } ] +:page-context-links: [{"name": "Cloud", "to": "deploy:deployment-option/cloud/managed-connectors/monitor-connectors.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/monitoring/k-monitor-connectors.adoc" } ] :page-cloud: true include::manage:partial$monitor-connectors.adoc[] \ No newline at end of file diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/aks-guide.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/aks-guide.adoc index af816ba55..5ec79736c 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/aks-guide.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/aks-guide.adoc @@ -28,7 +28,7 @@ helm version == Create an AKS cluster -Your AKS cluster must have one worker node available for each Redpanda broker that you plan to deploy in your Redpanda cluster. You also need to run the worker nodes on a machine type that supports the xref:./kubernetes-cluster-requirements.adoc[requirements and recommendations] for production deployments. +Your AKS cluster must have one worker node available for each Redpanda broker that you plan to deploy in your Redpanda cluster. You also need to run the worker nodes on a machine type that supports the xref:./k-requirements.adoc[requirements and recommendations] for production deployments. In this step, you create an AKS cluster with three nodes on https://learn.microsoft.com/en-us/azure/virtual-machines/lsv3-series[Standard_L8s_v3 Azure Virtual Machines (Azure VMs)]. Deploying three nodes allows your AKS cluster to support a Redpanda cluster with three brokers. The Standard_L8s_v3 Azure VMs come with: diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/eks-guide.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/eks-guide.adoc index 393393b23..a3d31c6bb 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/eks-guide.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/eks-guide.adoc @@ -242,7 +242,7 @@ helm version == Create an EKS cluster -Your EKS cluster must have one worker node available for each Redpanda broker that you plan to deploy in your Redpanda cluster. You also need to run the worker nodes on an EC2 instance type that supports the xref:./kubernetes-cluster-requirements.adoc[requirements and recommendations] for production deployments. +Your EKS cluster must have one worker node available for each Redpanda broker that you plan to deploy in your Redpanda cluster. You also need to run the worker nodes on an EC2 instance type that supports the xref:./k-requirements.adoc[requirements and recommendations] for production deployments. In this step, you create an EKS cluster with three nodes on https://aws.amazon.com/ec2/instance-types/c5/[`c5d.2xlarge` instance types]. Deploying three nodes allows your EKS cluster to support a Redpanda cluster with three brokers. The `c5d.2xlarge` instance type comes with: diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/get-started-dev.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/get-started-dev.adoc index 2e6fdcb99..f98401411 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/get-started-dev.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/get-started-dev.adoc @@ -1,6 +1,6 @@ = Get Started with Redpanda in Kubernetes :description: Find guides for setting up a three-broker Redpanda cluster in different Kubernetes platforms. -:page-aliases: quickstart:kubernetes-qs-dev.adoc, getting-started:quick-start-kubernetes.adoc, get-started:quick-start/kubernetes-qs-dev.adoc, quickstart:index.adoc, quickstart:index/index.adoc +:page-aliases: quickstart:kubernetes-qs-dev.adoc, getting-started:quick-start-kubernetes.adoc, get-started:quick-start/kubernetes-qs-dev.adoc, quickstart:index.adoc, quickstart:index/index.adoc, quickstart:kubernetes-qs-cloud.adoc, getting-started:kubernetes-qs-cloud.adoc For end-to-end guides on secure deployments of Redpanda on managed Kubernetes services, see: @@ -9,7 +9,7 @@ For end-to-end guides on secure deployments of Redpanda on managed Kubernetes se * xref:./gke-guide.adoc[Google Kubernetes Engine] (GKE) * xref:./local-guide.adoc[Local (kind or minikube)] -Or, if you're ready to go into production, see the xref:./production-workflow.adoc[production deployment workflow]. +Or, if you're ready to go into production, see the xref:./k-production-workflow.adoc[production deployment workflow]. include::shared:partial$suggested-reading.adoc[] diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/gke-guide.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/gke-guide.adoc index e8da38f96..b71c7135e 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/gke-guide.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/gke-guide.adoc @@ -27,7 +27,7 @@ helm version == Create a GKE cluster -Your GKE cluster must have one worker node available for each Redpanda broker that you plan to deploy in your Redpanda cluster. You also need to run the worker nodes on a machine type that supports the xref:./kubernetes-cluster-requirements.adoc[requirements and recommendations] for production deployments. +Your GKE cluster must have one worker node available for each Redpanda broker that you plan to deploy in your Redpanda cluster. You also need to run the worker nodes on a machine type that supports the xref:./k-requirements.adoc[requirements and recommendations] for production deployments. In this step, you create a GKE cluster with three nodes on https://cloud.google.com/compute/docs/compute-optimized-machines#c2d_series[`c2d-standard-8` machine types]. Deploying three nodes allows your GKE cluster to support a Redpanda cluster with three brokers. The `c2d-standard-8` instance type comes with: diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc index 73cab45a4..1fcc838b9 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc @@ -252,7 +252,7 @@ helm upgrade --install redpanda redpanda/redpanda \ == Configuration advice -This section provides advice for configuring the Redpanda Connectors subchart. All settings are nested in the `connectors` property of the Redpanda Helm chart. For all available settings, see xref:reference:connector-helm-spec.adoc[]. +This section provides advice for configuring the Redpanda Connectors subchart. All settings are nested in the `connectors` property of the Redpanda Helm chart. For all available settings, see xref:reference:k-connector-helm-spec.adoc[]. === Name overrides @@ -271,7 +271,7 @@ connectors: fullnameOverride: 'redpanda-connector-instance-prod' ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#nameoverride[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#nameoverride[Helm specification]. === Labels @@ -284,7 +284,7 @@ connectors: env: 'production' ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#commonlabels[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#commonlabels[Helm specification]. === Tolerations @@ -300,7 +300,7 @@ connectors: effect: "NoSchedule" ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#tolerations[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#tolerations[Helm specification]. === Docker image @@ -316,7 +316,7 @@ connectors: tag: "1.2.3" ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#image[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#image[Helm specification]. === Kafka Connect @@ -339,7 +339,7 @@ connectors: schemaRegistryURL: "http://schema-registry.default.svc.cluster.local:8081" ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#connectors[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#connectors[Helm specification]. === Authentication @@ -356,7 +356,7 @@ connectors: secretRef: "sasl-password-secret" ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#auth[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#auth[Helm specification]. === Container resources @@ -377,7 +377,7 @@ connectors: javaGCLogEnabled: false ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#container[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#container[Helm specification]. === Logging @@ -390,7 +390,7 @@ connectors: level: "info" ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#logging[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#logging[Helm specification]. === Monitoring @@ -403,9 +403,9 @@ connectors: enabled: true ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#monitoring[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#monitoring[Helm specification]. -See also: xref:manage:kubernetes/monitoring/monitor-connectors.adoc[] +See also: xref:manage:kubernetes/monitoring/k-monitor-connectors.adoc[] === Deployment strategy @@ -423,7 +423,7 @@ connectors: maxUnavailable: 1 ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#deployment[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#deployment[Helm specification]. === Probes @@ -441,7 +441,7 @@ connectors: periodSeconds: 10 ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#deployment[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#deployment[Helm specification]. === Deployment history @@ -455,7 +455,7 @@ connectors: revisionHistoryLimit: 10 ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#deployment[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#deployment[Helm specification]. === Affinity rules @@ -496,7 +496,7 @@ In this example: - The `preferredDuringSchedulingIgnoredDuringExecution` section is a soft rule that tries to ensure the Kubernetes scheduler doesn't place two Pods with the same `app: redpanda-connector` label in the same zone. However, if it's not possible, the scheduler can still place the Pods in the same zone. -For all available settings, see the xref:reference:connector-helm-spec.adoc#deployment[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#deployment[Helm specification]. === Graceful shutdown @@ -509,7 +509,7 @@ connectors: terminationGracePeriodSeconds: 30 ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#deployment[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#deployment[Helm specification]. === Service account @@ -523,7 +523,7 @@ connectors: name: "redpanda-connector-service-account" ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#serviceaccount[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#serviceaccount[Helm specification]. === Producers @@ -542,7 +542,7 @@ connectors: producerLingerMS: 1 ---- -For all available settings, see the xref:reference:connector-helm-spec.adoc#connectors[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#connectors[Helm specification]. === Topics @@ -562,7 +562,7 @@ connectors: Here, `_internal_connectors_offsets` is the dedicated Kafka topic where Kafka Connect persists the offsets of the source connector. -For all available settings, see the xref:reference:connector-helm-spec.adoc#connectors[Helm specification]. +For all available settings, see the xref:reference:k-connector-helm-spec.adoc#connectors[Helm specification]. == Verify the deployment @@ -746,6 +746,6 @@ You should see your new connector in the list. == Next steps -- xref:manage:kubernetes/manage-connectors.adoc[] -- xref:manage:kubernetes/monitoring/monitor-connectors.adoc[] +- xref:manage:kubernetes/k-manage-connectors.adoc[] +- xref:manage:kubernetes/monitoring/k-monitor-connectors.adoc[] diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-production-deployment.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc similarity index 94% rename from modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-production-deployment.adoc rename to modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc index 990430d0e..4a334d337 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-production-deployment.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc @@ -1,6 +1,7 @@ = Redpanda in Kubernetes :description: Learn about Redpanda in Kubernetes and the tools that are available. :tags: ["Kubernetes"] +:page-aliases: deploy:deployment-option/self-hosted/kubernetes/kubernetes-production-deployment.adoc Kubernetes is a container orchestration tool that helps you to manage Redpanda deployments using declarative configuration files called _manifests_. Kubernetes provides a standardized way of achieving the following: @@ -93,11 +94,11 @@ Whether you're deploying locally or in the cloud, choose one of the following gu * xref:./eks-guide.adoc[Elastic Kubernetes Service] (EKS) * xref:./gke-guide.adoc[Google Kubernetes Engine] (GKE) -Or, you can explore our xref:./production-workflow.adoc[production workflow] to learn more about the requirements and best practices. +Or, you can explore our xref:./k-production-workflow.adoc[production workflow] to learn more about the requirements and best practices. include::shared:partial$suggested-reading.adoc[] * https://kubernetes.io/docs/concepts/extend-kubernetes/operator/[Kubernetes operator documentation^] * https://helm.sh/docs/intro/using_helm/[Helm documentation^] -* xref:reference:redpanda-helm-spec.adoc[Redpanda Helm Specification] -* xref:reference:crd.adoc[Redpanda CRD Reference] +* xref:reference:k-redpanda-helm-spec.adoc[Redpanda Helm Specification] +* xref:reference:k-crd.adoc[Redpanda CRD Reference] diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-deploy.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-deployment.adoc similarity index 82% rename from modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-deploy.adoc rename to modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-deployment.adoc index cd10a5712..1479d0949 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-deploy.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-deployment.adoc @@ -1,14 +1,15 @@ -= Deploy Redpanda in Kubernetes += Deploy Redpanda for Production in Kubernetes :description: Deploy a Redpanda cluster in Kubernetes. :tags: ["Kubernetes"] -:page-aliases: deploy:deployment-option/self-hosted/kubernetes/kubernetes-best-practices.adoc, deploy:deployment-option/self-hosted/kubernetes/redpanda-cluster-recommendations.adoc +:page-aliases: deploy:deployment-option/self-hosted/kubernetes/kubernetes-best-practices.adoc, deploy:deployment-option/self-hosted/kubernetes/redpanda-cluster-recommendations.adoc, deploy:deployment-option/self-hosted/kubernetes/kubernetes-deploy.adoc :page-toclevels: 1 +:page-context-links: [{"name": "Linux", "to": "deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc" },{"name": "Kubernetes", "to": "deploy:deployment-option/self-hosted/kubernetes/k-production-deployment.adoc" } ] This topic describes how to configure and deploy one or more Redpanda clusters in Kubernetes. == Prerequisites -Make sure that your Kubernetes cluster meets the xref:./kubernetes-cluster-requirements.adoc[requirements]. +Make sure that your Kubernetes cluster meets the xref:./k-requirements.adoc[requirements]. == Deploy a Redpanda cluster @@ -19,7 +20,7 @@ To deploy Redpanda, you can use the following methods: Regardless of the method you choose to deploy Redpanda, you'll deploy the Redpanda Helm chart, which includes Redpanda and Redpanda Console. Redpanda Console comes bundled as a subchart within the Redpanda Helm chart. -TIP: For more details about the differences between these two methods, see xref:./kubernetes-production-deployment.adoc[]. +TIP: For more details about the differences between these two methods, see xref:./k-deployment-overview.adoc[]. [tabs] ==== @@ -86,7 +87,7 @@ kubectl --namespace rollout status --watch deployment/redpanda-contr deployment "redpanda-controller-operator" successfully rolled out ---- -. Install a xref:reference:crd.adoc[Redpanda custom resource] to deploy a Redpanda cluster and Redpanda Console. +. Install a xref:reference:k-crd.adoc[Redpanda custom resource] to deploy a Redpanda cluster and Redpanda Console. + .`redpanda-cluster.yaml` [,yaml,lines=4+6+7] @@ -101,8 +102,8 @@ spec: ---- + - `metadata.name`: Name to assign the Redpanda cluster. This name is also assigned to the Helm release. -- xref:reference:crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-redpanda-v1alpha1-chartref[`spec.chartRef`]: Information about the Helm chart that will be used to deploy Redpanda. -- xref:reference:crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-redpanda-v1alpha1-redpandaclusterspec[`spec.clusterSpec`]: This is where you can override default values in the Redpanda Helm chart. See <> for details. +- xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-redpanda-v1alpha1-chartref[`spec.chartRef`]: Information about the Helm chart that will be used to deploy Redpanda. +- xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-redpanda-v1alpha1-redpandaclusterspec[`spec.clusterSpec`]: This is where you can override default values in the Redpanda Helm chart. See <> for details. . Apply the Redpanda resource: + @@ -130,7 +131,7 @@ This step may take a few minutes. You can watch for new Pods to make sure that t kubectl get pod --namespace ``` + -If it's taking too long, see xref:manage:kubernetes/troubleshooting/troubleshoot.adoc[Troubleshooting]. +If it's taking too long, see xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc[Troubleshooting]. . Verify that each Redpanda broker is scheduled on only one Kubernetes node: + @@ -295,7 +296,7 @@ helm install redpanda-two redpanda/redpanda \ == Configuration advice -This section provides advice for configuring the Redpanda Helm chart. For all available settings, see xref:reference:redpanda-helm-spec.adoc[]. To learn how to customize the Redpanda Helm chart, see xref:manage:kubernetes/configure-helm-chart.adoc[Customize the Helm Chart]. +This section provides advice for configuring the Redpanda Helm chart. For all available settings, see xref:reference:k-redpanda-helm-spec.adoc[]. To learn how to customize the Redpanda Helm chart, see xref:manage:kubernetes/k-configure-helm-chart.adoc[Customize the Helm Chart]. === Name overrides @@ -310,7 +311,7 @@ nameOverride: 'redpanda-production' fullnameOverride: 'redpanda-instance-prod' ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#nameoverride[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#nameoverride[Helm specification]. === Labels @@ -322,7 +323,7 @@ commonLabels: env: 'production' ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#commonlabels[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#commonlabels[Helm specification]. === Tolerations @@ -337,7 +338,7 @@ tolerations: effect: "NoSchedule" ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#tolerations[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#tolerations[Helm specification]. === Docker image @@ -353,7 +354,7 @@ image: imagePullSecrets: [] ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#image[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#image[Helm specification]. === Number of Redpanda brokers @@ -367,12 +368,12 @@ statefulset: NOTE: You must provision one dedicated worker node for each Redpanda broker that you plan to deploy in your Redpanda cluster. The Redpanda Helm chart configures <> to make sure that each Redpanda broker runs on its own worker node. -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#statefulset-replicas[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#statefulset-replicas[Helm specification]. See also: - xref:./k-high-availability.adoc[] -- xref:./kubernetes-cluster-requirements.adoc#number-of-worker-nodes[Kubernetes Cluster Requirements] +- xref:./k-requirements.adoc#number-of-worker-nodes[Kubernetes Cluster Requirements] === TLS @@ -391,7 +392,7 @@ tls: caEnabled: true ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#tls[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#tls[Helm specification]. See also: xref:manage:kubernetes/security/kubernetes-tls.adoc[] @@ -409,9 +410,9 @@ auth: users: [] ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#auth[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#auth[Helm specification]. -See also: xref:manage:kubernetes/security/sasl-kubernetes.adoc[] +See also: xref:manage:kubernetes/security/authentication/k-authentication.adoc[] === Resources @@ -428,12 +429,12 @@ resources: max: 10Gi ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#resources[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#resources[Helm specification]. See also: -- xref:manage:kubernetes/manage-resources.adoc[] -- xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc[] +- xref:manage:kubernetes/k-manage-resources.adoc[] +- xref:deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc[] === Storage @@ -461,12 +462,12 @@ For an example of configuring local PersistentVolumes backed by NVMe disks, see * xref:./gke-guide.adoc#create-sc[Google Kubernetes Engine] (GKE) ==== -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#storage[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#storage[Helm specification]. See also: -- xref:manage:kubernetes/storage/volume-types.adoc[] -- xref:manage:kubernetes/storage/configure-storage.adoc[] +- xref:manage:kubernetes/storage/k-volume-types.adoc[] +- xref:manage:kubernetes/storage/k-configure-storage.adoc[] === External access @@ -483,12 +484,12 @@ external: type: NodePort ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#external[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#external[Helm specification]. See also: -- xref:manage:kubernetes/networking/networking-and-connectivity.adoc[] -- xref:manage:kubernetes/networking/configure-listeners.adoc[] +- xref:manage:kubernetes/networking/k-networking-and-connectivity.adoc[] +- xref:manage:kubernetes/networking/k-configure-listeners.adoc[] === ExternalDNS @@ -509,12 +510,12 @@ external: enabled: true ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#external[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#external[Helm specification]. See also: -- xref:manage:kubernetes/networking/configure-external-access-nodeport.adoc#externaldns[ExternalDNS with a NodePort Service] -- xref:manage:kubernetes/networking/configure-external-access-loadbalancer.adoc#externaldns[ExternalDNS with LoadBalancer Services] +- xref:manage:kubernetes/networking/external/k-nodeport.adoc#externaldns[ExternalDNS with a NodePort Service] +- xref:manage:kubernetes/networking/external/k-loadbalancer.adoc#externaldns[ExternalDNS with LoadBalancer Services] === Logging @@ -526,7 +527,7 @@ logging: level: "info" ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#logging[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#logging[Helm specification]. === Monitoring @@ -538,7 +539,7 @@ monitoring: enabled: true ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#monitoring[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#monitoring[Helm specification]. See also: xref:manage:kubernetes/monitor.adoc[] @@ -555,7 +556,7 @@ statefulset: maxUnavailable: 1 ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#statefulset[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#statefulset[Helm specification]. === Affinity rules @@ -586,7 +587,7 @@ statefulset: topologyKey: "kubernetes.io/zone" ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#statefulset[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#statefulset[Helm specification]. See also: xref:./k-high-availability.adoc[] @@ -600,7 +601,7 @@ statefulset: terminationGracePeriodSeconds: 100 ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#statefulset[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#statefulset[Helm specification]. See also: xref:upgrade:k-rolling-upgrade.adoc[] @@ -615,7 +616,7 @@ serviceAccount: name: "redpanda-service-account" ---- -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#serviceaccount[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#serviceaccount[Helm specification]. [[RBAC]] === Role-based access control (RBAC) @@ -631,9 +632,9 @@ rbac: NOTE: If you use the Redpanda Operator, you must also deploy the Redpanda Operator Helm chart with `rbac.createRPKBundleCRs` set to `true` to give it the required roles. -For all available settings, see the xref:reference:redpanda-helm-spec.adoc#rbac[Helm specification]. +For all available settings, see the xref:reference:k-redpanda-helm-spec.adoc#rbac[Helm specification]. -See also: xref:manage:kubernetes/kubernetes-rack-awareness.adoc[] +See also: xref:manage:kubernetes/k-rack-awareness.adoc[] == Find the latest versions of the Redpanda Helm charts @@ -653,6 +654,8 @@ helm list --namespace include::deploy:partial$kubernetes/default-components.adoc[leveloffset=+1] +include::deploy:partial$kubernetes/guides/troubleshoot.adoc[leveloffset=+1] + == Next steps See the xref:manage:kubernetes/index.adoc[Manage Kubernetes topics] to learn how to customize the chart to meet your needs. @@ -660,5 +663,5 @@ See the xref:manage:kubernetes/index.adoc[Manage Kubernetes topics] to learn how include::shared:partial$suggested-reading.adoc[] - xref:./k-high-availability.adoc[] -- xref:reference:redpanda-helm-spec.adoc[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] +- xref:reference:k-redpanda-helm-spec.adoc[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/production-workflow.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-workflow.adoc similarity index 72% rename from modules/deploy/pages/deployment-option/self-hosted/kubernetes/production-workflow.adoc rename to modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-workflow.adoc index abc7a8122..5d60a89e8 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/production-workflow.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-workflow.adoc @@ -1,9 +1,10 @@ = Production Deployment Workflow for Kubernetes :description: Learn how to deploy Redpanda in Kubernetes for production. :tags: ["Kubernetes"] +:page-aliases: deploy:deployment-option/self-hosted/kubernetes/production-workflow.adoc The production deployment tasks involve Kubernetes administrators (admins) as well as Kubernetes users. . All: xref:./kubernetes-requirements-index.adoc[Review the requirements and recommendations]. -. Admin: xref:./kubernetes-tune-workers.adoc[Tune the worker nodes]. +. Admin: xref:./k-tune-workers.adoc[Tune the worker nodes]. . User: xref:./kubernetes-deploy.adoc[Deploy Redpanda]. diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-requirements.adoc similarity index 87% rename from modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc rename to modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-requirements.adoc index abebd39e9..cc15737fe 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-requirements.adoc @@ -1,8 +1,8 @@ = Kubernetes Cluster Requirements and Recommendations :description: A list of requirements and recommendations for provisioning Kubernetes clusters and worker nodes for running Redpanda in production. :tags: ["Kubernetes"] -:page-aliases: deploy:deployment-option/self-hosted/kubernetes/cloud-instance-local-storage.adoc, deploy:deployment-option/self-hosted/kubernetes/kubernetes-requirements-index.adoc -:page-context-links: [{"name": "Linux", "to": "deploy:deployment-option/self-hosted/manual/production/requirements.adoc" },{"name": "Kubernetes", "to": "deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc" } ] +:page-aliases: deploy:deployment-option/self-hosted/kubernetes/cloud-instance-local-storage.adoc, deploy:deployment-option/self-hosted/kubernetes/kubernetes-requirements-index.adoc, deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc +:page-context-links: [{"name": "Linux", "to": "deploy:deployment-option/self-hosted/manual/production/requirements.adoc" },{"name": "Kubernetes", "to": "deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc" } ] :env-kubernetes: This topic provides the requirements and recommendations for provisioning Kubernetes clusters and worker nodes for running Redpanda in production. @@ -15,8 +15,8 @@ xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-deploy.adoc[]. include::shared:partial$suggested-reading.adoc[] -- xref:reference:redpanda-helm-spec.adoc[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] +- xref:reference:k-redpanda-helm-spec.adoc[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] - xref:deploy:deployment-option/self-hosted/manual/sizing.adoc[Sizing Guidelines] - Resources for Kubernetes managed services: diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-tune-workers.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-tune-workers.adoc similarity index 97% rename from modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-tune-workers.adoc rename to modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-tune-workers.adoc index 0acbd7e6d..ffe257f8a 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/kubernetes-tune-workers.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-tune-workers.adoc @@ -1,6 +1,7 @@ = Tune Kubernetes Worker Nodes for Production :description: To get the best performance from your hardware, set Redpanda to production mode and run the autotuner tool. The autotuner identifies your hardware configuration and tunes itself to give you the best performance. :tags: ["Kubernetes"] +:page-aliases: deploy:deployment-option/self-hosted/kubernetes/kubernetes-tune-workers.adoc To get the best performance from your hardware, set Redpanda to production mode on each worker node and run the xref:reference:rpk/rpk-redpanda/rpk-redpanda-tune.adoc[autotuner tool]. The autotuner identifies the hardware configuration on your worker node and optimizes the Linux kernel to give you the best performance. diff --git a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/local-guide.adoc b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/local-guide.adoc index c5e0a7018..510ac5c4f 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/kubernetes/local-guide.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/kubernetes/local-guide.adoc @@ -1,5 +1,6 @@ = Deploy a Local Development Cluster with kind or minikube :description: Deploy a local Redpanda cluster with Redpanda Console using the Helm chart. +:page-aliases: getting-started:kubernetes-qs-local-access.adoc, quickstart:kubernetes-qs-local-access.adoc, quickstart:kubernetes-qs-minikube.adoc, getting-started:kubernetes-qs-minikube.adoc Deploy a local Redpanda cluster with Redpanda Console using the Helm chart. Explore the essentials of how Redpanda works in Kubernetes and what components are deployed by default. Then, use `rpk` both as an internal client and an external client to interact with your Redpanda cluster from the command line. @@ -171,7 +172,7 @@ kubectl --namespace rollout status --watch deployment/redpanda-contr deployment "redpanda-controller-operator" successfully rolled out ---- -. Install a xref:reference:crd.adoc[Redpanda custom resource] in the same namespace as the Redpanda Operator: +. Install a xref:reference:k-crd.adoc[Redpanda custom resource] in the same namespace as the Redpanda Operator: + .`redpanda-cluster.yaml` [,yaml] @@ -281,7 +282,7 @@ Helm + Operator:: + -- -.. Create a xref:manage:kubernetes/manage-topics.adoc[Topic resource]: +.. Create a xref:manage:kubernetes/k-manage-topics.adoc[Topic resource]: + .`topic.yaml` [,yaml] @@ -495,7 +496,7 @@ kubectl --namespace get secret redpanda-external-root-certificate -o include::get-started:partial$install-rpk-linux.adoc[] -- -. Configure `rpk` to connect to your cluster using the xref:manage:kubernetes/networking/connect-to-redpanda.adoc#rpk-profile[pre-configured profile]: +. Configure `rpk` to connect to your cluster using the xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc#rpk-profile[pre-configured profile]: + [source,bash] ---- diff --git a/modules/deploy/pages/deployment-option/self-hosted/manual/production/requirements.adoc b/modules/deploy/pages/deployment-option/self-hosted/manual/production/requirements.adoc index c136e29f5..e861ffb2a 100644 --- a/modules/deploy/pages/deployment-option/self-hosted/manual/production/requirements.adoc +++ b/modules/deploy/pages/deployment-option/self-hosted/manual/production/requirements.adoc @@ -1,6 +1,6 @@ = Requirements and Recommendations :description: A list of requirements and recommendations for provisioning servers to run Redpanda in production. -:page-context-links: [{"name": "Linux", "to": "deploy:deployment-option/self-hosted/manual/production/requirements.adoc" },{"name": "Kubernetes", "to": "deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "deploy:deployment-option/self-hosted/manual/production/requirements.adoc" },{"name": "Kubernetes", "to": "deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc" } ] This topic provides the requirements and recommendations for provisioning servers to run Redpanda in production. diff --git a/modules/deploy/partials/high-availability.adoc b/modules/deploy/partials/high-availability.adoc index 8830446c7..23ca482fd 100644 --- a/modules/deploy/partials/high-availability.adoc +++ b/modules/deploy/partials/high-availability.adoc @@ -1,8 +1,8 @@ // define single-sourced links for different deployments ifdef::env-kubernetes[] -:remote-read-replicas: manage:kubernetes/remote-read-replicas.adoc -:rack-awareness: manage:kubernetes/kubernetes-rack-awareness.adoc -:tiered-storage: manage:kubernetes/storage/tiered-storage.adoc +:remote-read-replicas: manage:kubernetes/k-remote-read-replicas.adoc +:rack-awareness: manage:kubernetes/k-rack-awareness.adoc +:tiered-storage: manage:kubernetes/storage/tiered-storage/k-tiered-storage.adoc endif::[] ifndef::env-kubernetes[] :remote-read-replicas: manage:remote-read-replicas.adoc @@ -145,8 +145,8 @@ Data persistence and protection are crucial for high availability: See also: -- xref:manage:kubernetes/storage/volume-types.adoc[] -- xref:manage:kubernetes/storage/configure-storage.adoc[] +- xref:manage:kubernetes/storage/k-volume-types.adoc[] +- xref:manage:kubernetes/storage/k-configure-storage.adoc[] endif::[] == HA features in Redpanda diff --git a/modules/deploy/partials/kubernetes/default-components.adoc b/modules/deploy/partials/kubernetes/default-components.adoc index 1c0179fe3..274bc5004 100644 --- a/modules/deploy/partials/kubernetes/default-components.adoc +++ b/modules/deploy/partials/kubernetes/default-components.adoc @@ -154,7 +154,7 @@ External access is made available by a NodePort service that opens the following | 9644 |=== -To learn more, see xref:manage:kubernetes/networking/networking-and-connectivity.adoc[Networking and Connectivity in Kubernetes]. +To learn more, see xref:manage:kubernetes/networking/k-networking-and-connectivity.adoc[Networking and Connectivity in Kubernetes]. == TLS Certificates diff --git a/modules/deploy/partials/kubernetes/guides/deploy-redpanda.adoc b/modules/deploy/partials/kubernetes/guides/deploy-redpanda.adoc index 50ecd1cca..150be81bd 100644 --- a/modules/deploy/partials/kubernetes/guides/deploy-redpanda.adoc +++ b/modules/deploy/partials/kubernetes/guides/deploy-redpanda.adoc @@ -60,7 +60,7 @@ kubectl --namespace rollout status --watch deployment/redpanda-contr deployment "redpanda-controller-operator" successfully rolled out ---- -. Install a xref:reference:crd.adoc[Redpanda custom resource] in the same namespace as the Redpanda Operator: +. Install a xref:reference:k-crd.adoc[Redpanda custom resource] in the same namespace as the Redpanda Operator: + .`redpanda-cluster.yaml` [,yaml,lines=9+14+18] diff --git a/modules/deploy/partials/kubernetes/guides/external-access-intro.adoc b/modules/deploy/partials/kubernetes/guides/external-access-intro.adoc index ab5f1bc5a..d43abdb36 100644 --- a/modules/deploy/partials/kubernetes/guides/external-access-intro.adoc +++ b/modules/deploy/partials/kubernetes/guides/external-access-intro.adoc @@ -14,5 +14,5 @@ To access your Redpanda brokers externally, you can map your worker nodes' IP ad ==== IP addresses can change. If the IP addresses of your worker nodes change, you must update your `/etc/hosts` file with the new mappings. -In a production environment, it's a best practice to use ExternalDNS to manage DNS records for your brokers. See xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc#use-externaldns-for-external-access[Use ExternalDNS for external access]. +In a production environment, it's a best practice to use ExternalDNS to manage DNS records for your brokers. See xref:deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc#use-externaldns-for-external-access[Use ExternalDNS for external access]. ==== diff --git a/modules/deploy/partials/kubernetes/guides/external-access-steps.adoc b/modules/deploy/partials/kubernetes/guides/external-access-steps.adoc index 8fbb5d653..54f9033ee 100644 --- a/modules/deploy/partials/kubernetes/guides/external-access-steps.adoc +++ b/modules/deploy/partials/kubernetes/guides/external-access-steps.adoc @@ -39,7 +39,7 @@ include::get-started:partial$install-rpk-homebrew.adoc[] -- ===== -. Configure `rpk` to connect to your cluster using the xref:manage:kubernetes/networking/connect-to-redpanda.adoc#rpk-profile[pre-configured profile]: +. Configure `rpk` to connect to your cluster using the xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc#rpk-profile[pre-configured profile]: + [source,bash] ---- diff --git a/modules/deploy/partials/kubernetes/guides/next-steps.adoc b/modules/deploy/partials/kubernetes/guides/next-steps.adoc index b06059176..c5c5402be 100644 --- a/modules/deploy/partials/kubernetes/guides/next-steps.adoc +++ b/modules/deploy/partials/kubernetes/guides/next-steps.adoc @@ -4,4 +4,4 @@ * xref:manage:console/index.adoc[Learn more about Redpanda Console] * xref:get-started:rpk-install.adoc[Learn more about rpk] -TIP: When you're ready to use a registered domain, make sure to remove your entries from the `/etc/hosts` file, and see xref:manage:kubernetes/networking/configure-external-access-nodeport.adoc#use-the-default-redpanda-subdomains[Configure External Access through a NodePort Service]. \ No newline at end of file +TIP: When you're ready to use a registered domain, make sure to remove your entries from the `/etc/hosts` file, and see xref:manage:kubernetes/networking/external/k-nodeport.adoc#use-the-default-redpanda-subdomains[Configure External Access through a NodePort Service]. \ No newline at end of file diff --git a/modules/deploy/partials/kubernetes/guides/start-streaming.adoc b/modules/deploy/partials/kubernetes/guides/start-streaming.adoc index 052eaf489..4d1e4f957 100644 --- a/modules/deploy/partials/kubernetes/guides/start-streaming.adoc +++ b/modules/deploy/partials/kubernetes/guides/start-streaming.adoc @@ -17,7 +17,7 @@ Helm + Operator:: + -- -.. Create a xref:manage:kubernetes/manage-topics.adoc[Topic resource]: +.. Create a xref:manage:kubernetes/k-manage-topics.adoc[Topic resource]: + .`topic.yaml` [,yaml] diff --git a/modules/deploy/partials/kubernetes/guides/suggested-reading-content.adoc b/modules/deploy/partials/kubernetes/guides/suggested-reading-content.adoc index 0450552f8..f7e8fee7b 100644 --- a/modules/deploy/partials/kubernetes/guides/suggested-reading-content.adoc +++ b/modules/deploy/partials/kubernetes/guides/suggested-reading-content.adoc @@ -1,7 +1,7 @@ * https://killercoda.com/redpanda/scenario/redpanda-k8s[Getting started with Redpanda in Kubernetes (blog)^] -* xref:manage:kubernetes/networking/networking-and-connectivity.adoc[Networking and Connectivity in Kubernetes] +* xref:manage:kubernetes/networking/k-networking-and-connectivity.adoc[Networking and Connectivity in Kubernetes] * xref:manage:kubernetes/security/kubernetes-tls.adoc[Configure TLS for Redpanda in Kubernetes] -* xref:manage:kubernetes/security/sasl-kubernetes.adoc[Configure SASL for Redpanda in Kubernetes] -* xref:reference:redpanda-helm-spec.adoc[Redpanda Helm Specification] -* xref:reference:crd.adoc[Redpanda CRD Reference] +* xref:manage:kubernetes/security/authentication/k-authentication.adoc[Configure SASL for Redpanda in Kubernetes] +* xref:reference:k-redpanda-helm-spec.adoc[Redpanda Helm Specification] +* xref:reference:k-crd.adoc[Redpanda CRD Reference] * https://github.com/redpanda-data/console[Redpanda Console README^] on GitHub diff --git a/modules/deploy/partials/kubernetes/guides/troubleshoot.adoc b/modules/deploy/partials/kubernetes/guides/troubleshoot.adoc index 302e7395a..e1013cbdf 100644 --- a/modules/deploy/partials/kubernetes/guides/troubleshoot.adoc +++ b/modules/deploy/partials/kubernetes/guides/troubleshoot.adoc @@ -2,6 +2,6 @@ Before troubleshooting your cluster, make sure that you have all the <>. -include::manage:kubernetes/troubleshooting/troubleshoot.adoc[tags=deployment,leveloffset=-1] +include::manage:kubernetes/troubleshooting/k-troubleshoot.adoc[tags=deployment,leveloffset=-1] -For more troubleshooting steps, see xref:manage:kubernetes/troubleshooting/troubleshoot.adoc[Troubleshoot Redpanda in Kubernetes]. \ No newline at end of file +For more troubleshooting steps, see xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc[Troubleshoot Redpanda in Kubernetes]. \ No newline at end of file diff --git a/modules/deploy/partials/requirements.adoc b/modules/deploy/partials/requirements.adoc index 64fd6320d..8f37677f0 100644 --- a/modules/deploy/partials/requirements.adoc +++ b/modules/deploy/partials/requirements.adoc @@ -36,7 +36,7 @@ Each Redpanda broker requires its own dedicated {node} for the following reasons - *Fault tolerance*: Ensuring each broker operates on a separate node enhances fault tolerance. If one node experiences issues, it won't directly impact the other brokers. ifdef::env-kubernetes[] -NOTE: The Redpanda Helm chart configures xref:reference:redpanda-helm-spec.adoc#statefulset-podantiaffinity[`podAntiAffinity` rules] to make sure that each Redpanda broker runs on its own {node}. +NOTE: The Redpanda Helm chart configures xref:reference:k-redpanda-helm-spec.adoc#statefulset-podantiaffinity[`podAntiAffinity` rules] to make sure that each Redpanda broker runs on its own {node}. *Recommendations*: xref:./kubernetes-deploy.adoc#pod-replicas[Deploy at least three Pod replicas]. @@ -75,7 +75,7 @@ endif::[] The Redpanda data directory (`/var/lib/redpanda/data`) and the Tiered Storage cache must be mounted on an XFS or ext4 file system. ifdef::env-kubernetes[] + -For information about supported volume types for different data in Redpanda, see xref:manage:kubernetes/storage/volume-types.adoc[]. +For information about supported volume types for different data in Redpanda, see xref:manage:kubernetes/storage/k-volume-types.adoc[]. endif::[] + CAUTION: Avoid using NFS (Network File System) for the Redpanda data directory or the Tiered Storage cache. @@ -118,7 +118,7 @@ endif::[] Before deploying Redpanda to production, each {node} that runs Redpanda must be tuned to optimize the Linux kernel for Redpanda processes. ifdef::env-kubernetes[] -See xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-tune-workers.adoc[]. +See xref:deploy:deployment-option/self-hosted/kubernetes/k-tune-workers.adoc[]. endif::[] ifndef::env-kubernetes[] See xref:deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc[]. diff --git a/modules/develop/pages/config-topics.adoc b/modules/develop/pages/config-topics.adoc index 60f925dda..33e34c2f4 100644 --- a/modules/develop/pages/config-topics.adoc +++ b/modules/develop/pages/config-topics.adoc @@ -1,6 +1,6 @@ = Manage Topics :description: Learn how to create topics, update topic configurations, and delete topics or records. -:page-context-links: [{"name": "Linux", "to": "develop:config-topics.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/manage-topics.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "develop:config-topics.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/k-manage-topics.adoc" } ] include::develop:partial$topic-defaults.adoc[] diff --git a/modules/develop/partials/run-transforms.adoc b/modules/develop/partials/run-transforms.adoc index 45340a71d..3c7b0348e 100644 --- a/modules/develop/partials/run-transforms.adoc +++ b/modules/develop/partials/run-transforms.adoc @@ -26,7 +26,7 @@ endif::[] Install `rpk` on your host machine and configure it to connect to your Redpanda cluster. ifdef::env-kubernetes[] + -You can use a xref:manage:kubernetes/networking/connect-to-redpanda.adoc#rpk-profile[pre-configured `rpk` profile]: +You can use a xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc#rpk-profile[pre-configured `rpk` profile]: + [source,bash] ---- @@ -304,7 +304,7 @@ rpk topic consume demo-2 You can see STDOUT and STDERR for your function in the broker's logs. ifdef::env-kubernetes[] -See xref:manage:kubernetes/troubleshooting/troubleshoot.adoc#view-redpanda-logs[View Redpanda logs]. +See xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc#view-redpanda-logs[View Redpanda logs]. endif::[] ==== diff --git a/modules/develop/partials/topic-defaults.adoc b/modules/develop/partials/topic-defaults.adoc index eedbaf259..ddeef6aca 100644 --- a/modules/develop/partials/topic-defaults.adoc +++ b/modules/develop/partials/topic-defaults.adoc @@ -1,5 +1,5 @@ ifdef::env-kubernetes[] -:cluster-props-link: manage:kubernetes/cluster-property-configuration.adoc +:cluster-props-link: manage:kubernetes/k-cluster-property-configuration.adoc endif::[] ifndef::env-kubernetes[] :cluster-props-link: manage:cluster-maintenance/cluster-property-configuration.adoc diff --git a/modules/manage/pages/cluster-maintenance/cluster-property-configuration.adoc b/modules/manage/pages/cluster-maintenance/cluster-property-configuration.adoc index 7917c59f8..8370451a7 100644 --- a/modules/manage/pages/cluster-maintenance/cluster-property-configuration.adoc +++ b/modules/manage/pages/cluster-maintenance/cluster-property-configuration.adoc @@ -1,6 +1,6 @@ = Configure Cluster Properties :description: Learn how to configure cluster properties. -:page-context-links: [{"name": "Linux", "to": "manage:cluster-maintenance/cluster-property-configuration.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/cluster-property-configuration.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:cluster-maintenance/cluster-property-configuration.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/k-cluster-property-configuration.adoc" } ] :page-aliases: manage:cluster-maintenance/configuration.adoc, deploy-self-hosted:configuration.adoc, cluster-administration:configuration.adoc, cluster-management:configuration.adoc, cluster-administration:cluster-property-configuration.adoc When you install Redpanda software, cluster configuration properties are automatically set to the default values. Examples of cluster properties include Kafka front-end settings, authentication settings, and settings for enabling features, like Tiered Storage and rack awareness. diff --git a/modules/manage/pages/cluster-maintenance/decommission-brokers.adoc b/modules/manage/pages/cluster-maintenance/decommission-brokers.adoc index 14c64d240..aed325d36 100644 --- a/modules/manage/pages/cluster-maintenance/decommission-brokers.adoc +++ b/modules/manage/pages/cluster-maintenance/decommission-brokers.adoc @@ -1,6 +1,6 @@ = Decommission Brokers :description: Remove a broker so that it is no longer considered part of the cluster. -:page-context-links: [{"name": "Linux", "to": "manage:cluster-maintenance/decommission-brokers.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/decommission-brokers.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:cluster-maintenance/decommission-brokers.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/k-decommission-brokers.adoc" } ] When you decommission a broker, its partition replicas are reallocated across the remaining brokers and it is removed from the cluster. You may want to decommission a broker in the following circumstances: diff --git a/modules/manage/pages/data-archiving.adoc b/modules/manage/pages/data-archiving.adoc index cc1f24158..6cf267a89 100644 --- a/modules/manage/pages/data-archiving.adoc +++ b/modules/manage/pages/data-archiving.adoc @@ -1,6 +1,6 @@ = Data Archiving :description: Set up data archiving to back up topics to cloud storage. -:page-context-links: [{"name": "Linux", "to": "manage:data-archiving.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/data-archiving.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:data-archiving.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/storage/tiered-storage/k-data-archiving.adoc" } ] :page-aliases: data-management:data-archiving.adoc include::manage:partial$data-archiving.adoc[] diff --git a/modules/manage/pages/kubernetes/cluster-property-configuration.adoc b/modules/manage/pages/kubernetes/k-cluster-property-configuration.adoc similarity index 88% rename from modules/manage/pages/kubernetes/cluster-property-configuration.adoc rename to modules/manage/pages/kubernetes/k-cluster-property-configuration.adoc index df7ae74ab..fd3d5072c 100644 --- a/modules/manage/pages/kubernetes/cluster-property-configuration.adoc +++ b/modules/manage/pages/kubernetes/k-cluster-property-configuration.adoc @@ -1,13 +1,14 @@ = Configure Cluster Properties in Kubernetes :description: Learn how to configure cluster properties in Kubernetes. -:page-context-links: [{"name": "Linux", "to": "manage:cluster-maintenance/cluster-property-configuration.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/cluster-property-configuration.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:cluster-maintenance/cluster-property-configuration.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/k-cluster-property-configuration.adoc" } ] +:page-aliases: manage:kubernetes/cluster-property-configuration.adoc -When you install Redpanda, it automatically generates a cluster configuration with default settings assigned to each cluster property. +When you install Redpanda, it automatically generates cluster configuration with default settings assigned to each cluster property. You might want to change some of the default settings, particularly if you plan to use features such as rack awareness or Tiered Storage, which are disabled by default. -To configure cluster properties, you must override the defaults in the Redpanda Helm chart's values using the `helm upgrade --install` command. +To configure cluster properties, you must override the defaults in the Redpanda Helm chart's values. Some cluster configuration properties require a restart. -By using the `helm upgrade --install` command, you allow Helm to restart the Pods for you automatically to make the changes take effect. +By overriding the defaults, you allow Helm to restart the Pods for you automatically to make the changes take effect. Using Helm to make cluster configuration changes also allows you to replicate, reproduce, and recover your cluster. To view all cluster properties, along with their descriptions and default settings, see xref:reference:cluster-properties.adoc[cluster configuration properties] and xref:reference:tunable-properties.adoc[tunable properties]. Some cluster configuration properties are nested within other objects in the Helm chart's values. For example, `cloud_storage_access_key` is nested inside `storage.tieredStorage`. @@ -16,8 +17,6 @@ NOTE: xref:reference:tunable-properties.adoc[Tunable properties], such as intern == Edit cluster properties -To change any property settings, edit the default configuration using the `--values` or `--set` flags in the `helm upgrade --install` command. For example, to set the config_ref:cloud_storage_access_key,true,cluster-properties[] cluster configuration: - [tabs] ====== Helm + Operator:: @@ -47,6 +46,8 @@ Helm:: + -- +To change any property settings, edit the default configuration using the `--values` or `--set` flags in the `helm upgrade --install` command. For example, to set the config_ref:cloud_storage_access_key,true,cluster-properties[] cluster configuration: + [tabs] ==== --values:: @@ -96,7 +97,7 @@ producer To see all Redpanda configurations for a broker, you can use the `rpk cluster config export` command to save the current Redpanda configuration to a file. For example, you may want to use the configuration file during debugging. -TIP: To get more detailed information about your Redpanda deployment, generate a xref:manage:kubernetes/troubleshooting/diagnostics-bundle.adoc[diagnostics bundle], which includes the Redpanda configuration files for all brokers in the cluster. +TIP: To get more detailed information about your Redpanda deployment, generate a xref:manage:kubernetes/troubleshooting/k-diagnostics-bundle.adoc[diagnostics bundle], which includes the Redpanda configuration files for all brokers in the cluster. . Execute the `rpk cluster config export` command inside a Pod container that's running a Redpanda broker. + diff --git a/modules/manage/pages/kubernetes/configure-helm-chart.adoc b/modules/manage/pages/kubernetes/k-configure-helm-chart.adoc similarity index 94% rename from modules/manage/pages/kubernetes/configure-helm-chart.adoc rename to modules/manage/pages/kubernetes/k-configure-helm-chart.adoc index a2e6bc743..372a4cc11 100644 --- a/modules/manage/pages/kubernetes/configure-helm-chart.adoc +++ b/modules/manage/pages/kubernetes/k-configure-helm-chart.adoc @@ -1,7 +1,7 @@ = Configure Redpanda in Kubernetes :description: Customize the values of the Redpanda Helm chart to configure the cluster and the Kubernetes components that the chart deploys. :tags: ["Kubernetes"] -:page-aliases: manage:kubernetes/helm-configuration.adoc, manage:helm-configuration.adoc +:page-aliases: manage:kubernetes/helm-configuration.adoc, manage:helm-configuration.adoc, deploy-self-hosted:arbitrary-configuration.adoc, features:kubernetes-additional-config.adoc, deployment:arbitrary-configuration.adoc, deployment:kubernetes-additional-config.adoc, manage:kubernetes/configure-helm-chart.adoc To configure the cluster and the Kubernetes components that the chart deploys, you can customize the values of the Redpanda Helm chart. @@ -22,7 +22,7 @@ helm repo update helm show values redpanda/redpanda ---- -This command displays all the values, descriptions, and defaults, which are also documented in the xref:reference:redpanda-helm-spec.adoc[Redpanda Helm Chart Specification]. +This command displays all the values, descriptions, and defaults, which are also documented in the xref:reference:k-redpanda-helm-spec.adoc[Redpanda Helm Chart Specification]. == Configure Redpanda @@ -32,7 +32,7 @@ Helm + Operator:: + -- -To customize the values of the Redpanda Helm chart, you can override the defaults in the xref:reference:crd.adoc#redpanda[Redpanda custom resource]. +To customize the values of the Redpanda Helm chart, you can override the defaults in the xref:reference:k-crd.adoc#redpanda[Redpanda custom resource]. You must add all your overrides to the `spec.clusterSpec` configuration. diff --git a/modules/manage/pages/kubernetes/decommission-brokers.adoc b/modules/manage/pages/kubernetes/k-decommission-brokers.adoc similarity index 98% rename from modules/manage/pages/kubernetes/decommission-brokers.adoc rename to modules/manage/pages/kubernetes/k-decommission-brokers.adoc index 7f6d4b80e..3c1b47787 100644 --- a/modules/manage/pages/kubernetes/decommission-brokers.adoc +++ b/modules/manage/pages/kubernetes/k-decommission-brokers.adoc @@ -1,7 +1,8 @@ = Decommission Brokers in Kubernetes :description: Remove a broker so that it is no longer considered part of the cluster. -:page-context-links: [{"name": "Linux", "to": "manage:cluster-maintenance/decommission-brokers.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/decommission-brokers.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:cluster-maintenance/decommission-brokers.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/k-decommission-brokers.adoc" } ] :tags: ["Kubernetes"] +:page-aliases: manage:kubernetes/decommission-brokers.adoc When you decommission a broker, its partition replicas are reallocated across the remaining brokers and it is removed from the cluster. You may want to decommission a broker in the following circumstances: @@ -130,7 +131,7 @@ Throughput is the primary measurement required to calculate future data storage | `(200MB/sec * 3d * 1.1) = 57.024TB / 5 brokers = 11.4TB` |=== -In the example cluster, only six hours of data locally must be retained. Any older data can be moved to xref:manage:kubernetes/storage/tiered-storage.adoc[Tiered Storage] with a retention of one year. So each broker should have 1.2TB of storage available, taking into account both throughput and current data. +In the example cluster, only six hours of data locally must be retained. Any older data can be moved to xref:manage:kubernetes/storage/tiered-storage/k-tiered-storage.adoc[Tiered Storage] with a retention of one year. So each broker should have 1.2TB of storage available, taking into account both throughput and current data. Cost and use case requirements determine how much to spend on local disk capacity. Tiered Storage can help to both decrease costs and expand data retention capabilities. @@ -588,7 +589,7 @@ helm_ref:logging[] == Next steps -If you have rack awareness enabled, you may want to reassign the remaining brokers to appropriate racks after the decommission process is complete. See xref:manage:kubernetes/kubernetes-rack-awareness.adoc[]. +If you have rack awareness enabled, you may want to reassign the remaining brokers to appropriate racks after the decommission process is complete. See xref:manage:kubernetes/k-rack-awareness.adoc[]. include::shared:partial$suggested-reading.adoc[] diff --git a/modules/manage/pages/kubernetes/manage-connectors.adoc b/modules/manage/pages/kubernetes/k-manage-connectors.adoc similarity index 96% rename from modules/manage/pages/kubernetes/manage-connectors.adoc rename to modules/manage/pages/kubernetes/k-manage-connectors.adoc index 3a20bfdc5..0c97d3790 100644 --- a/modules/manage/pages/kubernetes/manage-connectors.adoc +++ b/modules/manage/pages/kubernetes/k-manage-connectors.adoc @@ -1,5 +1,6 @@ = Create and Manage Connectors in Kubernetes :description: Learn how to create and manage connectors using Redpanda Console or the Kafka Connect REST API. +:page-aliases: manage:kubernetes/manage-connectors.adoc When you have Redpanda Connectors deployed, you can create and manage connectors using Redpanda Console or the Kafka Connect REST API. @@ -108,4 +109,4 @@ curl "localhost:8083/connectors/heartbeat-connector" -X 'DELETE' == Next steps -- xref:manage:kubernetes/monitoring/monitor-connectors.adoc[] \ No newline at end of file +- xref:manage:kubernetes/monitoring/k-monitor-connectors.adoc[] \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/manage-resources.adoc b/modules/manage/pages/kubernetes/k-manage-resources.adoc similarity index 94% rename from modules/manage/pages/kubernetes/manage-resources.adoc rename to modules/manage/pages/kubernetes/k-manage-resources.adoc index e9e1c9533..99cb2521b 100644 --- a/modules/manage/pages/kubernetes/manage-resources.adoc +++ b/modules/manage/pages/kubernetes/k-manage-resources.adoc @@ -1,6 +1,7 @@ = Manage Pod Resources in Kubernetes :description: Configure your Pod resources such as memory, CPU, and storage. :tags: ["Kubernetes", "Helm configuration"] +:page-aliases: manage:kubernetes/manage-resources.adoc You can define requirements for Pod resources such as CPU, memory, and storage. Redpanda Data recommends that you determine and set these values before deploying the cluster, but you can also update the values on a running cluster. @@ -15,7 +16,7 @@ kubectl describe nodes == Prerequisites -See xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc[] for memory, CPU, and storage. +See xref:deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc[] for memory, CPU, and storage. Make sure that your physical or virtual machines have enough resources to give to Redpanda. You assign resources to each Redpanda broker using the `values.yaml` settings. If you need to replace a worker node with one that has more resources, xref:./decommission-brokers.adoc[decommission the brokers] before you replace the worker nodes. @@ -101,7 +102,7 @@ resources: By default, Redpanda pins its threads to all cores that you allocate to it. On a dedicated worker node, CPU pinning allows maximum throughput, but in a development environment, where you may run other Pods on the same worker node as Redpanda, CPU pinning can cause your processes to run slower than usual. In these shared environments, you can tell Redpanda not to pin its threads or memory, and reduce the amount of polling it does to a minimum. -NOTE: In production environments, you must run Redpanda brokers on dedicated worker nodes. See xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc[Kubernetes Cluster Requirements]. +NOTE: In production environments, you must run Redpanda brokers on dedicated worker nodes. See xref:deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc[Kubernetes Cluster Requirements]. [tabs] ====== @@ -240,9 +241,9 @@ Setting the `min` and `max` configurations to the same values ensures that Kuber Make sure to provision enough disk storage for your streaming workloads. -If you use PersistentVolumes, you can set the storage capacity for each volume. For instructions, see xref:manage:kubernetes/storage/configure-storage.adoc[]. +If you use PersistentVolumes, you can set the storage capacity for each volume. For instructions, see xref:manage:kubernetes/storage/k-configure-storage.adoc[]. include::shared:partial$suggested-reading.adoc[] -- xref:reference:redpanda-helm-spec.adoc#resources[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] +- xref:reference:k-redpanda-helm-spec.adoc#resources[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] diff --git a/modules/manage/pages/kubernetes/manage-topics.adoc b/modules/manage/pages/kubernetes/k-manage-topics.adoc similarity index 82% rename from modules/manage/pages/kubernetes/manage-topics.adoc rename to modules/manage/pages/kubernetes/k-manage-topics.adoc index c6d7073c9..acab9f4fd 100644 --- a/modules/manage/pages/kubernetes/manage-topics.adoc +++ b/modules/manage/pages/kubernetes/k-manage-topics.adoc @@ -1,9 +1,10 @@ = Manage Topics with the Redpanda Operator :description: Use the Topic resource to declaratively create Kafka topics as part of a Redpanda deployment. Each Topic resource is mapped to a topic in your Redpanda cluster. The topic controller keeps the corresponding Kafka topic in sync with the Topic resource. -:page-context-links: [{"name": "Linux", "to": "develop:config-topics.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/manage-topics.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "develop:config-topics.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/k-manage-topics.adoc" } ] :env-kubernetes: +:page-aliases: manage:kubernetes/manage-topics.adoc -The Redpanda Operator allows you to declaratively create and manage Kafka topics using xref:reference:topic-crd.adoc[Topic custom resources] (resources) in Kubernetes. Each Topic resource is mapped to a topic in your Redpanda cluster. The topic controller, a component of the Redpanda Operator, keeps the corresponding Kafka topic in sync with the Topic resource. This resource allows you to create topics as part of a Redpanda deployment. +The Redpanda Operator allows you to declaratively create and manage Kafka topics using xref:reference:k-topic-crd.adoc[Topic custom resources] (resources) in Kubernetes. Each Topic resource is mapped to a topic in your Redpanda cluster. The topic controller, a component of the Redpanda Operator, keeps the corresponding Kafka topic in sync with the Topic resource. This resource allows you to create topics as part of a Redpanda deployment. == Prerequisites @@ -42,23 +43,23 @@ spec: interval: ---- -- xref:reference:topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`metadata.name`] (*required*): The name of the Topic resource. If the <> property is not set, the name of the Topic resource is also given to the topic in Redpanda. +- xref:reference:k-topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`metadata.name`] (*required*): The name of the Topic resource. If the <> property is not set, the name of the Topic resource is also given to the topic in Redpanda. + Valid names must consist of lowercase alphanumeric characters, hyphens (-), or periods (.). Names cannot start or end with a non-alphanumeric character. Underscores (_) are not allowed. For example, `chat-room` is a valid name, whereas `chat_room` is not. To use other characters such as underscores in your topic names, use the <> property. -- xref:reference:topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-kafkaapispec[`spec.kafkaApiSpec`] (*required*): Configuration details for connecting to Redpanda brokers. +- xref:reference:k-topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-kafkaapispec[`spec.kafkaApiSpec`] (*required*): Configuration details for connecting to Redpanda brokers. -- xref:reference:topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.partitions`]: The number of topic shards distributed across the brokers in a Redpanda cluster. This value cannot be decreased post-creation. Overrides the default cluster property xref:reference:cluster-properties.adoc#default_topic_partitions[`default_topic_partitions`]. +- xref:reference:k-topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.partitions`]: The number of topic shards distributed across the brokers in a Redpanda cluster. This value cannot be decreased post-creation. Overrides the default cluster property xref:reference:cluster-properties.adoc#default_topic_partitions[`default_topic_partitions`]. -- xref:reference:topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.replicationFactor`]: Specifies the number of topic replicas. The value must be an odd number. Overrides the default cluster property xref:reference:cluster-properties.adoc#default_topic_replications[`default_topic_replications`]. +- xref:reference:k-topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.replicationFactor`]: Specifies the number of topic replicas. The value must be an odd number. Overrides the default cluster property xref:reference:cluster-properties.adoc#default_topic_replications[`default_topic_replications`]. -- xref:reference:topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.additionalConfig`]: A map of any topic-specific configuration options. See xref:reference:topic-properties.adoc[]. +- xref:reference:k-topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.additionalConfig`]: A map of any topic-specific configuration options. See xref:reference:topic-properties.adoc[]. -- xref:reference:topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.metricsNamespace`]: The fully-qualified name of the topic metrics for use in multi-operator environments. Defaults to `redpanda-operator`. +- xref:reference:k-topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.metricsNamespace`]: The fully-qualified name of the topic metrics for use in multi-operator environments. Defaults to `redpanda-operator`. -- [[overwrite]]xref:reference:topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.overwriteTopicName`]: Overwrites the topic name in `metadata.name`. +- [[overwrite]]xref:reference:k-topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.overwriteTopicName`]: Overwrites the topic name in `metadata.name`. -- xref:reference:topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.interval`]: Sets the reconciliation interval for the topic controller. Default is 3 seconds (`3s`). +- xref:reference:k-topic-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-src-go-k8s-apis-cluster-redpanda-com-v1alpha1-topicspec[`spec.interval`]: Sets the reconciliation interval for the topic controller. Default is 3 seconds (`3s`). The default settings are best suited to a one-broker cluster in a development environment. To learn how to modify the default values in the configuration file, see xref:manage:cluster-maintenance/cluster-property-configuration.adoc[Configure Cluster Properties]. Even if you set default values that work for most topics, you may still want to change some properties for a specific topic. @@ -461,9 +462,9 @@ include::develop:partial$topic-defaults.adoc[] == Suggested reading -- xref:reference:topic-crd.adoc[] +- xref:reference:k-topic-crd.adoc[] - xref:reference:topic-properties.adoc[] == Next steps -Combine xref:manage:kubernetes/security/sasl-kubernetes.adoc[SASL authentication] with xref:manage:security/authorization.adoc[authorization] to control which users have permissions to interact with your topics. \ No newline at end of file +Combine xref:manage:kubernetes/security/authentication/k-authentication.adoc[SASL authentication] with xref:manage:security/authorization.adoc[authorization] to control which users have permissions to interact with your topics. \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/kubernetes-rack-awareness.adoc b/modules/manage/pages/kubernetes/k-rack-awareness.adoc similarity index 96% rename from modules/manage/pages/kubernetes/kubernetes-rack-awareness.adoc rename to modules/manage/pages/kubernetes/k-rack-awareness.adoc index faf5e60f9..13f63d4b3 100644 --- a/modules/manage/pages/kubernetes/kubernetes-rack-awareness.adoc +++ b/modules/manage/pages/kubernetes/k-rack-awareness.adoc @@ -1,7 +1,8 @@ = Enable Rack Awareness in Kubernetes :description: Enable rack awareness to place partition replicas across different failure zones. -:page-context-links: [{"name": "Linux", "to": "manage:rack-awareness.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/kubernetes-rack-awareness.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:rack-awareness.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/k-rack-awareness.adoc" } ] :page-tags: ["Kubernetes", "Helm configuration"] +:page-aliases: manage:kubernetes/kubernetes-rack-awareness.adoc include::manage:partial$rack-awareness.adoc[] @@ -238,5 +239,5 @@ Use rack awareness with xref:manage:cluster-maintenance/continuous-data-balancin include::shared:partial$suggested-reading.adoc[] -- xref:reference:redpanda-helm-spec.adoc#rackawareness[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] +- xref:reference:k-redpanda-helm-spec.adoc#rackawareness[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] diff --git a/modules/manage/pages/kubernetes/remote-read-replicas.adoc b/modules/manage/pages/kubernetes/k-remote-read-replicas.adoc similarity index 80% rename from modules/manage/pages/kubernetes/remote-read-replicas.adoc rename to modules/manage/pages/kubernetes/k-remote-read-replicas.adoc index 6c9fa46ca..36fdcb731 100644 --- a/modules/manage/pages/kubernetes/remote-read-replicas.adoc +++ b/modules/manage/pages/kubernetes/k-remote-read-replicas.adoc @@ -1,7 +1,8 @@ = Remote Read Replicas in Kubernetes :description: Create read-only topics (Remote Read Replica topics) that mirror topics on a different cluster. -:page-context-links: [{"name": "Linux", "to": "manage:remote-read-replicas.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/remote-read-replicas.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:remote-read-replicas.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/k-remote-read-replicas.adoc" } ] :env-kubernetes: :tags: ["Kubernetes", "Helm configuration"] +:page-aliases: manage:kubernetes/remote-read-replicas.adoc include::manage:partial$remote-read-replicas.adoc[] diff --git a/modules/manage/pages/kubernetes/resilience-testing.adoc b/modules/manage/pages/kubernetes/k-resilience-testing.adoc similarity index 97% rename from modules/manage/pages/kubernetes/resilience-testing.adoc rename to modules/manage/pages/kubernetes/k-resilience-testing.adoc index 4cbc12883..435478046 100644 --- a/modules/manage/pages/kubernetes/resilience-testing.adoc +++ b/modules/manage/pages/kubernetes/k-resilience-testing.adoc @@ -1,5 +1,6 @@ = Resilience Testing in Kubernetes :description: With resilience testing, you can introduce failures and observe how the system behaves under each failure scenario. +:page-aliases: manage:kubernetes/resilience-testing.adoc Resilience testing is an important part of ensuring that a system is reliable and can recover from failures. To perform resilience testing for Redpanda in Kubernetes, you can introduce failure scenarios and observe how the system behaves under each scenario. diff --git a/modules/manage/pages/kubernetes/k-rolling-restart.adoc b/modules/manage/pages/kubernetes/k-rolling-restart.adoc index 017e85bf6..31e9a884e 100644 --- a/modules/manage/pages/kubernetes/k-rolling-restart.adoc +++ b/modules/manage/pages/kubernetes/k-rolling-restart.adoc @@ -11,13 +11,13 @@ You should perform a rolling restart during operations such as configuration upd You must have the following: * xref:deploy:deployment-option/self-hosted/kubernetes/index.adoc[A Redpanda cluster running in Kubernetes]. -* The default xref:reference:redpanda-helm-spec.adoc#statefulset-updatestrategy-type[RollingUpdate strategy] configured in the Helm values. +* The default xref:reference:k-redpanda-helm-spec.adoc#statefulset-updatestrategy-type[RollingUpdate strategy] configured in the Helm values. == What happens during a rolling restart When you run Redpanda in Kubernetes, your Redpanda cluster is managed as a StatefulSet where each broker runs inside its own Pod. As a result, you can perform a rolling restart using the Kubernetes API to terminate one Pod at a time, starting from the one with the highest ordinal. -During a rolling restart the xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-production-deployment.adoc[Redpanda Helm chart] automates the following procedure on each broker, using the `preStop` and `postStart` lifecycle hooks: +During a rolling restart the xref:deploy:deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc[Redpanda Helm chart] automates the following procedure on each broker, using the `preStop` and `postStart` lifecycle hooks: . The `preStop` hook is executed immediately before a container is terminated. The `preStop` hook is responsible for the following: @@ -36,7 +36,7 @@ The Pod is then terminated and restarted due to the default rolling update polic The default `terminationGracePeriod` is 90 seconds, which should be long enough for maintenance mode to finish in large clusters. You can test different values in a development environment. To configure the `terminationGracePeriod`, -use the xref:reference:redpanda-helm-spec.adoc#statefulsetterminationgraceperiodseconds[`statefulset.terminationGracePeriodSeconds`] setting. +use the xref:reference:k-redpanda-helm-spec.adoc#statefulsetterminationgraceperiodseconds[`statefulset.terminationGracePeriodSeconds`] setting. ==== . The `postStart` hook is executed immediately after a container is created. The `postStart` hook takes the broker out of maintenance mode. This action re-integrates the broker into the cluster, allowing it to start handling requests and participate in the cluster's operations again. diff --git a/modules/manage/pages/kubernetes/scale.adoc b/modules/manage/pages/kubernetes/k-scale-redpanda.adoc similarity index 96% rename from modules/manage/pages/kubernetes/scale.adoc rename to modules/manage/pages/kubernetes/k-scale-redpanda.adoc index 45cf35a0a..f1c4c6f27 100644 --- a/modules/manage/pages/kubernetes/scale.adoc +++ b/modules/manage/pages/kubernetes/k-scale-redpanda.adoc @@ -1,5 +1,6 @@ = Scale Redpanda in Kubernetes :description: Learn how to scale a Redpanda cluster vertically to increase its resources and horizontally to add or remove brokers from a cluster. +:page-aliases: manage:kubernetes/scale.adoc You can scale a cluster both vertically, by increasing or decreasing the resources available to existing brokers, and horizontally, by increasing or decreasing the number of brokers in the cluster. @@ -7,7 +8,7 @@ You can scale a cluster both vertically, by increasing or decreasing the resourc Vertical scaling involves increasing the amount of resources available to Redpanda brokers (scaling up) or decreasing the amount of resources (scaling down). Resources include the amount of hardware available to Redpanda brokers, such as CPU cores, memory, and storage. -To scale a Redpanda cluster vertically, see xref:./manage-resources.adoc[Manage Pod Resources in Kubernetes]. +To scale a Redpanda cluster vertically, see xref:./k-manage-resources.adoc[Manage Pod Resources in Kubernetes]. IMPORTANT: You cannot decrease the number of CPU cores in a running cluster. @@ -30,9 +31,9 @@ Scaling out is the process of adding more brokers to your Redpanda cluster. You To add Redpanda brokers to your cluster: -. Ensure that you have one additional worker node for each Redpanda broker that you want to add. Each Redpanda broker requires its own dedicated worker node so that it has access to all resources. For more details, see xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc[]. +. Ensure that you have one additional worker node for each Redpanda broker that you want to add. Each Redpanda broker requires its own dedicated worker node so that it has access to all resources. For more details, see xref:deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc[]. -. If you use local PersistentVolumes (PV), ensure that your additional worker nodes have local disks available that meet the requirements of the configured StorageClass. See xref:manage:kubernetes/storage/configure-persistent-storage.adoc[]. +. If you use local PersistentVolumes (PV), ensure that your additional worker nodes have local disks available that meet the requirements of the configured StorageClass. See xref:manage:kubernetes/storage/k-persistent-storage.adoc[]. . If you have external access enabled, make sure that your new node has the necessary node ports open to external clients. See xref:manage:kubernetes/networking/index.adoc[]. @@ -114,7 +115,7 @@ kubectl exec redpanda-0 --namespace -- rpk cluster health Scaling in is the process of removing brokers from your Redpanda cluster. You may want to remove brokers for cost reduction and resource optimization. -To scale in a Redpanda cluster, you must decommission the brokers that you want to remove before updating the `statefulset.replica` setting in the Helm values. See xref:manage:kubernetes/decommission-brokers.adoc[]. +To scale in a Redpanda cluster, you must decommission the brokers that you want to remove before updating the `statefulset.replica` setting in the Helm values. See xref:manage:kubernetes/k-decommission-brokers.adoc[]. [[node-pvc]] == Install the Nodewatcher controller diff --git a/modules/manage/pages/kubernetes/upgrade-kubernetes.adoc b/modules/manage/pages/kubernetes/k-upgrade-kubernetes.adoc similarity index 96% rename from modules/manage/pages/kubernetes/upgrade-kubernetes.adoc rename to modules/manage/pages/kubernetes/k-upgrade-kubernetes.adoc index d427411be..8594b96e2 100644 --- a/modules/manage/pages/kubernetes/upgrade-kubernetes.adoc +++ b/modules/manage/pages/kubernetes/k-upgrade-kubernetes.adoc @@ -1,5 +1,6 @@ = Upgrade Kubernetes on Worker Nodes Running Redpanda :description: Learn how to update the Kubernetes control plane and worker nodes to a new version. +:page-aliases: manage:kubernetes/upgrade-kubernetes.adoc Upgrading the Kubernetes version in a cluster ensures that your infrastructure is up to date and secure. This process involves updating the Kubernetes control plane and worker nodes to a new version while also making sure that the Redpanda cluster continues to function with minimal downtime. @@ -8,7 +9,7 @@ Upgrading the Kubernetes version in a cluster ensures that your infrastructure i * A staging environment in which to test the upgrade procedure before performing it in production. * A running Redpanda deployment on a Kubernetes cluster. * Familiarity with your hosting platform (GKE, EKS, AKS, or self-hosted) and any CLI tools your platform provides, such as `gcloud` or `eksctl`. -* Confirmation that the new version of Kubernetes is compatible with the version of Redpanda you are using. See the xref:reference:redpanda-helm-spec.adoc#requirements[Helm chart requirements]. +* Confirmation that the new version of Kubernetes is compatible with the version of Redpanda you are using. See the xref:reference:k-redpanda-helm-spec.adoc#requirements[Helm chart requirements]. * <>. === Upgrade the Redpanda Helm chart @@ -25,7 +26,7 @@ Upgrading the Kubernetes version involves updating Kubernetes components and oth The Helm chart provides the following features to minimize data loss and downtime during the upgrade process: -* A Pod Disruption Budget (PDB) that limits the number of concurrently unavailable Pods within the StatefulSet, ensuring the desired level of redundancy. Hosting platforms such as EKS and GKE respect the PDB during node upgrades, providing a safer upgrade process. For the default PDB, see xref:reference:redpanda-helm-spec.adoc#statefulsetbudgetmaxunavailable[`budget.maxUnavailable`] in the Helm chart. +* A Pod Disruption Budget (PDB) that limits the number of concurrently unavailable Pods within the StatefulSet, ensuring the desired level of redundancy. Hosting platforms such as EKS and GKE respect the PDB during node upgrades, providing a safer upgrade process. For the default PDB, see xref:reference:k-redpanda-helm-spec.adoc#statefulsetbudgetmaxunavailable[`budget.maxUnavailable`] in the Helm chart. * Graceful shutdowns for all Pods within the StatefulSet to reduce potential data corruption. Depending on your type of storage volume, you must take precautions to ensure your deployment can tolerate node restarts and avoid data loss: diff --git a/modules/manage/pages/kubernetes/monitoring/monitor-connectors.adoc b/modules/manage/pages/kubernetes/monitoring/k-monitor-connectors.adoc similarity index 67% rename from modules/manage/pages/kubernetes/monitoring/monitor-connectors.adoc rename to modules/manage/pages/kubernetes/monitoring/k-monitor-connectors.adoc index 24f59e70d..6a87bfb46 100644 --- a/modules/manage/pages/kubernetes/monitoring/monitor-connectors.adoc +++ b/modules/manage/pages/kubernetes/monitoring/k-monitor-connectors.adoc @@ -1,6 +1,7 @@ = Monitor Connectors in Kubernetes :description: Monitor the health of your Redpanda Connectors using managed connector metrics. -:page-context-links: [{"name": "Cloud", "to": "deploy:deployment-option/cloud/managed-connectors/monitor-connectors.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/monitoring/monitor-connectors.adoc" } ] +:page-context-links: [{"name": "Cloud", "to": "deploy:deployment-option/cloud/managed-connectors/monitor-connectors.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/monitoring/k-monitor-connectors.adoc" } ] :env-kubernetes: +:page-aliases: manage:kubernetes/monitoring/monitor-connectors.adoc include::manage:partial$monitor-connectors.adoc[] \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/monitoring/monitor-redpanda.adoc b/modules/manage/pages/kubernetes/monitoring/k-monitor-redpanda.adoc similarity index 76% rename from modules/manage/pages/kubernetes/monitoring/monitor-redpanda.adoc rename to modules/manage/pages/kubernetes/monitoring/k-monitor-redpanda.adoc index b3655e36e..7ffbe1c97 100644 --- a/modules/manage/pages/kubernetes/monitoring/monitor-redpanda.adoc +++ b/modules/manage/pages/kubernetes/monitoring/k-monitor-redpanda.adoc @@ -1,6 +1,7 @@ = Monitor Redpanda in Kubernetes :description: Monitor the health of your system to predict issues and optimize performance. -:page-context-links: [{"name": "Linux", "to": "manage:monitoring.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/monitoring/monitor-redpanda.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:monitoring.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/monitoring/k-monitor-redpanda.adoc" } ] :env-kubernetes: +:page-aliases: manage:kubernetes/monitoring/monitor-redpanda.adoc include::manage:partial$monitor-redpanda.adoc[] \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/networking/external/index.adoc b/modules/manage/pages/kubernetes/networking/external/index.adoc index 7cc8265f2..e2048c0e7 100644 --- a/modules/manage/pages/kubernetes/networking/external/index.adoc +++ b/modules/manage/pages/kubernetes/networking/external/index.adoc @@ -1,5 +1,6 @@ = Configure External Access :description: Use Kubernetes Services to expose your Redpanda cluster to clients outside of your Kubernetes cluster. :page-layout: index +:page-aliases: features:kubernetes-external-connect.adoc, deployment:kubernetes-external-connect.adoc Setting up external access to your Redpanda cluster allows applications running outside the Kubernetes cluster to communicate with Redpanda. To make the Redpanda brokers externally accessible, the Pods must be exposed through Kubernetes Services. \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/networking/external/custom-services.adoc b/modules/manage/pages/kubernetes/networking/external/k-custom-services.adoc similarity index 87% rename from modules/manage/pages/kubernetes/networking/external/custom-services.adoc rename to modules/manage/pages/kubernetes/networking/external/k-custom-services.adoc index 63416e459..2024c9165 100644 --- a/modules/manage/pages/kubernetes/networking/external/custom-services.adoc +++ b/modules/manage/pages/kubernetes/networking/external/k-custom-services.adoc @@ -1,7 +1,7 @@ = Use a Custom Service for External Access :description: Expose your Redpanda cluster to clients outside of your Kubernetes cluster by using a custom Service. :tags: ["Kubernetes"] -:page-aliases: manage:kubernetes/networking/custom-services.adoc +:page-aliases: manage:kubernetes/networking/custom-services.adoc, manage:kubernetes/networking/external/custom-services.adoc By default, the Helm chart deploys a NodePort Service to provide external access to the Redpanda cluster. To use a custom Service, set `external.service.enabled` to `false`. Then, you can create your own Services to provide external access. @@ -77,14 +77,14 @@ Make sure to configure `external.addresses` with addresses that point to the wor If you use a custom domain (`external.domain`), provide subdomains for each replica in `external.addresses`. This custom domain is appended to each subdomain (`.`). -Make sure that your custom Service listens on the advertised ports that are configured for each listener. See xref:manage:kubernetes/networking/configure-listeners.adoc[]. +Make sure that your custom Service listens on the advertised ports that are configured for each listener. See xref:manage:kubernetes/networking/k-configure-listeners.adoc[]. == Next steps -- xref:manage:kubernetes/networking/configure-listeners.adoc[] -- xref:manage:kubernetes/networking/connect-to-redpanda.adoc[] +- xref:manage:kubernetes/networking/k-configure-listeners.adoc[] +- xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[] include::shared:partial$suggested-reading.adoc[] -- xref:reference:redpanda-helm-spec.adoc#external[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] \ No newline at end of file +- xref:reference:k-redpanda-helm-spec.adoc#external[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/networking/external/configure-external-access-loadbalancer.adoc b/modules/manage/pages/kubernetes/networking/external/k-loadbalancer.adoc similarity index 97% rename from modules/manage/pages/kubernetes/networking/external/configure-external-access-loadbalancer.adoc rename to modules/manage/pages/kubernetes/networking/external/k-loadbalancer.adoc index 339e3afbc..ec616d868 100644 --- a/modules/manage/pages/kubernetes/networking/external/configure-external-access-loadbalancer.adoc +++ b/modules/manage/pages/kubernetes/networking/external/k-loadbalancer.adoc @@ -1,7 +1,7 @@ = Configure External Access through LoadBalancer Services :description: Use LoadBalancer Services to expose your Redpanda cluster to clients outside of your Kubernetes cluster. :tags: ["Kubernetes", "Helm configuration"] -:page-aliases: manage:kubernetes/networking/configure-external-access-loadbalancer.adoc +:page-aliases: manage:kubernetes/networking/configure-external-access-loadbalancer.adoc, manage:kubernetes/networking/external/configure-external-access-loadbalancer.adoc When the `external.type` field is set to `LoadBalancer`, the Helm chart creates one LoadBalancer Service for each replica in the StatefulSet. Each LoadBalancer Service routes traffic to the external listener ports on a single Redpanda broker. To set up external access using LoadBalancer Services, you must configure the brokers to advertise addresses that resolve to the load balancer instances. @@ -663,10 +663,10 @@ rpk cluster info -X brokers=:31092 == Next steps -- xref:manage:kubernetes/networking/configure-listeners.adoc[Configure listeners] -- xref:manage:kubernetes/networking/connect-to-redpanda.adoc[] +- xref:manage:kubernetes/networking/k-configure-listeners.adoc[Configure listeners] +- xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[] include::shared:partial$suggested-reading.adoc[] -- xref:reference:redpanda-helm-spec.adoc#external[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] +- xref:reference:k-redpanda-helm-spec.adoc#external[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] diff --git a/modules/manage/pages/kubernetes/networking/external/configure-external-access-nodeport.adoc b/modules/manage/pages/kubernetes/networking/external/k-nodeport.adoc similarity index 97% rename from modules/manage/pages/kubernetes/networking/external/configure-external-access-nodeport.adoc rename to modules/manage/pages/kubernetes/networking/external/k-nodeport.adoc index c53f12cdd..2021f47e1 100644 --- a/modules/manage/pages/kubernetes/networking/external/configure-external-access-nodeport.adoc +++ b/modules/manage/pages/kubernetes/networking/external/k-nodeport.adoc @@ -1,7 +1,7 @@ = Configure External Access through a NodePort Service :description: Use a NodePort Service to expose your Redpanda cluster to clients outside of your Kubernetes cluster. :tags: ["Kubernetes", "Helm configuration"] -:page-aliases: manage:kubernetes/networking/configure-external-access-nodeport.adoc +:page-aliases: manage:kubernetes/networking/configure-external-access-nodeport.adoc, manage:kubernetes/networking/external/configure-external-access-nodeport.adoc By default, the Helm chart deploys a NodePort Service that routes traffic to the external listener ports on the Redpanda brokers. To set up external access using this NodePort Service, you must configure the brokers to advertise addresses that resolve to the IP address of the worker node. @@ -12,7 +12,7 @@ image::shared:nodeport.png[A client connects to a Pod through the NodePort Servi * One worker node for each Redpanda broker that you want to deploy. * Install xref:get-started:rpk-install.adoc[rpk] on your local machine so that you can test connections to your Redpanda cluster from outside Kubernetes. * Review xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-requirements-index.adoc[]. -* Understand xref:manage:kubernetes/networking/networking-and-connectivity.adoc[Kubernetes networking for Redpanda]. +* Understand xref:manage:kubernetes/networking/k-networking-and-connectivity.adoc[Kubernetes networking for Redpanda]. * Ensure that your Kubernetes cluster is accessible through your desired node port range. For example, with AWS EKS you must edit your inbound firewall rules. And with Azure AKS, you must https://learn.microsoft.com/en-us/azure/aks/use-node-public-ips[enable public IPs] on nodes in your node pool. * If you want brokers to advertise a custom domain, you must have control over the DNS settings for that domain. + @@ -569,10 +569,10 @@ rpk cluster info -X brokers=:31092 == Next steps -- xref:manage:kubernetes/networking/configure-listeners.adoc[Configure listeners] -- xref:manage:kubernetes/networking/connect-to-redpanda.adoc[] +- xref:manage:kubernetes/networking/k-configure-listeners.adoc[Configure listeners] +- xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[] include::shared:partial$suggested-reading.adoc[] -- xref:reference:redpanda-helm-spec.adoc#external[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] +- xref:reference:k-redpanda-helm-spec.adoc#external[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] diff --git a/modules/manage/pages/kubernetes/networking/configure-listeners.adoc b/modules/manage/pages/kubernetes/networking/k-configure-listeners.adoc similarity index 91% rename from modules/manage/pages/kubernetes/networking/configure-listeners.adoc rename to modules/manage/pages/kubernetes/networking/k-configure-listeners.adoc index 44ad845c2..d2f609826 100644 --- a/modules/manage/pages/kubernetes/networking/configure-listeners.adoc +++ b/modules/manage/pages/kubernetes/networking/k-configure-listeners.adoc @@ -1,7 +1,8 @@ = Configure Listeners in Kubernetes :description: Configure your Redpanda deployment in Kubernetes to meet specific network requirements by customizing advertised ports and TLS certificates for each listener. Learn to enable or disable access to these listeners as needed. -:page-context-links: [{"name": "Linux", "to": "manage:security/listener-configuration.adoc"}, {"name": "Kubernetes", "to": "manage:kubernetes/networking/configure-listeners.adoc"}] +:page-context-links: [{"name": "Linux", "to": "manage:security/listener-configuration.adoc"}, {"name": "Kubernetes", "to": "manage:kubernetes/networking/k-configure-listeners.adoc"}] :tags: [Kubernetes, Helm Configuration] +:page-aliases: manage:kubernetes/networking/configure-listeners.adoc You can fine-tune client interactions with Redpanda by customizing internal and external listener configurations. @@ -84,7 +85,7 @@ Redpanda doesn't validate the configured port numbers. Make sure to verify the f - Your configured port numbers are not in use by any other service. ==== -For the default ports, see the xref:reference:redpanda-helm-spec.adoc#listeners[Redpanda Helm Chart Specification] +For the default ports, see the xref:reference:k-redpanda-helm-spec.adoc#listeners[Redpanda Helm Chart Specification] For example, to customize the node ports for the external Kafka API listener: @@ -110,8 +111,8 @@ A Redpanda cluster provides granular control over the TLS certificates used by d Here's an example that configures two certificates: -- `public-ca-cert`: This certificate is configured with an xref:manage:kubernetes/security/tls/use-cert-manager.adoc[Issuer managed by cert-manager]. -- `private-ca-cert`. This certificate is configured with an xref:manage:kubernetes/security/tls/use-secrets.adoc[Opaque Secret] containing the `tls.crt`, `tls.key`, and `ca.crt` files. +- `public-ca-cert`: This certificate is configured with an xref:manage:kubernetes/security/tls/k-cert-manager.adoc[Issuer managed by cert-manager]. +- `private-ca-cert`. This certificate is configured with an xref:manage:kubernetes/security/tls/k-secrets.adoc[Opaque Secret] containing the `tls.crt`, `tls.key`, and `ca.crt` files. The external Admin API listener is configured with the `public-ca-cert` certificate. The internal Kafka API listener is configured with the `private-ca-cert` certificate, and the other listeners are configured with the default self-signed certificate. @@ -179,9 +180,9 @@ listeners: == Next steps -xref:manage:kubernetes/networking/connect-to-redpanda.adoc[] +xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[] include::shared:partial$suggested-reading.adoc[] -- xref:reference:redpanda-helm-spec.adoc#listeners[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] +- xref:reference:k-redpanda-helm-spec.adoc#listeners[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] diff --git a/modules/manage/pages/kubernetes/networking/connect-to-redpanda.adoc b/modules/manage/pages/kubernetes/networking/k-connect-to-redpanda.adoc similarity index 96% rename from modules/manage/pages/kubernetes/networking/connect-to-redpanda.adoc rename to modules/manage/pages/kubernetes/networking/k-connect-to-redpanda.adoc index d76d22187..7b75d83ae 100644 --- a/modules/manage/pages/kubernetes/networking/connect-to-redpanda.adoc +++ b/modules/manage/pages/kubernetes/networking/k-connect-to-redpanda.adoc @@ -1,5 +1,6 @@ = Connect to Redpanda in Kubernetes :description: Learn how to connect to a Redpanda cluster running in Kubernetes. +:page-aliases: manage:kubernetes/networking/connect-to-redpanda.adoc To work with a Redpanda cluster running in Kubernetes, you can connect clients to the listeners that are exposed by Redpanda brokers. Depending on how the listeners are configured, you can access them from within the Kubernetes cluster and/or from outside the Kubernetes cluster. @@ -32,7 +33,7 @@ You must have the following: == Connect to an internal cluster -To connect a client to Redpanda brokers running in the same Kubernetes cluster, use their xref:./networking-and-connectivity.adoc#internal-networking[fully qualified domain names] (FQDNs) and the internal port of a listener. Together, the FQDN and internal port are called an endpoint. These endpoints may be secured using TLS and/or authentication. +To connect a client to Redpanda brokers running in the same Kubernetes cluster, use their xref:./k-networking-and-connectivity.adoc#internal-networking[fully qualified domain names] (FQDNs) and the internal port of a listener. Together, the FQDN and internal port are called an endpoint. These endpoints may be secured using TLS and/or authentication. The `rpk` client on each Redpanda broker is pre-configured to connect to the internal Admin API and internal Kafka API of the local Redpanda cluster. To use other clients, such as a Kafka client, you must configure them. @@ -64,7 +65,7 @@ export RPK_PASS= export RPK_SASL_MECHANISM= ---- -For details about SASL authentication, see xref:manage:kubernetes/security/authentication/sasl-kubernetes.adoc[]. +For details about SASL authentication, see xref:manage:kubernetes/security/authentication/k-authentication.adoc[]. === Connect to the internal Kafka API @@ -111,7 +112,7 @@ listeners: authenticationMethod: null ---- -For details about SASL authentication, see xref:manage:kubernetes/security/authentication/sasl-kubernetes.adoc[]. +For details about SASL authentication, see xref:manage:kubernetes/security/authentication/k-authentication.adoc[]. TLS files are stored in Secret resources that you can mount onto any Pods that run clients. TLS files may include: @@ -381,7 +382,7 @@ listeners: authenticationMethod: null ---- -For details about SASL authentication, see xref:manage:kubernetes/security/authentication/sasl-kubernetes.adoc[]. +For details about SASL authentication, see xref:manage:kubernetes/security/authentication/k-authentication.adoc[]. TLS files are stored in Secrets that you can mount onto the Pods that are running the clients. TLS files may include: @@ -555,14 +556,14 @@ For all available endpoints, see xref:api:ROOT:admin-api.adoc[]. == Next steps -xref:./configure-listeners.adoc[] +xref:./k-configure-listeners.adoc[] == Suggested reading -- xref:./networking-and-connectivity.adoc[] +- xref:./k-networking-and-connectivity.adoc[] - xref:get-started:config-rpk-profile.adoc[] -- xref:manage:kubernetes/security/authentication/sasl-kubernetes.adoc[] +- xref:manage:kubernetes/security/authentication/k-authentication.adoc[] - xref:manage:kubernetes/security/tls/index.adoc[] - xref:reference:api-reference.adoc[] -- xref:reference:kubernetes-helm-index.adoc[] -- xref:reference:kubernetes-crd-index.adoc[] \ No newline at end of file +- xref:reference:k-helm-index.adoc[] +- xref:reference:k-crd-index.adoc[] \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/networking/networking-and-connectivity.adoc b/modules/manage/pages/kubernetes/networking/k-networking-and-connectivity.adoc similarity index 90% rename from modules/manage/pages/kubernetes/networking/networking-and-connectivity.adoc rename to modules/manage/pages/kubernetes/networking/k-networking-and-connectivity.adoc index 5c87e8e10..cd9012f8b 100644 --- a/modules/manage/pages/kubernetes/networking/networking-and-connectivity.adoc +++ b/modules/manage/pages/kubernetes/networking/k-networking-and-connectivity.adoc @@ -1,6 +1,7 @@ = About Networking and Connectivity in Kubernetes :description: Learn how internal and external connectivity works when Redpanda is running in Kubernetes. :tags: ["Kubernetes", "Helm configuration"] +:page-aliases: features:kubernetes-connectivity.adoc, deployment:kubernetes-connectivity.adoc, manage:kubernetes/networking/networking-and-connectivity.adoc To work with a Redpanda cluster running in Kubernetes, clients connect to the listeners that are exposed by Redpanda brokers. Each listener exposes an API. Each API can have multiple listeners. Depending on how the listeners are configured, clients can access them from within the Kubernetes cluster and/or from outside the Kubernetes cluster. For example, one listener may be configured for internal connections and another may be configured for external connections. @@ -22,7 +23,7 @@ To work with a Redpanda cluster running in Kubernetes, clients connect to the li == StatefulSets and Pod identities -Redpanda is a stateful application. Each Redpanda broker needs to store its state (topic partitions) in its own storage volume. As a result, Redpanda is deployed in a StatefulSet to manage the Pods in which the Redpanda brokers are running. StatefulSets ensure that the state associated with a particular Pod replica is always the same, no matter how often the Pod is recreated. +Redpanda is a stateful application. Each Redpanda broker needs to store its state, such as topic partitions, in its own storage volume. As a result, Redpanda is deployed in a StatefulSet to manage the Pods in which the Redpanda brokers are running. StatefulSets ensure that the state associated with a particular Pod replica is always the same, no matter how often the Pod is recreated. In a StatefulSet, each Pod is given a unique ordinal number in its name such as `redpanda-0`. A Pod with a particular ordinal number is always associated with a PersistentVolumeClaim with the same number. When a Pod in the StatefulSet is deleted and recreated, it is given the same ordinal number and so it mounts the same storage volume as the deleted Pod that it replaced. @@ -96,6 +97,6 @@ IMPORTANT: Load balancers are slower than the NodePort Service. Load balancers f Configure external access through a Service: -* xref:./configure-external-access-nodeport.adoc[NodePort] -* xref:./configure-external-access-loadbalancer.adoc[LoadBalancer] -* xref:./configure-listeners.adoc[Configure individual listeners] +* xref:./external/k-nodeport.adoc[NodePort] +* xref:./external/k-loadbalancer.adoc[LoadBalancer] +* xref:./k-configure-listeners.adoc[Configure individual listeners] diff --git a/modules/manage/pages/kubernetes/security/authentication/sasl-kubernetes.adoc b/modules/manage/pages/kubernetes/security/authentication/k-authentication.adoc similarity index 59% rename from modules/manage/pages/kubernetes/security/authentication/sasl-kubernetes.adoc rename to modules/manage/pages/kubernetes/security/authentication/k-authentication.adoc index e84115c29..c9ec3a1bf 100644 --- a/modules/manage/pages/kubernetes/security/authentication/sasl-kubernetes.adoc +++ b/modules/manage/pages/kubernetes/security/authentication/k-authentication.adoc @@ -1,8 +1,8 @@ = Configure Authentication for Redpanda in Kubernetes :description: Learn how to configure authentication for Redpanda in Kubernetes. -:page-context-links: [{"name": "Linux", "to": "manage:security/authentication.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/security/sasl-kubernetes.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:security/authentication.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/security/authentication/k-authentication.adoc" } ] :tags: ["Kubernetes", "Helm configuration"] -:page-aliases: security:sasl-kubernetes.adoc, manage:kubernetes/security/sasl-kubernetes.adoc +:page-aliases: security:sasl-kubernetes.adoc, manage:kubernetes/security/sasl-kubernetes.adoc, security:kubernetes-sasl.adoc, manage:kubernetes/security/authentication/sasl-kubernetes.adoc :env-kubernetes: :page-toclevels: 3 @@ -10,19 +10,19 @@ include::manage:partial$authentication.adoc[] == Troubleshoot -This section lists error messages and provides ways to diagnose and solve issues. For more troubleshooting steps, see xref:manage:kubernetes/troubleshooting/troubleshoot.adoc[Troubleshoot Redpanda in Kubernetes]. +This section lists error messages and provides ways to diagnose and solve issues. For more troubleshooting steps, see xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc[Troubleshoot Redpanda in Kubernetes]. -include::manage:kubernetes/troubleshooting/troubleshoot.adoc[tags=sasl] +include::manage:kubernetes/troubleshooting/k-troubleshoot.adoc[tags=sasl] == Next steps - xref:manage:security/authorization.adoc[] -- xref:manage:kubernetes/networking/configure-listeners.adoc[] -- xref:manage:kubernetes/networking/connect-to-redpanda.adoc[] +- xref:manage:kubernetes/networking/k-configure-listeners.adoc[] +- xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[] include::shared:partial$suggested-reading.adoc[] * https://killercoda.com/redpanda/scenario/redpanda-k8s-secure[Securing Redpanda in Kubernetes(Day 2 Ops)^] -* xref:reference:redpanda-helm-spec.adoc[Redpanda Helm Specification] -* xref:reference:crd.adoc[Redpanda CRD Reference] +* xref:reference:k-redpanda-helm-spec.adoc[Redpanda Helm Specification] +* xref:reference:k-crd.adoc[Redpanda CRD Reference] * xref:reference:rpk/rpk-acl/rpk-acl.adoc[`rpk acl`] diff --git a/modules/manage/pages/kubernetes/security/index.adoc b/modules/manage/pages/kubernetes/security/index.adoc index 6ed73fac5..6fe57308a 100644 --- a/modules/manage/pages/kubernetes/security/index.adoc +++ b/modules/manage/pages/kubernetes/security/index.adoc @@ -1,6 +1,7 @@ = Security for Redpanda in Kubernetes :description: Learn what options are available for securing Redpanda clusters, including TLS encryption, authentication, and authorization. :page-layout: index +:page-aliases: security:kubernetes-security.adoc, security:security-kubernetes.adoc {description} diff --git a/modules/manage/pages/kubernetes/security/tls/index.adoc b/modules/manage/pages/kubernetes/security/tls/index.adoc index 738beb44f..e8f4643f5 100644 --- a/modules/manage/pages/kubernetes/security/tls/index.adoc +++ b/modules/manage/pages/kubernetes/security/tls/index.adoc @@ -2,11 +2,11 @@ :description: Use TLS to authenticate Redpanda brokers and encrypt communication between clients and brokers. :page-context-links: [{"name": "Linux", "to": "manage:security/encryption.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/security/kubernetes-tls.adoc" } ] :tags: ["Kubernetes", "Security"] -:page-aliases: manage:kubernetes/security/kubernetes-tls.adoc, security:kubernetes-tls.adoc +:page-aliases: manage:kubernetes/security/kubernetes-tls.adoc, security:kubernetes-tls.adoc, security:kubernetes-mtls.adoc, features:tls-kubernetes.adoc, security:tls-kubernetes.adoc :page-layout: index Redpanda clusters can use Transport Layer Security (TLS) to secure internal and external communications with clients and other brokers. In the Redpanda Helm chart, TLS is enabled by default for all internal and external listeners, using self-signed certificates managed by glossterm:cert-manager[^]. You can configure the chart to use your own certificates with or without cert-manager. -Redpanda exposes several public metrics to help administrators manage their installed certificates. Configuring alerts on these metrics is a critical tool for managing certificate expiration and avoiding surprise outages. The xref:reference:public-metrics-reference.adoc#tls_metrics[public metrics reference] contains a full list of available TLS metrics. You can refer to the xref:manage:kubernetes/monitoring/monitor-redpanda.adoc[monitor Redpanda in Kubernetes] guide for full details on configuring Prometheus to monitor these metrics. This guide also explains how to create a Grafana dashboard for visualizations and alerting. \ No newline at end of file +Redpanda exposes several public metrics to help administrators manage their installed certificates. Configuring alerts on these metrics is a critical tool for managing certificate expiration and avoiding surprise outages. The xref:reference:public-metrics-reference.adoc#tls_metrics[public metrics reference] contains a full list of available TLS metrics. You can refer to the xref:manage:kubernetes/monitoring/k-monitor-redpanda.adoc[monitor Redpanda in Kubernetes] guide for full details on configuring Prometheus to monitor these metrics. This guide also explains how to create a Grafana dashboard for visualizations and alerting. \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/security/tls/use-cert-manager.adoc b/modules/manage/pages/kubernetes/security/tls/k-cert-manager.adoc similarity index 93% rename from modules/manage/pages/kubernetes/security/tls/use-cert-manager.adoc rename to modules/manage/pages/kubernetes/security/tls/k-cert-manager.adoc index d7ba2e5af..d9406aa56 100644 --- a/modules/manage/pages/kubernetes/security/tls/use-cert-manager.adoc +++ b/modules/manage/pages/kubernetes/security/tls/k-cert-manager.adoc @@ -1,5 +1,6 @@ = Use cert-manager to manage TLS certificates :description: Learn how to enable TLS encryption in your Redpanda cluster and use cert-manager to simplify the process of obtaining, renewing, and using certificates. +:page-aliases: manage:kubernetes/security/tls/use-cert-manager.adoc When using glossterm:cert-manager[^] for TLS certificate management, you have the option to use a self-signed certificate or a certificate signed by a trusted certificate authority (CA). This topic provides instructions for each option. @@ -186,7 +187,7 @@ include::get-started:partial$install-rpk-homebrew.adoc[] kubectl --namespace get secret redpanda-external-root-certificate -o go-template='{{ index .data "ca.crt" | base64decode }}' > ca.crt ``` -. Configure `rpk` to connect to your cluster using the xref:manage:kubernetes/networking/connect-to-redpanda.adoc#rpk-profile[pre-configured profile]: +. Configure `rpk` to connect to your cluster using the xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc#rpk-profile[pre-configured profile]: + [source,bash] ---- @@ -288,7 +289,7 @@ helm upgrade --install redpanda redpanda/redpanda --namespace --crea -- ====== + -By default, this certificate will be used to encrypt traffic between clients and all external listeners. You can select specific certificates for each external listener. See xref:manage:kubernetes/networking/configure-listeners.adoc#tls[Configure Listeners in Kubernetes]. +By default, this certificate will be used to encrypt traffic between clients and all external listeners. You can select specific certificates for each external listener. See xref:manage:kubernetes/networking/k-configure-listeners.adoc#tls[Configure Listeners in Kubernetes]. . Make sure the Certificates are in a `READY` state. + @@ -358,7 +359,7 @@ include::get-started:partial$install-rpk-homebrew.adoc[] kubectl --namespace get secret -o go-template='{{ index .data "ca.crt" | base64decode }}' > ca.crt ``` -. Configure `rpk` to connect to your cluster using the xref:manage:kubernetes/networking/connect-to-redpanda.adoc#rpk-profile[pre-configured profile]: +. Configure `rpk` to connect to your cluster using the xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc#rpk-profile[pre-configured profile]: + [source,bash] ---- @@ -398,24 +399,24 @@ kubectl exec redpanda-0 -n redpanda -c redpanda -- rpk cluster info -X brokers=r Port 9094 is the default container port for the external Kafka API. -For more details on connecting to Redpanda, see xref:manage:kubernetes/networking/connect-to-redpanda.adoc[]. +For more details on connecting to Redpanda, see xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[]. include::manage:partial$kubernetes/disable-tls.adoc[leveloffset=+1] == Troubleshoot -Here are some common troubleshooting scenarios and their solutions. For more troubleshooting steps, see xref:manage:kubernetes/troubleshooting/troubleshoot.adoc[Troubleshoot Redpanda in Kubernetes]. +Here are some common troubleshooting scenarios and their solutions. For more troubleshooting steps, see xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc[Troubleshoot Redpanda in Kubernetes]. -include::manage:kubernetes/troubleshooting/troubleshoot.adoc[tags=tls;networking] +include::manage:kubernetes/troubleshooting/k-troubleshoot.adoc[tags=tls;networking] == Next steps -- xref:manage:kubernetes/security/authentication/sasl-kubernetes.adoc[] -- xref:manage:kubernetes/networking/configure-listeners.adoc[] -- xref:manage:kubernetes/networking/connect-to-redpanda.adoc[] +- xref:manage:kubernetes/security/authentication/k-authentication.adoc[] +- xref:manage:kubernetes/networking/k-configure-listeners.adoc[] +- xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[] include::shared:partial$suggested-reading.adoc[] * https://killercoda.com/redpanda/scenario/redpanda-k8s-secure[Securing Redpanda in Kubernetes (Day 2 Ops)^] -* xref:reference:redpanda-helm-spec.adoc#external[Redpanda Helm Specification] -* xref:reference:crd.adoc[Redpanda CRD Reference] \ No newline at end of file +* xref:reference:k-redpanda-helm-spec.adoc#external[Redpanda Helm Specification] +* xref:reference:k-crd.adoc[Redpanda CRD Reference] \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/security/tls/use-secrets.adoc b/modules/manage/pages/kubernetes/security/tls/k-secrets.adoc similarity index 92% rename from modules/manage/pages/kubernetes/security/tls/use-secrets.adoc rename to modules/manage/pages/kubernetes/security/tls/k-secrets.adoc index ec9919d4e..62d967258 100644 --- a/modules/manage/pages/kubernetes/security/tls/use-secrets.adoc +++ b/modules/manage/pages/kubernetes/security/tls/k-secrets.adoc @@ -1,5 +1,6 @@ = Use Kubernetes Secrets to manage TLS certificates :description: Create TLS files and store them in Kubernetes Secret resources to configure Redpanda listeners with TLS certificates. +:page-aliases: manage:kubernetes/security/tls/use-secrets.adoc Learn how to configure Redpanda listeners with TLS using TLS certificates in your own Secret resources. @@ -182,7 +183,7 @@ helm upgrade --install redpanda redpanda/redpanda --namespace --crea -- ====== -By default, certificates will be used to encrypt traffic between clients and all external listeners. You can also select specific certificates for each external listener. See xref:manage:kubernetes/networking/configure-listeners.adoc#tls[Configure Listeners]. +By default, certificates will be used to encrypt traffic between clients and all external listeners. You can also select specific certificates for each external listener. See xref:manage:kubernetes/networking/k-configure-listeners.adoc#tls[Configure Listeners]. == Connect to Redpanda @@ -246,7 +247,7 @@ include::get-started:partial$install-rpk-homebrew.adoc[] kubectl --namespace get secret -o go-template='{{ index .data "ca.crt" | base64decode }}' > ca.crt ``` -. Configure `rpk` to connect to your cluster using the xref:manage:kubernetes/networking/connect-to-redpanda.adoc#rpk-profile[pre-configured profile]: +. Configure `rpk` to connect to your cluster using the xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc#rpk-profile[pre-configured profile]: + [source,bash] ---- @@ -286,24 +287,24 @@ kubectl exec redpanda-0 -n redpanda -c redpanda -- rpk cluster info -X brokers=r Port 9094 is the default container port for the external Kafka API. -For more details on connecting to Redpanda, see xref:manage:kubernetes/networking/connect-to-redpanda.adoc[]. +For more details on connecting to Redpanda, see xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[]. include::manage:partial$kubernetes/disable-tls.adoc[leveloffset=+1] == Troubleshoot -Here are some common troubleshooting scenarios and their solutions. For more troubleshooting steps, see xref:manage:kubernetes/troubleshooting/troubleshoot.adoc[Troubleshoot Redpanda in Kubernetes]. +Here are some common troubleshooting scenarios and their solutions. For more troubleshooting steps, see xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc[Troubleshoot Redpanda in Kubernetes]. -include::manage:kubernetes/troubleshooting/troubleshoot.adoc[tags=tls;networking] +include::manage:kubernetes/troubleshooting/k-troubleshoot.adoc[tags=tls;networking] == Next steps -- xref:manage:kubernetes/security/authentication/sasl-kubernetes.adoc[] -- xref:manage:kubernetes/networking/configure-listeners.adoc[] -- xref:manage:kubernetes/networking/connect-to-redpanda.adoc[] +- xref:manage:kubernetes/security/authentication/k-authentication.adoc[] +- xref:manage:kubernetes/networking/k-configure-listeners.adoc[] +- xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[] include::shared:partial$suggested-reading.adoc[] * https://killercoda.com/redpanda/scenario/redpanda-k8s-secure[Securing Redpanda in Kubernetes (Day 2 Ops)^] -* xref:reference:redpanda-helm-spec.adoc#external[Redpanda Helm Specification] -* xref:reference:crd.adoc[Redpanda CRD Reference] \ No newline at end of file +* xref:reference:k-redpanda-helm-spec.adoc#external[Redpanda Helm Specification] +* xref:reference:k-crd.adoc[Redpanda CRD Reference] \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/storage/configure-storage.adoc b/modules/manage/pages/kubernetes/storage/k-configure-storage.adoc similarity index 86% rename from modules/manage/pages/kubernetes/storage/configure-storage.adoc rename to modules/manage/pages/kubernetes/storage/k-configure-storage.adoc index 651edce0b..f06462211 100644 --- a/modules/manage/pages/kubernetes/storage/configure-storage.adoc +++ b/modules/manage/pages/kubernetes/storage/k-configure-storage.adoc @@ -1,7 +1,7 @@ = Configure Storage for the Redpanda data directory in Kubernetes :description: pass:q[Configure Redpanda to store the data directory in PersistentVolumes, `hostPath` volumes, or `emptyDir` volumes.] :tags: ["Kubernetes", "Helm configuration"] -:page-aliases: manage:kubernetes/configure-storage.adoc +:page-aliases: manage:kubernetes/configure-storage.adoc, manage:kubernetes/storage/configure-storage.adoc :page-layout: index Redpanda brokers must store their data directories on disk (`/var/lib/redpanda/data`). By default, the Redpanda Helm chart uses the default StorageClass in a Kubernetes cluster to create one PersistentVolumeClaim for each Pod that runs a Redpanda broker. The default StorageClass in your Kubernetes cluster depends on the Kubernetes platform that you are using. You can customize your deployment to use the following storage volumes. \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/storage/delete-persistentvolume.adoc b/modules/manage/pages/kubernetes/storage/k-delete-persistentvolume.adoc similarity index 77% rename from modules/manage/pages/kubernetes/storage/delete-persistentvolume.adoc rename to modules/manage/pages/kubernetes/storage/k-delete-persistentvolume.adoc index a9b4fdb8a..e7ae043d8 100644 --- a/modules/manage/pages/kubernetes/storage/delete-persistentvolume.adoc +++ b/modules/manage/pages/kubernetes/storage/k-delete-persistentvolume.adoc @@ -1,7 +1,7 @@ = Delete PersistentVolumes in Kubernetes :description: Learn how to delete a PersistentVolume (PV) before removing a broker and its data from the cluster or to perform maintenance or upgrades on the PersistentVolume. :tags: ["Kubernetes"] -:page-aliases: manage:kubernetes/delete-persistentvolume.adoc +:page-aliases: manage:kubernetes/delete-persistentvolume.adoc, manage:kubernetes/storage/delete-persistentvolume.adoc Deleting a PersistentVolume (PV) can be necessary for a variety of reasons, such as removing a broker and its data from the cluster or performing maintenance or upgrades on the PersistentVolume. @@ -21,7 +21,7 @@ To delete a PersistentVolume, follow these steps to ensure that your data is mov kubectl get persistentvolume ---- -. xref:manage:kubernetes/decommission-brokers.adoc[Decommission the broker] that has a PersistentVolumeClaim (PVC) bound to the PV. +. xref:manage:kubernetes/k-decommission-brokers.adoc[Decommission the broker] that has a PersistentVolumeClaim (PVC) bound to the PV. + Decommissioning ensures no data loss by gracefully moving the broker's topic partitions and replicas to other brokers in the cluster. @@ -54,9 +54,9 @@ kubectl delete persistentvolume + The StatefulSet schedules a new Pod on the same worker node and assigns it a unique node ID. + -If you use PVs for the Redpanda data directory, the Pod will have a new PVC bound to a PV that is set in xref:reference:redpanda-helm-spec.adoc#storagepersistentvolumestorageclass[`storage.persistentVolume.storageClass`]. See xref:./configure-storage.adoc[Use PersistentVolumes]. +If you use PVs for the Redpanda data directory, the Pod will have a new PVC bound to a PV that is set in xref:reference:k-redpanda-helm-spec.adoc#storagepersistentvolumestorageclass[`storage.persistentVolume.storageClass`]. See xref:./k-configure-storage.adoc[Use PersistentVolumes]. + -If you use PVs for the Tiered Storage cache, the Pod will have a new PVC bound to a PV that is set in xref:reference:redpanda-helm-spec.adoc#storagetieredstoragepersistentvolumestorageclass[`storage.tieredStoragePersistentVolume.storageClass`]. See xref:./tiered-storage.adoc#caching[Tiered Storage Caching]. +If you use PVs for the Tiered Storage cache, the Pod will have a new PVC bound to a PV that is set in xref:reference:k-redpanda-helm-spec.adoc#storagetieredstoragepersistentvolumestorageclass[`storage.tieredStoragePersistentVolume.storageClass`]. See xref:./tiered-storage.adoc#caching[Tiered Storage Caching]. . Verify that the new Redpanda broker is running and that it has access to the appropriate PersistentVolume. + diff --git a/modules/manage/pages/kubernetes/storage/configure-emptydir.adoc b/modules/manage/pages/kubernetes/storage/k-emptydir.adoc similarity index 87% rename from modules/manage/pages/kubernetes/storage/configure-emptydir.adoc rename to modules/manage/pages/kubernetes/storage/k-emptydir.adoc index a503caa63..da5ceb882 100644 --- a/modules/manage/pages/kubernetes/storage/configure-emptydir.adoc +++ b/modules/manage/pages/kubernetes/storage/k-emptydir.adoc @@ -1,7 +1,8 @@ = Store the Redpanda Data Directory in emptyDir Volumes :description: pass:q[Learn how to configure Redpanda to store the data directory in Kubernetes `emptyDir` volumes. This setup is only for development environments.] +:page-aliases: manage:kubernetes/storage/configure-emptydir.adoc -You can configure Redpanda to use Kubernetes xref:./volume-types.adoc[`emptyDir`] volumes to store the Redpanda data directory. +You can configure Redpanda to use Kubernetes xref:./k-volume-types.adoc[`emptyDir`] volumes to store the Redpanda data directory. WARNING: Use `emptyDir` volumes only for development environments. When a Pod is removed from a node for any reason, the data in the `emptyDir` volume is deleted permanently. @@ -86,10 +87,10 @@ helm upgrade --install redpanda redpanda/redpanda \ include::shared:partial$suggested-reading.adoc[] -- xref:./volume-types.adoc[] +- xref:./k-volume-types.adoc[] - For more details about `emptyDir` volumes, see the https://kubernetes.io/docs/concepts/storage/volumes/#emptydir[Kubernetes documentation^]. -- xref:reference:redpanda-helm-spec.adoc[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] +- xref:reference:k-redpanda-helm-spec.adoc[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] == Next steps diff --git a/modules/manage/pages/kubernetes/storage/configure-hostpath.adoc b/modules/manage/pages/kubernetes/storage/k-hostpath.adoc similarity index 87% rename from modules/manage/pages/kubernetes/storage/configure-hostpath.adoc rename to modules/manage/pages/kubernetes/storage/k-hostpath.adoc index 75556596f..9e08db4e0 100644 --- a/modules/manage/pages/kubernetes/storage/configure-hostpath.adoc +++ b/modules/manage/pages/kubernetes/storage/k-hostpath.adoc @@ -1,7 +1,8 @@ = Store the Redpanda Data Directory in hostPath Volumes :description: pass:q[Learn how to configure Redpanda to store the data directory in Kubernetes `hostPath` volumes. This setup is only for development environments.] +:page-aliases: manage:kubernetes/storage/configure-hostpath.adoc -You can configure Redpanda to use Kubernetes xref:./volume-types.adoc[`hostPath`] volumes to store the Redpanda data directory. A `hostPath` volume mounts a file or directory from the host node's file system into your Pod. +You can configure Redpanda to use Kubernetes xref:./k-volume-types.adoc[`hostPath`] volumes to store the Redpanda data directory. A `hostPath` volume mounts a file or directory from the host node's file system into your Pod. WARNING: Use `hostPath` volumes only for development environments. If the Pod is deleted and recreated, it might be scheduled on another worker node and lose access to the data. @@ -100,10 +101,10 @@ include::manage:partial$kubernetes/init-container.adoc[] include::shared:partial$suggested-reading.adoc[] -- xref:./volume-types.adoc[] +- xref:./k-volume-types.adoc[] - For details about `hostPath` volumes, see the https://kubernetes.io/docs/concepts/storage/volumes/#hostpath[Kubernetes documentation^]. -- xref:reference:redpanda-helm-spec.adoc[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] +- xref:reference:k-redpanda-helm-spec.adoc[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] == Next steps diff --git a/modules/manage/pages/kubernetes/storage/configure-persistent-storage.adoc b/modules/manage/pages/kubernetes/storage/k-persistent-storage.adoc similarity index 88% rename from modules/manage/pages/kubernetes/storage/configure-persistent-storage.adoc rename to modules/manage/pages/kubernetes/storage/k-persistent-storage.adoc index cbb9d1c53..0a2bfc7b3 100644 --- a/modules/manage/pages/kubernetes/storage/configure-persistent-storage.adoc +++ b/modules/manage/pages/kubernetes/storage/k-persistent-storage.adoc @@ -1,7 +1,8 @@ = Store the Redpanda Data Directory in PersistentVolumes :description: Learn how to configure Redpanda to store the data directory in Kubernetes PersistentVolumes with a static provisioner or a dynamic provisioner. +:page-aliases: manage:kubernetes/storage/configure-persistent-storage.adoc -You can configure Redpanda to use Kubernetes xref:./volume-types.adoc[PersistentVolumes] (PV) to store the Redpanda data directory using either a static provisioner or a dynamic provisioner. +You can configure Redpanda to use Kubernetes xref:./k-volume-types.adoc[PersistentVolumes] (PV) to store the Redpanda data directory using either a static provisioner or a dynamic provisioner. == Prerequisites @@ -126,10 +127,10 @@ In the output, ensure the PVC is mounted to the correct path and that the source include::shared:partial$suggested-reading.adoc[] -- xref:./volume-types.adoc[] +- xref:./k-volume-types.adoc[] - For more details about PersistentVolumes, see the https://kubernetes.io/docs/concepts/storage/persistent-volumes/[Kubernetes documentation^]. -- xref:reference:redpanda-helm-spec.adoc[Redpanda Helm Specification] -- xref:reference:crd.adoc[Redpanda CRD Reference] +- xref:reference:k-redpanda-helm-spec.adoc[Redpanda Helm Specification] +- xref:reference:k-crd.adoc[Redpanda CRD Reference] == Next Steps @@ -137,4 +138,4 @@ include::shared:partial$suggested-reading.adoc[] - xref:manage:kubernetes/monitoring/index.adoc#infrastructure-resources[Monitor disk usage] in Redpanda. - https://kubernetes.io/docs/concepts/storage/volume-health-monitoring/[Volume health monitoring^] in Kubernetes. -* Enable xref:manage:kubernetes/kubernetes-rack-awareness.adoc[rack awareness] to minimize data loss in the event of a rack failure. \ No newline at end of file +* Enable xref:manage:kubernetes/k-rack-awareness.adoc[rack awareness] to minimize data loss in the event of a rack failure. \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/storage/resize-persistentvolumes.adoc b/modules/manage/pages/kubernetes/storage/k-resize-persistentvolumes.adoc similarity index 98% rename from modules/manage/pages/kubernetes/storage/resize-persistentvolumes.adoc rename to modules/manage/pages/kubernetes/storage/k-resize-persistentvolumes.adoc index 47b3e6f5d..4c68e84f4 100644 --- a/modules/manage/pages/kubernetes/storage/resize-persistentvolumes.adoc +++ b/modules/manage/pages/kubernetes/storage/k-resize-persistentvolumes.adoc @@ -1,6 +1,7 @@ = Expand PersistentVolumes :url-kubernetes-expand-pvc: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#expanding-persistent-volumes-claims :description: Learn how to expand the size of your PersistentVolumes to give Redpanda brokers more storage capacity. +:page-aliases: manage:kubernetes/storage/resize-persistentvolumes.adoc To give Redpanda brokers more storage, you can expand the size of PersistentVolumes. The way you expand PersistentVolumes depends on the provisioner that you use. diff --git a/modules/manage/pages/kubernetes/storage/volume-types.adoc b/modules/manage/pages/kubernetes/storage/k-volume-types.adoc similarity index 97% rename from modules/manage/pages/kubernetes/storage/volume-types.adoc rename to modules/manage/pages/kubernetes/storage/k-volume-types.adoc index 256fa3158..27aeadca6 100644 --- a/modules/manage/pages/kubernetes/storage/volume-types.adoc +++ b/modules/manage/pages/kubernetes/storage/k-volume-types.adoc @@ -1,5 +1,6 @@ = Supported Volume Types for Data in Redpanda :description: Understand the three Kubernetes volume types supported by Redpanda, their lifecycles, use cases, storage locations, and their suitability for different Redpanda data requirements. +:page-aliases: manage:kubernetes/k-delete-persistentvolume.adoc, manage:kubernetes/storage/volume-types.adoc Redpanda supports PersistentVolumes, `emptyDir` volumes, and `hostPath` volumes for storing the <> and the <> in Kubernetes. The volume type you choose directly impacts performance and data integrity. This topic explains the three Kubernetes volume types supported by Redpanda, their lifecycles, use cases, storage locations, and their suitability for different Redpanda data requirements. @@ -171,8 +172,8 @@ include::shared:partial$suggested-reading.adoc[] ** link:https://kubernetes.io/docs/concepts/storage/volumes/#hostpath[hostPath volumes^] ** link:https://kubernetes.io/docs/concepts/storage/volumes/#emptydir[emptyDir volumes^] -- xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc[] +- xref:deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc[] == Next steps -xref:./configure-storage.adoc[] +xref:./k-configure-storage.adoc[] diff --git a/modules/manage/pages/kubernetes/tiered-storage-kubernetes/index.adoc b/modules/manage/pages/kubernetes/storage/tiered-storage/index.adoc similarity index 69% rename from modules/manage/pages/kubernetes/tiered-storage-kubernetes/index.adoc rename to modules/manage/pages/kubernetes/storage/tiered-storage/index.adoc index 717a68aeb..c5dc88bb5 100644 --- a/modules/manage/pages/kubernetes/tiered-storage-kubernetes/index.adoc +++ b/modules/manage/pages/kubernetes/storage/tiered-storage/index.adoc @@ -1,3 +1,4 @@ = Tiered Storage in Kubernetes :description: Configure your Redpanda cluster to offload log segments to cloud storage and save storage costs. :page-layout: index +:page-aliases: manage:kubernetes/tiered-storage-kubernetes/index.adoc diff --git a/modules/manage/pages/kubernetes/storage/data-archiving.adoc b/modules/manage/pages/kubernetes/storage/tiered-storage/k-data-archiving.adoc similarity index 56% rename from modules/manage/pages/kubernetes/storage/data-archiving.adoc rename to modules/manage/pages/kubernetes/storage/tiered-storage/k-data-archiving.adoc index 933a463fc..66b55d3eb 100644 --- a/modules/manage/pages/kubernetes/storage/data-archiving.adoc +++ b/modules/manage/pages/kubernetes/storage/tiered-storage/k-data-archiving.adoc @@ -1,8 +1,8 @@ = Data Archiving in Kubernetes :description: Set up data archiving to back up topics to cloud storage. -:page-context-links: [{"name": "Linux", "to": "manage:data-archiving.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/data-archiving.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:data-archiving.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/storage/tiered-storage/k-data-archiving.adoc" } ] :tags: ["Kubernetes", "Helm configuration"] :env-kubernetes: -:page-aliases: manage:kubernetes/data-archiving.adoc +:page-aliases: manage:kubernetes/data-archiving.adoc, manage:kubernetes/storage/data-archiving.adoc include::manage:partial$data-archiving.adoc[] diff --git a/modules/manage/pages/kubernetes/storage/tiered-storage.adoc b/modules/manage/pages/kubernetes/storage/tiered-storage/k-tiered-storage.adoc similarity index 71% rename from modules/manage/pages/kubernetes/storage/tiered-storage.adoc rename to modules/manage/pages/kubernetes/storage/tiered-storage/k-tiered-storage.adoc index edad523c7..20540ec54 100644 --- a/modules/manage/pages/kubernetes/storage/tiered-storage.adoc +++ b/modules/manage/pages/kubernetes/storage/tiered-storage/k-tiered-storage.adoc @@ -1,8 +1,9 @@ = Tiered Storage in Kubernetes :description: Configure your Redpanda cluster to offload log segments to object storage and save storage costs. -:page-context-links: [{"name": "Linux", "to": "manage:tiered-storage.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/storage/tiered-storage.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:tiered-storage.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/storage/tiered-storage/k-tiered-storage.adoc" } ] :env-kubernetes: :tags: ["Kubernetes", "Helm configuration"] -:page-aliases: manage:kubernetes/tiered-storage.adoc +:page-aliases: manage:kubernetes/tiered-storage.adoc, manage:kubernetes/storage/tiered-storage.adoc + include::manage:partial$tiered-storage.adoc[] \ No newline at end of file diff --git a/modules/manage/pages/kubernetes/troubleshooting/diagnostics-bundle.adoc b/modules/manage/pages/kubernetes/troubleshooting/k-diagnostics-bundle.adoc similarity index 99% rename from modules/manage/pages/kubernetes/troubleshooting/diagnostics-bundle.adoc rename to modules/manage/pages/kubernetes/troubleshooting/k-diagnostics-bundle.adoc index 20a32434e..9f7a7aea9 100644 --- a/modules/manage/pages/kubernetes/troubleshooting/diagnostics-bundle.adoc +++ b/modules/manage/pages/kubernetes/troubleshooting/k-diagnostics-bundle.adoc @@ -1,6 +1,7 @@ = Diagnostics Bundles in Kubernetes :description: Use the diagnostics bundle to debug issues yourself, or you can send it to the Redpanda support team to help resolve your issue. :tags: ["Kubernetes"] +:page-aliases: manage:kubernetes/troubleshooting/diagnostics-bundle.adoc A diagnostics bundle is a ZIP file with data that can help debug and diagnose issues with a Redpanda cluster, a broker, or the machines on which the brokers are running. You can use this file to debug issues yourself, or you can send it to the Redpanda support team to help resolve your issue. diff --git a/modules/manage/pages/kubernetes/troubleshooting/troubleshoot.adoc b/modules/manage/pages/kubernetes/troubleshooting/k-troubleshoot.adoc similarity index 98% rename from modules/manage/pages/kubernetes/troubleshooting/troubleshoot.adoc rename to modules/manage/pages/kubernetes/troubleshooting/k-troubleshoot.adoc index edc7e9d3e..6fc295541 100644 --- a/modules/manage/pages/kubernetes/troubleshooting/troubleshoot.adoc +++ b/modules/manage/pages/kubernetes/troubleshooting/k-troubleshoot.adoc @@ -1,6 +1,7 @@ = Troubleshoot Redpanda in Kubernetes :description: Find advice on how to diagnose and troubleshoot issues while deploying Redpanda in Kubernetes. :tags: ["Kubernetes"] +:page-aliases: manage:kubernetes/troubleshooting/troubleshoot.adoc This topic provides guidance on how to diagnose and troubleshoot issues with Redpanda deployments in Kubernetes. @@ -12,7 +13,7 @@ Before troubleshooting Redpanda, ensure that Kubernetes isn't the cause of the i If you're unsure of what is wrong, you can generate a diagnostics bundle that contains a wide range of data to help debug and diagnose a Redpanda cluster or the nodes on which the brokers are running. -See xref:./diagnostics-bundle.adoc[Diagnostics Bundles in Kubernetes]. +See xref:./k-diagnostics-bundle.adoc[Diagnostics Bundles in Kubernetes]. == View Helm chart configuration @@ -216,7 +217,7 @@ kubectl get storageclass kubectl get persistentvolume --namespace ---- -To learn how to configure different storage volumes, see xref:manage:kubernetes/configure-storage.adoc[Configure Storage]. +To learn how to configure different storage volumes, see xref:manage:kubernetes/storage/k-configure-storage.adoc[Configure Storage]. //end::deployment-unable-to-mount-volume[] //tag::deployment-dig-not-defined[] diff --git a/modules/manage/pages/monitoring.adoc b/modules/manage/pages/monitoring.adoc index fb1c72975..3a09901e7 100644 --- a/modules/manage/pages/monitoring.adoc +++ b/modules/manage/pages/monitoring.adoc @@ -1,6 +1,6 @@ = Monitor Redpanda :description: Metrics to monitor the health of your system to predict issues and optimize performance. -:page-context-links: [{"name": "Linux", "to": "manage:monitoring.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/monitoring/monitor-redpanda.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:monitoring.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/monitoring/k-monitor-redpanda.adoc" } ] :page-aliases: deploy-self-hosted:monitoring.adoc, cluster-administration:monitoring.adoc, cluster-management:monitoring.adoc include::manage:partial$monitor-redpanda.adoc[] diff --git a/modules/manage/pages/rack-awareness.adoc b/modules/manage/pages/rack-awareness.adoc index f7a7b3f4b..0ab7c69cc 100644 --- a/modules/manage/pages/rack-awareness.adoc +++ b/modules/manage/pages/rack-awareness.adoc @@ -1,6 +1,6 @@ = Enable Rack Awareness :description: Enable rack awareness to place partition replicas across different failure zones. -:page-context-links: [{"name": "Linux", "to": "manage:rack-awareness.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/kubernetes-rack-awareness.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:rack-awareness.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/k-rack-awareness.adoc" } ] :page-aliases: data-management:rack-awareness.adoc include::manage:partial$rack-awareness.adoc[] diff --git a/modules/manage/pages/remote-read-replicas.adoc b/modules/manage/pages/remote-read-replicas.adoc index ffd2ae284..f298b585c 100644 --- a/modules/manage/pages/remote-read-replicas.adoc +++ b/modules/manage/pages/remote-read-replicas.adoc @@ -1,6 +1,6 @@ = Remote Read Replicas :description: Learn how to create a Remote Read Replica topic, which is a read-only topic that mirrors a topic on a different cluster. -:page-context-links: [{"name": "Linux", "to": "manage:remote-read-replicas.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/remote-read-replicas.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:remote-read-replicas.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/k-remote-read-replicas.adoc" } ] :page-aliases: data-management:remote-read-replicas.adoc include::manage:partial$remote-read-replicas.adoc[] diff --git a/modules/manage/pages/security/authentication.adoc b/modules/manage/pages/security/authentication.adoc index b227f8b57..7a09374dd 100644 --- a/modules/manage/pages/security/authentication.adoc +++ b/modules/manage/pages/security/authentication.adoc @@ -1,6 +1,6 @@ = Configure Authentication :description: Redpanda supports multiple forms of authentication including SASL/SCRAM, mTLS with principal mapping, and basic authentication. -:page-context-links: [{"name": "Linux", "to": "manage:security/authentication.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/security/sasl-kubernetes.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:security/authentication.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/security/authentication/k-authentication.adoc" } ] :page-aliases: security:authentication.adoc :page-toclevels: 3 diff --git a/modules/manage/pages/security/listener-configuration.adoc b/modules/manage/pages/security/listener-configuration.adoc index 9be55e7dd..580cf9a15 100644 --- a/modules/manage/pages/security/listener-configuration.adoc +++ b/modules/manage/pages/security/listener-configuration.adoc @@ -1,6 +1,6 @@ = Configure Listeners :description: Use listeners to advertise the location of the broker, so other brokers in the cluster can be found. -:page-context-links: [{"name": "Linux", "to": "manage:security/listener-configuration.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/networking/configure-listeners.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:security/listener-configuration.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/networking/k-configure-listeners.adoc" } ] :page-aliases: cluster-administration:listener-configuration.adoc Apache Kafka® client libraries must be able to connect to every Redpanda broker diff --git a/modules/manage/pages/tiered-storage.adoc b/modules/manage/pages/tiered-storage.adoc index 6f84f3f8c..4fdd0e7e0 100644 --- a/modules/manage/pages/tiered-storage.adoc +++ b/modules/manage/pages/tiered-storage.adoc @@ -1,6 +1,6 @@ = Tiered Storage :description: Configure your Redpanda cluster to offload log segments to cloud storage and save storage costs. -:page-context-links: [{"name": "Linux", "to": "manage:tiered-storage.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/storage/tiered-storage.adoc" } ] +:page-context-links: [{"name": "Linux", "to": "manage:tiered-storage.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/storage/tiered-storage/k-tiered-storage.adoc" } ] :page-aliases: data-management:shadow-indexing.adoc, \ data-management:tiered-storage.adoc diff --git a/modules/manage/partials/authentication.adoc b/modules/manage/partials/authentication.adoc index 2bb4ddd69..e56accc5e 100644 --- a/modules/manage/partials/authentication.adoc +++ b/modules/manage/partials/authentication.adoc @@ -288,7 +288,7 @@ kubectl create secret generic redpanda-superusers \ --dry-run=client -o yaml | kubectl apply -f - ---- + -The xref:reference:redpanda-helm-spec.adoc#statefulset-sidecars-configwatcher-enabled[`config-watcher` sidecar] in the Pod polls the Secret resource for changes and triggers a rolling upgrade to add the new superusers to the Redpanda cluster. +The xref:reference:k-redpanda-helm-spec.adoc#statefulset-sidecars-configwatcher-enabled[`config-watcher` sidecar] in the Pod polls the Secret resource for changes and triggers a rolling upgrade to add the new superusers to the Redpanda cluster. - If you created superusers using a YAML list, you can update the list: + @@ -615,7 +615,7 @@ rpk topic describe myfirsttopic \ ``` ifdef::env-kubernetes[] -For more details on connecting to Redpanda, see xref:manage:kubernetes/networking/connect-to-redpanda.adoc[]. +For more details on connecting to Redpanda, see xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[]. endif::[] [[schema-and-http-to-redpanda]] diff --git a/modules/manage/partials/data-archiving.adoc b/modules/manage/partials/data-archiving.adoc index ffb1f398c..93f824b0c 100644 --- a/modules/manage/partials/data-archiving.adoc +++ b/modules/manage/partials/data-archiving.adoc @@ -4,7 +4,7 @@ include::shared:partial$enterprise-license.adoc[] ==== ifdef::env-kubernetes[] -:tiered-storage-link: manage:kubernetes/storage/tiered-storage.adoc +:tiered-storage-link: manage:kubernetes/storage/tiered-storage/k-tiered-storage.adoc endif::[] ifndef::env-kubernetes[] :tiered-storage-link: manage:tiered-storage.adoc diff --git a/modules/manage/partials/monitor-connectors.adoc b/modules/manage/partials/monitor-connectors.adoc index 49a1d4be9..870a0742e 100644 --- a/modules/manage/partials/monitor-connectors.adoc +++ b/modules/manage/partials/monitor-connectors.adoc @@ -317,6 +317,6 @@ ifdef::env-kubernetes[] == Next steps -xref:manage:kubernetes/manage-connectors.adoc[]. +xref:manage:kubernetes/k-manage-connectors.adoc[]. endif::[] \ No newline at end of file diff --git a/modules/manage/partials/recovery-mode.adoc b/modules/manage/partials/recovery-mode.adoc index 78d3ecbd7..2aac6b8c4 100644 --- a/modules/manage/partials/recovery-mode.adoc +++ b/modules/manage/partials/recovery-mode.adoc @@ -251,7 +251,7 @@ You can also disable a partition _outside_ of recovery mode, if the issue is loc The following examples show you how to use the Admin API to enable or disable partitions. The examples are based on the assumption that the Admin API port is `9644`. ifdef::env-kubernetes[] -For help connecting to the Admin API, see xref:manage:kubernetes/networking/connect-to-redpanda.adoc[]. +For help connecting to the Admin API, see xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[]. endif::[] NOTE: Use `kafka` as the `partition-namespace` when making API calls to manage partitions in user topics. diff --git a/modules/manage/partials/remote-read-replicas.adoc b/modules/manage/partials/remote-read-replicas.adoc index 1b595cf94..e60871af6 100644 --- a/modules/manage/partials/remote-read-replicas.adoc +++ b/modules/manage/partials/remote-read-replicas.adoc @@ -4,8 +4,8 @@ include::shared:partial$enterprise-license.adoc[] ==== ifdef::env-kubernetes[] -:tiered-storage-link: manage:kubernetes/storage/tiered-storage.adoc -:data-archiving-link: manage:kubernetes/data-archiving.adoc +:tiered-storage-link: manage:kubernetes/storage/tiered-storage/k-tiered-storage.adoc +:data-archiving-link: manage:kubernetes/storage/tiered-storage/k-data-archiving.adoc endif::[] ifndef::env-kubernetes[] :tiered-storage-link: manage:tiered-storage.adoc diff --git a/modules/manage/partials/tiered-storage.adoc b/modules/manage/partials/tiered-storage.adoc index b6f6c825c..467b8acbb 100644 --- a/modules/manage/partials/tiered-storage.adoc +++ b/modules/manage/partials/tiered-storage.adoc @@ -1,5 +1,5 @@ ifdef::env-kubernetes[] -:data-archiving-link: manage:kubernetes/data-archiving.adoc +:data-archiving-link: manage:kubernetes/storage/tiered-storage/k-data-archiving.adoc endif::[] ifndef::env-kubernetes[] :data-archiving-link: manage:data-archiving.adoc @@ -865,7 +865,7 @@ To enable remote read on an existing topic: rpk topic alter-config --set redpanda.remote.read=true ---- -See also: xref:manage:kubernetes/remote-read-replicas.adoc[Remote Read Replicas] +See also: xref:manage:kubernetes/k-remote-read-replicas.adoc[Remote Read Replicas] === Caching diff --git a/modules/manage/partials/whole-cluster-restore.adoc b/modules/manage/partials/whole-cluster-restore.adoc index d6d9b5445..949c4fe27 100644 --- a/modules/manage/partials/whole-cluster-restore.adoc +++ b/modules/manage/partials/whole-cluster-restore.adoc @@ -1,5 +1,5 @@ ifdef::env-kubernetes[] -:link-tiered-storage: manage:kubernetes/storage/tiered-storage.adoc +:link-tiered-storage: manage:kubernetes/storage/tiered-storage/k-tiered-storage.adoc :link-recovery-mode: manage:kubernetes/k-recovery-mode.adoc endif::[] ifndef::env-kubernetes[] diff --git a/modules/reference/pages/connector-helm-spec.adoc b/modules/reference/pages/k-connector-helm-spec.adoc similarity index 100% rename from modules/reference/pages/connector-helm-spec.adoc rename to modules/reference/pages/k-connector-helm-spec.adoc diff --git a/modules/reference/pages/console-helm-spec.adoc b/modules/reference/pages/k-console-helm-spec.adoc similarity index 100% rename from modules/reference/pages/console-helm-spec.adoc rename to modules/reference/pages/k-console-helm-spec.adoc diff --git a/modules/reference/pages/kubernetes-crd-index.adoc b/modules/reference/pages/k-crd-index.adoc similarity index 63% rename from modules/reference/pages/kubernetes-crd-index.adoc rename to modules/reference/pages/k-crd-index.adoc index 6524eb019..c941a6523 100644 --- a/modules/reference/pages/kubernetes-crd-index.adoc +++ b/modules/reference/pages/k-crd-index.adoc @@ -1,3 +1,4 @@ = Kubernetes Custom Resource Definitions :page-layout: index :description: Explore all custom resource definitions (CRDs) that are supported by the Redpanda Operator. +:page-aliases: reference:topic-crd.adoc, reference:crd.adoc, reference:kubernetes-crd-index.adoc \ No newline at end of file diff --git a/modules/reference/pages/crd.adoc b/modules/reference/pages/k-crd.adoc similarity index 99% rename from modules/reference/pages/crd.adoc rename to modules/reference/pages/k-crd.adoc index 83a2bd132..dae696be6 100644 --- a/modules/reference/pages/crd.adoc +++ b/modules/reference/pages/k-crd.adoc @@ -879,7 +879,7 @@ Redpanda defines the CRD for Redpanda clusters. RedpandaClusterSpec defines the desired state of a Redpanda cluster. These settings are the same as those defined in the Redpanda Helm chart. The values in these settings are passed to the Redpanda Helm chart through Flux. For all default values and links to more documentation, see https://docs.redpanda.com/current/reference/redpanda-helm-spec/. -For descriptions and default values, see xref:redpanda-helm-spec.adoc[]. +For descriptions and default values, see xref:k-redpanda-helm-spec.adoc[]. .Appears in: diff --git a/modules/reference/pages/kubernetes-helm-index.adoc b/modules/reference/pages/k-helm-index.adoc similarity index 50% rename from modules/reference/pages/kubernetes-helm-index.adoc rename to modules/reference/pages/k-helm-index.adoc index c3abb3120..d9d5f1401 100644 --- a/modules/reference/pages/kubernetes-helm-index.adoc +++ b/modules/reference/pages/k-helm-index.adoc @@ -1,3 +1,4 @@ = Kubernetes Helm Chart Specifications :page-layout: index :description: Explore the properties and values of all Helm charts that are supported by Redpanda. +:page-aliases: reference:connector-helm-spec.adoc, reference:console-helm-spec.adoc, reference:redpanda-helm-spec.adoc, reference:kubernetes-helm-index.adoc diff --git a/modules/reference/pages/kubernetes-index.adoc b/modules/reference/pages/k-index.adoc similarity index 68% rename from modules/reference/pages/kubernetes-index.adoc rename to modules/reference/pages/k-index.adoc index a70cef830..1b4f65278 100644 --- a/modules/reference/pages/kubernetes-index.adoc +++ b/modules/reference/pages/k-index.adoc @@ -1,3 +1,4 @@ = Kubernetes Reference :description: Reference topics for Redpanda in Kubernetes. :page-layout: index +:page-aliases: reference:kubernetes-index.adoc diff --git a/modules/reference/pages/redpanda-helm-spec.adoc b/modules/reference/pages/k-redpanda-helm-spec.adoc similarity index 100% rename from modules/reference/pages/redpanda-helm-spec.adoc rename to modules/reference/pages/k-redpanda-helm-spec.adoc diff --git a/modules/reference/pages/topic-crd.adoc b/modules/reference/pages/k-topic-crd.adoc similarity index 100% rename from modules/reference/pages/topic-crd.adoc rename to modules/reference/pages/k-topic-crd.adoc diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc index 49920e9b7..965ab5026 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc @@ -27,7 +27,7 @@ To learn more about a tuner, run `rpk redpanda tune help |tuner name|`. You should run the autotuner as part of the production deployment workflow. Redpanda recommends you first follow a guide for production deployment: * xref:deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc[Deploy for Production] -* xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-tune-workers.adoc[Tune Kubernetes Worker Nodes for Production] +* xref:deploy:deployment-option/self-hosted/kubernetes/k-tune-workers.adoc[Tune Kubernetes Worker Nodes for Production] While you follow the guides, consult this reference for details about the autotuner. ==== @@ -139,6 +139,6 @@ See also the xref:./rpk-redpanda-tune-list.adoc#tuners[Tuners reference] for des === Related topics * xref:deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc[Deploy for Production] -* xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-tune-workers.adoc[Tune Kubernetes Worker Nodes for Production] +* xref:deploy:deployment-option/self-hosted/kubernetes/k-tune-workers.adoc[Tune Kubernetes Worker Nodes for Production] * xref:./rpk-redpanda-mode.adoc[rpk redpanda mode production] * xref:./rpk-redpanda-tune-list.adoc[rpk redpanda tune list] diff --git a/modules/upgrade/pages/k-rolling-upgrade.adoc b/modules/upgrade/pages/k-rolling-upgrade.adoc index a32527575..d1e03e971 100644 --- a/modules/upgrade/pages/k-rolling-upgrade.adoc +++ b/modules/upgrade/pages/k-rolling-upgrade.adoc @@ -12,7 +12,7 @@ include::partial$rolling-upgrades/upgrade-limitations.adoc[] == Prerequisites * xref:deploy:deployment-option/self-hosted/kubernetes/index.adoc[A Redpanda cluster running in Kubernetes]. -* The default xref:reference:redpanda-helm-spec.adoc#statefulset-updatestrategy-type[RollingUpdate strategy] configured in the Helm values. +* The default xref:reference:k-redpanda-helm-spec.adoc#statefulset-updatestrategy-type[RollingUpdate strategy] configured in the Helm values. * Review the xref:k-compatibility.adoc[] topic. * https://stedolan.github.io/jq/download/[jq^] for listing available versions. @@ -124,7 +124,7 @@ The Helm chart's `preStop` lifecycle hook puts each broker into maintenance mode The default `terminationGracePeriod` is 90 seconds, which should be long enough for large clusters. You can test different values in a development environment. To configure the `terminationGracePeriod`, -use the xref:reference:redpanda-helm-spec.adoc#statefulsetterminationgraceperiodseconds[`statefulset.terminationGracePeriodSeconds`] setting. +use the xref:reference:k-redpanda-helm-spec.adoc#statefulsetterminationgraceperiodseconds[`statefulset.terminationGracePeriodSeconds`] setting. ==== To upgrade: @@ -273,7 +273,7 @@ NOTE: The Redpanda Operator rolls back automatically after three failed attempts If you are using the Redpanda Helm chart without the Redpanda Operator, you can roll back manually. -The StatefulSet uses the `RollingUpdate` strategy by default in xref:reference:redpanda-helm-spec.adoc#statefulsetupdatestrategytype[`statefulset.updateStrategy.type`], +The StatefulSet uses the `RollingUpdate` strategy by default in xref:reference:k-redpanda-helm-spec.adoc#statefulsetupdatestrategytype[`statefulset.updateStrategy.type`], which means all Pods in the StatefulSet are restarted in reverse-ordinal order. For details, see the https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies[Kubernetes documentation^]. . Find the previous revision: diff --git a/modules/upgrade/pages/migrate/kubernetes/helm-to-operator.adoc b/modules/upgrade/pages/migrate/kubernetes/helm-to-operator.adoc index 0e40af1ea..60fb147a7 100644 --- a/modules/upgrade/pages/migrate/kubernetes/helm-to-operator.adoc +++ b/modules/upgrade/pages/migrate/kubernetes/helm-to-operator.adoc @@ -21,9 +21,9 @@ spec: ``` - `metadata.name`: Name to assign the Redpanda cluster. This name is also assigned to the Helm release. -- xref:reference:crd.adoc#chartref[`spec.chartRef`]: Information about the Helm chart that will be used to deploy Redpanda. -- xref:reference:crd.adoc#helmrepositoryname[`spec.chartRef.helmRepositoryName`]: Name of the Helm repository where the Redpanda chart is located. -- xref:reference:crd.adoc#redpandaclusterspec[`spec.clusterSpec`]: This is where you can override default values in the Redpanda Helm chart. +- xref:reference:k-crd.adoc#chartref[`spec.chartRef`]: Information about the Helm chart that will be used to deploy Redpanda. +- xref:reference:k-crd.adoc#helmrepositoryname[`spec.chartRef.helmRepositoryName`]: Name of the Helm repository where the Redpanda chart is located. +- xref:reference:k-crd.adoc#redpandaclusterspec[`spec.clusterSpec`]: This is where you can override default values in the Redpanda Helm chart. == Prerequisites @@ -120,7 +120,7 @@ spec: + NOTE: By selecting the correct chart version, you ensure control over your deployment. If you don't select a chart version, the operator may upgrade your chart, potentially causing unintended downtime. + -TIP: The Redpanda Operator passes these values to the Redpanda Helm chart. The keys in the `clusterSpec` field are the same as those in the Redpanda Helm chart. For details on the structure and configuration options of the Redpanda custom resource, refer to the xref:reference:crd.adoc#redpandaclusterspec[Redpanda Operator CRD reference]. +TIP: The Redpanda Operator passes these values to the Redpanda Helm chart. The keys in the `clusterSpec` field are the same as those in the Redpanda Helm chart. For details on the structure and configuration options of the Redpanda custom resource, refer to the xref:reference:k-crd.adoc#redpandaclusterspec[Redpanda Operator CRD reference]. . Adopt the Redpanda cluster by creating an instance of the Redpanda custom resource in the same namespace as the Redpanda Operator: + @@ -254,4 +254,4 @@ After completing these steps, the Redpanda Operator is no longer managing your H == Next steps -For information about the latest Redpanda Operator and the new Redpanda custom resource, see xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-production-deployment.adoc[Redpanda in Kubernetes]. +For information about the latest Redpanda Operator and the new Redpanda custom resource, see xref:deploy:deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc[Redpanda in Kubernetes]. diff --git a/modules/upgrade/pages/migrate/kubernetes/operator.adoc b/modules/upgrade/pages/migrate/kubernetes/operator.adoc index e0c8fa383..220bc01a8 100644 --- a/modules/upgrade/pages/migrate/kubernetes/operator.adoc +++ b/modules/upgrade/pages/migrate/kubernetes/operator.adoc @@ -292,7 +292,7 @@ Replace `path-to-cluster-resource.yaml` with the absolute path to your Cluster m + Replace `path-to-console-resource.yaml` with the absolute path to your Console manifest. -. Ensure that your migrated Redpanda resource is configured correctly. You can compare the xref:23.2@reference:redpanda-operator/crd.adoc[Cluster and Console CRD reference] to the xref:reference:crd.adoc[Redpanda CRD reference]. +. Ensure that your migrated Redpanda resource is configured correctly. You can compare the xref:23.2@reference:redpanda-operator/crd.adoc[Cluster and Console CRD reference] to the xref:reference:k-crd.adoc[Redpanda CRD reference]. + [NOTE] ==== @@ -446,4 +446,4 @@ The deprecated Redpanda Operator is now managing your resources. Any changes tha == Next steps -For information about the updated Redpanda Operator and the Redpanda custom resource, see xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-production-deployment.adoc[Redpanda in Kubernetes]. \ No newline at end of file +For information about the updated Redpanda Operator and the Redpanda custom resource, see xref:deploy:deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc[Redpanda in Kubernetes]. \ No newline at end of file diff --git a/modules/upgrade/partials/k-operator-compatibility-matrix.adoc b/modules/upgrade/partials/k-operator-compatibility-matrix.adoc index 15cc095d9..b8894bd74 100644 --- a/modules/upgrade/partials/k-operator-compatibility-matrix.adoc +++ b/modules/upgrade/partials/k-operator-compatibility-matrix.adoc @@ -5,14 +5,14 @@ | link:https://github.com/redpanda-data/redpanda-operator/releases[2.1.x] | -xref:reference:kubernetes-crd-index.adoc[Redpanda v1alpha1] +xref:reference:k-crd-index.adoc[Redpanda v1alpha1] |5.7.x, 5.6.x, 5.5.x | link:https://github.com/redpanda-data/helm-charts/releases/operator-0.3.26[0.3.x] | link:https://github.com/redpanda-data/redpanda-operator/releases[23.2.x] | -xref:reference:kubernetes-crd-index.adoc[Redpanda v1alpha1] +xref:reference:k-crd-index.adoc[Redpanda v1alpha1] |5.7.x, 5.6.x, 5.5.x |=== diff --git a/scripts/generate-k8s-compatibility-matrix/generate-rp-matrix.js b/scripts/generate-k8s-compatibility-matrix/generate-rp-matrix.js index 45ca428e8..eae184a97 100644 --- a/scripts/generate-k8s-compatibility-matrix/generate-rp-matrix.js +++ b/scripts/generate-k8s-compatibility-matrix/generate-rp-matrix.js @@ -165,7 +165,7 @@ async function fetchOperatorChartDetails(chartVersion) { const crds = response.data.crds; if (crds) { for (i = 0; i < crds.length; i++) { - crdVersions += `\n\nxref:reference:kubernetes-crd-index.adoc[${crds[i].kind} ${crds[i].version}]` + crdVersions += `\n\nxref:reference:k-crd-index.adoc[${crds[i].kind} ${crds[i].version}]` } } diff --git a/tools/add-caret-external-links.py b/tools/add-caret-external-links.py index df3b0f0f3..804d1bfb3 100644 --- a/tools/add-caret-external-links.py +++ b/tools/add-caret-external-links.py @@ -37,9 +37,9 @@ def replace_link(match): # List of excluded file paths (relative paths) exclusion_list = [ 'reference\\pages\\redpanda-operator\\crd.adoc', - 'reference\\pages\\console-helm-spec.adoc', + 'reference\\pages\\k-console-helm-spec.adoc', 'reference\\pages\\crd.adoc', - 'reference\\pages\\redpanda-helm-spec.adoc', + 'reference\\pages\\k-redpanda-helm-spec.adoc', 'reference\\partials\\bundle-contents-k8s.adoc', 'reference\\partials\\bundle-contents-linux.adoc' ]