-
Notifications
You must be signed in to change notification settings - Fork 4
449 lines (405 loc) · 17.5 KB
/
Copy pathdeploy.yml
File metadata and controls
449 lines (405 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
name: Deploy Dashboard
on:
push:
branches:
- staging
release:
types:
- published
workflow_dispatch:
permissions:
contents: read
env:
NODE_VERSION: "22"
AWS_EKS_PROD_CLUSTER_NAME: ${{ secrets.AWS_EKS_PROD_CLUSTER_NAME }}
AWS_EKS_PROD_REGION: ${{ secrets.AWS_EKS_PROD_REGION }}
DASHBOARD_IMAGE_REGISTRY: ${{ secrets.DASHBOARD_IMAGE_REGISTRY }}
DASHBOARD_IMAGE_REPOSITORY: ${{ secrets.DASHBOARD_IMAGE_REPOSITORY }}
DASHBOARD_KUBE_CONTAINER: ${{ secrets.DASHBOARD_KUBE_CONTAINER }}
DASHBOARD_KUBE_DEPLOYMENT: ${{ secrets.DASHBOARD_KUBE_DEPLOYMENT }}
DASHBOARD_KUBE_NAMESPACE_PROD: ${{ secrets.DASHBOARD_KUBE_NAMESPACE_PROD }}
DASHBOARD_KUBE_NAMESPACE_STAGING: ${{ secrets.DASHBOARD_KUBE_NAMESPACE_STAGING }}
DASHBOARD_APP_URL_PROD: https://knowhereto.ai
DASHBOARD_APP_URL_STAGING: https://staging.knowhereto.ai
DASHBOARD_API_URL_PROD: https://api.knowhereto.ai
DASHBOARD_API_URL_STAGING: https://api-staging.knowhereto.ai
DASHBOARD_AUTH_BASE_URL: /api/auth
DASHBOARD_AUTH_COOKIE_DOMAIN_PROD: knowhereto.ai
DASHBOARD_AUTH_COOKIE_DOMAIN_STAGING: staging.knowhereto.ai
DASHBOARD_AUTH_COOKIE_PREFIX_PROD: better-auth
DASHBOARD_AUTH_COOKIE_PREFIX_STAGING: better-auth-staging
DASHBOARD_AUTH_ALLOWED_CALLBACK_ORIGINS_PROD: https://notebook.knowhereto.ai
DASHBOARD_AUTH_ALLOWED_CALLBACK_ORIGINS_STAGING: https://notebook.staging.knowhereto.ai
DASHBOARD_POSTHOG_HOST: https://us.i.posthog.com
jobs:
migrate:
name: Run main database migration
runs-on: ubuntu-latest
needs: build-and-publish
if: ${{ github.event_name == 'release' || github.ref == 'refs/heads/staging' || github.event_name == 'workflow_dispatch' }}
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Enable pnpm
run: corepack enable
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VERSION }}
cache: pnpm
- name: Install dependencies
run: pnpm install --frozen-lockfile
- name: Run main database migration
env:
DATABASE_URL: ${{ secrets.DATABASE_MIGRATION_URL }}
shell: bash
run: |
set -euo pipefail
if [ -z "${DATABASE_URL}" ]; then
echo "::error::Missing DATABASE_MIGRATION_URL repository secret"
exit 1
fi
pnpm db:migrate
build-and-publish:
name: Build and Publish
runs-on: ubuntu-latest
steps:
- name: Validate semantic release tag
if: ${{ github.event_name == 'release' }}
shell: bash
run: |
release_tag="${{ github.event.release.tag_name }}"
semver_pattern='^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z.-]+)?$'
if [[ ! "$release_tag" =~ $semver_pattern ]]; then
echo "::error::Dashboard releases must use semantic version tags like v1.0.1. Date-based tags such as 2026.06.26.1 or v2026.06.26.1 are not supported."
exit 1
fi
- name: Checkout
uses: actions/checkout@v4
with:
persist-credentials: false
ref: ${{ github.event_name == 'release' && github.event.release.tag_name || github.ref }}
- name: Decide deployment context
id: context
shell: bash
run: |
if [ "${{ github.event_name }}" = "release" ]; then
environment="prod"
else
environment="staging"
fi
if [ "$environment" = "prod" ]; then
kube_namespace="${DASHBOARD_KUBE_NAMESPACE_PROD}"
app_url="${DASHBOARD_APP_URL_PROD}"
api_url="${DASHBOARD_API_URL_PROD}"
auth_cookie_domain="${DASHBOARD_AUTH_COOKIE_DOMAIN_PROD}"
auth_cookie_prefix="${DASHBOARD_AUTH_COOKIE_PREFIX_PROD}"
auth_allowed_callback_origins="${DASHBOARD_AUTH_ALLOWED_CALLBACK_ORIGINS_PROD}"
else
kube_namespace="${DASHBOARD_KUBE_NAMESPACE_STAGING}"
app_url="${DASHBOARD_APP_URL_STAGING}"
api_url="${DASHBOARD_API_URL_STAGING}"
auth_cookie_domain="${DASHBOARD_AUTH_COOKIE_DOMAIN_STAGING}"
auth_cookie_prefix="${DASHBOARD_AUTH_COOKIE_PREFIX_STAGING}"
auth_allowed_callback_origins="${DASHBOARD_AUTH_ALLOWED_CALLBACK_ORIGINS_STAGING}"
fi
auth_base_url="${DASHBOARD_AUTH_BASE_URL}"
missing=()
for variable_name in \
AWS_EKS_PROD_CLUSTER_NAME \
AWS_EKS_PROD_REGION \
DASHBOARD_IMAGE_REGISTRY \
DASHBOARD_IMAGE_REPOSITORY \
DASHBOARD_KUBE_CONTAINER \
DASHBOARD_KUBE_DEPLOYMENT \
api_url \
app_url \
auth_cookie_domain \
auth_cookie_prefix \
auth_allowed_callback_origins \
auth_base_url \
kube_namespace
do
if [ -z "${!variable_name}" ]; then
missing+=("$variable_name")
fi
done
if [ "${#missing[@]}" -gt 0 ]; then
printf 'Missing deployment configuration: %s\n' "${missing[*]}" >&2
exit 1
fi
short_sha="${GITHUB_SHA::8}"
if [ "${{ github.event_name }}" = "release" ]; then
release_tag="${{ github.event.release.tag_name }}"
image_tag="${release_tag}-${environment}"
else
image_tag="${environment}-${short_sha}"
fi
latest_tag="${environment}-latest"
image_uri="${DASHBOARD_IMAGE_REGISTRY}/${DASHBOARD_IMAGE_REPOSITORY}:${image_tag}"
latest_uri="${DASHBOARD_IMAGE_REGISTRY}/${DASHBOARD_IMAGE_REPOSITORY}:${latest_tag}"
echo "environment=${environment}" >> "$GITHUB_OUTPUT"
echo "image_tag=${image_tag}" >> "$GITHUB_OUTPUT"
echo "image_uri=${image_uri}" >> "$GITHUB_OUTPUT"
echo "api_url=${api_url}" >> "$GITHUB_OUTPUT"
echo "app_url=${app_url}" >> "$GITHUB_OUTPUT"
echo "auth_cookie_domain=${auth_cookie_domain}" >> "$GITHUB_OUTPUT"
echo "auth_cookie_prefix=${auth_cookie_prefix}" >> "$GITHUB_OUTPUT"
echo "auth_allowed_callback_origins=${auth_allowed_callback_origins}" >> "$GITHUB_OUTPUT"
echo "auth_base_url=${auth_base_url}" >> "$GITHUB_OUTPUT"
echo "kube_container=${DASHBOARD_KUBE_CONTAINER}" >> "$GITHUB_OUTPUT"
echo "kube_deployment=${DASHBOARD_KUBE_DEPLOYMENT}" >> "$GITHUB_OUTPUT"
echo "kube_namespace=${kube_namespace}" >> "$GITHUB_OUTPUT"
echo "latest_uri=${latest_uri}" >> "$GITHUB_OUTPUT"
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v4
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: ${{ env.AWS_EKS_PROD_REGION }}
- name: Login to AWS image registry
shell: bash
run: |
aws ecr get-login-password --region "${AWS_EKS_PROD_REGION}" \
| docker login --username AWS --password-stdin "${DASHBOARD_IMAGE_REGISTRY}"
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Build and push image
uses: docker/build-push-action@v6
with:
context: .
push: true
tags: |
${{ steps.context.outputs.image_uri }}
${{ steps.context.outputs.latest_uri }}
build-args: |
NEXT_PUBLIC_API_URL=${{ steps.context.outputs.api_url }}
AUTH_COOKIE_PREFIX=${{ steps.context.outputs.auth_cookie_prefix }}
NEXT_PUBLIC_AUTH_BASE_URL=${{ steps.context.outputs.auth_base_url }}
NEXT_PUBLIC_AUTH_ALLOWED_CALLBACK_ORIGINS=${{ steps.context.outputs.auth_allowed_callback_origins }}
NEXT_PUBLIC_APP_URL=${{ steps.context.outputs.app_url }}
NEXT_PUBLIC_POSTHOG_KEY=${{ secrets.NEXT_PUBLIC_POSTHOG_KEY }}
NEXT_PUBLIC_POSTHOG_HOST=${{ env.DASHBOARD_POSTHOG_HOST }}
cache-from: type=gha
cache-to: type=gha,mode=max
- name: Summarize image
shell: bash
run: |
echo "Environment: ${{ steps.context.outputs.environment }}"
echo "API URL: ${{ steps.context.outputs.api_url }}"
echo "App URL: ${{ steps.context.outputs.app_url }}"
echo "Auth Base URL: ${{ steps.context.outputs.auth_base_url }}"
echo "Auth Cookie Domain: ${{ steps.context.outputs.auth_cookie_domain }}"
echo "Auth Cookie Prefix: ${{ steps.context.outputs.auth_cookie_prefix }}"
echo "Auth Allowed Callback Origins: ${{ steps.context.outputs.auth_allowed_callback_origins }}"
echo "Image: ${{ steps.context.outputs.image_uri }}"
echo "Deployment: ${{ steps.context.outputs.kube_deployment }}"
echo "Namespace: ${{ steps.context.outputs.kube_namespace }}"
deploy:
name: Deploy
runs-on: ubuntu-latest
needs: [build-and-publish, migrate]
if: >-
${{ always() &&
needs.build-and-publish.result == 'success' &&
(needs.migrate.result == 'success' || needs.migrate.result == 'skipped') }}
steps:
- name: Validate semantic release tag
if: ${{ github.event_name == 'release' }}
shell: bash
run: |
release_tag="${{ github.event.release.tag_name }}"
semver_pattern='^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z.-]+)?$'
if [[ ! "$release_tag" =~ $semver_pattern ]]; then
echo "::error::Dashboard releases must use semantic version tags like v1.0.1. Date-based tags such as 2026.06.26.1 or v2026.06.26.1 are not supported."
exit 1
fi
- name: Decide deployment context
shell: bash
run: |
if [ "${{ github.event_name }}" = "release" ]; then
environment="prod"
else
environment="staging"
fi
if [ "$environment" = "prod" ]; then
kube_namespace="${DASHBOARD_KUBE_NAMESPACE_PROD}"
app_url="${DASHBOARD_APP_URL_PROD}"
api_url="${DASHBOARD_API_URL_PROD}"
auth_cookie_domain="${DASHBOARD_AUTH_COOKIE_DOMAIN_PROD}"
auth_cookie_prefix="${DASHBOARD_AUTH_COOKIE_PREFIX_PROD}"
auth_allowed_callback_origins="${DASHBOARD_AUTH_ALLOWED_CALLBACK_ORIGINS_PROD}"
else
kube_namespace="${DASHBOARD_KUBE_NAMESPACE_STAGING}"
app_url="${DASHBOARD_APP_URL_STAGING}"
api_url="${DASHBOARD_API_URL_STAGING}"
auth_cookie_domain="${DASHBOARD_AUTH_COOKIE_DOMAIN_STAGING}"
auth_cookie_prefix="${DASHBOARD_AUTH_COOKIE_PREFIX_STAGING}"
auth_allowed_callback_origins="${DASHBOARD_AUTH_ALLOWED_CALLBACK_ORIGINS_STAGING}"
fi
auth_base_url="${DASHBOARD_AUTH_BASE_URL}"
missing=()
for variable_name in \
AWS_EKS_PROD_CLUSTER_NAME \
AWS_EKS_PROD_REGION \
DASHBOARD_IMAGE_REGISTRY \
DASHBOARD_IMAGE_REPOSITORY \
DASHBOARD_KUBE_CONTAINER \
DASHBOARD_KUBE_DEPLOYMENT \
api_url \
app_url \
auth_cookie_domain \
auth_cookie_prefix \
auth_allowed_callback_origins \
auth_base_url \
kube_namespace
do
if [ -z "${!variable_name}" ]; then
missing+=("$variable_name")
fi
done
if [ "${#missing[@]}" -gt 0 ]; then
printf 'Missing deployment configuration: %s\n' "${missing[*]}" >&2
exit 1
fi
short_sha="${GITHUB_SHA::8}"
if [ "${{ github.event_name }}" = "release" ]; then
release_tag="${{ github.event.release.tag_name }}"
image_tag="${release_tag}-${environment}"
else
image_tag="${environment}-${short_sha}"
fi
image_uri="${DASHBOARD_IMAGE_REGISTRY}/${DASHBOARD_IMAGE_REPOSITORY}:${image_tag}"
echo "DEPLOY_ENVIRONMENT=${environment}" >> "$GITHUB_ENV"
echo "DEPLOY_IMAGE_URI=${image_uri}" >> "$GITHUB_ENV"
echo "DEPLOY_KUBE_CONTAINER=${DASHBOARD_KUBE_CONTAINER}" >> "$GITHUB_ENV"
echo "DEPLOY_KUBE_DEPLOYMENT=${DASHBOARD_KUBE_DEPLOYMENT}" >> "$GITHUB_ENV"
echo "DEPLOY_KUBE_NAMESPACE=${kube_namespace}" >> "$GITHUB_ENV"
echo "DEPLOY_API_URL=${api_url}" >> "$GITHUB_ENV"
echo "DEPLOY_APP_URL=${app_url}" >> "$GITHUB_ENV"
echo "DEPLOY_AUTH_COOKIE_DOMAIN=${auth_cookie_domain}" >> "$GITHUB_ENV"
echo "DEPLOY_AUTH_COOKIE_PREFIX=${auth_cookie_prefix}" >> "$GITHUB_ENV"
echo "DEPLOY_AUTH_ALLOWED_CALLBACK_ORIGINS=${auth_allowed_callback_origins}" >> "$GITHUB_ENV"
echo "DEPLOY_AUTH_BASE_URL=${auth_base_url}" >> "$GITHUB_ENV"
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v4
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: ${{ env.AWS_EKS_PROD_REGION }}
- name: Setup kubectl
uses: azure/setup-kubectl@v3
- name: Update kubeconfig
shell: bash
run: |
aws eks update-kubeconfig \
--name "${AWS_EKS_PROD_CLUSTER_NAME}" \
--region "${AWS_EKS_PROD_REGION}"
- name: Configure deployment environment
shell: bash
run: |
kubectl set env "deployment/${DEPLOY_KUBE_DEPLOYMENT}" \
"NEXT_PUBLIC_API_URL=${DEPLOY_API_URL}" \
"NEXT_PUBLIC_AUTH_BASE_URL=${DEPLOY_AUTH_BASE_URL}" \
"AUTH_COOKIE_DOMAIN=${DEPLOY_AUTH_COOKIE_DOMAIN}" \
"AUTH_COOKIE_PREFIX=${DEPLOY_AUTH_COOKIE_PREFIX}" \
"NEXT_PUBLIC_AUTH_ALLOWED_CALLBACK_ORIGINS=${DEPLOY_AUTH_ALLOWED_CALLBACK_ORIGINS}" \
"NEXT_PUBLIC_APP_URL=${DEPLOY_APP_URL}" \
--namespace "${DEPLOY_KUBE_NAMESPACE}"
- name: Attach optional newsletter database secret
shell: bash
run: |
set -euo pipefail
kubectl set env "deployment/${DEPLOY_KUBE_DEPLOYMENT}" \
NEWSLETTER_DATABASE_URL- \
--namespace "${DEPLOY_KUBE_NAMESPACE}"
newsletter_secret_patch="$(
cat <<PATCH
spec:
template:
spec:
containers:
- name: ${DEPLOY_KUBE_CONTAINER}
env:
- name: NEWSLETTER_DATABASE_URL
valueFrom:
secretKeyRef:
name: knowhere-secrets
key: newsletter-database-url
optional: true
PATCH
)"
kubectl patch "deployment/${DEPLOY_KUBE_DEPLOYMENT}" \
--namespace "${DEPLOY_KUBE_NAMESPACE}" \
--type=strategic \
--patch "${newsletter_secret_patch}"
- name: Roll out dashboard image
shell: bash
run: |
kubectl set image "deployment/${DEPLOY_KUBE_DEPLOYMENT}" \
"${DEPLOY_KUBE_CONTAINER}=${DEPLOY_IMAGE_URI}" \
--namespace "${DEPLOY_KUBE_NAMESPACE}"
kubectl rollout status "deployment/${DEPLOY_KUBE_DEPLOYMENT}" \
--namespace "${DEPLOY_KUBE_NAMESPACE}" \
--timeout=300s
- name: Summarize deployment
shell: bash
run: |
echo "Environment: ${DEPLOY_ENVIRONMENT}"
echo "Image: ${DEPLOY_IMAGE_URI}"
echo "Deployment: ${DEPLOY_KUBE_DEPLOYMENT}"
echo "Container: ${DEPLOY_KUBE_CONTAINER}"
echo "Namespace: ${DEPLOY_KUBE_NAMESPACE}"
echo "API URL: ${DEPLOY_API_URL}"
echo "App URL: ${DEPLOY_APP_URL}"
echo "Auth Base URL: ${DEPLOY_AUTH_BASE_URL}"
echo "Auth Cookie Domain: ${DEPLOY_AUTH_COOKIE_DOMAIN}"
echo "Auth Cookie Prefix: ${DEPLOY_AUTH_COOKIE_PREFIX}"
echo "Auth Allowed Callback Origins: ${DEPLOY_AUTH_ALLOWED_CALLBACK_ORIGINS}"
attach-release-assets:
name: Attach Release Assets
if: ${{ github.event_name == 'release' }}
runs-on: ubuntu-latest
needs: deploy
permissions:
contents: write
steps:
- name: Checkout released source
uses: actions/checkout@v4
with:
ref: ${{ github.event.release.tag_name }}
fetch-depth: 0
- name: Create source archive
env:
RELEASE_TAG: ${{ github.event.release.tag_name }}
DEPLOYED_SHA: ${{ github.sha }}
shell: bash
run: |
set -euo pipefail
mkdir -p release-assets
git archive --format=zip --output="release-assets/knowhere-dashboard-${RELEASE_TAG}-source.zip" "${DEPLOYED_SHA}"
cat > release-assets/build-info.json <<EOF
{
"repository": "${GITHUB_REPOSITORY}",
"release_tag": "${RELEASE_TAG}",
"deployed_commit": "${DEPLOYED_SHA}",
"workflow_run_id": "${GITHUB_RUN_ID}",
"workflow_run_url": "https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
}
EOF
- name: Upload release assets
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
RELEASE_TAG: ${{ github.event.release.tag_name }}
shell: bash
run: |
set -euo pipefail
gh release upload "${RELEASE_TAG}" \
release-assets/knowhere-dashboard-${RELEASE_TAG}-source.zip \
release-assets/build-info.json \
--repo "${GITHUB_REPOSITORY}" \
--clobber