Skip to content

Commit

Permalink
Merge branch 'v-WIP/24.3' into DOC-677
Browse files Browse the repository at this point in the history
# Conflicts:
#	modules/get-started/pages/licensing/monitor-license-status.adoc
#	modules/get-started/pages/whats-new.adoc
#	modules/reference/pages/properties/cluster-properties.adoc
  • Loading branch information
Deflaimun committed Dec 2, 2024
2 parents 293bdcd + be9743f commit 1c5b0da
Show file tree
Hide file tree
Showing 22 changed files with 587 additions and 41 deletions.
2 changes: 1 addition & 1 deletion antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ asciidoc:
console-beta-version: '2.8.0-beta.1'
console-beta-tag: 'v2.8.0-beta.1'
# --
supported-kubernetes-version: 1.21
supported-kubernetes-version: 1.25.0-0
supported-helm-version: 3.10.0
supported-rhel-required: '8'
supported-rhel-recommended: '9+'
Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@
*** xref:manage:security/iam-roles.adoc[]
** xref:manage:tiered-storage-linux/index.adoc[Tiered Storage]
*** xref:manage:tiered-storage.adoc[]
*** xref:manage:topic-iceberg-integration.adoc[Iceberg topics]
*** xref:manage:fast-commission-decommission.adoc[]
*** xref:manage:mountable-topics.adoc[]
*** xref:manage:remote-read-replicas.adoc[Remote Read Replicas]
Expand Down
2 changes: 1 addition & 1 deletion modules/deploy/partials/linux/install-fips.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To install Redpanda for FIPS compliance, run:

[,bash]
----
sudo apt install -y redpanda-rpk-fips redpanda-tuners redpanda redpanda-fips
sudo apt install -y redpanda-rpk-fips redpanda-fips
----

NOTE: Alternatively, you could run `sudo apt install -y redpanda-fips`, which also picks up and includes the `redpanda` install package.
Expand Down
16 changes: 16 additions & 0 deletions modules/get-started/pages/whats-new.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ This topic includes new content added in version {page-component-version}. For a
* xref:redpanda-cloud:get-started:whats-new-cloud.adoc[]
* xref:redpanda-cloud:get-started:cloud-overview.adoc#redpanda-cloud-vs-self-managed-feature-compatibility[Redpanda Cloud vs Self-Managed feature compatibility]
== Iceberg topics

The xref:manage:topic-iceberg-integration.adoc[Iceberg integration for Redpanda] allows you to store topic data in the cloud in the Iceberg open table format. This makes your streaming data immediately available in downstream analytical systems without setting up and maintaining additional ETL pipelines. You can also integrate your data directly into commonly-used big data processing frameworks, standardizing and simplifying the consumption of streams as tables in a wide variety of data analytics pipelines.

== Leader pinning

For a Redpanda cluster deployed across multiple availability zones (AZs), xref:develop:produce-data/leader-pinning.adoc[leader pinning] ensures that a topic's partition leaders are geographically closer to clients. Leader pinning can lower networking costs and help guarantee lower latency by routing produce and consume requests to brokers located in certain AZs.
Expand Down Expand Up @@ -115,3 +119,15 @@ The following cluster properties are new in this version:
* xref:reference:properties/cluster-properties.adoc#default_leaders_preference[`default_leaders_preference`]
* xref:reference:properties/cluster-properties.adoc#rpk_path[`rpk_path`]
* xref:reference:properties/cluster-properties.adoc#tombstone_retention_ms[`tombstone_retention_ms`]
* xref:reference:properties/cluster-properties.adoc#iceberg_catalog_base_location[`iceberg_catalog_base_location`]
* xref:reference:properties/cluster-properties.adoc#iceberg_catalog_commit_interval_ms[`iceberg_catalog_commit_interval_ms`]
* xref:reference:properties/cluster-properties.adoc#iceberg_catalog_type[`iceberg_catalog_type`]
* xref:reference:properties/cluster-properties.adoc#iceberg_delete[`iceberg_delete`]
* xref:reference:properties/cluster-properties.adoc#iceberg_rest_catalog_client_id[`iceberg_rest_catalog_client_id`]
* xref:reference:properties/cluster-properties.adoc#iceberg_rest_catalog_client_secret[`iceberg_rest_catalog_client_secret`]
* xref:reference:properties/cluster-properties.adoc#iceberg_rest_catalog_crl_file[`iceberg_rest_catalog_crl_file`]
* xref:reference:properties/cluster-properties.adoc#iceberg_rest_catalog_endpoint[`iceberg_rest_catalog_endpoint`]
* xref:reference:properties/cluster-properties.adoc#iceberg_rest_catalog_prefix[`iceberg_rest_catalog_prefix`]
* xref:reference:properties/cluster-properties.adoc#iceberg_rest_catalog_request_timeout_ms[`iceberg_rest_catalog_request_timeout_ms`]
* xref:reference:properties/cluster-properties.adoc#iceberg_rest_catalog_token[`iceberg_rest_catalog_token`]
* xref:reference:properties/cluster-properties.adoc#iceberg_rest_catalog_trust_file[`iceberg_rest_catalog_trust_file`]
438 changes: 438 additions & 0 deletions modules/manage/pages/topic-iceberg-integration.adoc

Large diffs are not rendered by default.

7 changes: 4 additions & 3 deletions modules/manage/partials/monitor-health.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,12 @@ rate(redpanda_kafka_request_latency_seconds_count{redpanda_request="produce"}[5m

==== Internal RPC latency

To monitor Redpanda internal RPC latency, use the xref:reference:public-metrics-reference.adoc#redpanda_rpc_request_latency_seconds[`redpanda_rpc_request_latency_seconds`] histogram. For example, create a query for the 99th percentile latency:
To monitor Redpanda internal RPC latency, use the xref:reference:public-metrics-reference.adoc#redpanda_rpc_request_latency_seconds[`redpanda_rpc_request_latency_seconds`] histogram with
the `redpanda_server="internal"` label. For example, create a query for the 99th percentile latency:

[,promql]
----
histogram_quantile(0.99, (sum(rate(redpanda_rpc_request_latency_seconds_bucket[5m])) by (le, provider, region, instance, namespace, pod, redpanda_server)))
histogram_quantile(0.99, (sum(rate(redpanda_rpc_request_latency_seconds_bucket{redpanda_server="internal"}[5m])) by (le, provider, region, instance, namespace, pod)))
----

You can monitor the rate of internal RPC requests with xref:reference:public-metrics-reference.adoc#redpanda_rpc_request_latency_seconds[`redpanda_rpc_request_latency_seconds`] histogram's count:
Expand Down Expand Up @@ -263,4 +264,4 @@ rate(redpanda_rest_proxy_request_errors_total[5m])

=== Data transforms

See xref:develop:data-transforms/monitor.adoc[].
See xref:develop:data-transforms/monitor.adoc[].
4 changes: 2 additions & 2 deletions modules/reference/pages/k-connector-helm-spec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

:description: Find the default values and descriptions of settings in the Redpanda Connectors Helm chart.

image:https://img.shields.io/badge/Version-0.1.13-informational?style=flat-square[Version:
0.1.13]
image:https://img.shields.io/badge/Version-0.1.14-informational?style=flat-square[Version:
0.1.14]
image:https://img.shields.io/badge/Type-application-informational?style=flat-square[Type:
application]
image:https://img.shields.io/badge/AppVersion-v1.0.31-informational?style=flat-square[AppVersion:
Expand Down
8 changes: 4 additions & 4 deletions modules/reference/pages/k-operator-helm-spec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

:description: Find the default values and descriptions of settings in the Redpanda Operator Helm chart.

image:https://img.shields.io/badge/Version-0.4.32-informational?style=flat-square[Version:
0.4.32]
image:https://img.shields.io/badge/Version-0.4.34-informational?style=flat-square[Version:
0.4.34]
image:https://img.shields.io/badge/Type-application-informational?style=flat-square[Type:
application]
image:https://img.shields.io/badge/AppVersion-v2.2.5--24.2.7-informational?style=flat-square[AppVersion:
v2.2.5-24.2.7]
image:https://img.shields.io/badge/AppVersion-v2.3.2--24.3.1-informational?style=flat-square[AppVersion:
v2.3.2-24.3.1]

This page describes the official Redpanda Operator Helm Chart. In
particular, this page describes the contents of the chart’s
Expand Down
25 changes: 12 additions & 13 deletions modules/reference/pages/k-redpanda-helm-spec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

:description: Find the default values and descriptions of settings in the Redpanda Helm chart.

image:https://img.shields.io/badge/Version-5.9.10-informational?style=flat-square[Version:
5.9.10]
image:https://img.shields.io/badge/Version-5.9.14-informational?style=flat-square[Version:
5.9.14]
image:https://img.shields.io/badge/Type-application-informational?style=flat-square[Type:
application]
image:https://img.shields.io/badge/AppVersion-v24.2.7-informational?style=flat-square[AppVersion:
Expand Down Expand Up @@ -791,8 +791,7 @@ resources documentation].
Redpanda makes use of a thread per core model. For details, see this
https://redpanda.com/blog/tpc-buffers[blog]. For this reason, Redpanda
should only be given full cores. Note: You can increase cores, but
decreasing cores is not currently supported. See the
https://github.com/redpanda-data/redpanda/issues/350[GitHub issue]. This
decreasing cores is supported only from 24.3 Redpanda version. This
setting is equivalent to `--smp`, `resources.requests.cpu`, and
`resources.limits.cpu`. For production, use `4` or greater. To maximize
efficiency, use the `static` CPU manager policy by specifying an even
Expand Down Expand Up @@ -820,14 +819,14 @@ Enables memory locking. For production, set to `true`.
enable_memory_locking: false It is recommended to have at least 2Gi of
memory per core for the Redpanda binary. This memory is taken from the
total memory given to each container. The Helm chart allocates 80% of
the container’s memory to Redpanda, leaving the rest for the Seastar
subsystem (reserveMemory) and other container processes. So at least
2.5Gi per core is recommended in order to ensure Redpanda has a full
2Gi. These values affect `--memory` and `--reserve-memory` flags passed
to Redpanda and the memory requests/limits in the StatefulSet. Valid
suffixes: k, M, G, T, P, Ki, Mi, Gi, Ti, Pi To create `Guaranteed` Pod
QoS for Redpanda brokers, provide both container max and min values for
the container. For details, see
the container’s memory to Redpanda, leaving the rest for other container
processes. So at least 2.5Gi per core is recommended in order to ensure
Redpanda has a full 2Gi. These values affect `--memory` and
`--reserve-memory` flags passed to Redpanda and the memory
requests/limits in the StatefulSet. Valid suffixes: k, M, G, T, P, Ki,
Mi, Gi, Ti, Pi To create `Guaranteed` Pod QoS for Redpanda brokers,
provide both container max and min values for the container. For
details, see
https://kubernetes.io/docs/tasks/configure-pod-container/quality-service-pod/#create-a-pod-that-gets-assigned-a-qos-class-of-guaranteed
* Every container in the Pod must have a memory limit and a memory
request. * For every container in the Pod, the memory limit must equal
Expand Down Expand Up @@ -1207,7 +1206,7 @@ https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#sta

=== link:++https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=statefulset.sideCars.controllers.image.tag++[statefulset.sideCars.controllers.image.tag]

*Default:* `"v2.2.5-24.2.7"`
*Default:* `"v2.3.2-24.3.1"`

=== link:++https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=statefulset.sideCars.controllers.metricsAddress++[statefulset.sideCars.controllers.metricsAddress]

Expand Down
34 changes: 27 additions & 7 deletions modules/reference/pages/properties/cluster-properties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1672,7 +1672,7 @@ URL of Iceberg REST catalog endpoint.

=== iceberg_rest_catalog_prefix

Prefix part of the Iceberg REST catalog URL. Prefix is appended to the catalog path, for example `/v1/{prefix}/namespaces`.
Prefix part of the Iceberg REST catalog URL. Prefix is appended to the catalog path, for example `/v1/\{prefix}/namespaces`.

*Requires restart:* Yes

Expand Down Expand Up @@ -3724,13 +3724,33 @@ Quota manager GC frequency in milliseconds.

*Accepted values:* [`-17592186044416`, `17592186044415`]

*Default:* `30.0`
*Default:* `30000` (30s)

---

=== raft_replica_max_flush_delay_ms

Maximum delay between two subsequent flushes. After this delay, the log is automatically force flushed.

*Unit*: milliseconds

*Requires restart:* No

*Nullable:* No

*Visibility:* `tunable`

*Type:* integer

*Accepted values:* [`1`, `17592186044415`]

*Default:* `100`

---

=== election_timeout_ms

Election timeout expressed in milliseconds.
Raft election timeout expressed in milliseconds.

*Unit:* milliseconds

Expand Down Expand Up @@ -3800,7 +3820,7 @@ Number of milliseconds for Raft leader heartbeats.

*Type:* integer

*Accepted values:* [`-17592186044416`, `17592186044415`]
*Accepted values:* [`1`, `17592186044415`]

*Default:* `150`

Expand Down Expand Up @@ -4329,17 +4349,17 @@ NOTE: Both <<retention_local_target_bytes_default,`retention_local_target_bytes_

The period during which disk usage is checked for disk pressure, and data is optionally trimmed to meet the target.

*Unit*: seconds
*Unit*: milliseconds

*Requires restart:* No

*Visibility:* `tunable`

*Type:* integer

*Accepted values:* [`-17592186044416`, `17592186044415`]
*Accepted values:* [`0`, `17592186044415`]

*Default:* `30`
*Default:* `30000` (30s)

---

Expand Down
30 changes: 30 additions & 0 deletions modules/reference/pages/properties/topic-properties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,36 @@ CAUTION: Setting `redpanda.remote.readreplica` together with either `redpanda.re

---

=== Apache Iceberg integration properties

Integrate Redpanda topics as Iceberg tables.

==== redpanda.iceberg.mode

Enable the Iceberg integration for the topic. You can choose one of three modes.

**Default**: `disabled`

**Values**:

- `key_value`: Creates an Iceberg table with a `Key` column and a `Value` column. Redpanda stores the raw topic content in the `Value` column.
- `value_schema_id_prefix`: Creates an Iceberg table whose structure matches the Redpanda schema for the topic, with columns corresponding to each field. Redpanda parses the topic values per field and stores them in the corresponding table columns.
- `disabled`: Disables writing to an Iceberg table for the topic.

**Related topics**:

- xref:manage:topic-iceberg-integration.adoc[]

==== redpanda.iceberg.delete

Whether the corresponding Iceberg table is deleted upon deleting the topic.

**Default**: `true`

**Related topics**:

- xref:manage:topic-iceberg-integration.adoc[]

=== Redpanda topic properties

Configure Redpanda-specific topic properties.
Expand Down
2 changes: 1 addition & 1 deletion modules/reference/pages/public-metrics-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ The low watermark for available memory at process start.

=== redpanda_memory_free_memory

Available memory in bytes.
Total amount of unallocated memory for a CPU shard (core), in bytes.

*Type*: gauge

Expand Down
16 changes: 12 additions & 4 deletions modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
= rpk generate app
// tag::single-source[]

ifdef::env-cloud[]
NOTE: This command is only supported in Serverless clusters.

endif::[]

Generate a sample application to connect with Redpanda.

This command generates a starter application to produce and consume from the
settings defined in the `rpk profile`. Its goal is to get you producing and
consuming quickly with Redpanda in a language that is familiar to you.

By default, this will run interactively, prompting you to select a language and
By default, this runs interactively, prompting you to select a language and
a user with which to create your application. To use this without interactivity,
specify how you would like your application to be created using flags.
specify how you want your application to be created using flags.

The `--language` option allows you to specify the language. There is no default.
The `--language` flag lets you specify the language. There is no default.

The `--new-sasl--user` flag allows you to generate a new SASL user
The `--new-sasl--user` flag lets you generate a new SASL user
with admin ACLs. If you don't want to use your current profile user or don't want to create a
new one, you can use the `--no-user` flag to generate the starter app without the user.

ifndef::env-cloud[]
If you are having trouble connecting to your cluster, you can use the common xref:reference:rpk/rpk-x-options.adoc#adminhosts[`-X admin.hosts=<host:ports>`] flag to pass a specific Admin API address.

endif::[]

== Examples

* Generate an app with interactive prompts:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
:page-aliases: reference:rpk/rpk-acl/rpk-acl-user-create.adoc, reference:rpk/rpk-security/rpk-security-acl-user-create.adoc
// tag::single-source[]

ifdef::env-cloud[]
NOTE: This command is only supported in Serverless clusters.

endif::[]

Create a SASL user.

This command creates a single SASL user with the given password, optionally
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
:page-aliases: reference:rpk/rpk-acl/rpk-acl-user-delete.adoc, reference:rpk/rpk-security/rpk-security-acl-user-delete.adoc
// tag::single-source[]

ifdef::env-cloud[]
NOTE: This command is only supported in Serverless clusters.

endif::[]

Delete a SASL user.

This command deletes the specified SASL account from Redpanda. This does not
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
:page-aliases: reference:rpk/rpk-acl/rpk-acl-user-list.adoc, reference:rpk/rpk-security/rpk-security-acl-user-list.adoc
// tag::single-source[]

ifdef::env-cloud[]
NOTE: This command is only supported in Serverless clusters.

endif::[]

List SASL users.

== Usage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
:page-aliases: reference:rpk/rpk-acl/rpk-acl-user-update.adoc, reference:rpk/rpk-security/rpk-security-acl-user-update.adoc
// tag::single-source[]

ifdef::env-cloud[]
NOTE: This command is only supported in Serverless clusters.

endif::[]

Update SASL user credentials

CAUTION: The default value for the `--mechanism` flag is `SCRAM-SHA-256`. Set the flag when using a different mechanism to avoid unexpected changes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
:page-aliases: reference:rpk/rpk-acl/rpk-acl-user.adoc, reference:rpk/rpk-security/rpk-security-acl-user.adoc
// tag::single-source[]

ifdef::env-cloud[]
NOTE: This command is only supported in Serverless clusters.

endif::[]

Manage SCRAM users.

If SCRAM is enabled, a SCRAM user is what you use to talk to Redpanda, and ACLs
Expand Down
10 changes: 9 additions & 1 deletion modules/reference/pages/rpk/rpk-security/rpk-security.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@
// tag::single-source[]
:description: These commands let you create SASL users and create, list, and delete ACLs and RBAC.

Manage Redpanda security.
ifdef::env-cloud[]
NOTE: This command is only supported in Serverless clusters.

endif::[]

ifdef::env-cloud[]
NOTE: This command is only supported in Serverless clusters.

endif::[]

== Usage

Expand Down
Binary file added modules/shared/images/iceberg-integration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 1c5b0da

Please sign in to comment.