ia: Restructure deployment docs (#1304)

Author: JakeSCahill

modules/ROOT/nav.adoc

@@ -63,37 +63,47 @@
 *** xref:develop:data-transforms/labs.adoc[Examples]
 ** xref:develop:transactions.adoc[]
 * xref:deploy:index.adoc[Deploy]
-** xref:deploy:deployment-option/self-hosted/kubernetes/index.adoc[Kubernetes]
-*** 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]
-*** xref:deploy:deployment-option/self-hosted/kubernetes/get-started-dev.adoc[Guides]
-**** xref:deploy:deployment-option/self-hosted/kubernetes/aks-guide.adoc[Azure AKS]
-**** xref:deploy:deployment-option/self-hosted/kubernetes/eks-guide.adoc[Amazon EKS]
-**** xref:deploy:deployment-option/self-hosted/kubernetes/gke-guide.adoc[Google GKE]
-**** xref:deploy:deployment-option/self-hosted/kubernetes/local-guide.adoc[Local (kind and minikube)]
-** xref:deploy:deployment-option/self-hosted/manual/index.adoc[Linux]
-*** xref:deploy:deployment-option/self-hosted/manual/production/requirements.adoc[Hardware and Software Requirements]
-*** xref:deploy:deployment-option/self-hosted/manual/production/index.adoc[Deployment Options]
-**** xref:deploy:deployment-option/self-hosted/manual/production/dev-deployment.adoc[Deploy for Development]
-**** xref:deploy:deployment-option/self-hosted/manual/production/production-deployment-automation.adoc[]
-**** xref:deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc[]
-**** xref:deploy:deployment-option/self-hosted/manual/production/production-readiness.adoc[]
-*** xref:deploy:deployment-option/self-hosted/manual/high-availability.adoc[High Availability]
-*** xref:deploy:deployment-option/self-hosted/manual/sizing-use-cases.adoc[Sizing Use Cases]
-*** xref:deploy:deployment-option/self-hosted/manual/sizing.adoc[Sizing Guidelines]
-*** xref:deploy:deployment-option/self-hosted/manual/linux-system-tuning.adoc[System Tuning]
-** xref:deploy:deployment-option/self-hosted/docker-image.adoc[Connectors]
+** xref:deploy:redpanda/index.adoc[Redpanda]
+*** xref:deploy:redpanda/kubernetes/index.adoc[Kubernetes]
+**** xref:deploy:redpanda/kubernetes/k-deployment-overview.adoc[Overview]
+**** xref:deploy:redpanda/kubernetes/get-started-dev.adoc[Get Started]
+***** xref:deploy:redpanda/kubernetes/aks-guide.adoc[Azure AKS]
+***** xref:deploy:redpanda/kubernetes/eks-guide.adoc[Amazon EKS]
+***** xref:deploy:redpanda/kubernetes/gke-guide.adoc[Google GKE]
+***** xref:deploy:redpanda/kubernetes/local-guide.adoc[Local (kind and minikube)]
+**** xref:deploy:redpanda/kubernetes/k-production-workflow.adoc[Deployment Workflow]
+**** xref:deploy:redpanda/kubernetes/k-requirements.adoc[Requirements and Recommendations]
+**** xref:deploy:redpanda/kubernetes/k-tune-workers.adoc[Tune Worker Nodes]
+**** xref:deploy:redpanda/kubernetes/k-production-deployment.adoc[Deploy Redpanda]
+**** xref:deploy:redpanda/kubernetes/k-high-availability.adoc[High Availability]
+*** xref:deploy:redpanda/manual/index.adoc[Linux]
+**** xref:deploy:redpanda/manual/production/requirements.adoc[Hardware and Software Requirements]
+**** xref:deploy:redpanda/manual/production/index.adoc[Deployment Options]
+***** xref:deploy:redpanda/manual/production/dev-deployment.adoc[Deploy for Development]
+***** xref:deploy:redpanda/manual/production/production-deployment-automation.adoc[]
+***** xref:deploy:redpanda/manual/production/production-deployment.adoc[]
+***** xref:deploy:redpanda/manual/production/production-readiness.adoc[]
+**** xref:deploy:redpanda/manual/high-availability.adoc[High Availability]
+**** xref:deploy:redpanda/manual/sizing-use-cases.adoc[Sizing Use Cases]
+**** xref:deploy:redpanda/manual/sizing.adoc[Sizing Guidelines]
+**** xref:deploy:redpanda/manual/linux-system-tuning.adoc[System Tuning]
+** xref:deploy:console/index.adoc[Redpanda Console]
+*** xref:deploy:console/kubernetes/index.adoc[Kubernetes]
+**** xref:deploy:console/kubernetes/k-requirements.adoc[Requirements]
+**** xref:deploy:console/kubernetes/deploy.adoc[Deploy on Kubernetes]
+*** xref:deploy:console/linux/index.adoc[Linux]
+**** xref:deploy:console/linux/requirements.adoc[Requirements]
+**** xref:deploy:console/linux/deploy.adoc[Deploy on Linux]
+** xref:redpanda-connect:home:index.adoc[Redpanda Connect]
+** xref:deploy:kafka-connect/index.adoc[Kafka Connect]
+*** xref:deploy:kafka-connect/k-deploy-kafka-connect.adoc[Deploy on Kubernetes]
+*** xref:deploy:kafka-connect/deploy-kafka-connect.adoc[Deploy on Docker]
 * xref:manage:index.adoc[Manage]
 ** xref:manage:kubernetes/index.adoc[Kubernetes]
 *** 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/k-manage-connectors.adoc[Manage Kafka Connect]
 *** xref:manage:kubernetes/storage/index.adoc[Storage]
 **** xref:manage:kubernetes/storage/k-volume-types.adoc[Volume Types]
 **** xref:manage:kubernetes/storage/k-configure-storage.adoc[Configure Storage]
@@ -133,7 +143,7 @@
 *** xref:manage:kubernetes/k-recovery-mode.adoc[Recovery Mode]
 *** xref:manage:kubernetes/monitoring/index.adoc[Monitor]
 **** xref:manage:kubernetes/monitoring/k-monitor-redpanda.adoc[Redpanda]
-**** xref:manage:kubernetes/monitoring/k-monitor-connectors.adoc[Connectors]
+**** xref:manage:kubernetes/monitoring/k-monitor-connectors.adoc[Kafka Connect]
 *** xref:manage:kubernetes/k-rolling-restart.adoc[Rolling Restart]
 *** xref:manage:kubernetes/k-resilience-testing.adoc[Resilience Testing]
 ** xref:manage:cluster-maintenance/index.adoc[Cluster Maintenance]
@@ -181,13 +191,12 @@
 *** xref:manage:schema-reg/schema-reg-overview.adoc[Overview]
 *** xref:manage:schema-reg/manage-schema-reg.adoc[]
 **** xref:manage:schema-reg/schema-reg-api.adoc[API]
-**** xref:console:ui/schema-reg.adoc[Redpanda Console]
 **** xref:manage:kubernetes/k-schema-controller.adoc[Kubernetes]
 *** xref:manage:schema-reg/schema-reg-authorization.adoc[Schema Registry Authorization]
 *** xref:manage:schema-reg/schema-id-validation.adoc[]
 *** xref:console:ui/schema-reg.adoc[Manage in Redpanda Console]
 ** xref:manage:console/index.adoc[Redpanda Console]
-*** xref:console:config/configure-console.adoc[Configure Console]
+*** xref:console:config/configure-console.adoc[Configure Redpanda Console]
 *** xref:console:config/enterprise-license.adoc[Add an Enterprise License]
 *** xref:console:config/connect-to-redpanda.adoc[Connect to Redpanda]
 *** xref:console:config/security/index.adoc[Security]
@@ -196,9 +205,9 @@
 **** xref:console:config/security/tls-termination.adoc[TLS Termination]
 *** xref:console:config/http-path-rewrites.adoc[HTTP Path Rewrites]
 *** xref:console:config/deserialization.adoc[Deserialization]
-*** xref:console:config/kafka-connect.adoc[Kafka Connect]
 *** xref:console:config/topic-documentation.adoc[Topic Documentation]
 *** xref:console:config/analytics.adoc[Telemetry]
+*** xref:console:config/kafka-connect.adoc[Kafka Connect]
 ** xref:manage:recovery-mode.adoc[Recovery Mode]
 ** xref:manage:rack-awareness.adoc[Rack Awareness]
 ** xref:manage:monitoring.adoc[]

modules/console/pages/config/analytics.adoc

@@ -1,5 +1,5 @@
 = Redpanda Console Telemetry
-:description: Understand what telemetry Redpanda Console collects by default, how it is handled, and how to disable it.
+:description: Learn what telemetry Redpanda Console collects by default, how it is handled, and how to disable it.
 
 Redpanda Console collects telemetry (analytics) data for purposes including product improvements and user experience optimization. This document explains what data is collected, how it is processed, and how you can disable telemetry if desired.
 
@@ -45,13 +45,79 @@ Telemetry data is processed with the following features:
 
 == Disable telemetry
 
-To turn off telemetry and user tracking, set the following in your Console configuration file:
+To turn off telemetry and user tracking, set the following in your Redpanda Console configuration:
+
+[tabs]
+======
+Standalone::
++
+--
 
 [source,yaml]
 ----
 analytics:
   enabled: false
 ----
 
+--
+
+Kubernetes embedded::
++
+--
+
+When Redpanda Console is part of the Redpanda Helm chart or Operator:
+
+[tabs]
+====
+Operator::
++
+[,yaml]
+.`redpanda-cluster`.yaml
+----
+apiVersion: cluster.redpanda.com/v1alpha2
+kind: Redpanda
+metadata:
+  name: redpanda
+spec:
+  clusterSpec:
+    console:
+      enabled: true
+      console:
+        config:
+          analytics:
+            enabled: false
+----
+
+Helm::
++
+[,yaml]
+.`redpanda-values.yaml`
+----
+console:
+  enabled: true
+  console:
+    config:
+      analytics:
+        enabled: false
+----
+====
+--
+Kubernetes standalone::
++
+--
+
+When using the standalone Redpanda Console Helm chart:
+
+[,yaml]
+.`console-values.yaml`
+----
+config:
+  analytics:
+    enabled: false
+----
+
+--
+======
+
 Restart the Redpanda Console service to apply the change and stop all telemetry and user tracking.
 

modules/console/pages/config/configure-console.adoc

@@ -1,5 +1,6 @@
+
 = Configure Redpanda Console
-:description: Redpanda Console configuration file with property descriptions.
+:description: Learn how to configure Redpanda Console using environment variables, YAML files, or command-line arguments.
 :page-aliases: console:reference/config.adoc, reference:console/config.adoc
 :page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/configure-console.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
 
@@ -8,25 +9,16 @@ include::console:partial$operator-console-version-note.adoc[]
 Redpanda Console loads configuration properties from three sources, in the following order of precedence:
 
 . Environment variables
-. YAML file configuration (recommended)
+. YAML file configuration
 . Command-line arguments
 
 Environment variables and YAML configurations can overwrite input that is set on the command line.
 
-== YAML file configuration
-
-The recommended configuration source is a YAML file. You can specify the path to the configuration file by setting either
-the `-config.filepath` flag or the `CONFIG_FILEPATH` environment variable.
-A reference configuration file is provided under <<Complete configuration file example>>.
-
-In Linux package installations, this file is located in `/etc/redpanda/redpanda-console-config.yaml` by default and Redpanda Console is configured to read from this file path.
-
-In containerized environments, ensure that the configuration file is mounted to a directory accessible by the Redpanda Console container. When the file is mounted, you can specify its file path using the `-config.filepath` flag or the `CONFIG_FILEPATH` environment variable.
+== Environment variable mapping
 
-== Environment variables
+Configuration options can be set using environment variables. The key for the environment variable is auto-generated by converting the <<config-yaml, YAML equivalent>> to uppercase and adding an underscore for each indentation level.
 
-Configuration options can be configured using environment variables. The key for the environment
-variable is auto-generated by converting the YAML equivalent to uppercase and adding an underscore for each indentation level. For example:
+For example:
 
 [cols="1m,1m"]
 |===
@@ -46,19 +38,144 @@ For configuration properties that expect a list of values, use commas between ea
 KAFKA_BROKERS=redpanda-0:9092,redpanda-1:9092,redpanda-2:9092
 ----
 
-NOTE: You cannot use environment variables to configure object arrays, such as the configuration
-for Kafka Connect clusters. In this case, use a YAML file, and provide secrets using environment variables or command line arguments.
+NOTE: You cannot use environment variables to configure object arrays, such as the configuration for Kafka Connect clusters. In this case, use a YAML file, and provide secrets using environment variables or command line arguments.
+
+== Platform-specific configuration
+
+Redpanda Console can be deployed in several ways. The configuration method and file structure you use depends on your deployment scenario. Use the tabs on this page and throughout the docs to find the instructions and examples for your environment.
+
+- **Standalone (binary, Docker, or systemd):**
+  For users running Redpanda Console as a separate service, either on a VM, bare metal, or in a container (not managed by Kubernetes or the Redpanda Operator/Helm chart).
+- **Kubernetes embedded:**
+  For users running Redpanda Console as part of a Redpanda cluster managed by the Redpanda Operator or the Redpanda Helm chart.
+- **Kubernetes standalone:**
+  For users deploying Redpanda Console in Kubernetes using the dedicated Redpanda Console Helm chart (not as part of a Redpanda cluster).
+
+[tabs]
+======
+Standalone::
++
+--
+Use this method when deploying Redpanda Console as a standalone service (binary, Docker, or systemd).
+
+The recommended configuration source is a YAML file. You can specify the path to the configuration file by setting either the `-config.filepath` flag or the `CONFIG_FILEPATH` environment variable.
+
+In Linux package installations, this file is located in `/etc/redpanda/redpanda-console-config.yaml` by default and Redpanda Console is configured to read from this file path.
+
+In containerized environments, ensure that the configuration file is mounted to a directory accessible by the Redpanda Console container. When the file is mounted, you can specify its file path using the `-config.filepath` flag or the `CONFIG_FILEPATH` environment variable.
+
+--
+Kubernetes embedded::
++
+--
+
+Use this method when Redpanda Console is deployed as part of the Redpanda Helm chart or Redpanda Operator.
+
+NOTE: When Redpanda Console is embedded in the Redpanda deployment, the Kafka broker configuration is automatically set to connect to the Redpanda cluster in the same deployment.
+
+[tabs]
+====
+Operator::
++
+Configure Redpanda Console in the `console` section of your Redpanda custom resource:
++
+[,yaml]
+.`redpanda-cluster`.yaml
+----
+apiVersion: cluster.redpanda.com/v1alpha2
+kind: Redpanda
+metadata:
+  name: redpanda
+spec:
+  clusterSpec:
+    console:
+      enabled: true
+      console:
+        config:
+          #kafka:
+            #brokers: [] # Auto-configured to connect to this Redpanda cluster
+          server:
+            listenPort: 8080
+          # Add any other Redpanda Console configuration here
+----
++
+Apply the configuration:
++
+[,bash]
+----
+kubectl apply -f redpanda-cluster.yaml --namespace <namespace>
+----
+
+Helm::
++
+Configure Redpanda Console in the `console` section of your Redpanda Helm values file:
++
+[,yaml]
+.`redpanda-values.yaml`
+----
+console:
+  enabled: true
+  console:
+    config:
+      #kafka:
+        #brokers: [] # Auto-configured to connect to this Redpanda cluster
+      server:
+        listenPort: 8080
+      # Add any other Redpanda Console configuration here
+----
++
+Apply the configuration:
++
+[,bash]
+----
+helm upgrade --install redpanda redpanda/redpanda \
+  --namespace <namespace> \
+  --values redpanda-values.yaml
+----
+====
+--
+Kubernetes standalone::
++
+--
+
+Use this method when deploying Redpanda Console as a standalone service in Kubernetes using the dedicated Redpanda Console Helm chart.
 
-include::shared:partial$community-supported-kc.adoc[]
+When using the standalone Redpanda Console Helm chart, configure Redpanda Console through the `config` section of your values file:
+
+[,yaml]
+.`console-values.yaml`
+----
+config:
+  kafka:
+    brokers:
+      - redpanda-0.redpanda.svc.cluster.local:9092
+      - redpanda-1.redpanda.svc.cluster.local:9092
+  server:
+    listenPort: 8080
+  # Add any other Redpanda Console configuration here
+----
+
+Apply the configuration:
+
+[,bash]
+----
+helm upgrade --install console redpanda/console \
+  --namespace redpanda \
+  --values console-values.yaml
+----
+
+--
+======
 
 == Docker Compose example
 
 If you are using Docker Compose, you can mount the configuration file and set the environment variable in your `docker-compose.yml` file:
 
-```yaml
+[,yaml,subs="attributes+"]
+----
 console:
     container_name: redpanda-console
-    image: docker.redpanda.com/redpandadata/console:latest
+    image: docker.redpanda.com/redpandadata/console:{latest-console-tag}
     entrypoint: /bin/sh
     command: -c 'echo "$$CONSOLE_CONFIG_FILE" > /tmp/config.yml
     volumes:
@@ -70,8 +187,9 @@ console:
         # See https://docs.redpanda.com/current/console/config/connect-to-redpanda/
         kafka:
           brokers: ["redpanda-0:9092","redpanda-1:9092","redpanda-2:9092"]
-```
+----
 
+[[config-yaml]]
 == Complete configuration file example
 
 The following YAML file contains a complete list of all Redpanda Console configuration properties and their descriptions. All values are default values.