airship-in-a-bottle/doc/source/index.rst
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

2.2 KiB

Note

These documents will be reworked to reflect the changes associated with becoming an OpenStack hosted project: Airship. Expect major changes to occur with time. See more at airshipit.org

Airship

Airship is a collection of components that coordinate to form a means of configuring, deploying and maintaining a Kubernetes environment using a declarative set of yaml documents. More details on using parts of Airship may be found by using the Treasuremap

Approach

Airship revolves around the setup and use of Kubernetes and Helm and takes cues from these projects. The first use case of Airship is the deployment of OpenStack-Helm which also influences Airship's direction.

Building this Documentation

Use of sphinx-build -b html docs/source docs/build will build a html version of this documentation that can be viewed using a browser at docs/build/index.html on the local filesystem.

Specification Details

Proposed, approved, and implemented specifications for Airship projects are available.

Conventions and Standards

conventions security/guide dev-getting-started