Skip to content

operator: link cloud_storage_* field docs to the object storage page #2001

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
JakeSCahill merged 2 commits into from
Oct 26, 2026
Merged

operator: link cloud_storage_* field docs to the object storage page #2001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4d20de
operator: link cloud_storage_* field docs to the object storage page
JakeSCahill Oct 22, 2026
17f28cf
operator: link the cores field to the architecture page's tpc anchor
JakeSCahill Oct 22, 2026
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
7 changes: 7 additions & 0 deletions .changes/unreleased/operator-Fixed-20261022-153000.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
project: operator
kind: Fixed
body: |-
The `cloud_storage_*` field descriptions in `RedpandaClusterSpec.config` link to the Object Storage Properties page, where those properties are documented

They linked to the cluster and tunable properties pages with anchors that do not exist there, so the CRD reference and `kubectl explain` sent readers to a page without the property. Link-only change: no field, schema or default changes.
time: 2026-10-22T15:30:00.000000+01:00
60 changes: 30 additions & 30 deletions operator/api/redpanda/v1alpha2/redpanda_clusterspec_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,67 +660,67 @@ type Tiered struct {

// TieredConfig configures Tiered Storage, which requires an Enterprise license configured in `enterprise.licenseKey` or `enterprise.licenseSecretRef`.TieredConfig is a top-level field of the Helm values.
type TieredConfig struct {
// Enables Tiered Storage, if a license key is provided. See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_enabled.
// Enables Tiered Storage, if a license key is provided. See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enabled.
CloudStorageEnabled *apiutil.JSONBoolean `json:"cloud_storage_enabled,omitempty"`
// See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_api_endpoint.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint.
CloudStorageAPIEndpoint *string `json:"cloud_storage_api_endpoint,omitempty"`
// See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_api_endpoint_port.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint_port.
CloudStorageAPIEndpointPort *int `json:"cloud_storage_api_endpoint_port,omitempty"`
// See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_bucket.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_bucket.
CloudStorageBucket *string `json:"cloud_storage_bucket,omitempty"`
// See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_container.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_container.
CloudStorageAzureContainer *string `json:"cloud_storage_azure_container,omitempty"`
// See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_managed_identity_id.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_managed_identity_id.
CloudStorageAzureManagedIdentityID *string `json:"cloud_storage_azure_managed_identity_id,omitempty"`
// See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_storage_account.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_storage_account.
CloudStorageAzureStorageAccount *string `json:"cloud_storage_azure_storage_account,omitempty"`
// See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_shared_key.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_shared_key.
CloudStorageAzureSharedKey *string `json:"cloud_storage_azure_shared_key,omitempty"`
// See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_endpoint.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_endpoint.
CloudStorageAzureADLSEndpoint *string `json:"cloud_storage_azure_adls_endpoint,omitempty"`
// See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_port.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_port.
CloudStorageAzureADLSPort *int `json:"cloud_storage_azure_adls_port,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_cache_check_interval.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_check_interval.
CloudStorageCacheCheckInterval *int `json:"cloud_storage_cache_check_interval,omitempty"`
// See https://docs.redpanda.com/current/reference/node-properties/#cloud_storage_cache_directory.
CloudStorageCacheDirectory *string `json:"cloud_storage_cache_directory,omitempty"`
// See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_cache_size.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_size.
CloudStorageCacheSize *string `json:"cloud_storage_cache_size,omitempty"`
// See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_credentials_source.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_credentials_source.
CloudStorageCredentialsSource *string `json:"cloud_storage_credentials_source,omitempty"`
// See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_disable_tls.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_disable_tls.
CloudStorageDisableTLS *bool `json:"cloud_storage_disable_tls,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_read.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_read.
CloudStorageEnableRemoteRead *bool `json:"cloud_storage_enable_remote_read,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_write.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_write.
CloudStorageEnableRemoteWrite *bool `json:"cloud_storage_enable_remote_write,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_initial_backoff_ms.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_initial_backoff_ms.
CloudStorageInitialBackoffMs *int `json:"cloud_storage_initial_backoff_ms,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_manifest_upload_timeout_ms.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_manifest_upload_timeout_ms.
CloudStorageManifestUploadTimeoutMs *int `json:"cloud_storage_manifest_upload_timeout_ms,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_max_connection_idle_time_ms.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connection_idle_time_ms.
CloudStorageMaxConnectionIdleTimeMs *int `json:"cloud_storage_max_connection_idle_time_ms,omitempty"`
// See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_max_connections.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connections.
CloudStorageMaxConnections *int `json:"cloud_storage_max_connections,omitempty"`
// Deprecated: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_reconciliation_interval_ms.
CloudStorageReconciliationIntervalMs *int `json:"cloud_storage_reconciliation_interval_ms,omitempty"`
// See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_region.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_region.
CloudStorageRegion *string `json:"cloud_storage_region,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_max_upload_interval_sec.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_max_upload_interval_sec.
CloudStorageSegmentMaxUploadIntervalSec *int `json:"cloud_storage_segment_max_upload_interval_sec,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_upload_timeout_ms.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_upload_timeout_ms.
CloudStorageSegmentUploadTimeoutMs *int `json:"cloud_storage_segment_upload_timeout_ms,omitempty"`
// See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_trust_file.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_trust_file.
CloudStorageTrustFile *string `json:"cloud_storage_trust_file,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_d_coeff.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_d_coeff.
CloudStorageUploadCtrlDCoeff *int `json:"cloud_storage_upload_ctrl_d_coeff,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_max_shares.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_max_shares.
CloudStorageUploadCtrlMaxShares *int `json:"cloud_storage_upload_ctrl_max_shares,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_min_shares.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_min_shares.
CloudStorageUploadCtrlMinShares *int `json:"cloud_storage_upload_ctrl_min_shares,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_p_coeff.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_p_coeff.
CloudStorageUploadCtrlPCoeff *int `json:"cloud_storage_upload_ctrl_p_coeff,omitempty"`
// See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_update_interval_ms.
// See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_update_interval_ms.
CloudStorageUploadCtrlUpdateIntervalMs *int `json:"cloud_storage_upload_ctrl_update_interval_ms,omitempty"`
}

Expand Down Expand Up @@ -1156,7 +1156,7 @@ type RPControllers struct {

// CPU configures CPU resources for containers. See https://docs.redpanda.com/current/manage/kubernetes/manage-resources/.
type CPU struct {
// Specifies the number of CPU cores available to the application. Redpanda makes use of a thread per core model. For details, see https://docs.redpanda.com/current/get-started/architecture/#thread-per-core-model. For this reason, Redpanda should only be given full cores. Note: You can increase cores, but decreasing cores is not currently supported. See the GitHub issue:https://github.com/redpanda-data/redpanda/issues/350. This setting is equivalent to `--smp`, `resources.requests.cpu`, and `resources.limits.cpu`. For production, use `4` or greater.
// Specifies the number of CPU cores available to the application. Redpanda makes use of a thread per core model. For details, see https://docs.redpanda.com/current/get-started/architecture/#tpc. For this reason, Redpanda should only be given full cores. Note: You can increase cores, but decreasing cores is not currently supported. See the GitHub issue:https://github.com/redpanda-data/redpanda/issues/350. This setting is equivalent to `--smp`, `resources.requests.cpu`, and `resources.limits.cpu`. For production, use `4` or greater.
Cores *resource.Quantity `json:"cores,omitempty"`
Comment on lines +1159 to 1160

@claude claude Bot Oct 23, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lint flags --smp as unexpanded jargon, and the rest of this comment carries two more problems that the CRD reference and kubectl explain publish verbatim: it says decreasing cores "is not currently supported", which contradicts the description of the same cores key in charts/redpanda/chart/values.yaml:417 ("decreasing cores is supported only from 24.3 Redpanda version"), and issue:https://... has no space after the colon, so the link renders mangled. The rewrite says what --smp controls instead of naming it bare, aligns the version claim with the chart using terminology.md's "or later" form, drops should (do-not-use list), and drops the issue 350 link, which no longer describes a current limitation.

Suggested change
// Specifies the number of CPU cores available to the application. Redpanda makes use of a thread per core model. For details, see https://docs.redpanda.com/current/get-started/architecture/#tpc. For this reason, Redpanda should only be given full cores. Note: You can increase cores, but decreasing cores is not currently supported. See the GitHub issue:https://github.com/redpanda-data/redpanda/issues/350. This setting is equivalent to `--smp`, `resources.requests.cpu`, and `resources.limits.cpu`. For production, use `4` or greater.
Cores *resource.Quantity `json:"cores,omitempty"`
// Specifies the number of CPU cores available to the application. Redpanda uses a thread per core model, so give it only full cores. For details, see https://docs.redpanda.com/current/get-started/architecture/#tpc. You can increase cores at any time; decreasing cores requires Redpanda 24.3 or later. This setting is equivalent to the `--smp` flag, which sets the core count on the Redpanda process, and to `resources.requests.cpu` and `resources.limits.cpu`. For production, use `4` or greater.
Cores *resource.Quantity `json:"cores,omitempty"`

doc-strings-review:fp=9d65b2d51d72dbb1

// Specifies whether Redpanda assumes it has all of the provisioned CPU. This should be `true` unless the container has CPU affinity. Equivalent to: `--idle-poll-time-us 0`, `--thread-affinity 0`, and `--poll-aio 0`. If the value of full cores in `resources.cpu.cores` is less than `1`, this setting is set to `true`.
Overprovisioned *bool `json:"overprovisioned,omitempty"`
Expand Down
Loading
Loading