-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsetup.sh
More file actions
executable file
·509 lines (442 loc) · 17.5 KB
/
setup.sh
File metadata and controls
executable file
·509 lines (442 loc) · 17.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
#!/usr/bin/env bash
set -euo pipefail
# Better Stack GCP Integration Setup
#
# Sets up metrics access and log forwarding for a GCP project or whole organization.
#
# Org mode (--org-id provided): org-level IAM roles + org-level log sink (all projects)
# Project mode (no --org-id): project-level IAM roles + project-level log sink
#
# Usage:
# # Org mode (all projects, including future ones):
# ./setup.sh \
# --project=<your-gcp-project> \
# --org-id=<your-gcp-org-id> \
# --source-token=<source-token> \
# --ingesting-host=<ingesting-host>
#
# # Project mode (single project only):
# ./setup.sh \
# --project=<your-gcp-project> \
# --source-token=<source-token> \
# --ingesting-host=<ingesting-host>
#
# # Teardown:
# ./setup.sh --teardown --project=<your-gcp-project> --ingesting-host=<ingesting-host> [--org-id=<your-gcp-org-id>]
# --- Defaults ---
REGION="europe-west1"
BATCH_COUNT="100"
BETTERSTACK_SA="gcp-integration@better-stack.iam.gserviceaccount.com"
ORG_ID=""
TEARDOWN=false
# --- Parse arguments ---
for arg in "$@"; do
case "$arg" in
--project=*) PROJECT="${arg#*=}" ;;
--org-id=*) ORG_ID="${arg#*=}" ;;
--source-token=*) SOURCE_TOKEN="${arg#*=}" ;;
--ingesting-host=*) INGESTING_HOST="${arg#*=}" ;;
--betterstack-sa=*) BETTERSTACK_SA="${arg#*=}" ;;
--region=*) REGION="${arg#*=}" ;;
--batch-count=*) BATCH_COUNT="${arg#*=}" ;;
--teardown) TEARDOWN=true ;;
*) echo "Unknown argument: $arg"; exit 1 ;;
esac
done
SA_EMAIL="betterstack-integration@${PROJECT:-unknown}.iam.gserviceaccount.com"
SOURCE_ID="${INGESTING_HOST:+${INGESTING_HOST%%.*}}"
SINK_NAME="${SOURCE_ID:+betterstack-logs-sink-${SOURCE_ID}}"
TOPIC_NAME="${SOURCE_ID:+betterstack-logs-${SOURCE_ID}}"
TOPIC_DEADLETTER="${SOURCE_ID:+betterstack-logs-deadletter-${SOURCE_ID}}"
SUB_NAME="${SOURCE_ID:+betterstack-logs-pull-${SOURCE_ID}}"
DATAFLOW_PREFIX="${SOURCE_ID:+betterstack-logs-${SOURCE_ID}}"
ROLES=(
roles/monitoring.viewer
roles/compute.viewer
roles/cloudasset.viewer
roles/browser
roles/logging.configWriter
roles/logging.viewer
roles/pubsub.editor
)
if [ -n "$ORG_ID" ]; then
MODE="org"
else
MODE="project"
fi
# --- Teardown ---
if [ "$TEARDOWN" = true ]; then
MISSING=()
[ -z "${PROJECT:-}" ] && MISSING+=("--project")
[ -z "${INGESTING_HOST:-}" ] && MISSING+=("--ingesting-host")
if [ ${#MISSING[@]} -gt 0 ]; then
echo "Error: Missing required arguments for teardown: ${MISSING[*]}"
exit 1
fi
echo "This will remove all Better Stack integration resources:"
echo " Project: $PROJECT"
echo " Mode: $MODE"
[ -n "$ORG_ID" ] && echo " Org: $ORG_ID"
echo ""
read -p "Are you sure? (y/N) " -n 1 -r
echo ""
[ "$REPLY" = "y" ] || { echo "Aborted."; exit 0; }
DATAFLOW_SA_EMAIL="betterstack-dataflow@${PROJECT}.iam.gserviceaccount.com"
DATAFLOW_ROLES=(roles/dataflow.worker roles/storage.objectAdmin roles/pubsub.subscriber roles/pubsub.viewer)
ERRORS=0
echo ""
echo "Cancelling Dataflow job..."
JOB_IDS=$(gcloud dataflow jobs list --region="$REGION" --project="$PROJECT" \
--filter="name~^${DATAFLOW_PREFIX} AND NOT state:(JOB_STATE_CANCELLED OR JOB_STATE_DONE OR JOB_STATE_FAILED OR JOB_STATE_DRAINED)" \
--format='value(JOB_ID)' 2>/dev/null || true)
if [ -n "$JOB_IDS" ]; then
while IFS= read -r JOB_ID; do
echo " Cancelling $JOB_ID in $REGION..."
if ! gcloud dataflow jobs cancel "$JOB_ID" --region="$REGION" --project="$PROJECT" 2>&1; then
echo " WARNING: Failed to cancel Dataflow job $JOB_ID"
ERRORS=$((ERRORS + 1))
fi
done <<< "$JOB_IDS"
else
echo " No active Dataflow jobs found in $REGION"
fi
echo "Deleting Pub/Sub subscription..."
if ! gcloud pubsub subscriptions delete "$SUB_NAME" --project="$PROJECT" --quiet 2>&1; then
echo " WARNING: Failed to delete Pub/Sub subscription"
ERRORS=$((ERRORS + 1))
fi
echo "Deleting Pub/Sub topics..."
for topic in "$TOPIC_NAME" "$TOPIC_DEADLETTER"; do
if ! gcloud pubsub topics delete "$topic" --project="$PROJECT" --quiet 2>&1; then
echo " WARNING: Failed to delete Pub/Sub topic $topic"
ERRORS=$((ERRORS + 1))
fi
done
echo "Deleting log sink..."
if [ "$MODE" = "org" ]; then
if ! gcloud logging sinks delete "$SINK_NAME" --organization="$ORG_ID" --quiet 2>&1; then
echo " WARNING: Failed to delete org log sink"
ERRORS=$((ERRORS + 1))
fi
else
if ! gcloud logging sinks delete "$SINK_NAME" --project="$PROJECT" --quiet 2>&1; then
echo " WARNING: Failed to delete project log sink"
ERRORS=$((ERRORS + 1))
fi
fi
echo "Deleting WIF pool (cascades providers)..."
if ! gcloud iam workload-identity-pools delete betterstack-pool \
--location=global --project="$PROJECT" --quiet 2>&1; then
echo " WARNING: Failed to delete WIF pool"
ERRORS=$((ERRORS + 1))
fi
echo "Removing IAM bindings..."
if [ "$MODE" = "org" ]; then
for role in "${ROLES[@]}"; do
gcloud organizations remove-iam-policy-binding "$ORG_ID" \
--member="serviceAccount:${SA_EMAIL}" \
--role="$role" --quiet > /dev/null 2>&1 || true
done
else
for role in "${ROLES[@]}"; do
gcloud projects remove-iam-policy-binding "$PROJECT" \
--member="serviceAccount:${SA_EMAIL}" \
--role="$role" --quiet > /dev/null 2>&1 || true
done
fi
for role in "${DATAFLOW_ROLES[@]}"; do
gcloud projects remove-iam-policy-binding "$PROJECT" \
--member="serviceAccount:${DATAFLOW_SA_EMAIL}" \
--role="$role" --quiet > /dev/null 2>&1 || true
done
echo " IAM bindings removed."
echo "Deleting service accounts..."
if ! gcloud iam service-accounts delete "$SA_EMAIL" --project="$PROJECT" --quiet 2>&1; then
echo " WARNING: Failed to delete service account $SA_EMAIL"
ERRORS=$((ERRORS + 1))
fi
if ! gcloud iam service-accounts delete "$DATAFLOW_SA_EMAIL" --project="$PROJECT" --quiet 2>&1; then
echo " WARNING: Failed to delete service account $DATAFLOW_SA_EMAIL"
ERRORS=$((ERRORS + 1))
fi
echo ""
if [ "$ERRORS" -gt 0 ]; then
echo "Teardown completed with $ERRORS warning(s). Review output above."
else
echo "Teardown complete."
fi
exit 0
fi
# --- Validate required arguments ---
MISSING=()
[ -z "${PROJECT:-}" ] && MISSING+=("--project")
[ -z "${SOURCE_TOKEN:-}" ] && MISSING+=("--source-token")
[ -z "${INGESTING_HOST:-}" ] && MISSING+=("--ingesting-host")
if [ ${#MISSING[@]} -gt 0 ]; then
echo "Error: Missing required arguments: ${MISSING[*]}"
echo ""
echo "Usage:"
echo " ./setup.sh \\"
echo " --project=CUSTOMER_PROJECT \\"
echo " [--org-id=ORG_ID] \\"
echo " --source-token=SOURCE_TOKEN \\"
echo " --ingesting-host=INGESTING_HOST \\"
echo " --region=europe-west1"
exit 1
fi
SA_EMAIL="betterstack-integration@${PROJECT}.iam.gserviceaccount.com"
echo "Better Stack GCP Integration Setup"
echo "==================================="
echo ""
echo " Project: $PROJECT"
echo " Mode: $MODE"
[ -n "$ORG_ID" ] && echo " Organization: $ORG_ID"
echo " Region: $REGION"
echo " Ingesting host: $INGESTING_HOST"
echo " Better Stack SA: $BETTERSTACK_SA"
echo ""
# --- Step 0: Pre-flight permission checks ---
echo "Checking permissions..."
TOKEN=$(gcloud auth print-access-token)
# Check project-level permissions
PROJECT_PERMS=(
iam.serviceAccounts.create
iam.serviceAccounts.setIamPolicy
pubsub.topics.create
pubsub.subscriptions.create
logging.sinks.create
dataflow.jobs.create
serviceusage.services.enable
)
# In project mode, also need project-level IAM binding permission
if [ "$MODE" = "project" ]; then
PROJECT_PERMS+=(resourcemanager.projects.setIamPolicy)
fi
PERMS_JSON=$(printf '"%s",' "${PROJECT_PERMS[@]}" | sed 's/,$//')
RESULT=$(curl -s -X POST \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d "{\"permissions\":[$PERMS_JSON]}" \
"https://cloudresourcemanager.googleapis.com/v1/projects/${PROJECT}:testIamPermissions")
GRANTED=$(echo "$RESULT" | python3 -c "import sys,json; perms=json.load(sys.stdin).get('permissions',[]); [print(p) for p in perms]" 2>/dev/null || true)
PROJECT_MISSING=()
for perm in "${PROJECT_PERMS[@]}"; do
if ! echo "$GRANTED" | grep -q "^${perm}$"; then
PROJECT_MISSING+=("$perm")
fi
done
if [ ${#PROJECT_MISSING[@]} -gt 0 ]; then
echo ""
echo "Error: Missing project-level permissions on '$PROJECT':"
for perm in "${PROJECT_MISSING[@]}"; do
echo " - $perm"
done
echo ""
echo "You likely need roles/owner or roles/editor on the project."
exit 1
fi
# Check org-level permissions (only in org mode)
if [ "$MODE" = "org" ]; then
ORG_PERMS=(
resourcemanager.organizations.setIamPolicy
logging.sinks.create
)
ORG_PERMS_JSON=$(printf '"%s",' "${ORG_PERMS[@]}" | sed 's/,$//')
ORG_RESULT=$(curl -s -X POST \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d "{\"permissions\":[$ORG_PERMS_JSON]}" \
"https://cloudresourcemanager.googleapis.com/v1/organizations/${ORG_ID}:testIamPermissions")
ORG_GRANTED=$(echo "$ORG_RESULT" | python3 -c "import sys,json; perms=json.load(sys.stdin).get('permissions',[]); [print(p) for p in perms]" 2>/dev/null || true)
ORG_MISSING=()
for perm in "${ORG_PERMS[@]}"; do
if ! echo "$ORG_GRANTED" | grep -q "^${perm}$"; then
ORG_MISSING+=("$perm")
fi
done
if [ ${#ORG_MISSING[@]} -gt 0 ]; then
echo ""
echo "Error: Missing organization-level permissions on org '$ORG_ID':"
for perm in "${ORG_MISSING[@]}"; do
echo " - $perm"
done
echo ""
echo "You likely need roles/resourcemanager.organizationAdmin on the organization."
exit 1
fi
fi
echo " All permissions verified."
echo ""
# --- Step 1: Enable APIs ---
echo "Step 1: Enabling APIs..."
APIS=(dataflow pubsub logging monitoring compute cloudasset iamcredentials)
for api in "${APIS[@]}"; do
gcloud services enable "${api}.googleapis.com" --project="$PROJECT" --quiet
done
echo " APIs enabled."
echo ""
# --- Step 2: Create service accounts + IAM roles ---
echo "Step 2: Creating service accounts and granting IAM roles ($MODE mode)..."
# Integration SA (for metrics access + log sink management, impersonated by Better Stack)
gcloud iam service-accounts create betterstack-integration \
--project="$PROJECT" \
--display-name="Better Stack Integration" 2>/dev/null || true
# Dataflow worker SA (least-privilege for running the pipeline)
DATAFLOW_SA_EMAIL="betterstack-dataflow@${PROJECT}.iam.gserviceaccount.com"
gcloud iam service-accounts create betterstack-dataflow \
--project="$PROJECT" \
--display-name="Better Stack Dataflow Worker" 2>/dev/null || true
DATAFLOW_ROLES=(
roles/dataflow.worker
roles/storage.objectAdmin
roles/pubsub.subscriber
roles/pubsub.viewer
)
for role in "${DATAFLOW_ROLES[@]}"; do
gcloud projects add-iam-policy-binding "$PROJECT" \
--member="serviceAccount:${DATAFLOW_SA_EMAIL}" \
--role="$role" --condition=None --quiet > /dev/null 2>&1
done
echo " Dataflow worker SA: $DATAFLOW_SA_EMAIL"
if [ "$MODE" = "org" ]; then
for role in "${ROLES[@]}"; do
gcloud organizations add-iam-policy-binding "$ORG_ID" \
--member="serviceAccount:${SA_EMAIL}" \
--role="$role" --condition=None --quiet > /dev/null 2>&1
done
echo " Org-level roles granted."
else
for role in "${ROLES[@]}"; do
gcloud projects add-iam-policy-binding "$PROJECT" \
--member="serviceAccount:${SA_EMAIL}" \
--role="$role" --condition=None --quiet > /dev/null 2>&1
done
echo " Project-level roles granted."
fi
echo " Service account: $SA_EMAIL"
echo ""
# --- Step 3: Workload Identity Federation ---
echo "Step 3: Setting up Workload Identity Federation..."
PROJECT_NUMBER=$(gcloud projects describe "$PROJECT" --format='value(projectNumber)')
# Create WIF pool (undelete first if it was soft-deleted)
POOL_STATE=$(gcloud iam workload-identity-pools describe betterstack-pool \
--location=global --project="$PROJECT" --format='value(state)' 2>/dev/null || true)
if [ "$POOL_STATE" = "DELETED" ]; then
gcloud iam workload-identity-pools undelete betterstack-pool \
--location=global --project="$PROJECT"
elif [ "$POOL_STATE" != "ACTIVE" ]; then
gcloud iam workload-identity-pools create betterstack-pool \
--location=global --project="$PROJECT" \
--display-name="Better Stack Integration"
fi
# Create or update OIDC provider (issuer is Google, locked to our SA email)
WIF_PROVIDER_ARGS=(
--workload-identity-pool=betterstack-pool
--location=global --project="$PROJECT"
--issuer-uri="https://accounts.google.com"
--attribute-mapping="google.subject=assertion.sub,attribute.sa_email=assertion.email"
--attribute-condition="assertion.email=='${BETTERSTACK_SA}'"
--allowed-audiences="https://iam.googleapis.com/projects/${PROJECT_NUMBER}/locations/global/workloadIdentityPools/betterstack-pool/providers/betterstack-provider"
)
if gcloud iam workload-identity-pools providers describe betterstack-provider \
--workload-identity-pool=betterstack-pool --location=global --project="$PROJECT" > /dev/null 2>&1; then
gcloud iam workload-identity-pools providers update-oidc betterstack-provider "${WIF_PROVIDER_ARGS[@]}" 2>/dev/null || true
else
gcloud iam workload-identity-pools providers create-oidc betterstack-provider "${WIF_PROVIDER_ARGS[@]}" 2>/dev/null || true
fi
# Grant WIF principal Workload Identity User on customer SA
gcloud iam service-accounts add-iam-policy-binding "$SA_EMAIL" \
--project="$PROJECT" \
--member="principalSet://iam.googleapis.com/projects/${PROJECT_NUMBER}/locations/global/workloadIdentityPools/betterstack-pool/attribute.sa_email/${BETTERSTACK_SA}" \
--role="roles/iam.workloadIdentityUser" --quiet > /dev/null
echo " WIF pool: betterstack-pool"
echo " Provider: betterstack-provider (locked to $BETTERSTACK_SA)"
echo " $BETTERSTACK_SA can now impersonate $SA_EMAIL via WIF"
echo ""
# --- Step 4: Pub/Sub resources ---
echo "Step 4: Creating Pub/Sub resources..."
gcloud pubsub topics create "$TOPIC_NAME" --project="$PROJECT" 2>/dev/null || true
gcloud pubsub subscriptions create "$SUB_NAME" \
--topic="$TOPIC_NAME" --project="$PROJECT" \
--ack-deadline=60 2>/dev/null || true
gcloud pubsub topics create "$TOPIC_DEADLETTER" --project="$PROJECT" 2>/dev/null || true
echo " Topic: $TOPIC_NAME"
echo " Subscription: $SUB_NAME"
echo " Deadletter topic: $TOPIC_DEADLETTER"
echo ""
# --- Step 5: Log sink ---
echo "Step 5: Creating log sink ($MODE mode)..."
SINK_EXCLUSION_FILTER='resource.type="dataflow_step" AND resource.labels.job_name=~"^betterstack-logs-"'
if [ "$MODE" = "org" ]; then
gcloud logging sinks create "$SINK_NAME" \
"pubsub.googleapis.com/projects/${PROJECT}/topics/${TOPIC_NAME}" \
--organization="$ORG_ID" --include-children \
--exclusion="name=exclude-betterstack-dataflow,filter=${SINK_EXCLUSION_FILTER}" \
--quiet 2>/dev/null || true
WRITER=$(gcloud logging sinks describe "$SINK_NAME" \
--organization="$ORG_ID" --format='value(writerIdentity)')
echo " Sink: $SINK_NAME (org-level, all projects)"
else
gcloud logging sinks create "$SINK_NAME" \
"pubsub.googleapis.com/projects/${PROJECT}/topics/${TOPIC_NAME}" \
--project="$PROJECT" \
--exclusion="name=exclude-betterstack-dataflow,filter=${SINK_EXCLUSION_FILTER}" \
--quiet 2>/dev/null || true
WRITER=$(gcloud logging sinks describe "$SINK_NAME" \
--project="$PROJECT" --format='value(writerIdentity)')
echo " Sink: $SINK_NAME (project-level)"
fi
echo " Exclusion: betterstack-logs-* dataflow job logs"
# The logging service account may take a moment to propagate after sink creation
for i in 1 2 3 4 5; do
if gcloud pubsub topics add-iam-policy-binding "$TOPIC_NAME" \
--member="$WRITER" --role=roles/pubsub.publisher \
--project="$PROJECT" --quiet > /dev/null 2>&1; then
break
fi
echo " Waiting for logging service account to propagate (attempt $i/5)..."
sleep 10
done
echo " Writer: $WRITER"
echo ""
# --- Step 6: Launch Dataflow job ---
echo "Step 6: Launching Dataflow job..."
# Check if a matching job is already running
EXISTING_JOB=$(gcloud dataflow jobs list --region="$REGION" --project="$PROJECT" \
--filter="name~^${DATAFLOW_PREFIX} AND state=Running" --format='value(JOB_ID)' 2>/dev/null || true)
if [ -n "$EXISTING_JOB" ]; then
echo " Dataflow job already running: $EXISTING_JOB (skipping)"
else
gcloud dataflow flex-template run "${DATAFLOW_PREFIX}-$(date +%Y%m%d-%H%M%S)" \
--template-file-gcs-location="gs://betterstack/pubsub-to-betterstack.json" \
--region="$REGION" --project="$PROJECT" \
--service-account-email="$DATAFLOW_SA_EMAIL" \
--parameters="input_subscription=projects/${PROJECT}/subscriptions/${SUB_NAME}" \
--parameters="better_stack_source_token=${SOURCE_TOKEN}" \
--parameters="better_stack_ingesting_host=${INGESTING_HOST}" \
--parameters="batch_size=${BATCH_COUNT}"
fi
echo ""
# --- Summary ---
echo "==================================="
echo "Setup complete!"
echo "==================================="
echo ""
echo " Project: $PROJECT"
echo " Service account: $SA_EMAIL"
echo " Impersonated by: $BETTERSTACK_SA"
if [ "$MODE" = "org" ]; then
echo " Log sink: $SINK_NAME (org-level, all projects)"
else
echo " Log sink: $SINK_NAME (project-level)"
fi
echo " Dataflow job: running in $REGION"
echo ""
echo "Configure in Better Stack with:"
echo " Project ID: $PROJECT"
echo " Project Number: $PROJECT_NUMBER"
echo ""
TEARDOWN_CMD="./setup.sh --teardown --project=$PROJECT --ingesting-host=$INGESTING_HOST"
[ -n "$ORG_ID" ] && TEARDOWN_CMD="$TEARDOWN_CMD --org-id=$ORG_ID"
echo "To remove everything:"
echo " $TEARDOWN_CMD"