Skip to content

fix: v27 updates for installation references #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 29, 2025
Merged

fix: v27 updates for installation references #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7c6cbc
fix: v27 updates for installation references
wass3r Aug 29, 2025
5a939bf
missing another
wass3r Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/reference/installation/server/compiler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,18 @@ Some examples of what the modification endpoint can do include, but are not limi

The following options are used to configure the component:

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

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

Expand Down
31 changes: 17 additions & 14 deletions docs/reference/installation/server/database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,23 @@ Any sensitive data stored in the database will be encrypted using the [Advanced

The following options are used to configure the component:

| Name | Description | Required | Default | Environment Variables |
| ----------------------------- | ---------------------------------------------------------------- | -------- | ------------- | --------------------------------------------------------------------- |
| `database.addr` | full connection string to the database | `true` | `sqlite3` | `DATABASE_ADDR`\`VELA_DATABASE_ADDR` |
| `database.driver` | type of client to control and operate the database | `true` | `vela.sqlite` | `DATABASE_DRIVER`\`VELA_DATABASE_DRIVER` |
| `database.compression.level` | level of compression for logs stored in the database | `true` | `3` | `DATABASE_COMPRESSION_LEVEL`\`VELA_DATABASE_COMPRESSION_LEVEL` |
| `database.connection.idle` | maximum number of idle connections to the database | `true` | `2` | `DATABASE_CONNECTION_IDLE`\`VELA_DATABASE_CONNECTION_IDLE` |
| `database.connection.life` | duration of time a connection is reusable | `true` | `30m` | `DATABASE_CONNECTION_LIFE`\`VELA_DATABASE_CONNECTION_LIFE` |
| `database.connection.open` | maximum number of open connections to the database | `true` | `0` | `DATABASE_CONNECTION_OPEN`\`VELA_DATABASE_CONNECTION_OPEN` |
| `database.encryption.key` | AES-256 key for encrypting/decrypting values in the database | `true` | `N/A` | `DATABASE_ENCRYPTION_KEY`\`VELA_DATABASE_ENCRYPTION_KEY` |
| `database.skip_creation` | skips the creation of tables and indexes in the database | `false` | `false` | `DATABASE_SKIP_CREATION`\`VELA_DATABASE_SKIP_CREATION` |
| `database.log.level` | log level for database | `false` | `warn` | `DATABASE_LOG_LEVEL` \ `VELA_DATABASE_LOG_LEVEL` |
| `database.log.show_sql` | show sql query in logs | `false` | `false` | `DATABASE_LOG_SHOW_SQL` \ `VELA_DATABASE_LOG_SHOW_SQL` |
| `database.log.skip_notfound` | skip logging not found errors | `false` | `true` | `DATABASE_LOG_SKIP_NOTFOUND` \ `VELA_DATABASE_LOG_SKIP_NOTFOUND` |
| `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` |
| Name | Description | Required | Default | Environment Variables |
| -------------------------------- | ------------------------------------------------------------------ | -------- | ------------- | ------------------------------------------------------------------------ |
| `database.addr` | full connection string / DSN to the database | `true` | `vela.sqlite` | `DATABASE_ADDR`,`VELA_DATABASE_ADDR` |
| `database.driver` | type of client to control and operate the database | `true` | `sqlite3` | `DATABASE_DRIVER`,`VELA_DATABASE_DRIVER` |
| `database.compression.level` | level of compression for logs stored in the database | `true` | `3` | `DATABASE_COMPRESSION_LEVEL`,`VELA_DATABASE_COMPRESSION_LEVEL` |
| `database.connection.idle` | maximum number of idle connections to the database | `true` | `2` | `DATABASE_CONNECTION_IDLE`,`VELA_DATABASE_CONNECTION_IDLE` |
| `database.connection.life` | duration of time a connection is reusable | `true` | `30m` | `DATABASE_CONNECTION_LIFE`,`VELA_DATABASE_CONNECTION_LIFE` |
| `database.connection.open` | maximum number of open connections to the database | `true` | `0` | `DATABASE_CONNECTION_OPEN`,`VELA_DATABASE_CONNECTION_OPEN` |
| `database.encryption.key` | AES-256 key for encrypting/decrypting values in the database | `true` | `N/A` | `DATABASE_ENCRYPTION_KEY`,`VELA_DATABASE_ENCRYPTION_KEY` |
| `database.skip_creation` | skips the creation of tables and indexes in the database | `false` | `false` | `DATABASE_SKIP_CREATION`,`VELA_DATABASE_SKIP_CREATION` |
| `database.log.level` | log level for database | `false` | `warn` | `DATABASE_LOG_LEVEL` \ `VELA_DATABASE_LOG_LEVEL` |
| `database.log.show_sql` | show sql query in logs | `false` | `false` | `DATABASE_LOG_SHOW_SQL` \ `VELA_DATABASE_LOG_SHOW_SQL` |
| `database.log.skip_notfound` | skip logging not found errors | `false` | `true` | `DATABASE_LOG_SKIP_NOTFOUND` \ `VELA_DATABASE_LOG_SKIP_NOTFOUND` |
| `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` |
| `database.log.partitioned` | enables partition-aware log cleanup for partitioned log tables | `false` | `false` | `DATABASE_LOG_PARTITIONED` \ `VELA_DATABASE_LOG_PARTITIONED` |
| `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` |
| `database.log.partition_schema` | database schema containing log table partitions | `false` | `public` | `DATABASE_LOG_PARTITION_SCHEMA` \ `VELA_DATABASE_LOG_PARTITION_SCHEMA` |

:::note
For more information on these configuration options, please see the [server reference](/docs/reference/installation/server/server.md).
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/installation/server/queue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Workloads published to the queue are managed with a [first in, first out (FIFO)]

The following options are used to configure the component:

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