lourenco/mgmt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
3261c405bd468668787880dd306d0bd18f347b7d
mgmt/docs/quick-start-guide.md
goberghen 5dfdb5b5f9 docs: Fix headers formating
2017-01-22 16:05:27 +06:00

5.1 KiB
Raw Blame History

mgmt

mgmt quick start guide

Available from:

https://github.com/purpleidea/mgmt/

This documentation is available in: Markdown or PDF format.

Table of Contents

  1. Introduction
  2. Dependencies
  3. Quick start
  4. Examples
  5. Installation
  6. Authors - Authors and contact information

Introduction:

This guide is intended for developers. Once mgmt is minimally viable, we'll publish a quick start guide for users too. In the meantime, please contribute! If you're brand new to mgmt, it's probably a good idea to start by reading the introductory article or to watch an introductory video. Once you're familiar with the general idea, please start hacking...

Dependencies:

Software projects have a few different kinds of dependencies. There are build dependencies, runtime dependencies, and additionally, a few extra dependencies required for running the test suite.

Build

  • golang 1.6 or higher (required, available in most distros)
  • golang libraries (required, available with go get ./...) a partial list includes:
github.com/coreos/etcd/client
gopkg.in/yaml.v2
gopkg.in/fsnotify.v1
github.com/urfave/cli
github.com/coreos/go-systemd/dbus
github.com/coreos/go-systemd/util
github.com/libvirt/libvirt-go
  • stringer (optional), available as a package on some platforms, otherwise via go get
golang.org/x/tools/cmd/stringer
  • pandoc (optional), for building a pdf of the documentation

Runtime

A relatively modern GNU/Linux system should be able to run mgmt without any problems. Since mgmt runs as a single statically compiled binary, all of the library dependencies are included. It is expected, that certain advanced resources require host specific facilities to work. These requirements are listed below:

Resource Dependency Version
file inotify ?
hostname systemd-hostnamed ?
nspawn systemd-nspawn ?
pkg packagekitd ?
svc systemd ?
virt libvirtd ?

For building a visual representation of the graph, graphviz is required.

Testing

  • golint github.com/golang/lint/golint

Quick start:

  • Make sure you have golang version 1.6 or greater installed.
  • If you do not have a GOPATH yet, create one and export it:
mkdir $HOME/gopath
export GOPATH=$HOME/gopath
  • You might also want to add the GOPATH to your ~/.bashrc or ~/.profile.
  • For more information you can read the GOPATH documentation.
  • Next download the mgmt code base, and switch to that directory:
go get -u github.com/purpleidea/mgmt
cd $GOPATH/src/github.com/purpleidea/mgmt
  • Run make deps to install system and golang dependencies. Take a look at misc/make-deps.sh for details.
  • Run make build to get a freshly built mgmt binary.
  • Run time ./mgmt run --yaml examples/graph0.yaml --converged-timeout=5 --tmp-prefix to try out a very simple example!
  • To run continuously in the default mode of operation, omit the --converged-timeout option.
  • Have fun hacking on our future technology!

Examples:

Please look in the examples/ folder for some examples!

Installation:

Installation of mgmt from distribution packages currently needs improvement. At the moment we have:

Please contribute more! We'd especially like to see a Debian package!

Authors

Copyright (C) 2013-2016+ James Shubin and the project contributors

Please see the AUTHORS file for more information.