Skip to content

auto-docs: Update CRD reference doc for release #1141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2025
Merged

auto-docs: Update CRD reference doc for release #1141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 16 additions & 30 deletions modules/reference/pages/k-console-helm-spec.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

:description: Find the default values and descriptions of settings in the Redpanda Console Helm chart.

image:https://img.shields.io/badge/Version-0.7.31-informational?style=flat-square[Version:
0.7.31]
image:https://img.shields.io/badge/Version-3.1.0-informational?style=flat-square[Version:
3.1.0]
image:https://img.shields.io/badge/Type-application-informational?style=flat-square[Type:
application]
image:https://img.shields.io/badge/AppVersion-v2.8.0-informational?style=flat-square[AppVersion:
v2.8.0]
image:https://img.shields.io/badge/AppVersion-v3.1.0-informational?style=flat-square[AppVersion:
v3.1.0]

This page describes the official Redpanda Console Helm Chart. In
particular, this page describes the contents of the chart’s
Expand Down Expand Up @@ -78,11 +78,7 @@ does not communicate with Kubernetes API.

*Default:* `{}`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=configmap.create++[configmap.create]

*Default:* `true`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=console.config++[console.config]
=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=config++[config]

Settings for the `Config.yaml` (required). For a reference of
configuration settings, see the
Expand All @@ -91,20 +87,13 @@ Console documentation].

*Default:* `{}`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=deployment.create++[deployment.create]
=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=configmap.create++[configmap.create]

*Default:* `true`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=enterprise++[enterprise]

Settings for license key, as an alternative to secret.enterprise when a
license secret is available

*Default:*
=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=deployment.create++[deployment.create]

....
{"licenseSecretRef":{"key":"","name":""}}
....
*Default:* `true`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=extraContainers++[extraContainers]

Expand Down Expand Up @@ -186,10 +175,6 @@ https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-regi

*Default:* `{}`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=ingress.className++[ingress.className]

*Default:* `nil`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=ingress.enabled++[ingress.enabled]

*Default:* `false`
Expand Down Expand Up @@ -256,6 +241,10 @@ Override `console.name` template.

*Default:* `99`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=podSecurityContext.fsGroupChangePolicy++[podSecurityContext.fsGroupChangePolicy]

*Default:* `"Always"`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=podSecurityContext.runAsUser++[podSecurityContext.runAsUser]

*Default:* `99`
Expand Down Expand Up @@ -310,7 +299,7 @@ secretMounts to mount files such as Certificates from Secrets.
*Default:*

....
{"create":true,"enterprise":{},"kafka":{},"login":{"github":{},"google":{},"jwtSecret":"","oidc":{},"okta":{}},"redpanda":{"adminApi":{}}}
{"authentication":{"jwtSigningKey":"","oidc":{}},"create":true,"kafka":{},"license":"","redpanda":{"adminApi":{}},"schemaRegistry":{},"serde":{}}
....

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=secret.kafka++[secret.kafka]
Expand All @@ -333,18 +322,15 @@ mount for the Redpanda Console container.

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=service.annotations++[service.annotations]

Override the value in `console.config.server.listenPort` if not `nil`
targetPort:

*Default:* `{}`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=service.port++[service.port]

*Default:* `8080`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=service.targetPort++[service.targetPort]

Override the value in `console.config.server.listenPort` if not `nil`

*Default:* `nil`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/console?modal=values&path=service.type++[service.type]

*Default:* `"ClusterIP"`
Expand Down
Loading