airship
/
drydock
Code Issues Proposed changes
A declarative host provisioning system.
221 Commits 2 Branches 0 Tags 9.5 MiB
Python 97.2%
Go 1.3%
Shell 0.8%
Smarty 0.3%
Makefile 0.3%
Go to file
Scott Hussey 48a1f54966 Create a base getting started guide 
Update README

Add dependencies
Add link to Getting Started

Document format fixes

Change-Id: I768bee88bc4776c06b1c1dcc1435c41e899cbed2
 		2017-08-07 12:55:31 -05:00
docs Create a base getting started guide 2017-08-07 12:55:31 -05:00
drydock_provisioner Remove errant line in comment 2017-07-21 16:31:21 -05:00
examples Update unimplemented function with message 2017-07-19 13:21:44 -05:00
tests Additional unit tests for REST client 2017-07-19 13:21:44 -05:00
.gitignore Adding Python .gitignore 2017-06-12 15:41:12 +01:00
Dockerfile Fix some docker image issues preventing startup 2017-07-19 13:21:44 -05:00
LICENSE Initial commit 2017-02-14 17:23:35 -05:00
README.md Create a base getting started guide 2017-08-07 12:55:31 -05:00
entrypoint.sh Fix some docker image issues preventing startup 2017-07-19 13:21:44 -05:00
requirements-direct.txt Add click dependency 2017-07-21 13:47:17 -05:00
requirements-test.txt Add DrydockClient unit tests 2017-07-19 13:20:26 -05:00
setup.py Add task commands to CLI with basic functionality 2017-07-19 13:21:44 -05:00
tox.ini Update tox with new requirements 2017-07-19 13:20:26 -05:00

README.md

drydock_provisioner

A python REST orchestrator to translate a YAML host topology to a provisioned set of hosts and provide a set of cloud-init post-provisioning instructions.

To build and run, first move into the root directory of the repo and run:

$ sudo docker build . -t drydock
$ sudo docker run -d -v $(pwd)/examples:/etc/drydock -P --name='drydock' drydock
$ DDPORT=$(sudo docker port drydock 8000/tcp | awk -F ':' '{ print $NF }')
$ curl -v http://localhost:${DDPORT}/api/v1.0/designs

To be useful, Drydock needs to operate in a realistic topology and has some required downstream services.

  • A VM running Canonical MaaS v2.2+
  • Docker running to start the Drydock image (can be co-located on the MaaS VM)
  • A second VM or Baremetal Node to provision via Drydock
    • Baremetal needs to be able to PXE boot
    • Preferrably Baremetal will have an IPMI OOB interface
    • Either VM or Baremetal will need to have one interface on the same L2 network (LAN or VLAN) as the MaaS VM

See the Getting Started guide for instructions.

Modular service

Design Consumer

aka ingester

Pluggable service to ingest a inventory/design specification, convert it to a standard internal representaion, and persist it to the Design State API. Initial implementation is the consumer of YAML schema.

Design State API

aka statemgmt

API for querying and updating the current design specification and persisted orchestration status. CRUD support of CIs that are not bootstrap-related, but can be used by other automation.

Control API

aka control

User-approachable API for initiating orchestration actions or accessing other internal APIs

Infrastructure Orchestrator

aka orchestrator

Handle validation of complete design, ordering and managing downstream API calls for hardware provisioning/bootstrapping

OOB Driver

Pluggable provider for server OOB (ILO) management

aka driver/oob

Node Driver

aka driver/node

Pluggable provisioner for server bootstrapping. Initial implementation is MaaS client.

Introspection API

aka introspection

API for bootstrapping nodes to load self data. Possibly pluggable as this is basically an authenticated bridge to the Design State API