Skip to content

Commit a4d3976

Browse files
committed
Merge branch 'rpk-v25.1.9' into rpk-v25.2
2 parents 480757a + 9b554b6 commit a4d3976

File tree

15 files changed

+173
-58
lines changed

15 files changed

+173
-58
lines changed

.github/workflows/get-cloud-api-spec.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,23 @@ jobs:
3636

3737
- name: Get commit SHA and build URL
3838
id: commit-info
39+
working-directory: redpanda-docs
3940
run: |
4041
COMMIT_SHA="${{ github.event.client_payload.commit_sha }}"
4142
COMMIT_URL="https://github.com/redpanda-data/cloudv2/commit/${COMMIT_SHA}"
4243
echo "COMMIT_SHA=${COMMIT_SHA}" >> $GITHUB_ENV
4344
echo "COMMIT_URL=${COMMIT_URL}" >> $GITHUB_ENV
4445
4546
- name: Install dependencies
47+
working-directory: redpanda-docs
4648
run: |
4749
npm install
4850
4951
- name: Run the script and save the output
52+
working-directory: redpanda-docs
5053
run: |
51-
npx doc-tools fetch -o redpanda-data -r cloudv2 -p proto/gen/openapi/openapi.controlplane.prod.yaml -d ../../modules/ROOT/attachments cloud-controlplane-api.yaml
52-
npx doc-tools fetch -o redpanda-data -r cloudv2 -p proto/gen/openapi/openapi.dataplane.prod.yaml -d ../../modules/ROOT/attachments cloud-dataplane-api.yaml
54+
npx doc-tools fetch -o redpanda-data -r cloudv2 -p proto/gen/openapi/openapi.controlplane.prod.yaml -d modules/ROOT/attachments -f cloud-controlplane-api.yaml
55+
npx doc-tools fetch -o redpanda-data -r cloudv2 -p proto/gen/openapi/openapi.dataplane.prod.yaml -d modules/ROOT/attachments -f cloud-dataplane-api.yaml
5356
env:
5457
VBOT_GITHUB_API_TOKEN: ${{ env.ACTIONS_BOT_TOKEN }}
5558
- name: Create pull request

modules/console/pages/index.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ image::topic.png[]
3434
Manage Redpanda users and control who has access to Redpanda Console:
3535

3636
* *Visual ACL management*: Create, view, and manage ACLs, ensuring that your data is secure and access is properly controlled.
37-
* *Identity provider integration*: For enterprise users, Redpanda Console integrates with identity providers (IDP) for single sign-on (SSO), making user management straightforward and secure.
37+
* *Rotate credentials*: Update user and service account passwords to maintain security without downtime.
38+
* *Identity provider integration*: For enterprise users, Redpanda Console integrates with identity providers (IdPs) for single sign-on (SSO), making user management straightforward and secure.
3839

3940
image::user.png[]
4041

modules/deploy/pages/deployment-option/self-hosted/manual/sizing.adoc

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,24 @@ Throughput and retention requirements can cause bottlenecks in the system. On an
1414

1515
In general, choose the number of nodes based on the following criteria, and add nodes for fault tolerance. This ensures that the system can operate with full throughput in a degraded state.
1616

17-
* Total network bandwidth must account for maximum simultaneous writes and reads, multiplied by the replication factor.
18-
* Have a minimum of 2 GB memory for each core, but more memory is better.
19-
* Have a minimum of 4 MB of memory for each topic partition replica. You can enforce this requirement in the tunable xref:reference:tunable-properties.adoc#topic_memory_per_partition[`topic_memory_per_partition` property].
20-
* Use Tiered Storage to unify historical and real-time data.
21-
* For AWS, test with either i3en, i4i, or is4gen; for GCP, test with n2-standard (GCP); and for Azure, test with lsv2. In general, choose instance types that prioritize storage and network performance.
22-
* Run hardware and Redpanda benchmark tests for a performance baseline.
17+
* **Network bandwidth**: Total bandwidth must account for maximum simultaneous writes and reads, multiplied by the replication factor.
18+
* **Memory per core**: Allocate a minimum of 2 GB memory for each CPU core. Additional memory could improve performance.
19+
* **Memory per partition**: Allocate a minimum of 2 MB of memory for each topic partition replica.
20+
+
21+
For example: If you have 10,000 total partitions with a replication factor of 3, you need at least 60 GB of memory across all brokers:
22+
+
23+
10,000 partitions × 3 replicas × 2 MB = 60,000 MB (60 GB)
24+
+
25+
If these partitions are evenly distributed across three brokers, each broker needs at least 20 GB of memory.
26+
* **Storage strategy**: Use Tiered Storage to unify historical and real-time data cost-effectively.
27+
* **Performance testing**: Run hardware and Redpanda benchmark tests to establish a performance baseline. Choose instance types that prioritize storage and network performance:
28+
+
29+
--
30+
* **AWS**: Test with i3en (NVMe SSD), i4i (NVMe), or is4gen (Intel-based NVMe) instances, or other NVMe-backed types
31+
* **Azure**: Test with Lsv2-series instances (high I/O performance) or other high-performance storage types
32+
* **GCP**: Test with n2-standard instances with local SSD or other high-performance local storage types
33+
--
34+
2335
2436
== Sizing considerations
2537

modules/reference/pages/internal-metrics-reference.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ curl http://<node-addr>:9644/metrics | grep "[HELP|TYPE]"
1818
----
1919
====
2020

21+
Internal metrics (`/metrics`) can generate thousands of metric series in production environments, so use them judiciously in monitoring systems to avoid performance issues. For alerting and dashboards, public metrics are preferable (`/public_metrics`) because they are optimized for lower cardinality.
22+
23+
The xref:reference:properties/cluster-properties.adoc#aggregate_metrics[aggregate_metrics] cluster property controls internal metrics cardinality. When you enable this property, internal metrics combine labels (like shard) to reduce the number of series. Public metrics always combine labels, regardless of this setting.
24+
2125
== vectorized_alien_receive_batch_queue_length
2226

2327
Indicates the current length of the alien receive batch queue.

modules/reference/pages/properties/object-storage-properties.adoc

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1712,23 +1712,32 @@ Maximum backoff interval when there is nothing to upload for a partition, in mil
17121712

17131713
=== cloud_storage_url_style
17141714

1715-
Specifies the addressing style to use for Amazon S3 requests. This configuration determines how S3 bucket URLs are formatted. Path style is supported for backward compatibility with legacy systems.
1715+
Configure the addressing style that controls how Redpanda formats bucket URLs for S3-compatible object storage.
17161716

1717-
When this property is not set (`null`), the client tries to use `virtual_host` addressing.
1717+
Leave this property unset (`null`) to use automatic configuration:
17181718

1719-
If the initial request fails, the client automatically tries the `path` style.
1719+
* For AWS S3: Redpanda attempts `virtual_host` addressing first, then falls back to `path` style if needed
1720+
* For MinIO: Redpanda automatically uses `path` style regardless of `MINIO_DOMAIN` configuration
17201721

1721-
If neither addressing style works, Redpanda terminates the startup, requiring manual configuration to proceed.
1722+
Set this property explicitly to override automatic configuration, ensure consistent behavior across deployments, or when using S3-compatible storage that requires a specific URL format.
1723+
1724+
CAUTION: AWS requires virtual-hosted addressing for buckets created after September 30, 2020. If you use AWS S3 with buckets created after this date, use `virtual_host` addressing.
1725+
1726+
NOTE: For MinIO deployments, Redpanda defaults to `path` style when this property is unset. To use `virtual_host` addressing with a configured `MINIO_DOMAIN`, set this property explicitly to `virtual_host`. For other S3-compatible storage backends, consult your provider's documentation to determine the required URL style.
17221727

17231728
*Requires restart:* Yes
17241729

17251730
*Visibility:* `user`
17261731

1727-
*Accepted values:*
1732+
*Type:* string
1733+
1734+
*Accepted values:* [`virtual_host`, `path`, `null`]
1735+
1736+
*Example formats:*
17281737

17291738
* `virtual_host` - Example: `<bucket-name>.s3.amazonaws.com`
17301739
* `path` - Example: `s3.amazonaws.com/<bucket-name>`
1731-
* `null`
1740+
* `null` - Enable automatic configuration
17321741

17331742
*Default:* `null`
17341743

modules/reference/pages/public-metrics-reference.adoc

Lines changed: 65 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,24 @@
44

55
This section provides reference descriptions for the public metrics exported from Redpanda's `/public_metrics` endpoint.
66

7-
include::reference:partial$public_metrics_tip.adoc[]
8-
97
// Cloud does not expose the internal metrics.
108
ifndef::env-cloud[]
119
include::shared:partial$metrics-usage-tip.adoc[]
1210
endif::[]
1311

12+
[IMPORTANT]
13+
====
14+
In a live system, Redpanda metrics are exported only for features that are in use. For example, Redpanda does not export metrics for consumer groups if no groups are registered.
15+
16+
To see the available public metrics in your system, query the `/public_metrics` endpoint:
17+
18+
[,bash]
19+
----
20+
curl http://<node-addr>:9644/public_metrics | grep "[HELP|TYPE]"
21+
----
22+
23+
====
24+
1425
== Cluster metrics
1526

1627
=== redpanda_cluster_brokers
@@ -634,6 +645,10 @@ Total time (in seconds) the CPU has been actively processing tasks.
634645

635646
*Usage*: Useful for tracking overall CPU utilization.
636647

648+
*Labels*:
649+
650+
* `shard`
651+
637652
---
638653

639654
=== redpanda_io_queue_total_read_ops
@@ -646,7 +661,7 @@ Cumulative count of read operations processed by the I/O queue.
646661

647662
* `class=("default" | "compaction" | "raft")`
648663

649-
* `ioshard`
664+
* `iogroup`
650665

651666
* `mountpoint`
652667

@@ -664,7 +679,7 @@ Cumulative count of write operations processed by the I/O queue.
664679

665680
* `class=("default" | "compaction" | "raft")`
666681

667-
* `ioshard`
682+
* `iogroup`
668683

669684
* `mountpoint`
670685

@@ -834,6 +849,14 @@ Alert indicator for cache storage free space, where:
834849

835850
---
836851

852+
=== redpanda_storage_cache_disk_total_bytes
853+
854+
Total size of attached storage, in bytes.
855+
856+
*Type*: gauge
857+
858+
---
859+
837860
=== redpanda_storage_disk_free_bytes
838861

839862
Amount of free disk space (in bytes) available on attached storage.
@@ -1191,6 +1214,11 @@ Total number of records fetched from a topic.
11911214

11921215
*Type*: counter
11931216

1217+
*Labels*:
1218+
1219+
* `redpanda_namespace`
1220+
* `redpanda_topic`
1221+
11941222
---
11951223

11961224
=== redpanda_kafka_records_produced_total
@@ -1199,6 +1227,11 @@ Total number of records produced to a topic.
11991227

12001228
*Type*: counter
12011229

1230+
*Labels*:
1231+
1232+
* `redpanda_namespace`
1233+
* `redpanda_topic`
1234+
12021235
---
12031236

12041237
=== redpanda_kafka_replicas
@@ -1826,6 +1859,34 @@ Indicator of whether a resource has at least one valid TLS certificate installed
18261859

18271860
---
18281861

1862+
=== redpanda_trust_file_crc32c
1863+
1864+
CRC32C checksum calculated from the contents of the trust file. This value is calculated when a valid certificate is loaded and a trust store is present. Otherwise, the value is zero.
1865+
1866+
*Type*: gauge
1867+
1868+
*Labels*:
1869+
1870+
- `area`
1871+
- `detail`
1872+
- `shard`
1873+
1874+
---
1875+
1876+
=== redpanda_truststore_expires_at_timestamp_seconds
1877+
1878+
Expiry time of the shortest-lived CA in the truststore, measured in seconds since epoch.
1879+
1880+
*Type*: gauge
1881+
1882+
*Labels*:
1883+
1884+
- `area`
1885+
- `detail`
1886+
- `shard`
1887+
1888+
---
1889+
18291890
[[data_transform_metrics]]
18301891
== Data transforms metrics
18311892

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ rpk cluster self-test start [flags]
4343

4444
|--cloud-backoff-ms |uint | The backoff in milliseconds for a cloud storage request (default `100`).
4545

46-
|--cloud-timeout-ms |uint | The timeout in milliseconds for a cloud storage request (default `5000`).
46+
|--cloud-timeout-ms |uint | The timeout in milliseconds for a cloud storage request (default `10000`).
4747

4848
|--disk-duration-ms |uint | The duration in milliseconds of individual
4949
disk test runs (default `30000`).

modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ time. Default: `12s`.
119119
|--metrics-samples |int |Number of metrics samples to take (at the interval of `--metrics-interval`). Must be higher or equals 2 (default 2).
120120

121121
|-n, --namespace |string |The Kubernetes namespace in which the Redpanda
122-
cluster is running. Default: `redpanda` +
122+
cluster is running. +
123123
*Kubernetes only*.
124124

125125
|-o, --output |string |The file path where the debug file will be

modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ rpk debug remote-bundle download [flags]
2929

3030
|-o, --output |string |The file path where the debug file will be written (default `./<timestamp>-remote-bundle.zip`).
3131

32+
|--upload-url |string |If provided, where to upload the bundle in addition to creating a copy on disk.
33+
3234
|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.
3335

3436
|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.

modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ rpk debug remote-bundle start [flags]
4141

4242
|--metrics-samples |int |Number of metrics samples to take (at the interval of `--metrics-interval` flag). Must be >= `2` (default `2`).
4343

44-
|-n, --namespace |string |(K8s only) The namespace to use to collect the resources from (default `redpanda`).
44+
|-n, --namespace |string |(K8s only) The namespace to use to collect the resources from.
4545

4646
|--no-confirm |- |Disable confirmation prompt.
4747

0 commit comments

Comments
 (0)