feat(web): dockerize web application #1253
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| name: web-build | ||
| on: | ||
| workflow_run: | ||
| workflows: [ci-web] | ||
| types: [completed] | ||
| branches: [main, release] | ||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event.workflow_run.head_branch }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| info: | ||
| name: Collect information | ||
| runs-on: ubuntu-latest | ||
| if: github.event.workflow_run.conclusion != 'failure' && github.event.repository.full_name == 'reearth/reearth-cms' && (github.event.workflow_run.head_branch == 'release' || !startsWith(github.event.head_commit.message, 'v')) | ||
| outputs: | ||
| sha_short: ${{ steps.info.outputs.sha_short }} | ||
| new_tag: ${{ steps.info.outputs.new_tag }} | ||
| new_tag_short: ${{ steps.info.outputs.new_tag_short }} | ||
| name: ${{ steps.info.outputs.name }} | ||
| steps: | ||
| - name: checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Fetch tags | ||
| run: git fetch --prune --unshallow --tags | ||
| - name: Get info | ||
| id: info | ||
| # The tag name should be retrieved lazily, as tagging may be delayed. | ||
| env: | ||
| BRANCH: ${{ github.event.workflow_run.head_branch }} | ||
| run: | | ||
| echo "::set-output name=sha_short::$(git rev-parse --short HEAD)" | ||
| if [[ "$BRANCH" = "release" ]]; then | ||
| TAG=$(git tag --points-at HEAD) | ||
| if [[ ! -z "$TAG" ]]; then | ||
| echo "::set-output name=new_tag::$TAG" | ||
| echo "::set-output name=new_tag_short::${TAG#v}" | ||
| else | ||
| echo "::set-output name=name::rc" | ||
| fi | ||
| else | ||
| echo "::set-output name=name::nightly" | ||
| fi | ||
| - name: Show info | ||
| env: | ||
| SHA_SHORT: ${{ steps.info.outputs.sha_short }} | ||
| NEW_TAG: ${{ steps.info.outputs.new_tag }} | ||
| NEW_TAG_SHORT: ${{ steps.info.outputs.new_tag_short }} | ||
| NAME: ${{ steps.info.outputs.name }} | ||
| run: echo "sha_short=$SHA_SHORT, new_tag=$NEW_TAG, new_tag_short=$NEW_TAG_SHORT, name=$NAME" | ||
|
|
||
| docker: | ||
| name: Build and push Docker image | ||
| runs-on: ubuntu-latest | ||
| needs: | ||
| - info | ||
| if: needs.info.outputs.name || needs.info.outputs.new_tag | ||
| env: | ||
| IMAGE_NAME: reearth/reearth-cms-web | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Set up QEMU | ||
| uses: docker/setup-qemu-action@v3 | ||
| - name: Set up Docker Buildx | ||
| uses: docker/setup-buildx-action@v3 | ||
| - name: Login to DockerHub | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| username: ${{ secrets.DOCKERHUB_USERNAME }} | ||
| password: ${{ secrets.DOCKERHUB_TOKEN }} | ||
| - name: Get options | ||
| id: options | ||
| env: | ||
| TAG: ${{ needs.info.outputs.tag_short }} | ||
| NAME: ${{ needs.info.outputs.name }} | ||
| SHA: ${{ needs.info.outputs.sha_short }} | ||
| run: | | ||
| if [[ -n $TAG ]]; then | ||
| PLATFORMS=linux/amd64,linux/arm64 | ||
| VERSION=$TAG | ||
| TAGS=$IMAGE_NAME:$TAG | ||
| if [[ ! $TAG =~ '-' ]]; then | ||
| TAGS+=,${IMAGE_NAME}:${TAG%.*} | ||
| TAGS+=,${IMAGE_NAME}:${TAG%%.*} | ||
| TAGS+=,${IMAGE_NAME}:latest | ||
| fi | ||
| else | ||
| PLATFORMS=linux/amd64 | ||
| VERSION=$SHA | ||
| TAGS=$IMAGE_NAME:$NAME | ||
| fi | ||
| echo "::set-output name=platforms::$PLATFORMS" | ||
| echo "::set-output name=version::$VERSION" | ||
| echo "::set-output name=tags::$TAGS" | ||
| - name: Build and push docker image | ||
| uses: docker/build-push-action@v6 | ||
| with: | ||
| context: ./web | ||
| platforms: ${{ steps.options.outputs.platforms }} | ||
| push: true | ||
| build-args: | | ||
| GITHUB_SHA=${{ needs.info.outputs.sha_short }} | ||
| VERSION=${{ steps.options.outputs.version }} | ||
| tags: ${{ steps.options.outputs.tags }} | ||
| cache-from: type=gha | ||
| cache-to: type=gha,mode=max |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| * | ||
|
There was a problem hiding this comment. Tip Allow listing is always good and safe. |
||
|
|
||
| !docker/ | ||
| !src/ | ||
|
|
||
| !index.html | ||
| !i18next-parser.config.js | ||
| !tsconfig.json | ||
| !package.json | ||
| !vite.config.ts | ||
| !yarn.lock | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| FROM node:20.18.0-slim AS builder | ||
| WORKDIR /app | ||
|
|
||
| ARG NODE_OPTIONS="--max-old-space-size=4096" | ||
| ARG GITHUB_SHA | ||
| ENV NODE_OPTIONS=$NODE_OPTIONS | ||
| ENV GITHUB_SHA=$GITHUB_SHA | ||
|
|
||
| RUN --mount=type=bind,source=package.json,target=package.json \ | ||
| --mount=type=bind,source=yarn.lock,target=yarn.lock \ | ||
| --mount=type=cache,target=/root/.yarn,sharing=locked \ | ||
| yarn install --frozen-lockfile --production=false | ||
|
|
||
| RUN --mount=type=bind,source=package.json,target=package.json \ | ||
| --mount=type=bind,source=yarn.lock,target=yarn.lock \ | ||
| --mount=type=bind,source=index.html,target=index.html \ | ||
| --mount=type=bind,source=tsconfig.json,target=tsconfig.json \ | ||
| --mount=type=bind,source=vite.config.ts,target=vite.config.ts \ | ||
| --mount=type=bind,source=src,target=src \ | ||
| --mount=type=cache,target=/root/.yarn,sharing=locked \ | ||
| yarn build | ||
|
|
||
| FROM nginx:1.27-alpine | ||
| WORKDIR /app | ||
|
|
||
| # Quite the Nginx startup logs. | ||
| ENV NGINX_ENTRYPOINT_QUIET_LOGS=true | ||
|
|
||
| # Default to Cloud Run port. | ||
| # Ref: https://cloud.google.com/run/docs/reference/container-contract#port | ||
| ENV PORT=8080 | ||
|
|
||
| # Defaults Google Cloud Load Balancer header. | ||
| # Ref: https://cloud.google.com/load-balancing/docs/https#target-proxies | ||
| ENV REAL_IP_HEADER=X-Forwarded-For | ||
|
Comment on lines
+29
to
+35
There was a problem hiding this comment. Note IMHO, vendor-specific configurations should be configurable since we are an OSS product; in this case, we can pass |
||
|
|
||
| COPY --from=builder --chown=nginx:nginx /app/dist /usr/share/nginx/html | ||
| COPY --chown=nginx:nginx docker/nginx.conf.template /etc/nginx/templates/nginx.conf.template | ||
| COPY --chown=nginx:nginx docker/40-envsubst-on-reearth-config.sh /docker-entrypoint.d | ||
| COPY --chown=nginx:nginx docker/reearth_config.json.template /opt/reearth-cms/reearth_config.json.template | ||
|
|
||
| ENTRYPOINT ["/docker-entrypoint.sh"] | ||
| CMD ["nginx", "-g", "daemon off;"] | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| #!/bin/sh | ||
|
|
||
| set -e | ||
|
|
||
| _REEARTH_CONFIG_TEMPLATE_FILE="/opt/reearth-cms/reearth_config.json.template" | ||
| _REEARTH_CONFIG_OUTPUT_FILE="/usr/share/nginx/html/reearth_config.json" | ||
|
|
||
| envsubst < "$_REEARTH_CONFIG_TEMPLATE_FILE" > "$_REEARTH_CONFIG_OUTPUT_FILE" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| log_format json escape=json '{' | ||
| '"body_bytes_sent": "$body_bytes_sent",' | ||
| '"http_referer": "$http_referer",' | ||
| '"http_user_agent": "$http_user_agent",' | ||
| '"remote_ip": "$remote_addr",' | ||
| '"remote_user": "$remote_user",' | ||
| '"request": "$request",' | ||
| '"request_id": "$request_id",' | ||
| '"request_method": "$request_method",' | ||
| '"request_time": "$request_time",' | ||
| '"request_uri": "$request_uri",' | ||
| '"server_name": "$server_name",' | ||
| '"status": "$status",' | ||
| '"time": "$time_iso8601"' | ||
| '}'; | ||
|
Comment on lines
+1
to
+15
There was a problem hiding this comment. I accessed the container via
|
||
|
|
||
| real_ip_header ${REAL_IP_HEADER}; | ||
|
|
||
| server { | ||
| listen ${PORT}; | ||
| root /usr/share/nginx/html; | ||
| server_name _; | ||
|
|
||
| access_log /dev/stdout json; | ||
| error_log /dev/stderr warn; | ||
|
|
||
| location / { | ||
| try_files $uri /index.html =404; | ||
| } | ||
|
|
||
| error_page 500 502 503 504 /50x.html; | ||
| location = /50x.html { | ||
| root /usr/share/nginx/html; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "auth0Audience": "$AUTH0_AUDIENCE", | ||
| "auth0ClientId": "$AUTH0_CLIENT_ID", | ||
| "auth0Domain": "$AUTH0_DOMAIN" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note
I changed it so that I could remove this block entirely after verifying our new Docker image without renaming the web (Docker) job.