86874eeb72
This removes the copy of AIAP documentation, and forwards the reader instead to the AIAP README from which the copy was forked. This is needed because the AIAP documentation has continued to evolve, so the deleted copy is out of date. Any changes made to the deleted document which are still relevant will need to be added to the AIAP README. Change-Id: I39a11b6edd5d4ef893d66a5e7e7be4186f895ace
113 lines
3.4 KiB
ReStructuredText
113 lines
3.4 KiB
ReStructuredText
..
|
|
Copyright 2017-2021 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.
|
|
|
|
=================================
|
|
Welcome to Airship documentation!
|
|
=================================
|
|
|
|
Airship is a collection of components that declaratively configure, deploy
|
|
and maintain a `Kubernetes`_ environment defined by `YAML`_ documents. Airship
|
|
is supported by the `OpenStack Foundation`_.
|
|
|
|
.. _OpenStack Foundation: https://www.openstack.org/foundation/
|
|
.. _Kubernetes: https://kubernetes.io/
|
|
.. _YAML: http://yaml.org/
|
|
|
|
About this Documentation
|
|
========================
|
|
|
|
Airship documentation serves the entire community with resources for users and
|
|
developers.
|
|
|
|
.. toctree::
|
|
:caption: Learn About Airship 2
|
|
:maxdepth: 1
|
|
|
|
What is Airship 2? <https://www.airshipit.org/collateral/Airship_2.0_White_Paper.pdf>
|
|
airship2/basics.rst
|
|
airship2/release-notes.rst
|
|
learn/vulnerabilities.rst
|
|
airship2/layering.rst
|
|
learn/glossary.rst
|
|
|
|
.. toctree::
|
|
:caption: Try Airship 2
|
|
:maxdepth: 1
|
|
|
|
Airship in a POD (AIAP) <https://opendev.org/airship/airshipctl/src/branch/master/tools/airship-in-a-pod>
|
|
airship2/baremetal.rst
|
|
airship2/providers.rst
|
|
|
|
.. toctree::
|
|
:caption: Develop Airship 2
|
|
:maxdepth: 1
|
|
|
|
develop/airship2-developers.rst
|
|
|
|
.. toctree::
|
|
:caption: Airship Project Documentation
|
|
:maxdepth: 1
|
|
|
|
Airship Documentation <https://docs.airshipit.org>
|
|
Airshipctl <https://docs.airshipit.org/airshipctl>
|
|
Airshipui <https://docs.airshipit.org/airshipui>
|
|
|
|
.. toctree::
|
|
:caption: Airship 1 Documentation
|
|
:maxdepth: 1
|
|
|
|
What is Airship 1? <https://www.airshipit.org/collateral/Airship_OnePager.pdf>
|
|
Airship-in-a-Bottle <https://opendev.org/airship/treasuremap/src/branch/v1.9/tools/deployment/aiab>
|
|
Airsloop: Simple Bare-Metal Airship <https://docs.airshipit.org/treasuremap/airsloop.html>
|
|
Seaworthy: Production-grade Airship <https://docs.airshipit.org/treasuremap/seaworthy.html>
|
|
Treasuremap <https://docs.airshipit.org/treasuremap>
|
|
develop/airship1-developers.rst
|
|
develop/conventions.rst
|
|
airship1/airship-1-flow.rst
|
|
|
|
Other Resources
|
|
---------------
|
|
|
|
* `Airship Blog <https://www.airshipit.org/blog>`_
|
|
* `Airship Website <https://www.airshipit.org>`_
|
|
* `Airship Wiki <https://wiki.openstack.org/wiki/Airship>`_
|
|
|
|
Get Involved
|
|
============
|
|
|
|
Join our mailing lists
|
|
----------------------
|
|
|
|
Receive Airship announcements and interact with our community on our `mailing
|
|
lists`_.
|
|
|
|
.. _mailing lists: http://lists.airshipit.org/cgi-bin/mailman/listinfo
|
|
|
|
Join our weekly calls
|
|
---------------------
|
|
|
|
Airship is constantly evolving. Contribute to the Airship design process and
|
|
day-to-day community operations in our `weekly calls`_.
|
|
|
|
.. _weekly calls: https://wiki.openstack.org/wiki/Airship#Get_in_Touch
|
|
|
|
Join our Slack workspace
|
|
------------------------
|
|
|
|
Get in touch with Airship developers and operators in our `Slack workspace`_.
|
|
|
|
.. _Slack workspace: https://airshipit.org/slack
|