Skip to content

Commit d6942bb

Browse files
committed
docs: add aliases to properties
1 parent 1be2c0c commit d6942bb

File tree

8 files changed

+26
-26
lines changed

8 files changed

+26
-26
lines changed

modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ You can configure credentials for the AWS Glue Data Catalog integration in eithe
8585
** config_ref:iceberg_rest_catalog_aws_access_key,true,properties/cluster-properties[`iceberg_rest_catalog_aws_access_key`] overrides config_ref:cloud_storage_access_key,true,properties/cluster-properties[`cloud_storage_access_key`]
8686
** config_ref:iceberg_rest_catalog_aws_secret_key,true,properties/cluster-properties[`iceberg_rest_catalog_aws_secret_key`] overrides config_ref:cloud_storage_secret_key,true,properties/cluster-properties[`cloud_storage_secret_key`]
8787
** config_ref:iceberg_rest_catalog_aws_region,true,properties/cluster-properties[`iceberg_rest_catalog_aws_region`] overrides config_ref:cloud_storage_region,true,properties/cluster-properties[`cloud_storage_region`]
88-
** config_ref:iceberg_rest_catalog_aws_credentials_source,true,properties/cluster-properties[`iceberg_rest_catalog_aws_credentials_source`] overrides config_ref:cloud_storage_credentials_source,true,properties/cluster-properties[`cloud_storage_credentials_source`]
88+
** config_ref:iceberg_rest_catalog_credentials_source,true,properties/cluster-properties[`iceberg_rest_catalog_credentials_source`] overrides config_ref:cloud_storage_credentials_source,true,properties/cluster-properties[`cloud_storage_credentials_source`]
8989

9090
== Update cluster configuration
9191

modules/manage/partials/audit-logging.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ With audit logging, the pattern of message generation may be very different from
361361

362362
A typical scenario with audit logging is to route the messages to an analytics platform like Splunk. If your retention period is too long, you may find that you are storing excessive amounts of replicated messages in both Redpanda and in your analytics suite. Identifying the right balance of retention and replication settings minimizes this duplication while retaining your data in a system that provides actionable intelligence.
363363

364-
Assess the retention needs for your audit logs. You may not need to keep the logs for the default seven days. This is controlled by setting xref:reference:topic-properties.adoc#retentionms[`retention.ms`] for the `_redpanda.audit_log` topic or by setting xref:reference:cluster-properties.adoc#delete_retention_ms[`delete_retention_ms`] at the cluster level.
364+
Assess the retention needs for your audit logs. You may not need to keep the logs for the default seven days. This is controlled by setting xref:reference:topic-properties.adoc#retentionms[`retention.ms`] for the `_redpanda.audit_log` topic or by setting xref:reference:cluster-properties.adoc#log_retention_ms[`log_retention_ms`] at the cluster level.
365365

366366
== Next steps
367367

modules/manage/partials/tiered-storage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1012,7 +1012,7 @@ At topic creation with Tiered Storage enabled:
10121012
* If `retention.ms` or `retention.bytes` is set, Redpanda initializes the `retention.local.target.*` properties.
10131013
* If `retention.local.target.ms` or `retention.local.target.bytes` is set, Redpanda initializes the `min(retention.bytes, retention.local.target.bytes)` and `max(retention.ms, retention.local.target.ms)` properties.
10141014
* If properties are not specified:
1015-
** Starting in version 22.3, new topics use the default retention values of one day for local storage (`retention_local_target_ms_default`) and seven days for all storage, including object storage (`delete_retention_ms`).
1015+
** Starting in version 22.3, new topics use the default retention values of one day for local storage (config_ref:retention_local_target_ms_default,true,cluster-properties[]) and seven days for all storage, including object storage (config_ref:log_retention_ms,true,cluster-properties[]).
10161016
** Upgraded topics retain their historical defaults of infinite retention.
10171017

10181018
After topic configuration, if Tiered Storage was disabled and must be enabled, or was enabled and must be disabled, Redpanda uses the local retention properties set for the topic. It is strongly recommended that you do not re-enable Tiered Storage after previously enabling and disabling it. Re-enabling Tiered Storage can result in inconsistent data and data gaps in Tiered Storage for a topic.

modules/reference/pages/properties/cluster-properties.adoc

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -838,6 +838,8 @@ The amount of memory to reserve per core for data transform (Wasm) virtual machi
838838

839839
*Type:* integer
840840

841+
*Aliases:* `wasm_per_core_memory_reservation`
842+
841843
ifndef::env-cloud[]
842844
*Default:* `20971520`
843845
endif::[]
@@ -861,6 +863,8 @@ The amount of memory to give an instance of a data transform (Wasm) virtual mach
861863

862864
*Type:* integer
863865

866+
*Aliases:* `wasm_per_function_memory_limit`
867+
864868
*Default:* `2097152`
865869

866870
---
@@ -2264,6 +2268,8 @@ Source of AWS credentials for Iceberg REST catalog SigV4 authentication. If not
22642268

22652269
*Visibility:* `user`
22662270

2271+
*Aliases:* `iceberg_rest_catalog_aws_credentials_source`
2272+
22672273
*Default:* `null`
22682274

22692275
---
@@ -2593,19 +2599,19 @@ Path to a file containing a certificate chain to trust for the REST Iceberg cata
25932599

25942600
---
25952601

2596-
// tag::iceberg_rest_catalog_prefix[]
2602+
// tag::iceberg_rest_catalog_warehouse[]
25972603
=== iceberg_rest_catalog_warehouse
25982604

25992605
Warehouse to use for the Iceberg REST catalog. Redpanda queries the catalog to retrieve warehouse-specific configurations and automatically configures settings like the appropriate prefix. The prefix is appended to the catalog path (for example, `/v1/\{prefix}/namespaces`).
26002606

2601-
*Alias:* `iceberg_rest_catalog_prefix`
2602-
26032607
*Requires restart:* Yes
26042608

26052609
*Visibility:* `user`
26062610

26072611
*Type:* string
26082612

2613+
*Aliases:* `iceberg_rest_catalog_prefix`
2614+
26092615
ifndef::env-cloud[]
26102616
*Default:* `null`
26112617
endif::[]
@@ -2616,7 +2622,7 @@ endif::[]
26162622

26172623
---
26182624

2619-
// end::iceberg_rest_catalog_prefix[]
2625+
// end::iceberg_rest_catalog_warehouse[]
26202626

26212627
=== iceberg_target_backlog_size
26222628

@@ -3850,6 +3856,8 @@ The amount of time to keep a log file before deleting it (in milliseconds). If s
38503856

38513857
*Visibility:* `user`
38523858

3859+
*Aliases:* `delete_retention_ms`
3860+
38533861
*Accepted values:* [`-17592186044416`, `17592186044415`]
38543862

38553863
*Default:* `604800000` (one week)
@@ -5673,6 +5681,8 @@ Always normalize schemas. If set, this overrides the `normalize` parameter in re
56735681

56745682
*Type:* boolean
56755683

5684+
*Aliases:* `schema_registry_normalize_on_startup`
5685+
56765686
*Default:* `false`
56775687

56785688
---
@@ -5694,20 +5704,6 @@ uses ACL-based authorization instead of the default `public/user/superuser` auth
56945704

56955705
---
56965706

5697-
=== schema_registry_normalize_on_startup
5698-
5699-
Normalize schemas as they are read from the topic on startup.
5700-
5701-
*Requires restart:* Yes
5702-
5703-
*Visibility:* `user`
5704-
5705-
*Type:* boolean
5706-
5707-
*Default:* `false`
5708-
5709-
---
5710-
57115707
=== segment_appender_flush_timeout_ms
57125708

57135709
Maximum delay until buffered data is written.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -868,6 +868,8 @@ Time limit on waiting for uploads to complete before a leadership transfer. If
868868

869869
*Type:* integer
870870

871+
*Aliases:* `cloud_storage_graceful_transfer_timeout`
872+
871873
*Accepted values:* [`-17592186044416`, `17592186044415`]
872874

873875
*Default:* `5000`
@@ -1218,6 +1220,8 @@ Maximum concurrent I/O cursors of materialized remote segments per CPU core. If
12181220

12191221
*Type:* integer
12201222

1223+
*Aliases:* `cloud_storage_max_readers_per_shard`
1224+
12211225
*Accepted values:* [`0`, `4294967295`]
12221226

12231227
*Default:* `null`

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ rpk cluster config set <key> <value> [flags]
5959
Setting properties to non-number values (such as setting string values with `-`) can be problematic for some terminals due to how POSIX flags are parsed. For example, the following command may not work from some terminals:
6060
6161
```
62-
rpk cluster config set delete_retention_ms -1
62+
rpk cluster config set log_retention_ms -1
6363
```
6464
6565
Workaround: Use `--` to disable parsing for all subsequent characters. For example:
6666
6767
```
68-
rpk cluster config set -- delete_retention_ms -1
68+
rpk cluster config set -- log_retention_ms -1
6969
```
7070
====
7171

modules/troubleshoot/partials/debug-bundle/inspect.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ cat admin/cluster_config.json | jq
9797
"topic_partitions_per_shard": 1000,
9898
"topic_partitions_reserve_shard0": 2,
9999
"transaction_coordinator_cleanup_policy": "delete",
100-
"transaction_coordinator_delete_retention_ms": 604800000,
100+
"transaction_coordinator_log_retention_ms": 604800000,
101101
"transaction_coordinator_log_segment_size": 1073741824,
102102
"transactional_id_expiration_ms": 604800000,
103103
"tx_timeout_delay_ms": 1000,
@@ -383,7 +383,7 @@ cat kafka.json | jq '.[1:]'
383383
"Source": "DEFAULT_CONFIG",
384384
"Synonyms": [
385385
{
386-
"Key": "delete_retention_ms",
386+
"Key": "log_retention_ms",
387387
"Value": "604800000",
388388
"Source": "DEFAULT_CONFIG"
389389
}

modules/upgrade/pages/deprecated/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ a| Client throughput quota cluster configuration:
4343
| This property was a workaround in an older version of Redpanda. It is no longer required and the property is ignored.
4444

4545
| 23.3.1
46-
| xref:reference:cluster-properties.adoc#delete_retention_ms[`delete_retention_ms`]
46+
| `delete_retention_ms`
4747
| Use xref:reference:cluster-properties.adoc#log_retention_ms[`log_retention_ms`] instead.
4848

4949
| 23.2.12

0 commit comments

Comments
 (0)