Artsy Docker Development Toolkit
Hokusai works with Kubernetes and Docker to manage a container driven workflow, from development to testing and deployment.
If you use homebrew, install Docker for Mac with: brew tap caskroom/cask && brew cask install docker
If you installed Docker for Mac, docker-compose is also installed. Otherwise install with: pip install docker-compose.
Install with: pip install awscli. Set the $AWS_ACCESS_KEY_ID and $AWS_SECRET_ACCESS_KEY and $AWS_REGION environment variables. You should have permissions to evaluate the aws ecr get-login comamnd for your ECR region and push access to your ECR repositories.
Install Hokusai with pip install . and hokusai will be installed on your PATH.
Ensure the environment variables $AWS_ACCESS_KEY_ID, $AWS_SECRET_ACCESS_KEY, $AWS_REGION and optionally, $AWS_ACCOUNT_ID are set in your shell.
Now run hokusai install to install Hokusai's dependencies. You'll need to provide the S3 bucket name and key of your org's kubectl config file.
To upgrade to the latest changes in this repo, run pip install --upgrade .
hokusai --help
hokusai {command} --help
You can add -v (Verbose) to any command which will show you details of the commands Hokusai will run.
hokusai install- installs and configures kubectl
Required options:
--s3-bucket: The S3 bucket containing your org's kubectl config file--s3-key: The S3 key of your org's kubectl config file
hokusai init- Writes hokusai project config tohokusai/config.yml, creates test, development and production yaml files alongside it, and adds a Dockerfile to the current directory.
Required options:
--aws-account-id: Your AWS account ID - can be found in your AWS account console.--framework: Either "rack" or "nodejs".--base-image: The base docker image for the projectDockerfile- i.e. "ruby:2.2" or "ruby:2.2-alpine" - see Docker Hub for valid base images.
hokusai check- Checks that Hokusai dependencies are correctly installed and configured for the current project
hokusai dev- Boot a development stack as defined inhokusai/development.yml.hokusai test- Boot a testing stack as defined inhokusai/test.ymland exits with the return code of the test command.
hokusai build- Build the latest docker image for the project.hokusai pull- Pull images for your project from your AWS ECR repo.hokusai push- Push a locally built image to your AWS ECR repo.hokusai images- List all project images in your local docker registry.
Hokusai uses kubectl to connect to Kubernetes. You first need to make sure kubectl is installed and you have proper config setup for connecting to your Kubernetes. Hokusai install commands provide basic setup for this:
hokusai install --helpRecommended approach is to upload your kubectl config to S3 and use following command to install it:
hokusai install --s3-bucket <bucket name> --s3-key <file key>hokusai config pull- Pulls config from the Kubernetes server and writes to thehokusaidirectory.hokusai config push- Pushes config from the hokusai directory to the Kubernetes server. Config is created for the project as the Kubernetes ConfigMap object{project}-config
hokusai secrets get- Prints secrets stored on the Kubernetes serverhokusai secrets set- Sets secrets on the Kubernetes server. Secrets are stored for the project as key-value pairs in the Kubernetes Secret object{project}-secretshokusai secrets unset- Removes secrets stored on the Kubernetes server
hokusai stack up- Launch a stack for a given Kubernetes context.hokusai stack down- Delete a stack defined for a given Kubernetes context.hokusai stack status- Print the stack status.
hokusai deploy- Update the Kubernetes deployment to a given image tag.hokusai promote- Update the Kubernetes deployment in a given context to match the deployment in another context
hokusai console- Launch a container and attach a shell session.hokusai run- Launch a container and run a given command. It exits with the status code of the command run in the container (useful forraketasks, etc).