Install helper added and updated the documentation

Signed-off-by: Aravinda Vishwanathapura <[email protected]>

Author: aravindavk

.github/workflows/on-release-tag.yaml

@@ -54,3 +54,23 @@ jobs:
           tag: ${{ github.ref }}
           overwrite: true
           file_glob: true
+  upload_release_files:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Upload gluster-metrics-exporter.service to the release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: extra/*.service
+          tag: ${{ github.ref }}
+          overwrite: true
+          file_glob: true
+      - name: Upload install.sh script to the release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: extra/install.sh
+          tag: ${{ github.ref }}
+          overwrite: true
+          file_glob: true

README.md

@@ -5,28 +5,49 @@
 Download the latest release with the command
 
 ```
-curl -L https://github.com/kadalu/gluster-metrics-exporter/releases/latest/download/gluster-metrics-exporter-`uname -m | sed 's|aarch64|arm64|' | sed 's|x86_64|amd64|'` -o gluster-metrics-exporter
+$ curl -fsSL https://github.com/kadalu/gluster-metrics-exporter/releases/latest/download/install.sh | sudo bash -x
 ```
 
-Make the `gluster-metrics-exporter` binary executable.
+Test to ensure the version you installed is up-to-date
 
 ```
-chmod +x ./gluster-metrics-exporter
+$ gluster-metrics-exporter --version
 ```
 
-Move the binary in to your PATH.
+## Usage:
+
+Start the Gluster Metrics exporter service in all the Storage nodes
 
 ```
-sudo mv ./gluster-metrics-exporter /usr/local/bin/gluster-metrics-exporter
+# systemctl enable gluster-metrics-exporter
+# systemctl start gluster-metrics-exporter
 ```
 
-Test to ensure the version you installed is up-to-date
+Above command picks up the Gluster hostname by running the `hostname` command. If the local Gluster hostname is different than create a hostname file in `/var/lib/glusterd`.
 
 ```
-$ gluster-metrics-exporter --version
+# echo "server1.example.com" > /var/lib/glusterd/hostname
 ```
 
-## Usage:
+To fetch the Prometheus compatible Metrics, call the API from any one Storage node.
+
+```
+$ curl http://server1.example.com:9713/metrics
+```
+
+To get the same metrics in JSON format
+
+```
+$ curl http://server1.example.com:9713/metrics.json
+```
+
+## Manually run the exporter (Without systemd)
+
+```
+# gluster-metrics-exporter
+```
+
+Available options
 
 ```
 Usage: gluster-metrics-exporter [OPTIONS]

extras/gluster-metrics-exporter.service extra/gluster-metrics-exporter.service

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+curl -fsSL https://github.com/kadalu/gluster-metrics-exporter/releases/latest/download/gluster-metrics-exporter-`uname -m | sed 's|aarch64|arm64|' | sed 's|x86_64|amd64|'` -o /tmp/gluster-metrics-exporter
+curl -fsSL https://github.com/kadalu/gluster-metrics-exporter/releases/latest/download/gluster-metrics-exporter.service -o /tmp/gluster-metrics-exporter.service
+
+install -m 700 /tmp/gluster-metrics-exporter.service /lib/systemd/system/
+install /tmp/gluster-metrics-exporter /usr/sbin/gluster-metrics-exporter