From ddb59f3d732854e35cadb8468586ea12c9bb62af Mon Sep 17 00:00:00 2001
From: Pawel Wieczorek
Date: Wed, 5 Aug 2020 10:08:39 +0200
Subject: Drop using symlinks for documentation markup rendering
Keeping only symlinks as the markup indicator does not trigger CI on
relevant patches changing documentation contents (there's no change in
symlink).
This can be resolved by dropping symlinks usage entirely. Sphinx and RTD
aren't going anywhere anytime soon.
To make sure all symlinks were replaced following one-liner was used:
$ find . -type l -name "*.rst" -exec readlink -e {} \; \
| xargs -I% git mv -f %{,.rst}
which finds all the symlinks in the repo with "*.rst" suffix, then reads
which file they link to and finally replaces given symlink with that
file.
This solution was suggested by:
Bartek Grzybowski
Issue-ID: INT-1672
Change-Id: I120e216b0b48032bb7b80c23cad799cd6f7cca53
Signed-off-by: Pawel Wieczorek
---
deployment/noheat/infra-openstack/HACKING.rst | 31 ++++++++++++++++++++++++++-
1 file changed, 30 insertions(+), 1 deletion(-)
mode change 120000 => 100644 deployment/noheat/infra-openstack/HACKING.rst
(limited to 'deployment/noheat/infra-openstack/HACKING.rst')
diff --git a/deployment/noheat/infra-openstack/HACKING.rst b/deployment/noheat/infra-openstack/HACKING.rst
deleted file mode 120000
index 3f7568eb2..000000000
--- a/deployment/noheat/infra-openstack/HACKING.rst
+++ /dev/null
@@ -1 +0,0 @@
-HACKING
\ No newline at end of file
diff --git a/deployment/noheat/infra-openstack/HACKING.rst b/deployment/noheat/infra-openstack/HACKING.rst
new file mode 100644
index 000000000..dcdc2062e
--- /dev/null
+++ b/deployment/noheat/infra-openstack/HACKING.rst
@@ -0,0 +1,30 @@
+=========================
+ 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.
--
cgit 1.2.3-korg