Skip to content

Latest commit

 

History

History
139 lines (82 loc) · 2.9 KB

Getting_Started.md

File metadata and controls

139 lines (82 loc) · 2.9 KB
Raw

Getting Started

Here's how to setup Hokusai and use it for say a Rails project.

We assume you have already installed Hokusai and the Setup steps have been performed.

Bootstrap Hokusai for a Rails project

cd ./path/to/my/git/rails/project
hokusai setup

It will:

  • Create an AWS Elastic Container Registry (ECR) repository for the project
  • Create the following example files under the project's root dir
    • Dockerfile
    • .dockerignore
  • Create the following example files under the project's root dir
    • hokusai/config.yml
    • hokusai/build.yml
    • hokusai/development.yml
    • hokusai/test.yml
    • hokusai/staging.yml
    • hokusai/production.yml

For a description of the YAML files, please see Hokusai Files.

Check that Hokusai is correctly configured for your project

hokusai check

It will run a series of tests and warn you of any problems.

Run the development environment

hokusai dev start

It will build a Docker image, then start a Docker Compose environment defined by (project)/hokusai/development.yml

If no errors, interact with the running environment with:

hokusai dev status
hokusai dev logs
hokusai dev run bash

Shut down the environment with:

hokusai dev stop

Since stop does not delete container filesystems, run this to delete them:

hokusai dev clean

Run the test suite in the test environment

hokusai test

It will build a Docker image, start a Docker Compose environment defined by (project)/hokusai/test.yml, run the defined test command in the main container (i.e. the one named after the project) to completion, and return its exit code.

Build and push an image to ECR

hokusai registry push

It will build and push an image to ECR. By default, it tags the image as the SHA1 of the HEAD of your current Git branch. The command will also tag the image as latest.

Once the image is pushed, list it and its tags in the registry with:

hokusai registry images

Create the Kubernetes staging environment

hokusai staging create

Check resources with:

hokusai staging status

Show logs with:

hokusai staging logs

Set Kubernetes staging environment variables

hokusai staging env set FOO=bar

Make pods pick up the change by:

hokusai staging refresh

Create the Kubernetes production environment

hokusai production create
hokusai production status
hokusai production logs

Set Kubernetes production environment variables

hokusai production env set FOO=bar

Make pods update by:

hokusai production refresh

Deploy changes to the Kubernetes staging environment

Make a commit, build new image, and push it to the registry, as mentioned above.

Deploy the new commit to staging with:

hokusai staging deploy {TAG}

where TAG is the tag of the commit you just made.

Promote the tag deployed on staging to production

hokusai pipeline promote