airship-in-a-bottle/README.md
Bryan Strassner 44b38244c4 Cleanup Airship verbiage in docs
This change attempts to move the airship-in-a-bottle documentation
closer to a target state for Airship by removing references to the
Undercloud Platform. This triggered the reformating of some paragraphs,
but this change does not attempt to correct all of the information -
much more a syntactical change of the documentation than a semantic
change. Requests to correct information in any significant way will be
deferred to subsequent work.

Some completely outdated pages were removed completely, as they provided
more distraction than benefit.

Documents that were "under development" since their inception (and
nothing more than "under development") have been eliminated and may be
re-instantiated if anyone ever has anything to say about the topics, but
for now, removed the clutter.

Change-Id: Ida72b3706c894771888d8b694e1cf95d6cf810ed
2018-08-15 16:08:10 -05:00

54 lines
1.4 KiB
Markdown

# Airship in a Bottle
Airship is a broad integration of several components
enabling an automated, resilient Kubernetes-based infrastructure for hosting
Helm-deployed containerized workloads.
Airship is the name for the project formerly known as UCP or the Undercloud
Platform.
To get started, run the following in a fresh Ubuntu 16.04 VM
(minimum 4vCPU/20GB RAM/32GB disk). This will deploy Airship and Openstack Helm
(OSH):
```
sudo -i
mkdir -p /root/deploy && cd "$_"
git clone https://git.openstack.org/openstack/airship-in-a-bottle
cd /root/deploy/airship-in-a-bottle/manifests/dev_single_node
./airship-in-a-bottle.sh
```
Or, alternatively, if you have Vagrant installed, just run the following
(only libvirt/kvm hypervisor is tested, but vagrant box supports VMware
Desktop/Workstation/Fusion, Parallels, and Hyper-V):
```
curl -O https://git.airshipit.org/cgit/airship-in-a-bottle/plain/Vagrantfile
vagrant up
```
## Components
### Shipyard
Platform orchestrator for initial deployment, platform updates, and server
redeployments
### Promenade
The bootstrapper for the Kubernetes control plane - both on an initial genesis node
to get a working Kubernetes cluster and for adding additional nodes to the existing
Kubernetes cluster.
### Armada
Provisioner for Helm charts. Provides the capability to override chart values.yaml
items.
### Drydock
The orchestrator for physical asset provisioning (e.g. server deployment).
### Deckhand
YAML design data manager.