Add instructions for running playbook to setup stack orchestrator

stack-orchestrator-setup/README.md

@@ -1 +1,72 @@
 # stack-orchestrator-setup
+
+## Setup Ansible
+
+To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
+
+## Setup Stack Orchestrator
+
+The following commands have to be executed in the [`stack-orchestrator-setup`](./) directory. This playbook will install Docker and Stack Orchestrator on the machine if they aren't already present
+
+### On Local Host
+
+To setup stack orchestrator and docker locally, execute the `setup-laconic-so.yml` Ansible playbook:
+
+```bash
+LANG=en_US.utf8 ansible-playbook setup-laconic-so.yml --user $USER -kK
+```
+
+### On Remote Host
+
+To run the playbook on a remote host:
+
+- Create a new `hosts.ini` file:
+
+   ```bash
+   cp ../hosts.example.ini hosts.ini
+   ```
+
+- Edit the [`hosts.ini`](./hosts.ini) file to run the playbook on a remote machine:
+
+  ```ini
+  [deployment_host]
+  <host_name> ansible_host=<target_ip> ansible_user=<ssh_user> ansible_ssh_common_args='-o ForwardAgent=yes'
+  ```
+
+  - Replace `<host_name>` with the alias of your choice
+  - Replace `<target_ip>` with the IP address or hostname of the target machine
+  - Replace `<ssh_user>` with the SSH username (e.g., dev, ubuntu)
+
+- Verify that you are able to connect to the host using the following command
+
+  ```bash
+  ansible all -m ping -i hosts.ini -k
+
+  # Expected output:
+
+  # <host_name> | SUCCESS => {
+  #  "ansible_facts": {
+  #      "discovered_interpreter_python": "/usr/bin/python3.10"
+  #  },
+  #  "changed": false,
+  #  "ping": "pong"
+  # }
+  ```
+
+- Execute the `setup-laconic-so.yml` Ansible playbook for setting up stack orchestrator and docker on a remote machine:
+
+  ```bash
+  LANG=en_US.utf8 ansible-playbook setup-laconic-so.yml  -i hosts.ini  --extra-vars='{ "target_host": "deployment_host"}' --user $USER -kK
+  ```
+
+## Verify Installation
+
+- To verify installtion, run the following commands:
+
+  ```bash
+  # Check version of docker
+  docker --version
+
+  # Check version of Stack Orchestrator
+  laconic-so version
+  ```

stack-orchestrator-setup/setup-docker.yml

@@ -1,7 +1,9 @@
 - name: Set up Docker
-  hosts: remote_host
+  hosts: "{{ target_host }}"
   become: yes
+
   vars:
+    target_host: "localhost"
     docker_gpg_key_url: "https://download.docker.com/linux/ubuntu/gpg"
     docker_gpg_key_path: "/etc/apt/keyrings/docker.asc"
 
@@ -11,10 +13,6 @@
       register: is_docker_present
       ignore_errors: yes
 
-    - name: Check if docker is present
-      debug:
-        var: "Output of `which docker` is {{ is_docker_present }}"
-
     - block:
         - name: Exit if docker is present
           debug:

stack-orchestrator-setup/setup-laconic-so.yml

@@ -2,10 +2,27 @@
   import_playbook: setup-docker.yml
 
 - name: Set up Stack Orchestrator
-  hosts: remote_host
+  hosts: "{{ target_host }}"
+
   vars:
+    target_host: "localhost"
+
+  environment:
+    PATH: "{{ ansible_env.PATH }}:/home/{{ansible_user}}/bin"
 
   tasks:
+    - name: Check if Stack Orchestrator is installed
+      shell: which laconic-so
+      register: is_so_present
+      ignore_errors: yes
+
+    - block:
+        - name: Exit if Stack Orchestrator is present
+          debug:
+            msg: "Stack Orchestrator already on host, ending play"
+        - meta: end_play
+      when: is_so_present.rc == 0
+
     - name: Install jq
       apt:
         name: jq