Add .adoc files, generated from .yaml

2020-12-02 11:52:00 +01:00
parent 3444ac3021
commit c900b4deee
17 changed files with 491 additions and 11 deletions
@@ -0,0 +1,17 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/DB.yaml
+
+= DB
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *DB_DSN*
+|`string`
+|"sqlite3://file::memory:?cache=shared&mode=memory"|Database connection string.
+|===
@@ -0,0 +1,23 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/HTTPClient.yaml
+
+= HTTPClient
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *HTTP_CLIENT_TSL_INSECURE*
+|`bool`
+|false|Allow insecure (invalid, expired TSL/SSL certificates) connections.
+[IMPORTANT]
+We strongly recommend keeping this value set to false except for local development or demos.
+
+3+| *HTTP_CLIENT_TIMEOUT*
+|`time.Duration`
+|30 * time.Second|Default timeout for clients.
+|===
@@ -0,0 +1,68 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/HTTPServer.yaml
+
+= HTTPServer
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *HTTP_ADDR*
+|`string`
+|":80"|IP and port for the HTTP server.
+3+| *HTTP_LOG_REQUEST*
+|`bool`
+|false|Log HTTP requests.
+3+| *HTTP_LOG_RESPONSE*
+|`bool`
+|false|Log HTTP responses.
+3+| *HTTP_ERROR_TRACING*
+|`bool`
+|false|
+3+| *HTTP_ENABLE_HEALTHCHECK_ROUTE*
+|`bool`
+|true|
+3+| *HTTP_ENABLE_VERSION_ROUTE*
+|`bool`
+|true|Enable `/version` route.
+3+| *HTTP_ENABLE_DEBUG_ROUTE*
+|`bool`
+|false|Enable `/debug` route.
+3+| *HTTP_METRICS*
+|`bool`
+|false|Enable (prometheus) metrics.
+3+| *HTTP_METRICS_NAME*
+|`string`
+|"corteza"|Name for metrics endpoint.
+3+| *HTTP_METRICS_USERNAME*
+|`string`
+|"metrics"|Username for the metrics endpoint.
+3+| *HTTP_METRICS_PASSWORD*
+|`string`
+|string(rand.Bytes(5))|Password for the metrics endpoint.
+3+| *HTTP_REPORT_PANIC*
+|`bool`
+|true|Report HTTP panic to Sentry.
+3+| *HTTP_API_ENABLED*
+|`bool`
+|true|
+3+| *HTTP_API_BASE_URL*
+|`string`
+||
+3+| *HTTP_WEBAPP_ENABLED*
+|`bool`
+|false|
+3+| *HTTP_WEBAPP_BASE_URL*
+|`string`
+|"/"|
+3+| *HTTP_WEBAPP_BASE_DIR*
+|`string`
+|"webapp/public"|
+3+| *HTTP_WEBAPP_LIST*
+|`string`
+|"admin,auth,messaging,compose"|
+|===
@@ -2,9 +2,9 @@

 This file is meant to help with the creation of a .YAML file inside options package.

-The name of the .YAML will dedicate the name of the .gen.go file e.g. fileName1.yaml -> fileName1.gen.go, filename2.yaml -> filename2.gen.go
+The name of the *.YAML* will dedicate the name of the *.gen.go* file e.g. fileName1.yaml -> fileName1.gen.go, filename2.yaml -> filename2.gen.go

-The contents of the .YAML file should look like this:
+The contents of the *.YAML* file should look like this:

   name: ...

@@ -16,17 +16,20 @@ The contents of the .YAML file should look like this:
        type: ...
        env: ...
        default: ...
+        description: ...
      


-**name**
-   - It is the name of the struct
+**name**: ::
+* It is the name of the struct

-**imports** 
-   - The list of imports that are needed, if there are no imporsts you may skip this step
+**imports**: :: 
+* The list of imports that are needed, if there are no imporsts you may skip this step
+
+**props**: ::
+* *name* -> name of variable
+* *type* -> the type of variable if not given it is "string" by default
+* *env* -> environment value that if it is not defined will be auto generated from "name" and "props: - name"
+* *default* -> the default value that is asigned to the "prop" strings should be given in double quotations if they are to be qouted
+* *description* -> description contains the "comment" for the entire prop line

-**props**
-   - props: - *name* -> name of variable
-   - props: - *type* -> the type of variable if not given it is "string" by default
-   - props: - *env* -> environment value that if it is not defined will be auto generated from "name" and "props: - name"
-   - props: - *default* -> the default value that is asigned to the "prop" strings should be given in double quotations if they are to be qouted
@@ -0,0 +1,36 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/SMTP.yaml
+
+= SMTP
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *SMTP_HOST*
+|`string`
+|"localhost"|The SMTP server hostname. 
+
+3+| *SMTP_PORT*
+|`int`
+|25|The SMTP post.
+3+| *SMTP_USER*
+|`string`
+||The SMTP username.
+3+| *SMTP_PASS*
+|`string`
+||The SMTP password.
+3+| *SMTP_FROM*
+|`string`
+||The SMTP `from` email parameter
+3+| *SMTP_TLS_INSECURE*
+|`bool`
+|false|Allow insecure (invalid, expired TLS certificates) connections.
+3+| *SMTP_TLS_SERVER_NAME*
+|`string`
+||
+|===
@@ -0,0 +1,20 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/actionLog.yaml
+
+= ActionLog
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *ACTIONLOG_ENABLED*
+|`bool`
+|true|Enable action logging.
+3+| *ACTIONLOG_DEBUG*
+|`bool`
+|false|Enable debug action logging.
+|===
@@ -0,0 +1,23 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/auth.yaml
+
+= Auth
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *AUTH_JWT_SECRET*
+|`string`
+||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.
+
+3+| *AUTH_JWT_EXPIRY*
+|`time.Duration`
+|time.Hour * 24 * 30|Experation time for the auth JWT tokens.
+|===
@@ -0,0 +1,56 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/corredor.yaml
+
+= Corredor
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *CORREDOR_ENABLED*
+|`bool`
+|true|Enable/disable Corredor integration
+3+| *CORREDOR_ADDR*
+|`string`
+|"localhost:50051"|Hostname and port of the Corredor gRPC server.
+3+| *CORREDOR_MAX_BACKOFF_DELAY*
+|`time.Duration`
+|time.Minute|Max delay for backoff on connection.
+3+| *CORREDOR_MAX_RECEIVE_MESSAGE_SIZE*
+|`int`
+|2 << 23|Max message size that can be recived.
+3+| *CORREDOR_DEFAULT_EXEC_TIMEOUT*
+|`time.Duration`
+|time.Minute|
+3+| *CORREDOR_LIST_TIMEOUT*
+|`time.Duration`
+|time.Second * 2|
+3+| *CORREDOR_LIST_REFRESH*
+|`time.Duration`
+|time.Second * 5|
+3+| *CORREDOR_RUN_AS_ENABLED*
+|`bool`
+|true|
+3+| *CORREDOR_CLIENT_CERTIFICATES_ENABLED*
+|`bool`
+|false|
+3+| *CORREDOR_CLIENT_CERTIFICATES_PATH*
+|`string`
+|"/certs/corredor/client"|
+3+| *CORREDOR_CLIENT_CERTIFICATES_CA*
+|`string`
+|"ca.crt"|
+3+| *CORREDOR_CLIENT_CERTIFICATES_PRIVATE*
+|`string`
+|"private.key"|
+3+| *CORREDOR_CLIENT_CERTIFICATES_PUBLIC*
+|`string`
+|"public.crt"|
+3+| *CORREDOR_CLIENT_CERTIFICATES_SERVER_NAME*
+|`string`
+||
+|===
@@ -0,0 +1,17 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/environment.yaml
+
+= Environment
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *ENVIRONMENT*
+|`string`
+|"production"|
+|===
@@ -0,0 +1,20 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/eventbus.yaml
+
+= Eventbus
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *EVENTBUS_SCHEDULER_ENABLED*
+|`bool`
+|true|Enable eventbus sheduler.
+3+| *EVENTBUS_SCHEDULER_INTERVAL*
+|`time.Duration`
+|time.Minute|Set time interval for `eventbus` scheduler.
+|===
@@ -0,0 +1,17 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/monitor.yaml
+
+= Monitor
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *MONITOR_INTERVAL*
+|`time.Duration`
+|300 * time.Second|Output (log) interval for monitoring.
+|===
@@ -0,0 +1,38 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/objectStore.yaml
+
+= ObjectStore
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *STORAGE_PATH*
+|`string`
+|"var/store"|Location where uploaded files are stored.
+3+| *MINIO_ENDPOINT*
+|`string`
+||
+3+| *MINIO_SECURE*
+|`bool`
+|true|
+3+| *MINIO_ACCESS_KEY*
+|`string`
+||
+3+| *MINIO_SECRET_KEY*
+|`string`
+||
+3+| *MINIO_SSEC_KEY*
+|`string`
+||
+3+| *MINIO_BUCKET*
+|`string`
+||
+3+| *MINIO_STRICT*
+|`bool`
+|false|
+|===
@@ -0,0 +1,17 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/provision.yaml
+
+= Provision
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *PROVISION_ALWAYS*
+|`bool`
+|true|Controls if provision should run when the server starts.
+|===
@@ -0,0 +1,41 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/sentry.yaml
+
+= Sentry
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *SENTRY_DSN*
+|`string`
+||Set to enable Sentry client.
+3+| *SENTRY_DEBUG*
+|`bool`
+||Print out debugging information.
+3+| *SENTRY_ATTACH_STACKTRACE*
+|`bool`
+|true|Attach stacktraces
+3+| *SENTRY_SAMPLE_RATE*
+|`float32`
+||Sample rate for event submission (0.0 - 1.0. defaults to 1.0)
+3+| *SENTRY_MAX_BREADCRUMBS*
+|`int`
+|0|Maximum number of bredcrumbs.
+3+| *SENTRY_SERVERNAME*
+|`string`
+||Set reported Server name.
+3+| *SENTRY_RELEASE*
+|`string`
+|version.Version|Set reported Release.
+3+| *SENTRY_DIST*
+|`string`
+||Set reported distribution.
+3+| *SENTRY_ENVIRONMENT*
+|`string`
+||Set reported environment.
+|===
@@ -0,0 +1,23 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/upgrade.yaml
+
+= Upgrade
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *UPGRADE_DEBUG*
+|`bool`
+|false|Enable/disable debug logging.
+To enable debug logging set `UPGRADE_DEBUG=true`.
+
+3+| *UPGRADE_ALWAYS*
+|`bool`
+|true|Controls if the upgradable systems should
+be upgraded when the server starts.
+|===
@@ -0,0 +1,38 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/waitFor.yaml
+
+= WaitFor
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *WAIT_FOR*
+|`time.Duration`
+|0|Delays API startup for the amount of time specified (10s, 2m...).
+This delay happens before service (`WAIT_FOR_SERVICES`) probing.
+
+3+| *WAIT_FOR_STATUS_PAGE*
+|`bool`
+|true|Show temporary status web page.
+3+| *WAIT_FOR_SERVICES*
+|`string`
+||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.
+
+3+| *WAIT_FOR_SERVICES_TIMEOUT*
+|`time.Duration`
+|time.Minute|Max time for each service probe.
+3+| *WAIT_FOR_SERVICES_PROBE_TIMEOUT*
+|`time.Duration`
+|time.Second * 30|Timeout for each service probe.
+3+| *WAIT_FOR_SERVICES_PROBE_INTERVAL*
+|`time.Duration`
+|time.Second * 5|Interval between service probes.
+|===
@@ -0,0 +1,23 @@
+// This file is auto-generated.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//
+// Definitions file that controls how this file is generated:
+// pkg/options/websocket.yaml
+
+= Websocket
+
+[cols="2,3,5a"]
+|===
+|Type|Default value|Description
+3+| *WEBSOCKET_TIMEOUT*
+|`time.Duration`
+|15 * time.Second|Time before `WsServer` gets timed out.
+3+| *WEBSOCKET_PING_TIMEOUT*
+|`time.Duration`
+|120 * time.Second|
+3+| *WEBSOCKET_PING_PERIOD*
+|`time.Duration`
+|((120 * time.Second) * 9) / 10|
+|===