initial commit

Author: bsanchez-the-roach

src/current/_data/v26.3/cockroach-commands.json

@@ -0,0 +1,23 @@
+{% comment %}
+  This include generates a fields table (not flags) for cockroach commands.
+  Used for Store fields and Standard Output fields.
+
+  Required parameters:
+  - fields: Array of field objects from the JSON data
+
+  Each field object should have:
+  - field (required): The field name
+  - description (required): Full description including all metadata
+  - deprecated (optional): Boolean indicating if deprecated
+{% endcomment %}
+
+Field | Description
+-----|------------
+{% for field_item in include.fields -%}
+{%- assign field_id = field_item.field | downcase | replace: ' ', '-' | replace: '[', '' | replace: ']', '' -%}
+{% if field_item.deprecated -%}
+<a name="fields-{{ field_id }}"></a>`{{ field_item.field }}` | **Deprecated.** {{ field_item.description }}
+{% else -%}
+<a name="fields-{{ field_id }}"></a>`{{ field_item.field }}` | {{ field_item.description }}
+{% endif -%}
+{% endfor %}

src/current/_includes/v26.3/reference/fields-table.md

@@ -4,43 +4,28 @@
   Required parameters:
   - flags: Array of flag objects from the JSON data
 
-  Each flag object can have:
-  - flag or field (required): The flag name (--flag) or field name (for store fields)
-  - description (required): Description of the flag
+  Each flag object should have:
+  - flag (required): The flag name (--flag) or field name (for store fields)
   - short (optional): Short version of the flag (-f)
-  - default (optional): Default value
-  - env_var (optional): Environment variable that can set this flag
-  - example (optional): Single example
-  - examples (optional): Array of examples
-  - note (optional): Additional note
-  - warning (optional): Warning message
-  - production_recommendation (optional): Production recommendation
-  - defaults (optional): Array of platform-specific defaults
+  - description (required): Full description including all metadata
   - deprecated (optional): Boolean indicating if deprecated
-  - required (optional): Boolean indicating if required
 {% endcomment %}
 
 Flag | Description
 -----|------------
 {% for flag_item in include.flags -%}
-{% assign flag_name = flag_item.flag | default: flag_item.field -%}
+{%- assign flag_id = flag_item.flag | remove: '--' -%}
 {% if flag_item.deprecated -%}
 {% if flag_item.short -%}
-`{{ flag_name }}`<br>`{{ flag_item.short }}` | **Deprecated.** {{ flag_item.description }}
+<a name="flags-{{ flag_id }}"></a>`{{ flag_item.flag }}`<br>`{{ flag_item.short }}` | **Deprecated.** {{ flag_item.description }}
 {% else -%}
-`{{ flag_name }}` | **Deprecated.** {{ flag_item.description }}
-{% endif -%}
-{% elsif flag_item.required -%}
-{% if flag_item.short -%}
-`{{ flag_name }}`<br>`{{ flag_item.short }}` | **REQUIRED.** {{ flag_item.description }}{% if flag_item.env_var %}<br><br>**Env Variable:** `{{ flag_item.env_var }}`{% endif %}{% if flag_item.default %}<br>**Default:** `{{ flag_item.default }}`{% endif %}{% if flag_item.example %}<br><br>**Example:** `{{ flag_item.example }}`{% endif %}{% if flag_item.examples %}<br><br>**Examples:**<br>{% for ex in flag_item.examples %}`{{ ex }}`<br>{% endfor %}{% endif %}{% if flag_item.note %}<br><br>**Note:** {{ flag_item.note }}{% endif %}{% if flag_item.warning %}<br><br>**Warning:** {{ flag_item.warning }}{% endif %}{% if flag_item.production_recommendation %}<br><br>**Production recommendation:** {{ flag_item.production_recommendation }}{% endif %}{% if flag_item.defaults %}<br><br>**Defaults:**<br>{% for d in flag_item.defaults %}- `{{ d }}`<br>{% endfor %}{% endif %}
-{% else -%}
-`{{ flag_name }}` | **REQUIRED.** {{ flag_item.description }}{% if flag_item.env_var %}<br><br>**Env Variable:** `{{ flag_item.env_var }}`{% endif %}{% if flag_item.default %}<br>**Default:** `{{ flag_item.default }}`{% endif %}{% if flag_item.example %}<br><br>**Example:** `{{ flag_item.example }}`{% endif %}{% if flag_item.examples %}<br><br>**Examples:**<br>{% for ex in flag_item.examples %}`{{ ex }}`<br>{% endfor %}{% endif %}{% if flag_item.note %}<br><br>**Note:** {{ flag_item.note }}{% endif %}{% if flag_item.warning %}<br><br>**Warning:** {{ flag_item.warning }}{% endif %}{% if flag_item.production_recommendation %}<br><br>**Production recommendation:** {{ flag_item.production_recommendation }}{% endif %}{% if flag_item.defaults %}<br><br>**Defaults:**<br>{% for d in flag_item.defaults %}- `{{ d }}`<br>{% endfor %}{% endif %}
+<a name="flags-{{ flag_id }}"></a>`{{ flag_item.flag }}` | **Deprecated.** {{ flag_item.description }}
 {% endif -%}
 {% else -%}
 {% if flag_item.short -%}
-`{{ flag_name }}`<br>`{{ flag_item.short }}` | {{ flag_item.description }}{% if flag_item.env_var %}<br><br>**Env Variable:** `{{ flag_item.env_var }}`{% endif %}{% if flag_item.default %}<br>**Default:** `{{ flag_item.default }}`{% endif %}{% if flag_item.example %}<br><br>**Example:** `{{ flag_item.example }}`{% endif %}{% if flag_item.examples %}<br><br>**Examples:**<br>{% for ex in flag_item.examples %}`{{ ex }}`<br>{% endfor %}{% endif %}{% if flag_item.note %}<br><br>**Note:** {{ flag_item.note }}{% endif %}{% if flag_item.warning %}<br><br>**Warning:** {{ flag_item.warning }}{% endif %}{% if flag_item.production_recommendation %}<br><br>**Production recommendation:** {{ flag_item.production_recommendation }}{% endif %}{% if flag_item.defaults %}<br><br>**Defaults:**<br>{% for d in flag_item.defaults %}- `{{ d }}`<br>{% endfor %}{% endif %}
+<a name="flags-{{ flag_id }}"></a>`{{ flag_item.flag }}`<br>`{{ flag_item.short }}` | {{ flag_item.description }}
 {% else -%}
-`{{ flag_name }}` | {{ flag_item.description }}{% if flag_item.env_var %}<br><br>**Env Variable:** `{{ flag_item.env_var }}`{% endif %}{% if flag_item.default %}<br>**Default:** `{{ flag_item.default }}`{% endif %}{% if flag_item.example %}<br><br>**Example:** `{{ flag_item.example }}`{% endif %}{% if flag_item.examples %}<br><br>**Examples:**<br>{% for ex in flag_item.examples %}`{{ ex }}`<br>{% endfor %}{% endif %}{% if flag_item.note %}<br><br>**Note:** {{ flag_item.note }}{% endif %}{% if flag_item.warning %}<br><br>**Warning:** {{ flag_item.warning }}{% endif %}{% if flag_item.production_recommendation %}<br><br>**Production recommendation:** {{ flag_item.production_recommendation }}{% endif %}{% if flag_item.defaults %}<br><br>**Defaults:**<br>{% for d in flag_item.defaults %}- `{{ d }}`<br>{% endfor %}{% endif %}
+<a name="flags-{{ flag_id }}"></a>`{{ flag_item.flag }}` | {{ flag_item.description }}
 {% endif -%}
 {% endif -%}
 {% endfor %}

src/current/_includes/v26.3/reference/flags-table.md

@@ -313,7 +313,7 @@ CockroachDB supports the [TLS 1.3 and TLS 1.2](https://wikipedia.org/wiki/Transp
 
 By default, CockroachDB negotiates TLS 1.3 for client connections when supported by the client. If the client does not support TLS 1.3, the connection will fall back to TLS 1.2.
 
-To restrict your cluster to only allow connections using specific cipher suites, use the [`--tls-cipher-suites`]({% link {{ page.version.version }}/cockroach-start.md %}#tls-cipher-suites) startup flag with the `cockroach start` command. This setting applies to all incoming SQL, RPC, and HTTP connections.
+To restrict your cluster to only allow connections using specific cipher suites, use the [`--tls-cipher-suites`]({% link {{ page.version.version }}/cockroach-start.md %}#flags-tls-cipher-suites) startup flag with the `cockroach start` command. This setting applies to all incoming SQL, RPC, and HTTP connections.
 
 
 The following cipher suites are enabled by default:

src/current/v26.3/authentication.md

@@ -58,7 +58,7 @@ The `--store` flag supports the following fields. Note that commas are used to s
 In-memory storage is not suitable for production deployments at this time.
 {{site.data.alerts.end}}
 
-{% include {{ page.version.version }}/reference/flags-table.md flags=single_node_cmd.flags.store %}
+{% include {{ page.version.version }}/reference/fields-table.md fields=single_node_cmd.flags.store %}
 
 ### Logging
 
@@ -98,11 +98,7 @@ nodeID:              1
 These details are also written to the `INFO` log in the `/logs` directory. You can retrieve them with a command like `grep 'node starting' node1/logs/cockroach.log -A 11`.
 {{site.data.alerts.end}}
 
-Field | Description
-------|------------
-{% for field in single_node_cmd.standard_output.fields -%}
-`{{ field.field }}` | {{ field.description }}
-{% endfor %}
+{% include {{ page.version.version }}/reference/fields-table.md fields=single_node_cmd.standard_output.fields %}
 
 ## Examples
 

src/current/v26.3/cockroach-start-single-node.md

@@ -166,7 +166,7 @@ For example, let's say that latency is 10ms from nodes in datacenter A to nodes
 
 #### Storage engine
 
-The `--storage-engine` flag is used to choose the storage engine used by the node. Note that this setting applies to all [stores](#store) on the node, including the [temp store](#temp-dir).
+The `--storage-engine` flag is used to choose the storage engine used by the node. Note that this setting applies to all [stores](#store) on the node, including the [temp store](#flags-temp-dir).
 
  As of v21.1 and later, CockroachDB always uses the [Pebble storage engine]({% link {{ page.version.version }}/architecture/storage-layer.md %}#pebble). As such, `pebble` is the default and only option for the `--storage-engine` flag.
 
@@ -190,7 +190,7 @@ In-memory storage is not suitable for production deployments at this time.
 {% include {{ page.version.version }}/prod-deployment/prod-guidance-store-volume.md %}
 {{site.data.alerts.end}}
 
-{% include {{ page.version.version }}/reference/flags-table.md flags=start_cmd.flags.store %}
+{% include {{ page.version.version }}/reference/fields-table.md fields=start_cmd.flags.store %}
 
 #### Write Ahead Log (WAL) failover
 
@@ -204,7 +204,7 @@ For more detailed instructions showing how to use, test, and monitor WAL failove
 
 To enable WAL failover, you must take one of the following actions:
 
-- Pass [`--wal-failover=among-stores`](#flag-wal-failover) to `cockroach start`, or
+- Pass [`--wal-failover=among-stores`](#flags-wal-failover) to `cockroach start`, or
 - Set the environment variable `COCKROACH_WAL_FAILOVER=among-stores` before starting the node.
 
 [Writing log files to local disk]({% link {{ page.version.version }}/configure-logs.md %}#output-to-files) using the default configuration can lead to cluster instability in the event of a [disk stall]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#disk-stalls). It's not enough to failover your WAL writes to another disk: you must also write your log files in such a way that the forward progress of your cluster is not stalled due to disk unavailability.
@@ -225,7 +225,7 @@ As an alternative to logging to local disks, you can configure [remote log sinks
 
 To disable WAL failover, you must [restart the node]({% link {{ page.version.version }}/node-shutdown.md %}#stop-and-restart-a-node) and either:
 
-- Pass the [`--wal-failover=disabled`](#flag-wal-failover) flag to `cockroach start`, or
+- Pass the [`--wal-failover=disabled`](#flags-wal-failover) flag to `cockroach start`, or
 - Set the environment variable `COCKROACH_WAL_FAILOVER=disabled` before restarting the node.
 
 ##### Monitor WAL failover
@@ -266,11 +266,7 @@ nodeID:              1
 These details are also written to the `INFO` log in the `/logs` directory. You can retrieve them with a command like `grep 'node starting' node1/logs/cockroach.log -A 11`.
 {{site.data.alerts.end}}
 
-Field | Description
-------|------------
-{% for field in start_cmd.standard_output.fields -%}
-`{{ field.field }}` | {{ field.description }}
-{% endfor %}
+{% include {{ page.version.version }}/reference/fields-table.md fields=start_cmd.standard_output.fields %}
 
 ## Examples
 

src/current/v26.3/cockroach-start.md

@@ -134,7 +134,7 @@ The standby cluster connects to the primary cluster's system virtual cluster usi
     cockroach workload init movr "postgresql://root@{node_advertise_address}:{node_advertise_port}?options=-ccluster=main&sslmode=verify-full&sslrootcert=certs/ca.crt&sslcert=certs/client.root.crt&sslkey=certs/client.root.key"
     ~~~
 
-    Replace `{node_advertise_address}` and `{node_advertise_port}` with a node's [`--advertise-addr`]({% link {{ page.version.version }}/cockroach-start.md %}#flags-advert-addr) IP address or hostname and port.
+    Replace `{node_advertise_address}` and `{node_advertise_port}` with a node's [`--advertise-addr`]({% link {{ page.version.version }}/cockroach-start.md %}#flags-advertise-addr) IP address or hostname and port.
 
     {% include {{ page.version.version }}/connect/cockroach-workload-parameters.md %} As a result, for the example in this tutorial, you will need:
     - `options=-ccluster=main`