diff --git a/.changes/unreleased/operator-Fixed-20261022-153000.yaml b/.changes/unreleased/operator-Fixed-20261022-153000.yaml new file mode 100644 index 000000000..b6d314d94 --- /dev/null +++ b/.changes/unreleased/operator-Fixed-20261022-153000.yaml @@ -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 diff --git a/operator/api/redpanda/v1alpha2/redpanda_clusterspec_types.go b/operator/api/redpanda/v1alpha2/redpanda_clusterspec_types.go index 65933c15b..75d982afb 100644 --- a/operator/api/redpanda/v1alpha2/redpanda_clusterspec_types.go +++ b/operator/api/redpanda/v1alpha2/redpanda_clusterspec_types.go @@ -655,67 +655,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"` } @@ -1147,7 +1147,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"` // 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"` diff --git a/operator/api/redpanda/v1alpha2/testdata/crd-docs.adoc b/operator/api/redpanda/v1alpha2/testdata/crd-docs.adoc index ac8e484fd..8c983c51a 100644 --- a/operator/api/redpanda/v1alpha2/testdata/crd-docs.adoc +++ b/operator/api/redpanda/v1alpha2/testdata/crd-docs.adoc @@ -508,7 +508,7 @@ CPU configures CPU resources for containers. See https://docs.redpanda.com/curre [cols="20a,50a,15a,15a", options="header"] |=== | Field | Description | Default | Validation -| *`cores`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api[$$Quantity$$]__ | 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. + | | +| *`cores`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api[$$Quantity$$]__ | 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. + | | | *`overprovisioned`* __boolean__ | 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`. + | | |=== @@ -5893,37 +5893,37 @@ TieredConfig configures Tiered Storage, which requires an Enterprise license con [cols="20a,50a,15a,15a", options="header"] |=== | Field | Description | Default | Validation -| *`cloud_storage_enabled`* __xref:{anchor_prefix}-github-com-redpanda-data-redpanda-operator-operator-api-apiutil-jsonboolean[$$JSONBoolean$$]__ | Enables Tiered Storage, if a license key is provided. See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_enabled. + | | -| *`cloud_storage_api_endpoint`* __string__ | See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_api_endpoint. + | | -| *`cloud_storage_api_endpoint_port`* __integer__ | See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_api_endpoint_port. + | | -| *`cloud_storage_bucket`* __string__ | See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_bucket. + | | -| *`cloud_storage_azure_container`* __string__ | See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_container. + | | -| *`cloud_storage_azure_managed_identity_id`* __string__ | See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_managed_identity_id. + | | -| *`cloud_storage_azure_storage_account`* __string__ | See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_storage_account. + | | -| *`cloud_storage_azure_shared_key`* __string__ | See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_shared_key. + | | -| *`cloud_storage_azure_adls_endpoint`* __string__ | See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_endpoint. + | | -| *`cloud_storage_azure_adls_port`* __integer__ | See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_port. + | | -| *`cloud_storage_cache_check_interval`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_cache_check_interval. + | | +| *`cloud_storage_enabled`* __xref:{anchor_prefix}-github-com-redpanda-data-redpanda-operator-operator-api-apiutil-jsonboolean[$$JSONBoolean$$]__ | Enables Tiered Storage, if a license key is provided. See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enabled. + | | +| *`cloud_storage_api_endpoint`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint. + | | +| *`cloud_storage_api_endpoint_port`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint_port. + | | +| *`cloud_storage_bucket`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_bucket. + | | +| *`cloud_storage_azure_container`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_container. + | | +| *`cloud_storage_azure_managed_identity_id`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_managed_identity_id. + | | +| *`cloud_storage_azure_storage_account`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_storage_account. + | | +| *`cloud_storage_azure_shared_key`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_shared_key. + | | +| *`cloud_storage_azure_adls_endpoint`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_endpoint. + | | +| *`cloud_storage_azure_adls_port`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_port. + | | +| *`cloud_storage_cache_check_interval`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_check_interval. + | | | *`cloud_storage_cache_directory`* __string__ | See https://docs.redpanda.com/current/reference/node-properties/#cloud_storage_cache_directory. + | | -| *`cloud_storage_cache_size`* __string__ | See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_cache_size. + | | -| *`cloud_storage_credentials_source`* __string__ | See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_credentials_source. + | | -| *`cloud_storage_disable_tls`* __boolean__ | See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_disable_tls. + | | -| *`cloud_storage_enable_remote_read`* __boolean__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_read. + | | -| *`cloud_storage_enable_remote_write`* __boolean__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_write. + | | -| *`cloud_storage_initial_backoff_ms`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_initial_backoff_ms. + | | -| *`cloud_storage_manifest_upload_timeout_ms`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_manifest_upload_timeout_ms. + | | -| *`cloud_storage_max_connection_idle_time_ms`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_max_connection_idle_time_ms. + | | -| *`cloud_storage_max_connections`* __integer__ | See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_max_connections. + | | +| *`cloud_storage_cache_size`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_size. + | | +| *`cloud_storage_credentials_source`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_credentials_source. + | | +| *`cloud_storage_disable_tls`* __boolean__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_disable_tls. + | | +| *`cloud_storage_enable_remote_read`* __boolean__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_read. + | | +| *`cloud_storage_enable_remote_write`* __boolean__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_write. + | | +| *`cloud_storage_initial_backoff_ms`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_initial_backoff_ms. + | | +| *`cloud_storage_manifest_upload_timeout_ms`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_manifest_upload_timeout_ms. + | | +| *`cloud_storage_max_connection_idle_time_ms`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connection_idle_time_ms. + | | +| *`cloud_storage_max_connections`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connections. + | | | *`cloud_storage_reconciliation_interval_ms`* __integer__ | Deprecated: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_reconciliation_interval_ms. + | | -| *`cloud_storage_region`* __string__ | See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_region. + | | -| *`cloud_storage_segment_max_upload_interval_sec`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_max_upload_interval_sec. + | | -| *`cloud_storage_segment_upload_timeout_ms`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_upload_timeout_ms. + | | -| *`cloud_storage_trust_file`* __string__ | See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_trust_file. + | | -| *`cloud_storage_upload_ctrl_d_coeff`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_d_coeff. + | | -| *`cloud_storage_upload_ctrl_max_shares`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_max_shares. + | | -| *`cloud_storage_upload_ctrl_min_shares`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_min_shares. + | | -| *`cloud_storage_upload_ctrl_p_coeff`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_p_coeff. + | | -| *`cloud_storage_upload_ctrl_update_interval_ms`* __integer__ | See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_update_interval_ms. + | | +| *`cloud_storage_region`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_region. + | | +| *`cloud_storage_segment_max_upload_interval_sec`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_max_upload_interval_sec. + | | +| *`cloud_storage_segment_upload_timeout_ms`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_upload_timeout_ms. + | | +| *`cloud_storage_trust_file`* __string__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_trust_file. + | | +| *`cloud_storage_upload_ctrl_d_coeff`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_d_coeff. + | | +| *`cloud_storage_upload_ctrl_max_shares`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_max_shares. + | | +| *`cloud_storage_upload_ctrl_min_shares`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_min_shares. + | | +| *`cloud_storage_upload_ctrl_p_coeff`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_p_coeff. + | | +| *`cloud_storage_upload_ctrl_update_interval_ms`* __integer__ | See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_update_interval_ms. + | | |=== diff --git a/operator/config/crd/bases/cluster.redpanda.com_redpandabrokerpools.yaml b/operator/config/crd/bases/cluster.redpanda.com_redpandabrokerpools.yaml index 8efa54829..5cfb35e79 100644 --- a/operator/config/crd/bases/cluster.redpanda.com_redpandabrokerpools.yaml +++ b/operator/config/crd/bases/cluster.redpanda.com_redpandabrokerpools.yaml @@ -9633,7 +9633,7 @@ spec: - type: string description: '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. + 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. diff --git a/operator/config/crd/bases/cluster.redpanda.com_redpandas.yaml b/operator/config/crd/bases/cluster.redpanda.com_redpandas.yaml index 380de484a..c803294f1 100644 --- a/operator/config/crd/bases/cluster.redpanda.com_redpandas.yaml +++ b/operator/config/crd/bases/cluster.redpanda.com_redpandas.yaml @@ -22628,7 +22628,7 @@ spec: - type: string description: '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. + 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. @@ -33457,98 +33457,98 @@ spec: or `enterprised.licenseSecretRef`. properties: cloud_storage_api_endpoint: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_api_endpoint. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint. type: string cloud_storage_api_endpoint_port: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_api_endpoint_port. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint_port. type: integer cloud_storage_azure_adls_endpoint: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_endpoint. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_endpoint. type: string cloud_storage_azure_adls_port: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_port. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_port. type: integer cloud_storage_azure_container: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_container. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_container. type: string cloud_storage_azure_managed_identity_id: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_managed_identity_id. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_managed_identity_id. type: string cloud_storage_azure_shared_key: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_shared_key. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_shared_key. type: string cloud_storage_azure_storage_account: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_storage_account. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_storage_account. type: string cloud_storage_bucket: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_bucket. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_bucket. type: string cloud_storage_cache_check_interval: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_cache_check_interval. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_check_interval. type: integer cloud_storage_cache_directory: description: See https://docs.redpanda.com/current/reference/node-properties/#cloud_storage_cache_directory. type: string cloud_storage_cache_size: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_cache_size. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_size. type: string cloud_storage_credentials_source: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_credentials_source. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_credentials_source. type: string cloud_storage_disable_tls: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_disable_tls. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_disable_tls. type: boolean cloud_storage_enable_remote_read: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_read. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_read. type: boolean cloud_storage_enable_remote_write: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_write. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_write. type: boolean cloud_storage_enabled: description: Enables Tiered Storage, if a license - key is provided. See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_enabled. + key is provided. See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enabled. x-kubernetes-preserve-unknown-fields: true cloud_storage_initial_backoff_ms: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_initial_backoff_ms. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_initial_backoff_ms. type: integer cloud_storage_manifest_upload_timeout_ms: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_manifest_upload_timeout_ms. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_manifest_upload_timeout_ms. type: integer cloud_storage_max_connection_idle_time_ms: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_max_connection_idle_time_ms. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connection_idle_time_ms. type: integer cloud_storage_max_connections: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_max_connections. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connections. type: integer cloud_storage_reconciliation_interval_ms: description: 'Deprecated: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_reconciliation_interval_ms.' type: integer cloud_storage_region: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_region. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_region. type: string cloud_storage_segment_max_upload_interval_sec: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_max_upload_interval_sec. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_max_upload_interval_sec. type: integer cloud_storage_segment_upload_timeout_ms: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_upload_timeout_ms. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_upload_timeout_ms. type: integer cloud_storage_trust_file: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_trust_file. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_trust_file. type: string cloud_storage_upload_ctrl_d_coeff: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_d_coeff. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_d_coeff. type: integer cloud_storage_upload_ctrl_max_shares: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_max_shares. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_max_shares. type: integer cloud_storage_upload_ctrl_min_shares: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_min_shares. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_min_shares. type: integer cloud_storage_upload_ctrl_p_coeff: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_p_coeff. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_p_coeff. type: integer cloud_storage_upload_ctrl_update_interval_ms: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_update_interval_ms. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_update_interval_ms. type: integer type: object credentialsSecretRef: @@ -56759,7 +56759,7 @@ spec: - type: string description: '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. + 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. @@ -67588,98 +67588,98 @@ spec: or `enterprised.licenseSecretRef`. properties: cloud_storage_api_endpoint: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_api_endpoint. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint. type: string cloud_storage_api_endpoint_port: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_api_endpoint_port. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_api_endpoint_port. type: integer cloud_storage_azure_adls_endpoint: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_endpoint. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_endpoint. type: string cloud_storage_azure_adls_port: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_adls_port. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_adls_port. type: integer cloud_storage_azure_container: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_container. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_container. type: string cloud_storage_azure_managed_identity_id: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_managed_identity_id. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_managed_identity_id. type: string cloud_storage_azure_shared_key: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_shared_key. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_shared_key. type: string cloud_storage_azure_storage_account: - description: See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_azure_storage_account. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_azure_storage_account. type: string cloud_storage_bucket: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_bucket. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_bucket. type: string cloud_storage_cache_check_interval: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_cache_check_interval. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_check_interval. type: integer cloud_storage_cache_directory: description: See https://docs.redpanda.com/current/reference/node-properties/#cloud_storage_cache_directory. type: string cloud_storage_cache_size: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_cache_size. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_cache_size. type: string cloud_storage_credentials_source: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_credentials_source. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_credentials_source. type: string cloud_storage_disable_tls: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_disable_tls. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_disable_tls. type: boolean cloud_storage_enable_remote_read: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_read. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_read. type: boolean cloud_storage_enable_remote_write: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_write. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enable_remote_write. type: boolean cloud_storage_enabled: description: Enables Tiered Storage, if a license - key is provided. See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_enabled. + key is provided. See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_enabled. x-kubernetes-preserve-unknown-fields: true cloud_storage_initial_backoff_ms: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_initial_backoff_ms. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_initial_backoff_ms. type: integer cloud_storage_manifest_upload_timeout_ms: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_manifest_upload_timeout_ms. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_manifest_upload_timeout_ms. type: integer cloud_storage_max_connection_idle_time_ms: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_max_connection_idle_time_ms. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connection_idle_time_ms. type: integer cloud_storage_max_connections: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_max_connections. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_max_connections. type: integer cloud_storage_reconciliation_interval_ms: description: 'Deprecated: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_reconciliation_interval_ms.' type: integer cloud_storage_region: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_region. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_region. type: string cloud_storage_segment_max_upload_interval_sec: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_max_upload_interval_sec. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_max_upload_interval_sec. type: integer cloud_storage_segment_upload_timeout_ms: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_upload_timeout_ms. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_segment_upload_timeout_ms. type: integer cloud_storage_trust_file: - description: See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_trust_file. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_trust_file. type: string cloud_storage_upload_ctrl_d_coeff: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_d_coeff. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_d_coeff. type: integer cloud_storage_upload_ctrl_max_shares: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_max_shares. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_max_shares. type: integer cloud_storage_upload_ctrl_min_shares: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_min_shares. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_min_shares. type: integer cloud_storage_upload_ctrl_p_coeff: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_p_coeff. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_p_coeff. type: integer cloud_storage_upload_ctrl_update_interval_ms: - description: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_update_interval_ms. + description: See https://docs.redpanda.com/current/reference/properties/object-storage-properties/#cloud_storage_upload_ctrl_update_interval_ms. type: integer type: object credentialsSecretRef: diff --git a/operator/config/crd/bases/cluster.redpanda.com_stretchclusters.yaml b/operator/config/crd/bases/cluster.redpanda.com_stretchclusters.yaml index 80236dec3..dca7d6aae 100644 --- a/operator/config/crd/bases/cluster.redpanda.com_stretchclusters.yaml +++ b/operator/config/crd/bases/cluster.redpanda.com_stretchclusters.yaml @@ -450,7 +450,7 @@ spec: - type: string description: '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. + 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.