Merge pull request #43 from vladimirvivien/single-exec-backend

Implement single executor backend for commands using scp/ssh

.github/workflows/compile-test.yaml

@@ -16,4 +16,12 @@ jobs:
       uses: actions/checkout@v1
 
     - name: test
-      run: GO111MODULE=on go test -v ./...
+      run: |
+        sudo ufw allow 2222
+        sudo ufw allow 2424
+        sudo ufw enable
+        sudo ufw status verbose
+        mkdir -p ~/.ssh
+        chmod 765 ~/.ssh
+        cp testing/keys/* ~/.ssh/
+        GO111MODULE=on go test -timeout 120s -v ./...

TODO.md

@@ -10,7 +10,7 @@ This tag/version reflects migration to github
 # v0.1.0-alpha.4
 * [x] Add automated build (Makefile etc)
 * [x] Git describe version reporting (i.e. `crash-diagnostics --version`)
-* [ ] Add project badges to README
+* [x] Add project badges to README
 * [x] Apply tag v0.1.0-alpha.4
 
 * Translate identified TODOs to issues.
@@ -45,11 +45,25 @@ This tag/version reflects migration to github
 * [x] Update changelog doc
 
 # v0.2.0-alpha.0
-* [ ] New directive `KUBEGET`
-* [ ] Update doc
+* [x] New directive `KUBEGET`
+* [x] Update doc
 
 
-# v0.2.1
+# v0.2.1-alpha.0
+* [x] Introduce support for command echo parameter
+* [x] Documentation update
+
+# v0.2.1-alpha.1
+* [x] Remove support for local execution model
+* [x] The default executor will use SSH/SCP even when targeting local machine
+* [x] Update test for new executor backend
+* [x] Update CI/CD to automate end-to-end tests using SSH server
+* [x] Documentation update
+
+# v0.2.2-alpha.0
+* [ ] Initial CloudAPI support
+
+# Other Tasks
 * [ ] Documentation update (tutorials and how tos)
 * [ ] Recipes (i.e. Diagnostics.file files for different well known debg)
 * [ ] Cloud API recipes (i.e. recipes to debug CAPV)

docs/README.md

@@ -231,7 +231,17 @@ FROM 10.10.100.2:22 10.10.100.3:22 10.10.100.4:22
 FROM hosts:"10.10.100.2:22 10.10.100.3:22 10.10.100.4:22"
 ```
 
-By default the `crash-diagnostics` will use SSH as a runtime to interact with the specified remote hosts.
+The `FROM` directive will also accept a machine named `local` which is an alias for the local machine as shown below:
+```
+FROM local 10.10.100.2:22
+```
+Which is equivalent to:
+
+```
+FROM 127.0.0.1:22 10.10.100.2:22
+```
+
+It should be noted that by default the `crash-diagnostics` executor uses `SSH` and `SCP` protocols at runtime to interact with the specified remote hosts. 
 
 ### KUBECONFIG
 This directive specifies the fully qualified path of the Kubernetes client configuration file or KUBECONFIG.  If the specified path does not exist, all subsquent command that uses this configuration will quietly fail (logged).