updated GitOps lab (#83)

* added ds deploy command
* added comments to scripts

Author: bartr

.ds/commands/applications/list

@@ -1,3 +1,5 @@
 #!/bin/bash
 
+# "ds applications list" queries the Res-Edge data service and displays a list of Applications
+
 KIC_RES_EDGE_ENTITYNAME="applications" "$CLI_CMD_DIR/res-edge/entity-list" "$@"

.ds/commands/applications/show

@@ -1,3 +1,5 @@
 #!/bin/bash
 
+# "ds applications show --id <id>" displays a json object from the Res-Edge data service
+
 KIC_RES_EDGE_ENTITYNAME="applications" "$CLI_CMD_DIR/res-edge/entity-show" "$@"

.ds/commands/cicd

@@ -1,60 +1,17 @@
 #!/bin/bash
 
-RESEDGE_AUTOMATION_DOCKER_IMAGE="ghcr.io/cse-labs/res-edge-automation:0.9"
+# "ds cicd" use the Res-Edge Automation docker image and the Res-Edge Data Service
+# to generate GitOps manifest files for each Cluster
 
-usage() {
-  echo "Usage: kic cicd [--show]"
-  exit 1
-}
+# Run "git status" to see the repo changes
 
-# check the number of parameters
-if [ $# -gt 1 ]; then
-  usage
-fi
-
-# extract the first parameter into a variable
-param="$1"
-
-# check if the parameter is valid
-if [ $# -eq 1 ]; then
-  if [[ $param == "--show" ]]; then
-    show_flag=1
-  else
-    usage
-  fi
-fi
-
-# If the flag is set, show a message
-if [[ $show_flag -eq 1 ]]; then
-  cat << EOF
-Default Script
-
-#!/bin/bash
-
-# The following command will execute the ghcr.io/cse-labs/res-edge-automation image in docker
-# and will mount the current directory into a working directory inside the container.
-# The container will retrieve all required information from the dataservice
-# and validate, create and/or update (as necessary) the clusters gitops manifest files
-# in the working directory without pushing changes to remote repository.
-
-docker run -it --rm \\
-  --net host \\
-  -v \$(pwd):/goa \\
-  ${RESEDGE_AUTOMATION_DOCKER_IMAGE} \\
-  -s "${DS_URL}"
-EOF
-  exit
-fi
+# The changes are not pushed to GitHub
+# use "ds deploy" to push any GitOps changes
 
 echo "Running ci-cd locally ..."
 
-# The following command will execute the ghcr.io/cse-labs/res-edge-automation image in docker
-# and will mount the current directory into a working directory inside the container.
-# The container will retrieve all required information from the dataservice
-# and validate, create and/or update (as necessary) the clusters gitops manifest files
-# in the working directory without pushing changes to remote repository.
 docker run -it --rm \
   --net host \
-  -v "$(pwd)":/goa \
-  ${RESEDGE_AUTOMATION_DOCKER_IMAGE} \
+  -v "$KIC_BASE":/goa \
+  ghcr.io/cse-labs/res-edge-automation:0.9 \
   -s "${DS_URL}"

.ds/commands/clusters/list

@@ -1,3 +1,5 @@
 #!/bin/bash
 
+# "ds clusters list" queries the Res-Edge data service and displays a list of Clusters
+
 KIC_RES_EDGE_ENTITYNAME="clusters" "$CLI_CMD_DIR/res-edge/entity-list" "$@"

.ds/commands/clusters/show

@@ -1,3 +1,5 @@
 #!/bin/bash
 
+# "ds clusters show --id <id>" displays a json object from the Res-Edge data service
+
 KIC_RES_EDGE_ENTITYNAME="clusters" "$CLI_CMD_DIR/res-edge/entity-show" "$@"

.ds/commands/deploy

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# "ds cicd" uses Res-Edge Automation to update the Cluster manifests in the "clusters" directory
+# "ds deploy" will commit and push any changes to the "clusters" directory tree to GitHub
+# It will not push changes outside the clusters directory
+
+if [[ $(git status "$KIC_BASE/clusters" --porcelain | wc -l ) = 0 ]]; then
+  echo "No updates to deploy"
+  exit 0
+fi
+
+git add "$KIC_BASE/clusters"
+git commit -m "Res-Edge Automation via ds cicd"
+git push

.ds/commands/env

@@ -1,3 +1,5 @@
 #!/bin/bash
 
-env | grep -e "^DS_" -e "^CLI_" -e "^KIC_" | sort
+# "ds env" will display a sorted list of environment variables used by the CLIs
+
+env | grep -e "^CLI_" -e "^DS_" -e "^KIC_" | sort

.ds/commands/groups/list

@@ -1,3 +1,5 @@
 #!/bin/bash
 
+# "ds groups list" queries the Res-Edge data service and displays a list of Groups
+
 KIC_RES_EDGE_ENTITYNAME="groups" "$CLI_CMD_DIR/res-edge/entity-list" "$@"

.ds/commands/groups/show

@@ -1,3 +1,5 @@
 #!/bin/bash
 
+# "ds groups show --id <id>" displays a json object from the Res-Edge data service
+
 KIC_RES_EDGE_ENTITYNAME="groups" "$CLI_CMD_DIR/res-edge/entity-show" "$@"

.ds/commands/namespaces/list

@@ -1,3 +1,5 @@
 #!/bin/bash
 
+# "ds namespaces list" queries the Res-Edge data service and displays a list of Namespaces
+
 KIC_RES_EDGE_ENTITYNAME="namespaces" "$CLI_CMD_DIR/res-edge/entity-list" "$@"