Mayu helps you to provision a cluster of bare metal machines with CoreOS Container Linux
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
client
docs
files
fs
hostmgr
httputil
logging
pxemgr
scripts
static_html
templates
tftproot
vendor
.gitignore
CONTRIBUTING.md
Dockerfile
Gopkg.lock
Gopkg.toml
LICENSE.md
README.md
config.yaml.dist
flag.go
main.go
main_test.go
version.go

README.md

CircleCI Go Report Card Docker Repository on Quay

Mayu

Mayu provides a set of mechanisms to bootstrap PXE-enabled bare metal nodes that must follow a specific configuration with Container Linux.

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.

Developing Mayu requires the following tools to be installed.

  • wget
  • go-bindata
  • cpio

Getting Mayu

Get the latest Docker image here: https://quay.io/repository/giantswarm/mayu

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

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

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.