Brickdoc App Engine

This is an internal project of Brickdoc LTD and all APIs are subject to change without notice. Not recommended for production use for external users.

Brickdoc App Engine is a MicroPaaS based on kubernetes, inspired by rancher/rio. It is designed to reduce the workload for developers deploying lightweight applications in kubernetes.

Philosophy

• Git as a single source of truth
• Continuous Deployment with Github Actions
• Convention over Configuration
• Optimize for programmer happiness

Quick Start example

---
name: Example Continuous Deployment
on:
  push:
    paths:
      # for monorepo
      - 'packages/some-package/**'
    branches:
      - master
      - main
jobs:
  cancel:
    # Cancel any previous CI runs to save GitHub Actions minutes
    name: 'Cancel Previous Runs'
    runs-on: ubuntu-latest
    timeout-minutes: 3
    steps:
      - uses: styfle/[email protected]
        with:
          access_token: ${{ github.token }}
  build:
    name: 'Build and Push Docker Image'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout the codebase
        uses: actions/checkout@v2
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v1
      - name: Login to GitHub Container Registry
        uses: docker/login-action@v1
        with:
          username: $USERNAME
          password: $PASSWORD
      - name: Cache Docker layers
        uses: actions/cache@v2
        with:
          path: /tmp/.buildx-cache
          key: somePackage-${{ runner.os }}-buildx-${{ github.sha }}
          restore-keys: |
            somePackage-${{ runner.os }}-buildx-
      - name: Build and push
        uses: docker/build-push-action@v2
        with:
          push: true
          tags: org/some-package:latest
          cache-from: type=local,src=/tmp/.buildx-cache
          cache-to: type=local,dest=/tmp/.buildx-cache-new
          # monorepo use only
          context: ./packages/some-package
          file: ./packages/some-package/Dockerfile
        # Temp fix
        # https://github.com/docker/build-push-action/issues/252
        # https://github.com/moby/buildkit/issues/1896
      - name: Move cache
        run: |
          rm -rf /tmp/.buildx-cache
          mv /tmp/.buildx-cache-new /tmp/.buildx-cache
  deploy:
    name: 'Deployment to BAE'
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deployment to App Engine
        uses: brickdoc/[email protected]
        with:
          name: some-package
          token: ${{ secrets.GITHUB_TOKEN }}
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.awsAccessKey }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.awsAccessSecret }}
          APP_ENV_NODE_ENV: production
          APP_SECRET_MASTER_KEY: ${{ secrets.SuperSecret }}

Parameters

Environment Variables

• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY
• AWS_DEFAULT_REGION
• AWS_EKS_CLUSTER
• APP_ENV_*
• APP_SECRET_*

Inputs

Name	Type	Description
type	"web" or "service"	Required. App type. default value is "web"
name	String	Required. App name.
namespace	String	Required. kubernetes namespace. default value is "cicd"
token	String	Github Token. create Deployment status.
image	String	Docker image with tag. defualt value is ghcr.io/${github-org}/${name}:latest
host	String	Website ingress host. default value is ${name}.${ENV.BAE_DOMAIN}
chart	String	Helm charts. default value is /charts/bae-simple-web
containerPort	String	Container server port. default value is "3000"
task	"deploy" or "remove"	Helm action. default value is "deploy"
extraArgs	String	Extra Arguements for helm command

Adavance Usage

Preview Environment

A preview environment is an ephemeral environment created with the code of your pull request. It provides a realistic environment for testing and debugging.The preview environment will be updated on each commit, and finally destroyed when the pull request is merged or closed.

name: updtaed-preview-environment-example

on:
  pull_request:
    types: [opend, synchronize]
jobs:
  update_preview:
    runs-on: ubuntu-latest
    steps:
      # ...
      - name: Deployment to BAE
        uses: brickdoc/app-engine@v1
        with:
          name: example-pr${{ github.event.pull_request.number}}
          host: example-pr${{ github.event.pull_request.number}}.brickdoc.dev
          token: ${{ secrets.GITHUB_TOKEN }}
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.awsAccessKey }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.awsAccessSecret }}

name: destroyed-preview-environment-example

on:
  pull_request:
    types: [closed]
jobs:
  update_preview:
    runs-on: ubuntu-latest
    steps:
      # ...
      - name: Destoryed BAE app
        uses: brickdoc/app-engine@v1
        with:
          name: example-pr${{ github.event.pull_request.number}}
          task: 'remove'
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.awsAccessKey }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.awsAccessSecret }}

Supported kubernetes distribution

• Amazon EKS

License

Copyight (c) 2021 Brickdoc Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.