Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions docs/quix-cloud/deployments/quix-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,22 @@ State-related variables are only present when [state management](./state-managem
| `Quix__Build__Id` | The build Id of the deployment. Multiple deployments will have the same build id if referencing the same commit of a application. |
| `Quix__Portal__Api` | The portal API endpoint, which depends on the environment. |
| `Quix__Sdk__Token` | SDK Token 1, as described [here](../access-security/streaming-token.md). |

## Storage and Quix Lake variables

The variables below are **conditional** — unlike the ones above, they are not always present:

- **`Quix__BlobStorage__Connection__Json`** is injected only when the deployment has a [blob storage connection](../quix-lake/blob-storage.md) **bound**.
- The **`Quix__Lakehouse__*`** variables (and the `CATALOG_URL` / `QUIX_LAKE_URL` aliases) are injected only when that connection also has **[Quix Lake](../quix-lake/overview.md) enabled**.

If neither condition is met, none of these variables are set, so guard for their absence in your code. The same variables are also injected into [dev sessions](../applications/dev-sessions/overview.md).

| Variable | Description |
|---------------------------------------|-------------------------------------------------------------------------------------------------------|
| `Quix__BlobStorage__Connection__Json` | The bound blob storage connection as a JSON document — provider plus credentials and bucket/container. Injected as a secret. |
| `Quix__Lakehouse__Catalog__Url` | The Quix Lake Catalog URL (preferred name). |
| `CATALOG_URL` | The Catalog URL — legacy / PyIceberg alias of `Quix__Lakehouse__Catalog__Url`. |
| `QUIX_LAKE_URL` | The Catalog URL — QuixLake / QuixLab alias of `Quix__Lakehouse__Catalog__Url`. |
| `Quix__Lakehouse__Catalog__AuthToken` | Auth token your code sends to authenticate requests to the Catalog — use it together with `Quix__Lakehouse__Catalog__Url`. Injected as a secret. |
| `Quix__Lakehouse__Query__Url` | The Quix Lake Query URL. |
| `Quix__Lakehouse__Query__AuthToken` | Auth token your code sends to authenticate requests to the Query service — use it together with `Quix__Lakehouse__Query__Url`. Injected as a secret. |
21 changes: 21 additions & 0 deletions docs/quix-cloud/quix-lake/blob-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,27 @@ If a step fails, you’ll see ✗ next to it along with the reason (for example,
6. Copy the information into the Quix MinIO connector form.
7. Click **Test Connection**.

## Variables injected into bound deployments

When a deployment — or a [dev session](../applications/dev-sessions/overview.md) — is bound to this blob storage connection, Quix injects the connection itself as a secret:

| Variable | Description |
|----------|-------------|
| `Quix__BlobStorage__Connection__Json` | The full connection as a JSON document — provider plus credentials and the bucket/container. Injected as a secret so values stay hidden in logs and the UI. |

The JSON carries the selected **Provider** (S3, GCS, Azure Blob, or MinIO) and the matching credential and location fields you entered above. Your code reads this one variable and deserializes it to connect to the storage.

When [Quix Lake](./overview.md) is enabled, the Lakehouse endpoints are injected too, so your code can reach the Catalog and Query services without hard-coding URLs:

| Variable | Description |
|----------|-------------|
| `Quix__Lakehouse__Catalog__Url` | The Catalog URL (preferred name). Also injected as `CATALOG_URL` (legacy / PyIceberg alias) and `QUIX_LAKE_URL` (QuixLake / QuixLab alias). |
| `Quix__Lakehouse__Catalog__AuthToken` | Authenticates your code's requests to the Catalog — pair it with `Quix__Lakehouse__Catalog__Url`. Only injected under the `Quix__` name (no alias). Injected as a secret. |
| `Quix__Lakehouse__Query__Url` | The Query URL. |
| `Quix__Lakehouse__Query__AuthToken` | Authenticates your code's requests to the Query service — pair it with `Quix__Lakehouse__Query__Url`. Injected as a secret. |

See [Quix Variables](../deployments/quix-variables.md) for the full list of variables the platform injects into deployments.

## Security & operations

- Dedicated principals per connection (IAM user / Service Account / MinIO user)
Expand Down
Loading