airshipctl/README.rst
Drew Walters 771536304a Update stale README and reformat docs
This change updates the stale README and makes it the landing page of
our new documentation. This change also makes several formatting changes
to make our documentation fit the new docs.airshipit.org framework.

Lastly, some items from the original README have been updated for
accuracy and moved to a separate page of the documentation.

Change-Id: Iae898b36034640df4d35a430eb28fbda028f10dd
Signed-off-by: Drew Walters <andrew.walters@att.com>
2020-05-11 15:49:32 +00:00

44 lines
1.7 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Airshipctl
==========
Airshipctl is a command-line interface that enables users to manage declarative
infrastructure and software.
Airshipctl aims to provide a seamless experience for operators wishing to
leverage the best open source options such as the `Cluster API`_, `Metal
Kubed`_, Kustomize_, and kubeadm_ by providing a straight forward and easily
approachable interface.
This project is the heart of our effort to produce Airship 2.0, which has
three main evolutions from `Airship 1.0`_:
* Expand our use of entrenched upstream projects.
* Embrace Kubernetes Custom Resource Definitions (CRD) everything becomes an
object in Kubernetes.
* Make the Airship control plane ephemeral.
To learn more about the Airship 2.0 evolution, reference the
`Airship blog series`_.
Contributing
------------
Airshipctl is under active development and welcomes new developers! Please
read our `developer guide`_ to begin contributing.
We also encourage new contributors and operators alike to join us in our
`Slack workspace`_ and subscribe to our `mailing lists`_.
You can learn more about Airship on the `Airship wiki`_.
.. _Airship 1.0: https://docs.airshipit.org/treasuremap
.. _Airship blog series: https://www.airshipit.org/blog/airship-blog-series-1-evolution-towards-2.0
.. _Airship wiki: https://wiki.openstack.org/wiki/Airship
.. _Cluster API: https://github.com/kubernetes-sigs/cluster-api
.. _developer guide: https://docs.airshipit.org/airshipctl/developers.html
.. _kubeadm: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm
.. _Kustomize: https://github.com/kubernetes-sigs/kustomize
.. _mailing lists: http://lists.airshipit.org/cgi-bin/mailman/listinfo
.. _Metal Kubed: https://metal3.io
.. _Slack workspace: http://airshipit.org/slack