Add new field in .yaml inside pkg/options to enable .adoc codegen

pkg/options/DB.yaml

@@ -3,4 +3,6 @@ name: DB
 
 props:
   - name: DSN
-    default: "sqlite3://file::memory:?cache=shared&mode=memory"
+    default: "sqlite3://file::memory:?cache=shared&mode=memory"
+    description: |
+      Database connection string.

pkg/options/HTTPClient.yaml

@@ -9,8 +9,13 @@ props:
     type: bool
     env: HTTP_CLIENT_TSL_INSECURE
     default: false
+    description: |
+      Allow insecure (invalid, expired TSL/SSL certificates) connections.
+      [IMPORTANT]
+      We strongly recommend keeping this value set to false except for local development or demos.
     
   - name: httpClientTimeout
     type: time.Duration
     env: HTTP_CLIENT_TIMEOUT
-    default: 30 * time.Second
+    default: 30 * time.Second
+    description: Default timeout for clients.

pkg/options/HTTPServer.yaml

@@ -8,80 +8,99 @@ props:
   - name: addr
     env: HTTP_ADDR
     default: ":80"
+    description: IP and port for the HTTP server.
 
   - name: logRequest
     type: bool
     env: HTTP_LOG_REQUEST
     default: false
+    description: Log HTTP requests.
     
   - name: logResponse
     type: bool
     env: HTTP_LOG_RESPONSE
     default: false
+    description: Log HTTP responses.
 
   - name: tracing
     type: bool
     env: HTTP_ERROR_TRACING
     default: false
+    description:
+
 
   - name: enableHealthcheckRoute
     type: bool
     env: HTTP_ENABLE_HEALTHCHECK_ROUTE
     default: true
+    description: 
 
   - name: enableVersionRoute 
     type: bool
     env: HTTP_ENABLE_VERSION_ROUTE
     default: true
+    description: Enable `/version` route.
 
   - name: enableDebugRoute     
     type: bool
     env: HTTP_ENABLE_DEBUG_ROUTE
     default: false
+    description: Enable `/debug` route.
 
   - name: enableMetrics
     type: bool
     env: HTTP_METRICS
     default: false
+    description: Enable (prometheus) metrics.
 
   - name: metricsServiceLabel
     env: HTTP_METRICS_NAME
     default: "corteza"
+    description: Name for metrics endpoint.
 
   - name: metricsUsername
     env: HTTP_METRICS_USERNAME
     default: "metrics"
+    description: Username for the metrics endpoint.
 
   - name: metricsPassword
     env: HTTP_METRICS_PASSWORD
     default: string(rand.Bytes(5))
+    description: Password for the metrics endpoint.
 
   - name: enablePanicReporting
     type: bool
     env: HTTP_REPORT_PANIC
     default: true
+    description: Report HTTP panic to Sentry.
     
   - name: apiEnabled
     type: bool
     env: HTTP_API_ENABLED
     default: true
+    description:
 
   - name: apiBaseUrl
     env: HTTP_API_BASE_URL
+    description:
 
   - name: webappEnabled
     type: bool
     env: HTTP_WEBAPP_ENABLED
     default: false
+    description:
 
   - name: webappBaseUrl
     env: HTTP_WEBAPP_BASE_URL
     default: "/"
+    description:
 
   - name: webappBaseDir
     env: HTTP_WEBAPP_BASE_DIR
     default: "webapp/public"
+    description:
     
   - name: webappList
     env: HTTP_WEBAPP_LIST
     default: "admin,auth,messaging,compose"
+    description:

pkg/options/SMTP.yaml

@@ -4,19 +4,27 @@ name: SMTP
 props:
   - name: host
     default: "localhost"
+    description: |
+      The SMTP server hostname. 
 
   - name: port
     type: int
     default: 25
+    description: The SMTP post. 
 
   - name: user
+    description: The SMTP username.
 
   - name: pass
+    description: The SMTP password.
 
   - name: from
+    description: The SMTP `from` email parameter
 
   - name: tlsInsecure
     type: bool
     default: false
+    description: Allow insecure (invalid, expired TLS certificates) connections.
 
   - name: tlsServerName
+    description: 

pkg/options/actionLog.yaml

@@ -5,7 +5,9 @@ props:
   - name: enabled
     type: bool
     default: true
+    description: Enable action logging.
     
   - name: debug
     type: bool
-    default: false
+    default: false
+    description: Enable debug action logging.

pkg/options/auth.yaml

@@ -8,8 +8,13 @@ imports:
 props:
   - name: secret
     env: AUTH_JWT_SECRET
+    description: |
+      Secret used for signing JWT tokens.
+      [IMPORTANT]
+      Make sure to provide a secret. If you don’t, a random value is assigned — this causes all of the tokens to become invalid after a server restart.
     
   - name: expiry
     type: time.Duration
     env: AUTH_JWT_EXPIRY
-    default: time.Hour * 24 * 30
+    default: time.Hour * 24 * 30
+    description: Experation time for the auth JWT tokens.

pkg/options/corredor.yaml

@@ -8,17 +8,21 @@ props:
   - name: enabled
     type: bool
     default: true
+    description: Enable/disable Corredor integration
 
   - name: addr
     default: "localhost:50051"
+    description: Hostname and port of the Corredor gRPC server.
 
   - name: maxBackoffDelay
     type: time.Duration
     default: time.Minute
+    description: Max delay for backoff on connection.
 
   - name: maxReceiveMessageSize
     type: int
     default: 2 << 23
+    description: Max message size that can be recived.
     
   - name: defaultExecTimeout
     type: time.Duration
@@ -38,11 +42,11 @@ props:
 
   - name: tlsCertEnabled
     type: bool
-    env: corredor_client_certificates_enabled
+    env: CORREDOR_CLIENT_CERTIFICATES_ENABLED
     default: false
   
   - name: tlsCertPath
-    env: corredor_client_certificates_path
+    env: CORREDOR_CLIENT_CERTIFICATES_PATH
     default: "/certs/corredor/client"
   
   - name: tlsCertCA

pkg/options/eventbus.yaml

@@ -7,7 +7,9 @@ props:
   - name: schedulerEnabled
     type: bool
     default: true
+    description: Enable eventbus sheduler.
 
   - name: schedulerInterval
     type: time.Duration
     default: time.Minute
+    description: Set time interval for `eventbus` scheduler.

pkg/options/monitor.yaml

@@ -7,4 +7,5 @@ imports:
 props:
   - name: interval
     type: time.Duration
-    default: 300 * time.Second
+    default: 300 * time.Second
+    description: Output (log) interval for monitoring.

pkg/options/objectStore.yaml

@@ -5,9 +5,11 @@ props:
   - name: path
     env: STORAGE_PATH
     default: "var/store"
+    description: Location where uploaded files are stored.
   
   - name: minioEndpoint   
     env: MINIO_ENDPOINT
+    description: 
   
   - name: minioSecure    
     type: bool   

pkg/options/provision.yaml

@@ -5,5 +5,8 @@ props:
   - name: always
     type: bool
     default: true
+    description: Controls if provision should run when the server starts.
+
   - name: path
     default: "provision/*"
+    description: Colon seperated paths to config files for provisioning.

pkg/options/sentry.yaml

@@ -6,27 +6,36 @@ imports:
   
 props:
   - name: DSN
+    description: Set to enable Sentry client.
 
   - name: debug
     type: bool
+    description: Print out debugging information.
 
   - name: attachStacktrace
     type: bool
     default: true
+    description: Attach stacktraces
 
   - name: sampleRate
     type: float32
+    description: Sample rate for event submission (0.0 - 1.0. defaults to 1.0)
 
   - name: maxBreadcrumbs
     type: int
     default: 0
+    description: Maximum number of bredcrumbs.
 
   - name: serverName
     env: SENTRY_SERVERNAME
+    description: Set reported Server name.
 
   - name: release
     default: version.Version
+    description: Set reported Release.
 
   - name: dist
+    description: Set reported distribution.
   
-  - name: environment
+  - name: environment
+    description: Set reported environment.

pkg/options/upgrade.yaml

@@ -5,7 +5,13 @@ props:
   - name: Debug 
     type: bool
     default: false
+    description: |
+      Enable/disable debug logging.
+      To enable debug logging set `UPGRADE_DEBUG=true`.
     
   - name: Always
     type: bool
-    default: true
+    default: true
+    description: |
+      Controls if the upgradable systems should
+      be upgraded when the server starts.

pkg/options/waitFor.yaml

@@ -9,26 +9,38 @@ props:
     type: time.Duration 
     env: WAIT_FOR
     default: 0
+    description: |
+      Delays API startup for the amount of time specified (10s, 2m...).
+      This delay happens before service (`WAIT_FOR_SERVICES`) probing.
 
   - name: StatusPage            
     type: bool          
     env: WAIT_FOR_STATUS_PAGE
     default: true
+    description: Show temporary status web page.
 
   - name: Services                     
     env: WAIT_FOR_SERVICES
+    description: |
+      Space delimited list of hosts and/or URLs to probe. Host format: `host` or 
+      `host:443` (port will default to 80).
+      
+      Services are probed in parallel.
 
   - name: ServicesTimeout       
     type: time.Duration 
     env: WAIT_FOR_SERVICES_TIMEOUT
     default: time.Minute
+    description: Max time for each service probe.
 
   - name: ServicesProbeTimeout  
     type: time.Duration 
     env: WAIT_FOR_SERVICES_PROBE_TIMEOUT
     default: time.Second * 30
+    description: Timeout for each service probe.
     
   - name: ServicesProbeInterval 
     type: time.Duration 
     env: WAIT_FOR_SERVICES_PROBE_INTERVAL
-    default: time.Second * 5
+    default: time.Second * 5
+    description: Interval between service probes.

pkg/options/websocket.yaml

@@ -8,11 +8,14 @@ props:
   - name: Timeout     
     type: time.Duration
     default: 15 * time.Second
+    description: Time before `WsServer` gets timed out.
 
   - name: PingTimeout 
     type: time.Duration
     default: 120 * time.Second
+    description: 
 
   - name: PingPeriod  
     type: time.Duration
-    default: ((120 * time.Second) * 9) / 10
+    default: ((120 * time.Second) * 9) / 10
+    description: