Add quick start
This adds a small quick starts but also doesn't
run integration jobs on doc changes.
Change-Id: Id95db9c275906a530878afbb7cfbaa61c33e5b75
diff --git a/doc/source/index.rst b/doc/source/index.rst
index df83fbc..2c4161f 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -10,6 +10,7 @@
:maxdepth: 1
:caption: Contents:
+ user/index
roles/index
releasenotes
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
new file mode 100644
index 0000000..de66057
--- /dev/null
+++ b/doc/source/user/index.rst
@@ -0,0 +1,7 @@
+User Guide
+==========
+
+.. toctree::
+ :maxdepth: 1
+
+ quickstart
\ No newline at end of file
diff --git a/doc/source/user/quickstart.rst b/doc/source/user/quickstart.rst
new file mode 100644
index 0000000..300fc0f
--- /dev/null
+++ b/doc/source/user/quickstart.rst
@@ -0,0 +1,65 @@
+Quickstart
+==========
+
+The quick start intends to provide the most near-production experience possible,
+as it is architected purely towards production-only environments. In order to
+get a quick production-ready experience of Atmosphere, you will need access to
+an OpenStack cloud.
+
+The quick start is powered by Molecule and it is used in continuous integration
+running against the VEXXHOST public cloud so that would be an easy target to
+use to try it out.
+
+You will need the following quotas set up in your cloud account:
+
+ * 8 instances
+ * 32 cores
+ * 128GB RAM
+ * 360GB storage
+
+These resources will be used to create a total of 8 instances broken up as
+follows:
+
+ * 3 Controller nodes
+ * 3 Ceph OSD nodes
+ * 2 Compute nodes
+
+First of all, you'll have to make sure you clone the repository locally to your
+system with ``git`` by running the following command::
+
+ $ git clone https://opendev.org/vexxhost/ansible-collection-atmosphere
+
+You will need ``tox`` installed on your operating system, you can simply make
+sure that you have the appropriate OpenStack environment variables set (such
+as ``OS_CLOUD`` or ``OS_AUTH_URL``, etc.) and then you can run the following
+command::
+
+ $ tox -e molecule -- converge
+
+This will create a Heat stack with the name ``atmosphere`` and start deploying
+the cloud. Once it's complete, you can login to any of the systems by using
+the ``login`` sub-command. For exampel, to login to the first controller node,
+you can run the following::
+
+ $ tox -e molecule -- login -h ctl1
+
+In all the controllers, you will find an ``openrc`` file location inside the
+``root`` account home directory, as well as the OpenStack client installed there
+as well. You can use it by running the following after logging in::
+
+ $ source /root/openrc
+ $ openstack server list
+
+The Kubernetes administrator configuration will also be available on all of the
+control plane nodes, you can simply use it by running ``kubectl`` commands on
+any of the controllers as ``root``::
+
+ $ kubectl get nodes -owide
+
+Once you're done with your environment and you need to tear it down, you can
+use the ``destroy`` sub-command::
+
+ $ tox -e molecule -- destroy
+
+For more information about the different commands used by Molecule, you can
+refer to the Molecule documentation.
\ No newline at end of file
diff --git a/roles/openstack_helm_endpoints/defaults/main.yml b/roles/openstack_helm_endpoints/defaults/main.yml
index 56050cb..1fef800 100644
--- a/roles/openstack_helm_endpoints/defaults/main.yml
+++ b/roles/openstack_helm_endpoints/defaults/main.yml
@@ -10,6 +10,7 @@
# .. contents:: Sections
# :local:
+
# .. envvar:: openstack_helm_endpoints_config [[[
#
# Additional overrides for the OpenStack Helm endpoints
diff --git a/zuul.d/jobs.yaml b/zuul.d/jobs.yaml
index 8f19a49..f461374 100644
--- a/zuul.d/jobs.yaml
+++ b/zuul.d/jobs.yaml
@@ -19,6 +19,8 @@
- zuul.d/playbooks/ansible-collection-atmosphere-tox-build/post-run.yml
vars:
tox_envlist: build
+ irrelevant-files:
+ - doc/.*
- job:
name: ansible-collection-atmosphere-tox-molecule
@@ -31,6 +33,8 @@
vars:
tox_environment:
STACK_NAME: "atmosphere-{{ zuul.build }}"
+ irrelevant-files:
+ - doc/.*
- job:
name: ansible-collection-atmosphere-tox-molecule-default