feat(v0.9): add initial migration framework (#338)

migrations/v0.9/DOCS.md

@@ -0,0 +1,131 @@
+# Documentation
+
+This document intends to provide information on how to get the Vela migration utility running locally.
+
+## Prerequisites
+
+* [Docker](https://docs.docker.com/install/) - building block for local development
+* [Golang](https://golang.org/dl/) - for source code and [dependency management](https://github.com/golang/go/wiki/Modules)
+* [Make](https://www.gnu.org/software/make/) - start up local development
+
+## Setup
+
+> NOTE: Please review the [prerequisites section](#prerequisites) before moving forward.
+* Clone this repository to your workstation:
+
+```sh
+# clone the project
+git clone git@github.com:go-vela/community.git $HOME/go-vela/community
+```
+
+* Navigate to the repository code:
+
+```sh
+# change into the project directory
+cd $HOME/go-vela/community/migrations/v0.9
+```
+
+* Set the environment variables for the database driver and configuration string in your local terminal:
+
+```sh
+# set the driver for the Vela database
+export VELA_DATABASE_DRIVER=<database driver from Vela server>
+# set the configuration string for the Vela database
+export VELA_DATABASE_CONFIG=<database config from Vela server>
+```
+
+* (OPTIONAL) Set the environment variables for the other database configuration in your local terminal:
+
+```sh
+# set the total number of open connections for the database (default: 0 - no limit)
+export VELA_DATABASE_CONNECTION_OPEN=<database connection open from Vela server>
+# set the total number of idle connections for the database (default: 2)
+export VELA_DATABASE_CONNECTION_IDLE=<database connection idle from Vela server>
+# set the duration for the life of the database connections (default: 30m)
+export VELA_DATABASE_CONNECTION_LIFE=<database connection life from Vela server>
+```
+
+## Start
+
+> NOTE: Please review the [setup section](#setup) before moving forward.
+This section covers the commands required to get the Vela application running locally.
+
+* Navigate to the repository code:
+
+```sh
+# change into the project directory
+cd $HOME/go-vela/community/migrations/v0.9
+```
+
+### CLI
+
+This method of running the application uses the Golang binary built from the source code.
+
+* Build the Golang binary targeting different operating systems and architectures:
+
+```sh
+# execute the `build` target with `make`
+make build
+# This command will output binaries to the following locations:
+#
+# * $HOME/go-vela/community/migrations/v0.9/release/darwin/amd64/vela-migration
+# * $HOME/go-vela/community/migrations/v0.9/release/linux/amd64/vela-migration
+# * $HOME/go-vela/community/migrations/v0.9/release/linux/arm64/vela-migration
+# * $HOME/go-vela/community/migrations/v0.9/release/linux/arm/vela-migration
+# * $HOME/go-vela/community/migrations/v0.9/release/windows/amd64/vela-migration
+```
+
+* Run the Golang binary for the specific operating system and architecture:
+
+```sh
+# run the Go binary for a Darwin (MacOS) operating system with amd64 architecture
+release/darwin/amd64/vela-migration
+# run the Go binary for a Linux operating system with amd64 architecture
+release/linux/amd64/vela-migration
+# run the Go binary for a Linux operating system with arm64 architecture
+release/linux/arm64/vela-migration
+# run the Go binary for a Linux operating system with arm architecture
+release/linux/arm/vela-migration
+# run the Go binary for a Windows operating system with amd64 architecture
+release/windows/amd64/vela-migration
+```
+
+### Docker
+
+This method of running the application uses a Docker container built from the `Dockerfile`.
+
+* Build the Docker image:
+
+```sh
+# execute the `docker-build` target with `make`
+make docker-build
+# This command is functionally equivalent to:
+#
+# docker build --no-cache -t target/vela-migration:local .
+```
+
+* Run the Docker image
+
+```sh
+# execute the `run` target with `make`
+make run
+# This command is functionally equivalent to:
+#
+# docker run --rm \
+#   -e VELA_ACTION_ALL=true \
+#   -e VELA_CONCURRENCY_LIMIT \
+#   -e VELA_DATABASE_DRIVER \
+#   -e VELA_DATABASE_CONFIG \
+#   -e VELA_DATABASE_CONNECTION_OPEN \
+#   -e VELA_DATABASE_CONNECTION_IDLE \
+#   -e VELA_DATABASE_CONNECTION_LIFE \
+#   -e VELA_DATABASE_ENCRYPTION_KEY \
+#   target/vela-migration:local
+```
+
+## Usage
+
+> NOTE: Please review the [start section](#start) before moving forward.
+This utility supports invoking the following actions when migrating to `v0.9.x`:
+
+* `action.all` - run all supported actions configured in the migration utility

migrations/v0.9/Dockerfile

@@ -0,0 +1,36 @@
+# Copyright (c) 2021 Target Brands, Inc. All rights reserved.
+#
+# Use of this source code is governed by the LICENSE file in this repository.
+
+################################################################################
+## docker build --no-cache --target binary -t target/vela-migration:binary .  ##
+################################################################################
+
+FROM golang:latest as binary
+
+COPY . /opt/go-vela/community
+
+WORKDIR /opt/go-vela/community
+
+RUN make clean
+
+RUN make build-linux-static
+
+################################################################################
+##  docker build --no-cache --target binary -t target/vela-migration:certs .  ##
+################################################################################
+
+FROM alpine as certs
+
+RUN apk add --update --no-cache ca-certificates
+
+################################################################################
+##  docker build --no-cache --target binary -t target/vela-migration:local .  ##
+################################################################################
+
+FROM scratch
+
+COPY --from=binary /opt/go-vela/community/release/linux/amd64/vela-migration /bin/vela-migration
+COPY --from=certs /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt
+
+CMD ["/bin/vela-migration"]