Repository navigation
operator: link cloud_storage_* field docs to the object storage page - #2001
Conversation
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.
✅ Snyk checks have passed. No issues have been found so far.
💻 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.
| // 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"` |
There was a problem hiding this comment.
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.
| // 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
…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.
The
cloud_storage_*field comments inRedpandaClusterSpec.configlink 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 andkubectl explainsend readers to a page without the property. This points the 29 links athttps://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_directoryalready resolves (broker properties page), andcloud_storage_reconciliation_interval_ms(2 links) is deprecated and has no heading on any docs page.Verification:
/streaming/current/reference/properties/object-storage-properties/), and each of the 29 anchor ids is present in the body (29 of 29)mainin exactly these 29 lines, each nowxref: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_dispatchofgenerate-crd.ymlwithtag=operator/v26.2.4, succeeded and opened docs PR 2256, since closed. It proves the generator path, not theclient_payload.tagpath 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_endpointto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpointhttps://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_api_endpoint_portto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint_porthttps://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_endpointto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_endpointhttps://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_portto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_porthttps://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_containerto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_containerhttps://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_managed_identity_idto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_managed_identity_idhttps://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_shared_keyto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_shared_keyhttps://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_storage_accountto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_storage_accounthttps://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_bucketto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_buckethttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_cache_check_intervalto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_check_intervalhttps://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_cache_sizeto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_sizehttps://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_credentials_sourceto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_credentials_sourcehttps://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_disable_tlsto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_disable_tlshttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_readto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_readhttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_writeto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_writehttps://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_enabledto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enabledhttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_initial_backoff_msto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_initial_backoff_mshttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_manifest_upload_timeout_msto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_manifest_upload_timeout_mshttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_max_connection_idle_time_msto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connection_idle_time_mshttps://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_max_connectionsto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connectionshttps://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_regionto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_regionhttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_max_upload_interval_secto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_max_upload_interval_sechttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_upload_timeout_msto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_upload_timeout_mshttps://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_trust_fileto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_trust_filehttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_d_coeffto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_d_coeffhttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_max_sharesto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_max_shareshttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_min_sharesto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_min_shareshttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_p_coeffto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_p_coeffhttps://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_update_interval_msto
https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_update_interval_ms