Skip to content

Commit 9c46f3e

Browse files
williamhyunYufei Gu
authored andcommitted
Fix telemetry quickstart example for 1.0 release (#1873)
1 parent d95935b commit 9c46f3e

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

getting-started/telemetry/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,16 @@ This example requires `jq` to be installed on your machine.
3333
2. Start the docker compose group by running the following command from the root of the repository:
3434

3535
```shell
36+
export ASSETS_PATH=$(pwd)/getting-started/assets/
37+
export CLIENT_ID=root
38+
export CLIENT_SECRET=s3cr3t
3639
docker compose -f getting-started/telemetry/docker-compose.yml up
3740
```
3841

3942
3. To access Polaris from the host machine, first request an access token:
4043

4144
```shell
42-
export POLARIS_TOKEN=$(curl -s http://polaris:8181/api/catalog/v1/oauth/tokens \
43-
--resolve polaris:8181:127.0.0.1 \
45+
export POLARIS_TOKEN=$(curl -s http://localhost:8181/api/catalog/v1/oauth/tokens \
4446
--user root:s3cr3t \
4547
-d 'grant_type=client_credentials' \
4648
-d 'scope=PRINCIPAL_ROLE:ALL' | jq -r .access_token)
@@ -50,10 +52,10 @@ This example requires `jq` to be installed on your machine.
5052
the `Polairs-Request-Id` header; you should see it in all logs and traces:
5153

5254
```shell
53-
curl -v http://127.0.0.1:8181/api/management/v1/principal-roles \
55+
curl -v 'http://localhost:8181/api/management/v1/principal-roles' \
5456
-H "Authorization: Bearer $POLARIS_TOKEN" \
5557
-H "Polaris-Request-Id: 1234"
56-
curl -v http://127.0.0.1:8181/api/catalog/v1/config?warehouse=polaris_demo \
58+
curl -v 'http://localhost:8181/api/catalog/v1/config?warehouse=quickstart_catalog' \
5759
-H "Authorization: Bearer $POLARIS_TOKEN" \
5860
-H "Polaris-Request-Id: 5678"
5961
```

getting-started/telemetry/docker-compose.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,15 @@ services:
3030
jaeger:
3131
condition: service_healthy
3232
environment:
33-
POLARIS_BOOTSTRAP_CREDENTIALS: POLARIS,root,s3cr3t
33+
POLARIS_BOOTSTRAP_CREDENTIALS: POLARIS,${CLIENT_ID},${CLIENT_SECRET}
3434
quarkus.otel.exporter.otlp.endpoint: http://jaeger:4317
3535
# Resource attributes (added to all traces)
3636
quarkus.otel.resource.attributes[0]: polaris.app=polaris-getting-started
3737
quarkus.otel.resource.attributes[1]: polaris.env=dev
38+
39+
polaris.features."ALLOW_INSECURE_STORAGE_TYPES": "true"
40+
polaris.features."SUPPORTED_CATALOG_STORAGE_TYPES": "[\"FILE\",\"S3\",\"GCS\",\"AZURE\"]"
41+
polaris.readiness.ignore-severe-issues: "true"
3842
# Custom metrics (added to all requests)
3943
polaris.metrics.tags.app: polaris-getting-started
4044
polaris.metrics.tags.env: dev
@@ -55,8 +59,11 @@ services:
5559
depends_on:
5660
polaris:
5761
condition: service_healthy
62+
environment:
63+
- CLIENT_ID=${CLIENT_ID}
64+
- CLIENT_SECRET=${CLIENT_SECRET}
5865
volumes:
59-
- ../assets/polaris/:/polaris
66+
- ${ASSETS_PATH}/polaris/:/polaris
6067
entrypoint: '/bin/sh -c "chmod +x /polaris/create-catalog.sh && /polaris/create-catalog.sh"'
6168

6269
prometheus:

0 commit comments

Comments
 (0)