pr

README

Maintainer: Nick Schuch

Overview

M8s is a CLI and API for building temporary environments in Kubernetes.

Often in your CI/CD workflows, you want a real environment to run automated or manual tests. For example, you might want to preview changes you are making in a branch or Pull Request. m8s provides a simple tool for acheiving this. It takes a docker compose file, and translates that into a pod definition Kubernetes understands, and deploys it on Kubernetes. The pod is ephemeral, meaning it's not meant to stick around for long, and any data will be deleted once the pod is removed.

Getting Started

To get started you will need 1 of each of the following:

Cluster

Kubernetes and the M8s API server running.

• GKE (Easy|Comprehensive)
• Openshift - Coming soon...
• Kops - Coming soon...

Pipelines

A continuous integration service / setup which will send information to the M8s API.

• CircleCI
• Bitbucket Pipelines - Coming soon...
• Jenkins - Coming soon...
• TravisCI - Coming soon...

Projects

Example implementations for applications.

• Drupal

Documentation

• User Interface
• Cache
• Solr
• Mailhog

Acknowledgements

Built in partnership with:

• Transport for NSW - https://www.transport.nsw.gov.au

Developing m8s

Roadmap

Our product roadmap can be found here

Getting Started

If you wish to work on m8s or any of its built-in systems, you will first need Go installed on your machine.

Local Development

Run Kubernetes

To start Kubernetes, run:

docker-compose up

This environment is provided by K3s

Start the M8s server

Now that the Kubernetes cluster is up, it's time to run the m8s server.

The following command will start the m8s server and connect it to the Kubernetes cluster.

make run

Run a test build

It is now time to run a build.

From the project of your choosing, here is an example command you can run:

$ m8s build --name=example \
            --domains=www.example.com \
            --token=123456789 \
            --api=127.0.0.1:8443 \
            --git-revision=xxxxxxxxxxxxxxxxxxxxxxxx \
            --git-repository=https://github.com/org/example \
            --insecure

Things which will need to be updated:

• Name, give the build a better name
• Git Revision
• Git Repository. For private repositories you can include the https://user:password@github.com/org/example syntax.

Also note the use of --insecure because we don't have certificates.

Dependencies

m8s stores its dependencies under vendor/, which Go 1.6+ will automatically recognize and load. We use dep to manage the vendored dependencies.

If you're developing m8s, there are a few tasks you might need to perform.

For details, see:

• Adding a dependency
• Updating a dependency

Tooling

• Dependency management - https://github.com/golang/dep
• Build - https://github.com/mitchellh/gox
• Linting - https://github.com/golang/lint
• GitHub Releases - https://github.com/tcnksm/ghr

Common Tasks

Adding a dependency

If you're adding a dependency, you'll need to vendor it in the same Pull Request as the code that depends on it. You should do this in a separate commit from your code, as makes PR review easier and Git history simpler to read in the future.

To add a dependency:

Assuming your work is on a branch called my-feature-branch, the steps look like this:

1. Vendor the new dependency.

   dep ensure -add github.com/foo/bar
   

2. Review the changes in git and commit them.

Updating a dependency

To update a dependency:

1. Update the dependency.

   dep ensure -update github.com/foo/bar
   

2. Review the changes in git and commit them.

Running quality checks

make lint test

Building binaries

make build

Release

Release artifacts are pushed to the github releases page when tagged properly. Use semantic versioning prefixed with v for version scheme. Examples:

• v1.0.0
• v1.1.0-beta1