Skip to content

Fix configuration option documentation for org/env/compute-pool/principal ids #14

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
autophagy merged 1 commit into from
Jun 7, 2025
Merged

Fix configuration option documentation for org/env/compute-pool/principal ids #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,16 +273,16 @@ The following configuration needs to be provided:
| `client.region` | `CLOUD_REGION` | Y | Confluent identifier for a cloud provider's region. For example: `us-east-1` |
| `client.flink-api-key` | `FLINK_API_KEY` | Y | API key for Flink access. |
| `client.flink-api-secret` | `FLINK_API_SECRET` | Y | API secret for Flink access. |
| `client.organization` | `ORG_ID` | Y | ID of the organization. For example: `b0b21724-4586-4a07-b787-d0bb5aacbf87` |
| `client.environment` | `ENV_ID` | Y | ID of the environment. For example: `env-z3y2x1` |
| `client.compute-pool` | `COMPUTE_POOL_ID` | Y | ID of the compute pool. For example: `lfcp-8m03rm` |
| `client.organization-id` | `ORG_ID` | Y | ID of the organization. For example: `b0b21724-4586-4a07-b787-d0bb5aacbf87` |
| `client.environment-id` | `ENV_ID` | Y | ID of the environment. For example: `env-z3y2x1` |
| `client.compute-pool-id` | `COMPUTE_POOL_ID` | Y | ID of the compute pool. For example: `lfcp-8m03rm` |

Additional configuration:

| Property key | Environment variable | Required | Comment |
|----------------------------|----------------------|----------|----------------------------------------------------------------------------------------------------------|
| `client.endpoint-template` | `ENDPOINT_TEMPLATE` | N | A template for the endpoint URL. For example: `https://flinkpls-dom123.{region}.{cloud}.confluent.cloud` |
| `client.principal` | `PRINCIPAL_ID` | N | Principal that runs submitted statements. For example: `sa-23kgz4` (for a service account) |
| `client.principal-id` | `PRINCIPAL_ID` | N | Principal that runs submitted statements. For example: `sa-23kgz4` (for a service account) |
| `client.context` | | N | A name for this Table API session. For example: `my_table_program` |
| `client.statement-name` | | N | Unique name for statement submission. By default, generated using a UUID. |
| `client.rest-endpoint` | `REST_ENDPOINT` | N | URL to the REST endpoint. For example: `proxyto.confluent.cloud` |
Expand Down