From 3d9bd5abfcb9bf55e3dd1b53cb3b6bc4bd45c0d1 Mon Sep 17 00:00:00 2001
From: Pawel Wieczorek
Date: Fri, 29 May 2020 18:12:38 +0200
Subject: Add Vagrant-based development environment
Development guide ("HACKING") is subject to change based on gathered
feedback.
Issue-ID: INT-1601
Change-Id: I8988c8a6e85d215485666690e0c281412a1ce869
Signed-off-by: Pawel Wieczorek
---
deployment/noheat/infra-openstack/HACKING | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
create mode 100644 deployment/noheat/infra-openstack/HACKING
(limited to 'deployment/noheat/infra-openstack/HACKING')
diff --git a/deployment/noheat/infra-openstack/HACKING b/deployment/noheat/infra-openstack/HACKING
new file mode 100644
index 000000000..d0c1edcc1
--- /dev/null
+++ b/deployment/noheat/infra-openstack/HACKING
@@ -0,0 +1,29 @@
+=========================
+ 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
+
+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