diff --git a/README.md b/README.md index 117de095..dd976f2d 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,13 @@ -# Airship in a Bottle +This project is no longer maintained. -Airship is a broad integration of several components -enabling an automated, resilient Kubernetes-based infrastructure for hosting -Helm-deployed containerized workloads. +The contents of this repository are still available in the Git source +code management system. To see the contents of this repository before +it reached its end of life, please check out the previous commit with +"git checkout HEAD^1". -Airship is the name for the project formerly known as UCP or the Undercloud -Platform. +For replacement code, please, refer to https://docs.airshipit.org +(Airship Treasuremap), specifically to one of the sites: Airskiff, +Airsloop, Seaworthy and others. -Find more documentation for Airship in a Bottle on -[Read the Docs](https://airshipit.readthedocs.io/). - -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://opendev.org/airship/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://opendev.org/airship/airship-in-a-bottle/raw/branch/master/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. +For any further questions, please email +airship-discuss@lists.airshipit.org or join #airshipit on Freenode.