Skip to content

Commit

Permalink
auto-docs: Update Helm spec
Browse files Browse the repository at this point in the history
  • Loading branch information
vbotbuildovich committed Jan 22, 2025
1 parent 8f93439 commit 08b2b12
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 49 deletions.
2 changes: 1 addition & 1 deletion modules/reference/pages/k-connector-helm-spec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ v1.11.0]

== Source Code

* https://github.com/redpanda-data/helm-charts
* https://github.com/redpanda-data/redpanda-operator/tree/main/charts/connectors

== Requirements

Expand Down
2 changes: 1 addition & 1 deletion modules/reference/pages/k-console-helm-spec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ v1.11.0]

== Source Code

* https://github.com/redpanda-data/helm-charts
* https://github.com/redpanda-data/redpanda-operator/tree/main/charts/console

== Requirements

Expand Down
44 changes: 10 additions & 34 deletions modules/reference/pages/k-operator-helm-spec.adoc
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 Operator Helm chart.

image:https://img.shields.io/badge/Version-0.4.38-informational?style=flat-square[Version:
0.4.38]
image:https://img.shields.io/badge/Version-0.4.39-informational?style=flat-square[Version:
0.4.39]
image:https://img.shields.io/badge/Type-application-informational?style=flat-square[Type:
application]
image:https://img.shields.io/badge/AppVersion-v2.3.5--24.3.2-informational?style=flat-square[AppVersion:
v2.3.5-24.3.2]
image:https://img.shields.io/badge/AppVersion-v2.3.6--24.3.3-informational?style=flat-square[AppVersion:
v2.3.6-24.3.3]

This page describes the official Redpanda Operator Helm Chart. In
particular, this page describes the contents of the chart’s
Expand All @@ -28,7 +28,7 @@ v1.11.0]

== Source Code

* https://github.com/redpanda-data/helm-charts
* https://github.com/redpanda-data/redpanda-operator/tree/main/charts/operator

== Requirements

Expand All @@ -55,7 +55,11 @@ controller, see
https://docs.redpanda.com/current/manage/kubernetes/k-decommission-brokers/#Automated[Use
the Decommission controller].

*Default:* `[]`
*Default:*

....
["--configurator-tag=v2.3.6-24.3.3"]
....

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

Expand Down Expand Up @@ -164,34 +168,6 @@ Sets the port for the webhook server to listen on.

*Default:* `9443`

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

Configuration for the Redpanda configurator, a component for managing
Redpanda configuration.

*Default:*

....
{"pullPolicy":"IfNotPresent","repository":"docker.redpanda.com/redpandadata/configurator"}
....

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

Sets the `pullPolicy` for the Redpanda configurator image.

*Default:* `"IfNotPresent"`

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

Sets the repository in which the Redpanda configurator image is
available.

*Default:*

....
"docker.redpanda.com/redpandadata/configurator"
....

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

Overrides the `redpanda-operator.fullname` template.
Expand Down
58 changes: 45 additions & 13 deletions modules/reference/pages/k-redpanda-helm-spec.adoc
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 Helm chart.

image:https://img.shields.io/badge/Version-5.9.18-informational?style=flat-square[Version:
5.9.18]
image:https://img.shields.io/badge/Version-5.9.19-informational?style=flat-square[Version:
5.9.19]
image:https://img.shields.io/badge/Type-application-informational?style=flat-square[Type:
application]
image:https://img.shields.io/badge/AppVersion-v24.3.2-informational?style=flat-square[AppVersion:
v24.3.2]
image:https://img.shields.io/badge/AppVersion-v24.3.3-informational?style=flat-square[AppVersion:
v24.3.3]

This page describes the official Redpanda Helm Chart. In particular,
this page describes the contents of the chart’s
Expand All @@ -28,7 +28,7 @@ v1.11.0]

== Source Code

* https://github.com/redpanda-data/helm-charts
* https://github.com/redpanda-data/redpanda-operator/tree/main/charts/redpanda

== Requirements

Expand Down Expand Up @@ -763,12 +763,44 @@ ClusterRoles.

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

Pod resource management. This section simplifies resource allocation by
providing a single location where resources are defined. Helm sets these
resource values within the `statefulset.yaml` and `configmap.yaml`
templates. The default values are for a development environment.
Production-level values and other considerations are documented, where
those values are different from the default. For details, see the
Pod resource management. This section simplifies resource allocation for
the redpanda container by providing a single location where resources
are defined.

Resources may be specified by either setting `resources.cpu` and
`resources.memory` (the default) or by setting `resources.requests` and
`resources.limits`.

For details on `resources.cpu` and `resources.memory`, see their
respective documentation below.

When `resources.limits` and `resources.requests` are set, the redpanda
container’s resources will be set to exactly the provided values. This
allows users to granularly control limits and requests to best suit
their use case. For example: `resources.requests.cpu` may be set without
setting `resources.limits.cpu` to avoid the potential of CPU throttling.

Redpanda’s resource related CLI flags will then be calculated as
follows: *
`--smp max(1, floor(coalesce(resources.requests.cpu, resources.limits.cpu)))`
*
`--memory coalesce(resources.requests.memory, resources.limits.memory) * 90%`
* `--reserve-memory 0` *
`--overprovisioned coalesce(resources.requests.cpu, resources.limits.cpu) < 1000m`

If neither a request nor a limit is provided for cpu or memory, the
corresponding flag will be omitted. As a result, setting
`resources.limits` and `resources.requests` to `{}` will result in
redpanda being run without `--smp` or `--memory`. (This is not
recommended).

If the computed CLI flags are undesirable, they may be overridden by
specifying the desired value through
`statefulset.additionalRedpandaCmdFlags`.

The default values are for a development environment. Production-level
values and other considerations are documented, where those values are
different from the default. For details, see the
https://docs.redpanda.com/docs/manage/kubernetes/manage-resources/[Pod
resources documentation].

Expand Down Expand Up @@ -1109,7 +1141,7 @@ PodSpec. See link:#merging-semantics[Merge Semantics] for details.
*Default:*

....
{"containers":[{"env":[],"name":"redpanda","securityContext":{}}],"securityContext":{}}
{"containers":[],"securityContext":{}}
....

=== link:++https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=statefulset.priorityClassName++[statefulset.priorityClassName]
Expand Down Expand Up @@ -1206,7 +1238,7 @@ https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#sta

=== link:++https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=statefulset.sideCars.controllers.image.tag++[statefulset.sideCars.controllers.image.tag]

*Default:* `"v2.3.5-24.3.2"`
*Default:* `"v2.3.6-24.3.3"`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=statefulset.sideCars.controllers.metricsAddress++[statefulset.sideCars.controllers.metricsAddress]

Expand Down

0 comments on commit 08b2b12

Please sign in to comment.