Skip to content

Commit 83f9637

Browse files
ddhodgeddhodge
authored
[doc] Clarify use of allowed_preview_flags_csv (yugabyte#27803)
Clarify use of allowed_preview_flags_csv, in particular as it relates to YugabyteDB Anywhere. Add the flag to v2.20.
1 parent 9475613 commit 83f9637

File tree

19 files changed

+178
-30
lines changed

19 files changed

+178
-30
lines changed

‎docs/content/preview/explore/query-1-performance/query-diagnostics.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ Query diagnostics collects the following information:
2727

2828
## Enable query diagnostics
2929

30-
Query diagnostics is {{<tags/feature/tp>}}. To use query diagnostics, enable and configure the following flags for each node of your cluster.
30+
Query diagnostics is {{<tags/feature/tp idea="2078">}}. To use query diagnostics, enable and configure the following flags for each node of your cluster.
3131

3232
| Flag | Description |
3333
| :--- | :---------- |
34-
| allowed_preview_flags_csv | Set the value of this flag to include `ysql_yb_enable_query_diagnostics`. |
34+
| [allowed_preview_flags_csv](../../../reference/configuration/yb-tserver/#allowed-preview-flags-csv) | Set the value of this flag to include `ysql_yb_enable_query_diagnostics`. |
3535
| ysql_yb_enable_query_diagnostics | Enable or disable query diagnostics. <br>Default: false. Changing this flag requires a VM restart. |
3636
| yb_query_diagnostics_circular_buffer_size | Size (in KB) of query diagnostics circular buffer that stores statuses of bundles.<br>Default: 64. Changing this flag requires a VM restart. |
3737

‎docs/content/preview/manage/backup-restore/instant-db-cloning.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ The following example demonstrates how to use a database clone to recover from a
150150
151151
```sh
152152
./bin/yugabyted start --advertise_address=127.0.0.1 \
153-
--master_flags "allowed_preview_flags_csv={enable_db_clone},enable_db_clone=true" \
153+
--master_flags "enable_db_clone=true" \
154154
--tserver_flags "ysql_hba_conf_csv={host all all 0.0.0.0/0 trust,local all all trust}"
155155
```
156156

‎docs/content/preview/reference/configuration/yb-master.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ body_class: configuration
1414

1515
Use the yb-master binary and its flags to configure the [YB-Master](../../../architecture/yb-master/) server. The yb-master executable file is located in the `bin` directory of YugabyteDB home.
1616

17+
{{< note title="Setting flags in YugabyteDB Anywhere" >}}
18+
19+
If you are using YugabyteDB Anywhere, set flags using the [Edit Flags](../../../yugabyte-platform/manage-deployments/edit-config-flags/#modify-configuration-flags) feature.
20+
21+
{{< /note >}}
22+
1723
## Syntax
1824

1925
```sh
@@ -1048,10 +1054,18 @@ Comma-separated values (CSV) formatted catalogue of [preview feature](/preview/r
10481054

10491055
By adding a flag to this list, you explicitly acknowledge and accept any potential risks or instability that may arise from modifying these preview features. This process serves as a safeguard, ensuring that you are fully aware of the experimental nature of the flags you are working with.
10501056

1051-
{{<warning>}}
1052-
Adding flags to this list doesn't automatically change any settings. It only grants permission for the flag to be modified. You still need to configure the flag separately after adding it to this list.
1057+
{{<warning title="You still need to set the flag">}}
1058+
Adding flags to this list doesn't automatically change any settings. It only _grants permission_ for the flag to be modified.
1059+
1060+
You still need to configure the flag separately after adding it to this list.
10531061
{{</warning>}}
10541062
1063+
{{<note title="Using YugabyteDB Anywhere">}}
1064+
If you are using YugabyteDB Anywhere, as with other flags, set `allowed_preview_flags_csv` using the [Edit Flags](../../../yugabyte-platform/manage-deployments/edit-config-flags/#modify-configuration-flags) feature.
1065+
1066+
After adding a preview flag to the `allowed_preview_flags_csv` list, you still need to set the flag using **Edit Flags** as well.
1067+
{{</note>}}
1068+
10551069
##### --ysql_index_backfill_rpc_timeout_ms
10561070
10571071
Deadline (in milliseconds) for each internal YB-Master to YB-TServer RPC for backfilling a chunk of the index.

‎docs/content/preview/reference/configuration/yb-tserver.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ This reference provides detailed information about various flags available for c
1818

1919
Use the yb-tserver binary and its flags to configure the YB-TServer server. The yb-tserver executable file is located in the `bin` directory of YugabyteDB home.
2020

21+
{{< note title="Setting flags in YugabyteDB Anywhere" >}}
22+
23+
If you are using YugabyteDB Anywhere, set flags using the [Edit Flags](../../../yugabyte-platform/manage-deployments/edit-config-flags/#modify-configuration-flags) feature.
24+
25+
{{< /note >}}
26+
2127
Flags are organized in the following categories.
2228

2329
| Category | Description |
@@ -2074,10 +2080,18 @@ Comma-separated values (CSV) formatted catalogue of [preview feature](/preview/r
20742080
20752081
By adding a flag to this list, you explicitly acknowledge and accept any potential risks or instability that may arise from modifying these preview features. This process serves as a safeguard, ensuring that you are fully aware of the experimental nature of the flags you are working with.
20762082
2077-
{{<warning>}}
2078-
Adding flags to this list doesn't automatically change any settings. It only grants permission for the flag to be modified. You still need to configure the flag separately after adding it to this list.
2083+
{{<warning title="You still need to set the flag">}}
2084+
Adding flags to this list doesn't automatically change any settings. It only _grants permission_ for the flag to be modified.
2085+
2086+
You still need to configure the flag separately after adding it to this list.
20792087
{{</warning>}}
20802088

2089+
{{<note title="Using YugabyteDB Anywhere">}}
2090+
If you are using YugabyteDB Anywhere, as with other flags, set `allowed_preview_flags_csv` using the [Edit Flags](../../../yugabyte-platform/manage-deployments/edit-config-flags/#modify-configuration-flags) feature.
2091+
2092+
After adding a preview flag to the `allowed_preview_flags_csv` list, you still need to set the flag using **Edit Flags** as well.
2093+
{{</note>}}
2094+
20812095
##### backfill_index_client_rpc_timeout_ms
20822096

20832097
{{% tags/wrap %}}

‎docs/content/preview/releases/ybdb-releases/v2.25.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -717,7 +717,7 @@ We're excited to announce the Technical Preview of two foundational features as
717717

718718
As part of this release, we have upgraded our PostgreSQL fork from version 11.2 to 15.0, enabling you to leverage the many key capabilities introduced in PostgreSQL between these two versions. This upgrade brings YSQL API support for numerous features, including stored generated columns, foreign keys on partitioned tables, and non-distinct NULLs in unique indexes. It also introduces query execution optimizations like incremental sort and memoization, along with various observability and security enhancements. For more information, refer to [PostgreSQL 15 features](../../../develop/pg15-features/).
719719

720-
**Query Diagnostics** {{<tags/feature/tp>}}
720+
**Query Diagnostics** {{<tags/feature/tp idea="2078">}}
721721

722722
This feature significantly simplifies tuning poorly performing SQL queries by allowing you to capture and export detailed diagnostic information, including bind variables and constants, pg_stat_statements statistics, schema details, active session history, and execution plans. Refer to [Query diagnostics](../../../explore/query-1-performance/query-diagnostics/).
723723

‎docs/content/stable/explore/observability/active-session-history.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ To use ASH, enable and configure the following flags for each node of your clust
3232

3333
| Flag | Description |
3434
| :--- | :---------- |
35-
| allowed_preview_flags_csv | Set the value of this flag to include `ysql_yb_ash_enable_infra,ysql_yb_enable_ash`. |
35+
| [allowed_preview_flags_csv](../../../reference/configuration/yb-tserver/#allowed-preview-flags-csv) | Set the value of this flag to include `ysql_yb_ash_enable_infra,ysql_yb_enable_ash`. |
3636
| ysql_yb_ash_enable_infra | Enable or disable ASH infrastructure. <br>Default: false. Changing this flag requires a TServer restart. |
3737
| ysql_yb_enable_ash | Works only in conjunction with the flag `ysql_yb_ash_enable_infra`. Setting this flag to true enables the collection of wait events for YSQL and YCQL queries, and YB-TServer requests.<br> Default: false. Changing this flag doesn't require a TServer restart. |
3838

‎docs/content/stable/manage/backup-restore/instant-db-cloning.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ The following example demonstrates how to use a database clone to recover from a
150150
151151
```sh
152152
./bin/yugabyted start --advertise_address=127.0.0.1 \
153-
--master_flags "allowed_preview_flags_csv={enable_db_clone},enable_db_clone=true" \
153+
--master_flags "enable_db_clone=true" \
154154
--tserver_flags "ysql_hba_conf_csv={host all all 0.0.0.0/0 trust,local all all trust}"
155155
```
156156

‎docs/content/stable/reference/configuration/yb-master.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ type: docs
1313

1414
Use the yb-master binary and its flags to configure the [YB-Master](../../../architecture/yb-master/) server. The yb-master executable file is located in the `bin` directory of YugabyteDB home.
1515

16+
{{< note title="Setting flags in YugabyteDB Anywhere" >}}
17+
18+
If you are using YugabyteDB Anywhere, set flags using the [Edit Flags](../../../yugabyte-platform/manage-deployments/edit-config-flags/#modify-configuration-flags) feature.
19+
20+
{{< /note >}}
21+
1622
## Syntax
1723

1824
```sh
@@ -1058,10 +1064,18 @@ Comma-separated values (CSV) formatted catalogue of [preview feature](/preview/r
10581064

10591065
By adding a flag to this list, you explicitly acknowledge and accept any potential risks or instability that may arise from modifying these preview features. This process serves as a safeguard, ensuring that you are fully aware of the experimental nature of the flags you are working with.
10601066

1061-
{{<warning>}}
1062-
Adding flags to this list doesn't automatically change any settings. It only grants permission for the flag to be modified. You still need to configure the flag separately after adding it to this list.
1067+
{{<warning title="You still need to set the flag">}}
1068+
Adding flags to this list doesn't automatically change any settings. It only _grants permission_ for the flag to be modified.
1069+
1070+
You still need to configure the flag separately after adding it to this list.
10631071
{{</warning>}}
10641072
1073+
{{<note title="Using YugabyteDB Anywhere">}}
1074+
If you are using YugabyteDB Anywhere, as with other flags, set `allowed_preview_flags_csv` using the [Edit Flags](../../../yugabyte-platform/manage-deployments/edit-config-flags/#modify-configuration-flags) feature.
1075+
1076+
After adding a preview flag to the `allowed_preview_flags_csv` list, you still need to set the flag using **Edit Flags** as well.
1077+
{{</note>}}
1078+
10651079
##### --ysql_index_backfill_rpc_timeout_ms
10661080
10671081
Deadline (in milliseconds) for each internal YB-Master to YB-TServer RPC for backfilling a chunk of the index.

‎docs/content/stable/reference/configuration/yb-tserver.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ type: docs
1313

1414
Use the yb-tserver binary and its flags to configure the [YB-TServer](../../../architecture/yb-tserver/) server. The yb-tserver executable file is located in the `bin` directory of YugabyteDB home.
1515

16+
{{< note title="Setting flags in YugabyteDB Anywhere" >}}
17+
18+
If you are using YugabyteDB Anywhere, set flags using the [Edit Flags](../../../yugabyte-platform/manage-deployments/edit-config-flags/#modify-configuration-flags) feature.
19+
20+
{{< /note >}}
21+
1622
## Syntax
1723

1824
```sh
@@ -1643,10 +1649,18 @@ Comma-separated values (CSV) formatted catalogue of [preview feature](/preview/r
16431649

16441650
By adding a flag to this list, you explicitly acknowledge and accept any potential risks or instability that may arise from modifying these preview features. This process serves as a safeguard, ensuring that you are fully aware of the experimental nature of the flags you are working with.
16451651

1646-
{{<warning>}}
1647-
Adding flags to this list doesn't automatically change any settings. It only grants permission for the flag to be modified. You still need to configure the flag separately after adding it to this list.
1652+
{{<warning title="You still need to set the flag">}}
1653+
Adding flags to this list doesn't automatically change any settings. It only _grants permission_ for the flag to be modified.
1654+
1655+
You still need to configure the flag separately after adding it to this list.
16481656
{{</warning>}}
16491657
1658+
{{<note title="Using YugabyteDB Anywhere">}}
1659+
If you are using YugabyteDB Anywhere, as with other flags, set `allowed_preview_flags_csv` using the [Edit Flags](../../../yugabyte-platform/manage-deployments/edit-config-flags/#modify-configuration-flags) feature.
1660+
1661+
After adding a preview flag to the `allowed_preview_flags_csv` list, you still need to set the flag using **Edit Flags** as well.
1662+
{{</note>}}
1663+
16501664
##### backfill_index_client_rpc_timeout_ms
16511665
16521666
Timeout (in milliseconds) for the backfill stage of a concurrent CREATE INDEX.

‎docs/content/v2.20/explore/connection-manager/connection-mgr-ysql.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ To start a YugabyteDB cluster with YSQL Connection Manager, set the [yb-tserver]
5050

5151
When `enable_ysql_conn_mgr` is set, each YB-TServer starts the YSQL Connection Manager process along with the PostgreSQL process. You should see one YSQL Connection Manager process per YB-TServer.
5252

53-
To create a single-node cluster with YSQL Connection Manager using [yugabyted](../../../reference/configuration/yugabyted/), use the following command:
53+
Because `enable_ysql_conn_mgr` is a preview flag, to use it, add the flag to the [allowed_preview_flags_csv](../../../reference/configuration/yb-tserver/#allowed-preview-flags-csv) list (that is, `allowed_preview_flags_csv=enable_ysql_conn_mgr`).
54+
55+
For example, to create a single-node cluster with YSQL Connection Manager using [yugabyted](../../../reference/configuration/yugabyted/), use the following command:
5456

5557
```sh
5658
./bin/yugabyted start --tserver_flags "enable_ysql_conn_mgr=true,allowed_preview_flags_csv={enable_ysql_conn_mgr}" --ui false
5759
```
5860

59-
Because `enable_ysql_conn_mgr` is a preview flag only, to use it, add the flag to the `allowed_preview_flags_csv` list (that is, `allowed_preview_flags_csv=enable_ysql_conn_mgr`).
60-
6161
{{< note >}}
6262

6363
To create a large number of client connections, ensure that "SHMMNI" (the maximum number of concurrent shared memory segments an OS allows) as well as [ulimit](../../../deploy/manual-deployment/system-config/#ulimits) is set correctly as follows:

0 commit comments

Comments
 (0)