2019-07-02 14:15:44 +02:00
|
|
|
..
|
|
|
|
|
Copyright 2017 AT&T Intellectual Property.
|
|
|
|
|
All Rights Reserved.
|
|
|
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
|
|
|
not use this file except in compliance with the License. You may obtain
|
|
|
|
|
a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
|
|
|
License for the specific language governing permissions and limitations
|
|
|
|
|
under the License.
|
|
|
|
|
|
|
|
|
|
.. 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`_
|
2019-07-10 19:01:40 +02:00
|
|
|
|
|
|
|
|
Welcome to Airship documentation!
|
|
|
|
|
=================================
|
|
|
|
|
|
2019-07-02 14:15:44 +02:00
|
|
|
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`_
|
2019-07-10 19:01:40 +02:00
|
|
|
|
2019-07-02 14:15:44 +02:00
|
|
|
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
|
|
|
|
|
---------------------------
|
2019-07-10 19:01:40 +02:00
|
|
|
|
2019-07-02 14:15:44 +02:00
|
|
|
Use of ``make docs`` will build a html version of this documentation that can
|
|
|
|
|
be viewed using a browser at doc/build/index.html on the local filesystem.
|
2019-07-10 19:01:40 +02:00
|
|
|
|
2019-07-02 14:15:44 +02:00
|
|
|
Specification Details
|
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
|
|
Proposed, approved, and implemented specifications_ for
|
|
|
|
|
Airship projects are available.
|
|
|
|
|
|
|
|
|
|
Conventions and Standards
|
|
|
|
|
-------------------------
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 3
|
|
|
|
|
|
|
|
|
|
conventions
|
|
|
|
|
security/guide
|
|
|
|
|
dev-getting-started
|
2019-07-10 19:01:40 +02:00
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
2019-07-02 14:15:44 +02:00
|
|
|
|
|
|
|
|
.. _airshipit.org: https://airshipit.org
|
|
|
|
|
.. _Helm: https://helm.sh/
|
|
|
|
|
.. _Kubernetes: https://kubernetes.io/
|
|
|
|
|
.. _Openstack: https://www.openstack.org/
|
|
|
|
|
.. _Openstack-Helm: https://docs.openstack.org/openstack-helm/latest/
|
|
|
|
|
.. _Treasuremap: https://opendev.org/airship/treasuremap/
|
|
|
|
|
.. _yaml: http://yaml.org/
|
|
|
|
|
.. _specifications: /projects/specs
|
