aboutsummaryrefslogtreecommitdiffstats
path: root/deployment/noheat/infra-openstack
diff options
context:
space:
mode:
Diffstat (limited to 'deployment/noheat/infra-openstack')
-rw-r--r--deployment/noheat/infra-openstack/HACKING30
-rw-r--r--[l---------]deployment/noheat/infra-openstack/HACKING.rst31
-rw-r--r--deployment/noheat/infra-openstack/README34
-rw-r--r--[l---------]deployment/noheat/infra-openstack/README.rst35
-rw-r--r--deployment/noheat/infra-openstack/vagrant/test/README31
-rw-r--r--[l---------]deployment/noheat/infra-openstack/vagrant/test/README.rst32
6 files changed, 95 insertions, 98 deletions
diff --git a/deployment/noheat/infra-openstack/HACKING b/deployment/noheat/infra-openstack/HACKING
deleted file mode 100644
index dcdc2062e..000000000
--- a/deployment/noheat/infra-openstack/HACKING
+++ /dev/null
@@ -1,30 +0,0 @@
-=========================
- Development environment
-=========================
-
-This environment focuses on interactions with OpenStack (here: DevStack) instance. Changes can be
-made from host machine but additional guest ("operator") is provided for developers' convenience.
-
-Environment on "operator" machine is already set up and can be accessed by:
-
-.. code-block:: shell
-
- $ vagrant ssh operator
-
-Provided ``clouds.yaml`` file differs slightly from the one that can be obtained with following
-steps:
-
-#. Open OpenStack dashboard (http://localhost:8080 forwarded from "devstack" machine)
-#. Navigate to ``Project``, then ``API Access`` on the left panel
-#. Select ``Download OpenStack RC File``, then ``OpenStack clouds.yaml File`` on the right side
-
-Summary of changes:
-
-- Added password from ``local.conf`` file (used in DevStack instance setup)
-- Removed ``project_id`` which might change on a new DevStack instance
-- Replaced ``auth_url`` based on machine's dynamic IP with the static private address
-- Added ``project_domain_name`` needed to run Ansible playbooks
-
-Installed Python package ``python-openstackclient`` includes key package ``openstacksdk`` as
-a dependency and provides additional CLI tools. Tool ``pip`` for Python 3 was used for installing
-these packages.
diff --git a/deployment/noheat/infra-openstack/HACKING.rst b/deployment/noheat/infra-openstack/HACKING.rst
index 3f7568eb2..dcdc2062e 120000..100644
--- a/deployment/noheat/infra-openstack/HACKING.rst
+++ b/deployment/noheat/infra-openstack/HACKING.rst
@@ -1 +1,30 @@
-HACKING \ No newline at end of file
+=========================
+ Development environment
+=========================
+
+This environment focuses on interactions with OpenStack (here: DevStack) instance. Changes can be
+made from host machine but additional guest ("operator") is provided for developers' convenience.
+
+Environment on "operator" machine is already set up and can be accessed by:
+
+.. code-block:: shell
+
+ $ vagrant ssh operator
+
+Provided ``clouds.yaml`` file differs slightly from the one that can be obtained with following
+steps:
+
+#. Open OpenStack dashboard (http://localhost:8080 forwarded from "devstack" machine)
+#. Navigate to ``Project``, then ``API Access`` on the left panel
+#. Select ``Download OpenStack RC File``, then ``OpenStack clouds.yaml File`` on the right side
+
+Summary of changes:
+
+- Added password from ``local.conf`` file (used in DevStack instance setup)
+- Removed ``project_id`` which might change on a new DevStack instance
+- Replaced ``auth_url`` based on machine's dynamic IP with the static private address
+- Added ``project_domain_name`` needed to run Ansible playbooks
+
+Installed Python package ``python-openstackclient`` includes key package ``openstacksdk`` as
+a dependency and provides additional CLI tools. Tool ``pip`` for Python 3 was used for installing
+these packages.
diff --git a/deployment/noheat/infra-openstack/README b/deployment/noheat/infra-openstack/README
deleted file mode 100644
index cb7cb9320..000000000
--- a/deployment/noheat/infra-openstack/README
+++ /dev/null
@@ -1,34 +0,0 @@
-==================================================
- Cloud infrastructure: OpenStack virtual machines
-==================================================
-
-Ansible roles and sample playbooks for creating virtual machines on OpenStack without Heat support.
-
-They will be used to create virtual machines hosting Service Mesh lab cluster.
-
-Prerequisites
--------------
-
-Infrastructure
-~~~~~~~~~~~~~~
-
-- OpenStack cloud (no Heat support required)
-
-Configuration
-~~~~~~~~~~~~~
-
-- OpenStack ``clouds.yaml`` file
-
-Dependencies
-~~~~~~~~~~~~
-
-- Ansible: tested on 2.9.9 (using Python 3.5.2)
-- openstacksdk_: tested on 0.46.0 (using Python 3.5.2)
-
-.. _openstacksdk: https://pypi.org/project/openstacksdk
-
-
-Expected output
----------------
-
-Ephemeral (disposable) OpenStack virtual machines for a Kubernetes cluster.
diff --git a/deployment/noheat/infra-openstack/README.rst b/deployment/noheat/infra-openstack/README.rst
index 100b93820..cb7cb9320 120000..100644
--- a/deployment/noheat/infra-openstack/README.rst
+++ b/deployment/noheat/infra-openstack/README.rst
@@ -1 +1,34 @@
-README \ No newline at end of file
+==================================================
+ Cloud infrastructure: OpenStack virtual machines
+==================================================
+
+Ansible roles and sample playbooks for creating virtual machines on OpenStack without Heat support.
+
+They will be used to create virtual machines hosting Service Mesh lab cluster.
+
+Prerequisites
+-------------
+
+Infrastructure
+~~~~~~~~~~~~~~
+
+- OpenStack cloud (no Heat support required)
+
+Configuration
+~~~~~~~~~~~~~
+
+- OpenStack ``clouds.yaml`` file
+
+Dependencies
+~~~~~~~~~~~~
+
+- Ansible: tested on 2.9.9 (using Python 3.5.2)
+- openstacksdk_: tested on 0.46.0 (using Python 3.5.2)
+
+.. _openstacksdk: https://pypi.org/project/openstacksdk
+
+
+Expected output
+---------------
+
+Ephemeral (disposable) OpenStack virtual machines for a Kubernetes cluster.
diff --git a/deployment/noheat/infra-openstack/vagrant/test/README b/deployment/noheat/infra-openstack/vagrant/test/README
deleted file mode 100644
index 03d9ea101..000000000
--- a/deployment/noheat/infra-openstack/vagrant/test/README
+++ /dev/null
@@ -1,31 +0,0 @@
-==============================
- Vagrant: simple test harness
-==============================
-
-Use ``make`` and ``git diff`` for a simple test harness for Vagrant-based environment.
-
-Prerequisites
--------------
-
-Dependencies
-~~~~~~~~~~~~
-
-- make: tested on 4.1
-- git: tested on 2.17.1
-
-
-Running
--------
-
-Command
-~~~~~~~
-
-.. code-block:: shell
-
- $ make test
-
-
-Credit
-------
-
-This is based on https://chrismorgan.info/blog/make-and-git-diff-test-harness blog post.
diff --git a/deployment/noheat/infra-openstack/vagrant/test/README.rst b/deployment/noheat/infra-openstack/vagrant/test/README.rst
index 100b93820..03d9ea101 120000..100644
--- a/deployment/noheat/infra-openstack/vagrant/test/README.rst
+++ b/deployment/noheat/infra-openstack/vagrant/test/README.rst
@@ -1 +1,31 @@
-README \ No newline at end of file
+==============================
+ Vagrant: simple test harness
+==============================
+
+Use ``make`` and ``git diff`` for a simple test harness for Vagrant-based environment.
+
+Prerequisites
+-------------
+
+Dependencies
+~~~~~~~~~~~~
+
+- make: tested on 4.1
+- git: tested on 2.17.1
+
+
+Running
+-------
+
+Command
+~~~~~~~
+
+.. code-block:: shell
+
+ $ make test
+
+
+Credit
+------
+
+This is based on https://chrismorgan.info/blog/make-and-git-diff-test-harness blog post.