@@ -49,20 +49,19 @@ To do this after cloning just run the following command from inside the reposito
4949
5050To read more about how submodules work read Git's [ submodules] documentation
5151
52- ## Preparation (VS Code)
52+ ## Preparation (VS Code Dev Container )
5353
5454After cloning, when you open this repository in VS-Code you will be told the folder
5555contains a _ Dev Container configuration file_ and will be invited to reopen the folder
5656in a container. Do so or select the command * Reopen in Container* using the
5757** Command Palette** (` Ctrl+Shift+P ` or ` Cmd+Shift+P ` on MacOS).
5858
5959If the container does not exist VS Code will take a few minutes to build it before
60- presenting you with a terminal in it where you will find the tools ` ansible `
61- and ` kubectl ` .
60+ presenting you with a terminal in it where you will find ` ansible ` and ` kubectl ` .
6261
63- ## Preparation (virtual environment)
62+ ## Preparation (Virtual environment)
6463
65- It's not then end of the world if you can't use VS Code and its devcontainer.
64+ It's not the end of the world if you can't use VS Code and its ** devcontainer** .
6665
6766If you are using a _ recent_ Python you can use a its built-in virtual environment
6867capability to create an execution environment containing Ansible and some other tools.
@@ -75,12 +74,12 @@ of the clone: -
7574 pip install --upgrade pip
7675 pip install -r .devcontainer/requirements.txt
7776
78- > As along as the requirements can be installed then any Python should be suitable
79- but we recommend recent versions , and currently use 3.12 and 3.13.
77+ > As along as the requirements can be installed then any Python should be suitable,
78+ but we recommend a recent version , and we commonly use 3.12 and 3.13.
8079
8180If you already use our kubernetes clusters you probably have ` kubectl `
82- installed. If not you now need to [ install kubectl] on your host,
83- one with a version that's suitable for our clusters. We currently use kubectl v1.32.
81+ installed. If not you now need to [ install kubectl] on your host.
82+ Install a version that's suitable for our clusters (we currently use kubectl v1.32) .
8483
8584You will also need to set a suitable value for the ` KUBECONFIG ` environment
8685variable. Unlike ` kubectl ` , the playbooks do not _ assume_ that you want to use
@@ -91,8 +90,8 @@ variable accordingly, like this: -
9190
9291## Running the playbooks
9392
94- With your environment set (VS code or a virtual environment) you should now
95- be able to run our playbooks by moving to the relevant submodule directory.
93+ With your chosen environment set (devcontainer or a virtual environment) you should now
94+ be able to run playbooks by moving to the relevant submodule directory.
9695
9796To run our basic ** ansible-infrastructure** playbook (using our built-in parameters
9897for a local cluster) simply change to its directory and run the ` site.yaml ` file: -
@@ -108,9 +107,8 @@ for a local cluster) simply change to its directory and run the `site.yaml` file
108107
109108Should anything change in the upstream repositories, while you can update
110109the root project using the standard ` git pull ` this will not
111- update the content of your submodules.
112-
113- To pull _ everything_ from the remote you can run this command: -
110+ update the content of your submodules. Instead, to pull _ everything_ from the repective
111+ remotes you can run this command: -
114112
115113 git pull --recurse-submodules
116114
@@ -125,6 +123,10 @@ if you want changes in a submodule to be tracked. As such you are _strongly advi
125123to read the [ submodule] documentation's ** Working on a Submodule** section first.
126124It will help you understanding how to edit and commit changes in a submodule.
127125
126+ Before you start editing a submodule make sure you have chosen a suitable branch.
127+ By default, when the submodules are cloned they exist in a detached state, and
128+ you need to select a suitable remote branch in order to commit any code.
129+
128130---
129131
130132[ ansible ] : https://docs.ansible.com
0 commit comments