Skip to content

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

Merged
JakeSCahill merged 2 commits into
mainfrom
crd-cloud-storage-doc-links
Oct 26, 2026
Merged

JakeSCahill merged 2 commits into
mainfrom
crd-cloud-storage-doc-links

Conversation

@JakeSCahill

@JakeSCahill JakeSCahill commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

The cloud_storage_* field comments in RedpandaClusterSpec.config link to anchors on the wrong page. The anchors exist only on the object storage properties page, but the links point at the cluster and tunable properties pages, so the CRD reference and kubectl explain send readers to a page without the property. This points the 29 links at https://docs.redpanda.com/current/reference/properties/object-storage-properties/#<property>. Link-only change: no other comment text, fields, schema or defaults change. The CRD manifest and the crd-docs testdata are regenerated (controller-gen 0.20.1 and crd-ref-docs 0.3.0, the pinned versions, reproduce them exactly).

Left alone: cloud_storage_cache_directory already resolves (broker properties page), and cloud_storage_reconciliation_interval_ms (2 links) is deprecated and has no heading on any docs page.

Verification:

  • the new page fetched once: HTTP 200 (canonical /streaming/current/reference/properties/object-storage-properties/), and each of the 29 anchor ids is present in the body (29 of 29)
  • the docs CRD reference regenerated from this branch with docs-extensions-and-macros 414 differs from a regeneration off main in exactly these 29 lines, each now xref:reference:properties/object-storage-properties.adoc#<property>[<property>]

The xref output depends on docs-extensions-and-macros PR 414, which is still open. Without it, the docs page shows these links as absolute docs.redpanda.com URLs.

A live receiver run happened: docs run 39766213713, a workflow_dispatch of generate-crd.yml with tag=operator/v26.2.4, succeeded and opened docs PR 2256, since closed. It proves the generator path, not the client_payload.tag path that a release dispatch uses.

Backport: #2005 (release/v26.2.x).

Rewritten links (old to new)
  • https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_api_endpoint
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint
  • https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_api_endpoint_port
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint_port
  • https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_endpoint
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_endpoint
  • https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_port
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_port
  • https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_container
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_container
  • https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_managed_identity_id
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_managed_identity_id
  • https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_shared_key
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_shared_key
  • https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_storage_account
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_storage_account
  • https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_bucket
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_bucket
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_cache_check_interval
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_check_interval
  • https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_cache_size
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_size
  • https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_credentials_source
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_credentials_source
  • https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_disable_tls
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_disable_tls
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_read
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_read
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_write
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_write
  • https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_enabled
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enabled
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_initial_backoff_ms
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_initial_backoff_ms
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_manifest_upload_timeout_ms
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_manifest_upload_timeout_ms
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_max_connection_idle_time_ms
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connection_idle_time_ms
  • https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_max_connections
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connections
  • https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_region
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_region
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_max_upload_interval_sec
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_max_upload_interval_sec
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_upload_timeout_ms
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_upload_timeout_ms
  • https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_trust_file
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_trust_file
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_d_coeff
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_d_coeff
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_max_shares
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_max_shares
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_min_shares
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_min_shares
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_p_coeff
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_p_coeff
  • https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_update_interval_ms
    to https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_update_interval_ms

The cloud_storage_* field comments in RedpandaClusterSpec.config link to
the cluster and tunable properties pages with anchors that only exist on
the object storage properties page, so the CRD reference and kubectl
explain send readers to a page without the property. Point the 29 links
at the page that documents them. Link-only change; the CRD manifest and
the crd-docs testdata are regenerated.

cloud_storage_reconciliation_interval_ms is left alone: the property is
deprecated and has no heading on any docs page.
@secpanda

secpanda commented Oct 22, 2026 •

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

The thread-per-core section's anchor is tpc, not thread-per-core-model, so
the link landed at the top of the page and the docs link converter leaves
it as a raw URL. Comment-only change; the CRD bases and the crd-docs test
fixture carry the same text.
@JakeSCahill
JakeSCahill marked this pull request as ready for review October 23, 2026 13:04
Comment on lines +1159 to 1160
// 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"`

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

@JakeSCahill
JakeSCahill merged commit 156e75f into main Oct 26, 2026
16 checks passed
JakeSCahill added a commit that referenced this pull request Oct 26, 2026
…ject storage page (#2001) (#2005)

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

Backport of #2001. The cloud_storage_* field comments in
RedpandaClusterSpec.config linked to the cluster and tunable properties
pages with anchors that only exist on the object storage properties
page. Point the 29 links there and regenerate the CRD manifest and the
crd-docs testdata.

* operator: link the cores field to the architecture page's tpc anchor

The thread-per-core section's anchor is tpc, not thread-per-core-model, so
the link landed at the top of the page and the docs link converter leaves
it as a raw URL. Comment-only change; the CRD bases and the crd-docs test
fixture carry the same text.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants