Fix documentation
diff --git a/README.md b/README.md
index 1826e8f..91557b2 100644
--- a/README.md
+++ b/README.md
@@ -5,15 +5,17 @@
=======
apt-get install python-virtualenv python-pip build-essential python-dev libssl-dev
- virtualenv venv-reclass-tools
- source venv-reclass-tools/bin/activate
- pip install https://github.com/dis-xcom/reclass-tools
+ pip install git+https://github.com/dis-xcom/reclass-tools
Usage
=====
This tool can be used to create a new class 'environment' generated from custom inventory.
+ # 1. See the nodes in reclass inventory:
+
+ reclass-inventory-list
+
Requirements
------------
@@ -24,23 +26,39 @@
Create 'environment' class
--------------------------
+ # This is a PoC of creating the 'environment' class.
+ # For CI tests, please generate your 'inventory.yaml' for step #3 and create
+ # the cookiecutter template based on example template from /examples directory.
+
+ # Below will be used 'cluster' model from 'mcp-baremetal-lab' repo
+ # and the cluster name 'mcp11-ovs-dpdk.local'.
+
# 1. Create a context file from the current reclass inventory:
reclass-create-inventory-context -d mcp11-ovs-dpdk.local > /tmp/context-mcp11-ovs-dpdk.local.yaml
# 2. Remove existing hardware-related objects from 'cluster', 'system' and 'service' classes:
- reclass-remove-key -r parameters.linux.network.interface /srv/salt/reclass/classes/cluster/physical_mcp11_ovs_dpdk
- reclass-remove-key -r parameters.linux.network.interface /srv/salt/reclass/classes/system/
- reclass-remove-key -r parameters.linux.network.interface /usr/share/salt-formulas/reclass/
+ reclass-remove-key parameters.linux.network.interface /srv/salt/reclass/classes/cluster/physical_mcp11_ovs_dpdk
+ reclass-remove-key parameters.linux.network.interface /srv/salt/reclass/classes/system/
+ reclass-remove-key parameters.linux.network.interface /usr/share/salt-formulas/reclass/
# 3. Render the 'environment' class using example template based on cookiecutter:
git clone https://github.com/dis-xcom/reclass_tools ~/reclass_tools
reclass-render-dir -t ~/reclass_tools/examples/environment -o /tmp/environment -c /tmp/context-mcp11-ovs-dpdk.local.yaml # You can add multiple YAMLs here
- # 4. Symlink 'environment' to the /srv/reclass/salt/classes
+ # 4. Check that the 'environment' has been created
+
+ tree /tmp/environment/
+
+ # 5. Symlink 'environment' to the /srv/salt/reclass/classes
ln -s /tmp/environment /srv/reclass/salt/classes
- # 5. Add new class '- environment.mcp11-ovs-dpdk.local' to the classes/cluster/<cluster_model>/infra/config.yml
+ # 6. Add new class '- environment.mcp11-ovs-dpdk.local' to the classes/cluster/<cluster_model>/infra/config.yml
+ # (edit the file manually for now)
+
+ # 7. Update the nodes for reclass inventory
+
+ salt-call state.sls reclass.storage