Skip to content

Commit 00fe270

Browse files
wass3rwass3r
authored
fix: v27 updates for installation references (#73)
* fix: v27 updates for installation references - adds missing env vars (some introduced in prev versions also) - fix some visual bug with using slashes to separate env vars * missing another
1 parent 68800e9 commit 00fe270

File tree

9 files changed

+207
-80
lines changed

9 files changed

+207
-80
lines changed

‎docs/reference/installation/server/compiler.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,18 @@ Some examples of what the modification endpoint can do include, but are not limi
3333

3434
The following options are used to configure the component:
3535

36-
| Name | Description | Required | Default | Environment Variables |
37-
| ------------------------------ | ---------------------------------------------------------------------------- | -------- | --------------------- | --------------------------------------------------------------------- |
38-
| `clone-image` | default clone image to use for Vela injected clone step | `true` | `target/vela-git` (1) | `VELA_CLONE_IMAGE` |
39-
| `github-driver` | enables using Github or GitHub Enterprise Server as a registry for templates | `false` | `false` | `COMPILER_GITHUB`\`VELA_COMPILER_GITHUB` |
40-
| `github-url` | fully qualified url to GitHub or GitHub Enterprise Server for templates | `false` | `N/A` | `COMPILER_GITHUB_URL`\`VELA_COMPILER_GITHUB_URL` |
41-
| `github-token` | token used for authentication when fetching registry templates | `false` | `N/A` | `COMPILER_GITHUB_TOKEN`\`VELA_COMPILER_GITHUB_TOKEN` |
42-
| `modification-addr` | fully qualified url to endpoint for modifying pipelines | `false` | `N/A` | `MODIFICATION_ADDR`\`VELA_MODIFICATION_ADDR` |
43-
| `modification-retries` | number of times to resend failed requests to the modification endpoint | `false` | `5` | `MODIFICATION_RETRIES`\`VELA_MODIFICATION_RETRIES` |
44-
| `modification-secret` | authenticates communication between compiler and the modification endpoint | `false` | `N/A` | `MODIFICATION_SECRET`\`VELA_MODIFICATION_SECRET` |
45-
| `modification-timeout` | timeout for requests sent to the modification endpoint | `false` | `8s` | `MODIFICATION_TIMEOUT`\`VELA_MODIFICATION_TIMEOUT` |
46-
| `max-template-depth` | max depth for calling nested templates during compilation | `true` | `3` | `MAX_TEMPLATE_DEPTH`\`VELA_MAX_TEMPLATE_DEPTH` |
47-
| `compiler-starlark-exec-limit` | execution step limit for compiling starlark pipelines | `true` | `7500` | `COMPILER_STARLARK_EXEC_LIMIT`\`VELA_COMPILER_STARLARK_EXEC_LIMIT` |
36+
| Name | Description | Required | Default | Environment Variables |
37+
| ------------------------------ | ---------------------------------------------------------------------------- | -------- | --------------------- | ------------------------------------------------------------------ |
38+
| `clone-image` | default clone image to use for Vela injected clone step | `true` | `target/vela-git` (1) | `VELA_CLONE_IMAGE` |
39+
| `github-driver` | enables using Github or GitHub Enterprise Server as a registry for templates | `false` | `false` | `COMPILER_GITHUB`,`VELA_COMPILER_GITHUB` |
40+
| `github-url` | fully qualified url to GitHub or GitHub Enterprise Server for templates | `false` | `N/A` | `COMPILER_GITHUB_URL`,`VELA_COMPILER_GITHUB_URL` |
41+
| `github-token` | token used for authentication when fetching registry templates | `false` | `N/A` | `COMPILER_GITHUB_TOKEN`,`VELA_COMPILER_GITHUB_TOKEN` |
42+
| `modification-addr` | fully qualified url to endpoint for modifying pipelines | `false` | `N/A` | `MODIFICATION_ADDR`,`VELA_MODIFICATION_ADDR` |
43+
| `modification-retries` | number of times to resend failed requests to the modification endpoint | `false` | `5` | `MODIFICATION_RETRIES`,`VELA_MODIFICATION_RETRIES` |
44+
| `modification-secret` | authenticates communication between compiler and the modification endpoint | `false` | `N/A` | `MODIFICATION_SECRET`,`VELA_MODIFICATION_SECRET` |
45+
| `modification-timeout` | timeout for requests sent to the modification endpoint | `false` | `8s` | `MODIFICATION_TIMEOUT`,`VELA_MODIFICATION_TIMEOUT` |
46+
| `max-template-depth` | max depth for calling nested templates during compilation | `true` | `3` | `MAX_TEMPLATE_DEPTH`,`VELA_MAX_TEMPLATE_DEPTH` |
47+
| `compiler-starlark-exec-limit` | execution step limit for compiling starlark pipelines | `true` | `7500` | `COMPILER_STARLARK_EXEC_LIMIT`,`VELA_COMPILER_STARLARK_EXEC_LIMIT` |
4848

4949
_(1) this will be the latest available, tagged release of `target/vela-git` at the time the server component is released_
5050

‎docs/reference/installation/server/database.md‎

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,23 @@ Any sensitive data stored in the database will be encrypted using the [Advanced
2020

2121
The following options are used to configure the component:
2222

23-
| Name | Description | Required | Default | Environment Variables |
24-
| ----------------------------- | ---------------------------------------------------------------- | -------- | ------------- | --------------------------------------------------------------------- |
25-
| `database.addr` | full connection string to the database | `true` | `sqlite3` | `DATABASE_ADDR`\`VELA_DATABASE_ADDR` |
26-
| `database.driver` | type of client to control and operate the database | `true` | `vela.sqlite` | `DATABASE_DRIVER`\`VELA_DATABASE_DRIVER` |
27-
| `database.compression.level` | level of compression for logs stored in the database | `true` | `3` | `DATABASE_COMPRESSION_LEVEL`\`VELA_DATABASE_COMPRESSION_LEVEL` |
28-
| `database.connection.idle` | maximum number of idle connections to the database | `true` | `2` | `DATABASE_CONNECTION_IDLE`\`VELA_DATABASE_CONNECTION_IDLE` |
29-
| `database.connection.life` | duration of time a connection is reusable | `true` | `30m` | `DATABASE_CONNECTION_LIFE`\`VELA_DATABASE_CONNECTION_LIFE` |
30-
| `database.connection.open` | maximum number of open connections to the database | `true` | `0` | `DATABASE_CONNECTION_OPEN`\`VELA_DATABASE_CONNECTION_OPEN` |
31-
| `database.encryption.key` | AES-256 key for encrypting/decrypting values in the database | `true` | `N/A` | `DATABASE_ENCRYPTION_KEY`\`VELA_DATABASE_ENCRYPTION_KEY` |
32-
| `database.skip_creation` | skips the creation of tables and indexes in the database | `false` | `false` | `DATABASE_SKIP_CREATION`\`VELA_DATABASE_SKIP_CREATION` |
33-
| `database.log.level` | log level for database | `false` | `warn` | `DATABASE_LOG_LEVEL` \ `VELA_DATABASE_LOG_LEVEL` |
34-
| `database.log.show_sql` | show sql query in logs | `false` | `false` | `DATABASE_LOG_SHOW_SQL` \ `VELA_DATABASE_LOG_SHOW_SQL` |
35-
| `database.log.skip_notfound` | skip logging not found errors | `false` | `true` | `DATABASE_LOG_SKIP_NOTFOUND` \ `VELA_DATABASE_LOG_SKIP_NOTFOUND` |
36-
| `database.log.slow_threshold` | queries higher than this value are considered slow and logged | `false` | `200ms` | `DATABASE_LOG_SLOW_THRESHOLD` \ `VELA_DATABASE_LOG_SLOW_THRESHOLD` |
23+
| Name | Description | Required | Default | Environment Variables |
24+
| -------------------------------- | ------------------------------------------------------------------ | -------- | ------------- | ------------------------------------------------------------------------ |
25+
| `database.addr` | full connection string / DSN to the database | `true` | `vela.sqlite` | `DATABASE_ADDR`,`VELA_DATABASE_ADDR` |
26+
| `database.driver` | type of client to control and operate the database | `true` | `sqlite3` | `DATABASE_DRIVER`,`VELA_DATABASE_DRIVER` |
27+
| `database.compression.level` | level of compression for logs stored in the database | `true` | `3` | `DATABASE_COMPRESSION_LEVEL`,`VELA_DATABASE_COMPRESSION_LEVEL` |
28+
| `database.connection.idle` | maximum number of idle connections to the database | `true` | `2` | `DATABASE_CONNECTION_IDLE`,`VELA_DATABASE_CONNECTION_IDLE` |
29+
| `database.connection.life` | duration of time a connection is reusable | `true` | `30m` | `DATABASE_CONNECTION_LIFE`,`VELA_DATABASE_CONNECTION_LIFE` |
30+
| `database.connection.open` | maximum number of open connections to the database | `true` | `0` | `DATABASE_CONNECTION_OPEN`,`VELA_DATABASE_CONNECTION_OPEN` |
31+
| `database.encryption.key` | AES-256 key for encrypting/decrypting values in the database | `true` | `N/A` | `DATABASE_ENCRYPTION_KEY`,`VELA_DATABASE_ENCRYPTION_KEY` |
32+
| `database.skip_creation` | skips the creation of tables and indexes in the database | `false` | `false` | `DATABASE_SKIP_CREATION`,`VELA_DATABASE_SKIP_CREATION` |
33+
| `database.log.level` | log level for database | `false` | `warn` | `DATABASE_LOG_LEVEL` \ `VELA_DATABASE_LOG_LEVEL` |
34+
| `database.log.show_sql` | show sql query in logs | `false` | `false` | `DATABASE_LOG_SHOW_SQL` \ `VELA_DATABASE_LOG_SHOW_SQL` |
35+
| `database.log.skip_notfound` | skip logging not found errors | `false` | `true` | `DATABASE_LOG_SKIP_NOTFOUND` \ `VELA_DATABASE_LOG_SKIP_NOTFOUND` |
36+
| `database.log.slow_threshold` | queries higher than this value are considered slow and logged | `false` | `200ms` | `DATABASE_LOG_SLOW_THRESHOLD` \ `VELA_DATABASE_LOG_SLOW_THRESHOLD` |
37+
| `database.log.partitioned` | enables partition-aware log cleanup for partitioned log tables | `false` | `false` | `DATABASE_LOG_PARTITIONED` \ `VELA_DATABASE_LOG_PARTITIONED` |
38+
| `database.log.partition_pattern` | naming pattern for log table partitions (e.g. `logs_%`, `logs_y%`) | `false` | `logs_%` | `DATABASE_LOG_PARTITION_PATTERN` \ `VELA_DATABASE_LOG_PARTITION_PATTERN` |
39+
| `database.log.partition_schema` | database schema containing log table partitions | `false` | `public` | `DATABASE_LOG_PARTITION_SCHEMA` \ `VELA_DATABASE_LOG_PARTITION_SCHEMA` |
3740

3841
:::note
3942
For more information on these configuration options, please see the [server reference](/docs/reference/installation/server/server.md).

‎docs/reference/installation/server/queue.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Workloads published to the queue are managed with a [first in, first out (FIFO)]
1616

1717
The following options are used to configure the component:
1818

19-
| Name | Description | Required | Default | Environment Variables |
20-
| ------------------- | ------------------------------------------------------------- | -------- | ---------- | ----------------------------------------------- |
21-
| `queue.addr` | full connection string to the queue | `true` | `N/A` | `QUEUE_ADDR`\`VELA_QUEUE_ADDR` |
19+
| Name | Description | Required | Default | Environment Variables |
20+
| ------------------- | ------------------------------------------------------------- | -------- | ---------- | -------------------------------------------- |
21+
| `queue.addr` | full connection string to the queue | `true` | `N/A` | `QUEUE_ADDR`/`VELA_QUEUE_ADDR` |
2222
| `queue.cluster` | configures the client for a queue cluster | `false` | `false` | `QUEUE_CLUSTER`\`VELA_QUEUE_CLUSTER` |
2323
| `queue.driver` | type of client to control and operate queue | `true` | `N/A` | `QUEUE_DRIVER`\`VELA_QUEUE_DRIVER` |
2424
| `queue.pop.timeout` | timeout for requests that pop items off the queue | `true` | `60s` | `QUEUE_POP_TIMEOUT`\`VELA_QUEUE_POP_TIMEOUT` |

0 commit comments

Comments
 (0)