Updated README with example (#1)

* Updated README with example

* Removing lint step for now

* Downloading go dependencies helps

* Removing lint again

* Fixed go version issue.
Was detecting 1.2 instead of 1.20

Author: cin

.github/workflows/pull_request.yml

@@ -5,9 +5,6 @@ on:
     branches:
       - main
 
-env:
-  GO_VERSION: 1.20
-
 jobs:
   run-tests:
     runs-on: ubuntu-latest
@@ -18,15 +15,17 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v3
         with:
-          go-version: ${{ env.GO_VERSION }}
+          go-version: "1.20"
 
       - name: Go Lint
-        uses: golangci/golangci-lint-action@v3.4.0
+        uses: golangci/golangci-lint-action@v3
         with:
           args: --timeout=5m --enable exportloopref
           skip-pkg-cache: true
           skip-build-cache: true
-          skip-go-installation: true
-      
-      - name: Build
-        run: go build -o k8s-parallel-exec
+
+      - name: Go Mod Download
+        run: go mod download
+
+      - name: Go Build
+        run: go build -o k8s-parallel-exec

.github/workflows/release.yml

@@ -5,29 +5,28 @@ on:
     types:
       - published
 
-env:
-  GO_VERSION: 1.20
-
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up Go
+    - name: Setup Go
       uses: actions/setup-go@v3
       with:
-        go-version: ${{ env.GO_VERSION }}
+        go-version: "1.20"
 
     - name: Go Lint
-      uses: golangci/golangci-lint-action@v3.4.0
+      uses: golangci/golangci-lint-action@v3
       with:
         args: --timeout=5m --enable exportloopref
         skip-pkg-cache: true
         skip-build-cache: true
-        skip-go-installation: true
 
-    - name: Build
+    - name: Go Mod Download
+      run: go mod download
+
+    - name: Go Build
       run: go build -o k8s-parallel-exec
 
     - name: Publish k8s-parallel-exec to assets

README.md

@@ -48,13 +48,22 @@ k8s-parallel-exec -kubeconfig /path/to/kubeconfig -c container-name -l label-sel
 - `-l`: Label selector to filter the pods.
 - `command-to-execute`: The command to run inside the specified container in each pod.
 
-
 Example
 ```sh
 k8s-parallel-exec -kubeconfig ~/.kube/config -c cassandra -l app=cassandra nodetool status
 ```
 This command would execute `nodetool status` on all the Cassandra containers in pods with the label "app=cassandra" in parallel, and then aggregate and display the results.
 
+If authentication is enabled and you don't want to expose credentials, you may have to do things like the following:
+
+```
+KPE_LABELS="cassandra-cluster-component=cassandra
+,cassandra-cluster-instance=test-cluster"
+k8s-parallel-exec -kubeconfig ~/.kube/kind-kcfg -l $KPE_LABELS -c cassandra -- bash -c 'nodetool --ssl -u $(cat /etc/cassandra-auth-config/admin-role) -pw $(cat /etc/cassandra-auth-config/admin-password) status'
+```
+
+Currently working on a way to make this better...
+
 ## Possible Features
 
 Here are some additional features that could make k8s-parallel-exec more useful: