Move table config to partial so it can be generated with dyy

Author: daniel-nichter

.gitignore

@@ -1,5 +1,5 @@
 *.tmp
 *.swp
 docs/public/
-resources/_gen/
+docs/resources/_gen/
 .hugo_build.lock

docs/.gitignore

@@ -0,0 +1,5 @@
+*.tmp
+*.swp
+docs/public/
+resources/_gen/
+.hugo_build.lock

docs/assets/_custom.scss

@@ -12,21 +12,21 @@
   --hl: #abf7a8; 
 }
 
-.yaml-doc-container {
+.dyy-container {
   font-family: 'Monaco', 'Courier New', monospace;
   max-width: 1400px;
   line-height: 1em;
-  background: var(--bg);
   font-size: 0.9rem;
 }
 
-.yaml-doc-container > .line:first-child > .yaml-section {
+.dyy-container > .line:first-child > .yaml-section {
   padding-top: 0.5rem;
   border-top-left-radius: 5px;
   border-top-right-radius: 5px;
+  border-color: white;
 }
 
-.yaml-doc-container > .line:first-child > .doc-panel {
+.dyy-container > .line:first-child > .doc-panel {
   padding-top: 0.5rem;
 }
 
@@ -38,6 +38,7 @@
 
 .yaml-section {
   background: var(--bg);
+  height: 100%;
 }
 
 .yaml-line {

docs/assets/table-config-v0-beta.md

@@ -0,0 +1,129 @@
+# License Key
+
+Required license key.
+`mlrd -license` to print all active licenses, or get licenses at https://mlrd.app.
+
+# DynamoDB Table
+
+`table_name` sets the DynamoDB table name that clients use.
+This setting is always required.
+
+The table name must be or match the common table name in the [table envs]({{ref . "table-envs" }}) for the license.
+
+**Values shown are only examples.**
+
+# Primary Key
+
+Primary key definition: required `partition_key` and optional `sort_key`.
+
+Values are coded attributes: "<type>,<attribute>".
+For example:
+* "S,Artist"
+* "N,Year"
+* "B,Checksum"
+
+If the primary key is not defined and the table mode is transparent or migration, mlrd auto-defines the table by calling `DescribeTable`.
+In SQL table mode, the primary key (and secondary indexes) must be defined.
+
+# Secondary Indexes
+
+Optional map of secondary indexes (GSI and LSI).
+
+* Map key: case-sensitive index name
+* Map fields are shown with example values
+
+`include` is a list of attributes to project with the secondary index.
+
+# AWS
+
+Configures AWS access to DynamoDB.
+
+By default (no values), the AWS SDK uses its defaults:
+* Env variables: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, etc.
+* Shared configuration files
+* Shared credentials files
+
+For security, mlrd does not accept AWS access key values in the table config.
+Best practice is to use AWS SDK defaults.
+
+# Migration Step
+
+Sets migration step, runs table in migration mode.
+See [migration overview]({{ref . "overview" }}).
+
+# MySQL
+
+MySQL connection and credential settings.
+
+If `hostname` and `socket` are not set, mlrd auto-detects a local MySQL socket; if that fails, it defaults to `host: 127.0.0.1:3306`.
+For consistency and clarity, set `socket` or `hostname`.
+If both are set, `socket` takes precedence.
+
+MySQL password source: one of `password`, `password_file`, `iam_auth`, or `password_secret` must be set and non-empty.
+mlrd supports online password rotation: password source is reloaded if MySQL returns an auth error; no need to restart mlrd.
+
+`table_name` defaults to `ddb.table_name`.
+This settings allows for a different MySQL table name.
+Clients always reference table by `ddb.table_name`.
+
+Other settings (`max_conn`, `storage`, etc.) are low-level and shouldn't be changed without consulting with mlrd.tech first.
+
+`sharded` affects how BatchGetItem and BatchWriteItem work.
+If false (default), SQL queries are optimized to run on a single node.
+If true, SQL queries are modified to execute on multiple shards.
+In the future, this setting will also affect TransactWriteItems and TransactGetItems.
+
+# TLS
+
+Certificate authority (CA), certificate, and key files for TLS connection to MySQL.
+
+`ca` can be defined alone.
+`key` and `cert` must be defined together.
+
+If no TLS is defined, a TLS-encrypted connection is still used (except for localhost and 127.0.0.1) but the sever identity is not verified.
+
+mlrd auto-detects AWS RDS/Aurora hostnames and uses the AWS Global Certificate Authority (CA) automatically.
+
+# AWS RDS
+
+AWS RDS access if MySQL is an AWS RDS or Aurora instance.
+
+# Low-level Storage
+
+Consult with mlrd.tech before changing these settings.
+
+# OpenTelemetry Metrics
+
+Configures mlrd to send OpenTelemetry metrics via gRPC (OLTP/gRPC).
+Set `endpoint` to enable.
+
+> [!NOTE]
+> **Sys Metrics**  
+> Tables inherit sys config metrics if set. This makes it easy to enable metrics for all tables. If table config contains a `metrics` section, it overrides the sys config metrics.
+
+`freq` is a Go time duration string, minimum "1s" but default "5s" recommended.
+
+`disable` disables table metrics, even if sys metrics are set.
+
+# Percentiles
+
+Percentiles to report for response time metrics.
+Defaults shown: P50 (median) and P99.
+
+# Sampling Rate
+
+Sampling rates (currently only response time).
+Values are every Nth:
+
+- 100 = 1%
+- 20 = 5%
+- 10 = 10%
+- 5 = 20%
+- 4 = 25% (default)
+- 2 = 50% 
+- 1 = 100% (not recommended)
+
+# Disable Features
+
+List of [features]({{ref . "feature-flags" }}) to disable.
+Consult with mlrd.tech before setting.

docs/assets/table-config-v0-beta.yaml

@@ -0,0 +1,57 @@
+lkey: "" # License Key {lkey}
+
+ddb: # DynamoDB Table {ddb}
+  table_name: "Albums"
+  primary_key: # Primary Key
+    partition_key: "S,Artist"
+    sort_key: "S,Title"
+  indexes: # Secondary Indexes
+    Year:
+      partition_key: "N,Year"
+      include: []
+  aws: # AWS
+    config_files: []
+    credentials_files: []
+    profile: ""
+    region: ""
+
+migration_step: "" # Migration Step {migration_step}
+
+mysql: # MySQL {mysql}
+  username: "mlrd"
+  hostname: ""
+  socket: ""
+  password: ""
+  password_file: ""
+  db: "mlrd"
+  table_name: ""
+  tls: # TLS
+    ca: ""
+    cert: ""
+    key: ""
+  aws: # AWS RDS
+    config_files: []
+    credentials_files: []
+    iam_auth: false
+    password_secret: ""
+    profile: ""
+    region: ""
+  max_conn: 100
+  max_conn_idle: 100
+  sharded: false
+  storage: # Low-level Storage
+    pk_len: 2048
+    sk_len: 1024
+    vgc: false
+
+metrics: # OpenTelemetry Metrics {metrics}
+  endpoint: ""
+  freq: "5s"
+  percentiles: # Percentiles
+    - 50
+    - 99
+  sampling: # Sampling Rate
+    response_time: 4
+  disable: false
+
+disable: [] # Disable Features