Settings provide hub configuration.
The T specifies the type:
I= integerS= stringB= boolean (0|1|true|false)
These settings pertain to the Hub in general.
| Name | T | Envar | Default | Definition |
|---|---|---|---|---|
| Build | S | BUILD | Hub build version. | |
| Namespace | S | NAMESPACE | konveyor-tackle | Home k8s Namespace. |
| DB.Path | S | DB_PATH | /tmp/tackle.db | Path to sqlite file. |
| DB.MaxConnections | I | DB_MAX_CONNECTION | 1 | Number of DB connections. |
| DB.SeedPath | S | DB_SEED_PATH | /tmp/seed | Path to seed files. |
| Bucket.Path | S | BUCKET_PATH | /tmp/bucket | Path to bucket storage directory. |
| Bucket.TTL | I | BUCKET_TTL | 1 (minute) | Orphaned buckets TTL (minutes). |
| File.TTL | I | FILE_TTL | 1 (minute) | Orphaned files TTL (minutes). |
| Cache.RWX | B | RWX_SUPPORTED | FALSE | Cache volume supports RWX. |
| Cache.Path | S | CACHE_PATH | /cache | Cache volume mount path. |
| Cache.PVC | S | CACHE_PVC | cache | Cache PVC name. Used when RWX suppored. |
| Shared.Path | S | SHARED_PATH | /shared | Shared volume mount path. |
| Encryption.Passphrase | S | ENCRYPTION_PASSPHRASE | tackle | RSA encryption passphrase. |
| Development | B | DEVELOPMENT | FALSE | Development mode. |
| Disconnected | B | DISCONNECTED | FALSE | Not connected to a cluster. |
| Product | S | APP_NAME | tackle | Product/application name. Affects target seeding. |
| Metrics.Enabled | B | METRICS_ENABLED | TRUE | Metrics reporting enabled. |
| Metrics.Port | I | METRICS_PORT | Metrics reporting (listen) port number. |
These settings pertain to authentication and authorization.
| Name | T | Envar | Default | Definition |
|---|---|---|---|---|
| Required | B | AUTH_REQUIRED | FALSE | API enforces authentication/authorization. |
| RolePath | S | RULE_PATH | /tmp/roles.yaml | Path to file used to seed roles. |
| UserPath | S | USER_PATH | /tmp/users/yaml | Path to file used to seed users. |
| Token.Key | S | ADDON_TOKEN | Key used to sign tokens. |
These settings pertain to the tasking system.
| Name | T | Envar | Default | Definition |
|---|---|---|---|---|
| SA | S | TASK_SA | Task pod service account name. | |
| Retries | I | TASK_RETRIES | 1 | Task pod creation retires. |
| Reaper.Created | I | TASK_REAP_CREATED | 72 (hour) | (seconds) task may remain in state=CREATED before deleted. |
| Reaper.Succeeded | I | TASK_REAP_SUCCEEDED | 72 (hour) | (seconds) before SUCCEEDED task's bucket released. |
| Reaper.Failed | I | TASK_REAP_FAILED | 30 (day) | (seconds) before FAILED task's bucket is bucket released. |
| Preemption.Enabled | B | TASK_PREEMPT_ENABLED | FALSE | Task.Policy.Preempt.Enabled default. |
| Preemption.Delayed | I | TASK_PREEMPT_DELAYED | 1 (minute) | (seconds) before READY task is deemed to be blocked and my trigger preemption. |
| Preemption.Postponed | I | TASK_PREEMPT_POSTPONED | 1 (minute) | (seconds) before task with PREEMPTED event will be postponed. |
| Preemption.Rate | I | TASK_PREEMPT_RATE | 10% | (percent) of lower priority RUNNING tasks to be preempted each pass. |
| Pod.Retention.Succeeded | I | TASK_POD_RETAIN_SUCCEEDED | 1 (minute) | (minutes) before SUCCEEDED task pod is reaped (deleted). |
| Pod.Retention.Failed | I | TASK_POD_RETAIN_FAILED | 72 (hour) | (minutes) before FAILED task pod is reaped (deleted). |
| Pod.UID | S | TASK_UID | Task pod run-as user id. |
These settings pertain to the frequency of manager main loops.
| Name | T | Envar | Default | Definition |
|---|---|---|---|---|
| Task | I | FREQUENCY_TASK | 1 (second) | (seconds) between each manager pass. |
| Reaper | I | FREQUENCY_REAPER | 1 (minute) | (minutes) between each reaper pass. |
These settings pertain to analysis.
| Name | T | Envar | Default | Definition |
|---|---|---|---|---|
| ReportPath | S | ANALYSIS_REPORT_PATH | /tmp/analysis/report | Path to static analysis report. |
| ArchiverEnabled | B | ANALYSIS_ARCHIVER_ENABLED | TRUE | Analysis report auto-archived. |
These settings pertain to the auto-create of lang-discovery tasks.
| Name | T | Envar | Default | Definition |
|---|---|---|---|---|
| Enabled | B | DISCOVERY_ENABLED | TRUE when not DISCONNECTED | Trigger discover tasks on application update. |
| Label | S | DISCOVERY_LABEL | konveyor.io/discovery | k8s label use to select lang-discover tasks. |
These settings are intended to be shared by the hub and the (Go) addons.
| Name | T | Envar | Default | Definition |
|---|---|---|---|---|
| HomeDir | S | ADDON_HOME | /addon | Addon home (working) directory. |
| Hub.URL | S | HUB_BASE_URL | http://localhost:8080 | Hub (base) URL. |
| Hub.Token | S | TOKEN | Auth token for hub API. | |
| Task.ID | I | TASK | Task addon working on. |
| Name | T | Envar | Default | Definition |
|---|---|---|---|---|
| RequirePasswordUpdate | B | KEYCLOAK_REQ_PASS_UPDATE | TRUE | User must change password. |
| Host | S | KEYCLOAK_HOST | Service hostname. | |
| Realm | S | KEYCLOAK_REALM | Realm name. | |
| ClientID | S | KEYCLOAK_CLIENT_ID | Client id. | |
| ClientSecret | S | KEYCLOAK_CLIENT_SECRET | Client secret. | |
| Admin.User | S | KEYCLOAK_ADMIN_USER | Admin client user. | |
| Admin.Password | S | KEYCLOAK_ADMIN_PASS | Admin client password. | |
| Admin.Realm | S | KEYCLOAK_ADMIN_REALM | Admin client realm. |