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 | 30 ------------------- deployment/noheat/infra-openstack/HACKING.rst | 31 ++++++++++++++++++- deployment/noheat/infra-openstack/README | 34 --------------------- deployment/noheat/infra-openstack/README.rst | 35 +++++++++++++++++++++- .../noheat/infra-openstack/vagrant/test/README | 31 ------------------- .../noheat/infra-openstack/vagrant/test/README.rst | 32 +++++++++++++++++++- 6 files changed, 95 insertions(+), 98 deletions(-) delete mode 100644 deployment/noheat/infra-openstack/HACKING mode change 120000 => 100644 deployment/noheat/infra-openstack/HACKING.rst delete mode 100644 deployment/noheat/infra-openstack/README mode change 120000 => 100644 deployment/noheat/infra-openstack/README.rst delete mode 100644 deployment/noheat/infra-openstack/vagrant/test/README mode change 120000 => 100644 deployment/noheat/infra-openstack/vagrant/test/README.rst (limited to 'deployment/noheat/infra-openstack') 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 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. 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 deleted file mode 120000 index 100b93820..000000000 --- a/deployment/noheat/infra-openstack/README.rst +++ /dev/null @@ -1 +0,0 @@ -README \ No newline at end of file diff --git a/deployment/noheat/infra-openstack/README.rst b/deployment/noheat/infra-openstack/README.rst new file mode 100644 index 000000000..cb7cb9320 --- /dev/null +++ b/deployment/noheat/infra-openstack/README.rst @@ -0,0 +1,34 @@ +================================================== + 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 deleted file mode 120000 index 100b93820..000000000 --- a/deployment/noheat/infra-openstack/vagrant/test/README.rst +++ /dev/null @@ -1 +0,0 @@ -README \ No newline at end of file diff --git a/deployment/noheat/infra-openstack/vagrant/test/README.rst b/deployment/noheat/infra-openstack/vagrant/test/README.rst new file mode 100644 index 000000000..03d9ea101 --- /dev/null +++ b/deployment/noheat/infra-openstack/vagrant/test/README.rst @@ -0,0 +1,31 @@ +============================== + 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. -- cgit 1.2.3-korg