-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documented environment variables used in Tink Server/CLI/Worker:
Hoping this is will help with the development and operation of Tink Server/CLI/Worker. Signed-off-by: Jacob Weinstock <[email protected]>
- Loading branch information
1 parent
3743d31
commit 474a5aa
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Environment Variables | ||
|
|
||
| The follow describes environment variables available to be set when running Tink Server or Tink CLI. | ||
|
|
||
| | Name | Type | Service(s) | Description | | ||
| | ---------------------------------------------------------------------------------------------- | ------ | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `TINK_AUTH_USERNAME=tink` | string | server | username to use for basic auth to http endpoints | | ||
| | `TINK_AUTH_PASSWORD=tink` | string | server | password to use for basic auth to http endpoints | | ||
| | `TINKERBELL_CERT_URL=http://127.0.0.1:42114/cert` | string | cli/worker | string url from which to get a TLS certificate | | ||
| | `TINKERBELL_CERTS_DIR=/certs` | string | server | a directory which contains the `bundle.pem` and `server-key.pem` files | | ||
| | `CERTS_DIR=/certs` | string | server | a directory which contains the `bundle.pem` and `server-key.pem` files | | ||
| | `TINKERBELL_TLS_CERT="-----BEGIN RSA PRIVATE KEY-----\n....\n-----END RSA PRIVATE KEY-----\n"` | string | server | a TLS certificate for use with Tink server | | ||
| | `TLS_CERT="-----BEGIN RSA PRIVATE KEY-----\n....\n-----END RSA PRIVATE KEY-----\n"` | string | server | a TLS certificate for use with Tink server | | ||
| | `TINKERBELL_GRPC_AUTHORITY=127.0.0.1:42113` | string | server/cli/worker | string url of the Tink gRPC server | | ||
| | `GRPC_AUTHORITY=127.0.0.1:42113` | string | server/cli | string url of the Tink gRPC server | | ||
| | `TINKERBELL_HTTP_AUTHORITY=127.0.0.1:42114` | string | server | string url of the Tink HTTP server | | ||
| | `HTTP_AUTHORITY=127.0.0.1:42114` | string | server | string url of the Tink HTTP server | | ||
| | `FACILITY=onprem` | string | server/cli | location for which the Tink server serves | | ||
| | `PGDATABASE=tinkerbell` | string | server | name of the PostgreSQL database for use in the Tink server | | ||
| | `POSTGRES_DATABASE=tinkerbell` | string | server | name of the PostgreSQL database for use in the Tink server | | ||
| | `PGUSER=tink` | string | server | PostgreSQL username for connecting to the DB | | ||
| | `POSTGRES_USER=tink` | string | server | PostgreSQL username for connecting to the DB | | ||
| | `PGPASSWORD=tink` | string | server | PostgreSQL password for connecting to the DB | | ||
| | `POSTGRES_PASSWORD=tink` | string | server | PostgreSQL password for connecting to the DB | | ||
| | `PGSSLMODE=disable` | string | server | sets the PostgreSQL SSL priority [docs](https://www.postgresql.org/docs/10/libpq-connect.html#LIBPQ-CONNECT-SSLMODE) | | ||
| | `POSTGRES_SSLMODE=disable` | string | server | sets the PostgreSQL SSL priority [docs](https://www.postgresql.org/docs/10/libpq-connect.html#LIBPQ-CONNECT-SSLMODE) | | ||
| | `MAX_WORKFLOW_DATA_VERSIONS=` | int | server | maximum number of workflow data versions to be kept in database | | ||
| | `EVENTS_TTL=60` | string | server | purges the events in the events table that have passed this TTL in minutes | | ||
| | `ONLY_MIGRATION=true` | bool | server | if set to true, only POSTGRES migrations are executed | | ||
| | `TINK_CLI_VERSION="0.0.0"` | string | cli | if set to `0.0.0`, the old get command is used | | ||
| | `DOCKER_REGISTRY=` | string | worker | the docker registry to use for pulling images | | ||
| | `REGISTRY_PASSWORD=` | string | worker | the password for the docker registry | | ||
| | `REGISTRY_USERNAME=` | string | worker | the username for the docker registry | | ||
| | `ID=` | string | worker | the id of the workflow to be executed | | ||
| | `RETRY_INTERVAL=` | int | worker | the interval in seconds between retries for setting up connections to, querying for workflows from, and sending status reports to Tink Server | | ||
| | `MAX_RETRIES=` | int | worker | the maximum number of retries for setting up connections and sending status reports to Tink Server | | ||
| | `MAX_FILE_SIZE=` | int | worker | the maximum size in bytes for the Tink worker data file | | ||
| | `CAPTURE_ACTION_LOGS=` | bool | worker | Capture action container output as part of worker logs | |