scheetz/mayu

Mayu helps you to provision a cluster of bare metal machines with CoreOS

Mayu

Mayu provides a set of mechanisms to bootstrap PXE-enabled bare metal nodes that must follow a specific configuration with CoreOS. It sets up fleet meta-data, and patched versions of fleet, etcd, and docker when using Yochu.

Prerequisites

Mayu requires some basic configuration and layer 2 connectivity to the rest of the nodes. Usually the cluster’s management node is used for this. The management node acts as a PXE server and should support three kinds of requests from the rest of the nodes: PXE, DHCP, and bootp. The rest of the nodes should be configured to boot via ethernet by default and share a network segment with the management node, so they get the PXE boot data from the management node on DHCP request.

You need dnsmasq (>= 2.75) installed. Make sure dnsmasq is not running via an init script or systemd after you installed it, as mayu starts its own dnsmasq. In case you don't want to care about this, you maybe want to use the docker image, where the dependency is built in. This eases the setup.

Further, mayu will keep track of all changes to the cluster by making git commits. This is a feature for production systems and requires git (> 1.7.4) installed. Use the -no-git flag when starting mayu to turn this feature off.

Developing Mayu requires the following tools to be installed.

• wget
• go-bindata
• cpio

Getting Mayu

Download the latest release from here: https://github.com/giantswarm/mayu/releases/latest

Clone the latest git repository version from here: https://github.com/giantswarm/mayu.git

Get the latest docker image from here: https://hub.docker.com/r/giantswarm/mayu/

Running Mayu

Configuring Mayu is explained in docs/configuration.md. After configuration have a look at docs/running.md on how to start Mayu.

Further Steps

Check more detailed documentation: docs

Check code documentation: godoc

Future Development

• Future directions/vision

Contact

• Mailing list: giantswarm
• IRC: #giantswarm on freenode.org
• Bugs: issues

Contributing & Reporting Bugs

See CONTRIBUTING for details on submitting patches, the contribution workflow as well as reporting bugs.

License

Mayu is under the Apache 2.0 license. See the LICENSE file for details.

Origin of the Name

mayu (まゆ[繭] pronounced "mah-yoo") is Japanese for cocoon.