aboutsummaryrefslogtreecommitdiffstats
path: root/deployment/noheat/infra-openstack/HACKING.rst
diff options
context:
space:
mode:
authorPawel Wieczorek <p.wieczorek2@samsung.com>2020-08-05 10:08:39 +0200
committerMorgan Richomme <morgan.richomme@orange.com>2020-08-10 14:30:55 +0000
commitddb59f3d732854e35cadb8468586ea12c9bb62af (patch)
tree34a857ec5623c6bc6ed96e30cad201474d90f550 /deployment/noheat/infra-openstack/HACKING.rst
parenta5b89b132a5b681ce0e81e46216443d0307c789f (diff)
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 <b.grzybowski@partner.samsung.com> Issue-ID: INT-1672 Change-Id: I120e216b0b48032bb7b80c23cad799cd6f7cca53 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
Diffstat (limited to 'deployment/noheat/infra-openstack/HACKING.rst')
-rw-r--r--[l---------]deployment/noheat/infra-openstack/HACKING.rst31
1 files changed, 30 insertions, 1 deletions
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.