Installation script with updated README

Author: surbhi kanthed

Documentation/Installation-script.md

@@ -0,0 +1,48 @@
+## Expected Output of following commands from Installation Script
+
+Make sure you follow all the steps in Prerequisites here at [CRC for Openshift Reporting Backend](https://github.com/dburugupalli/SSMT/blob/feature-1/Documentation/Installing_crc.md).  and go as per the instruction printed on terminal before and after every command is executed when you run the script.
+
+
+### Output after Metering Operator Installation for local OCP cluster. 
+```bash
+$oc get pods
+NAME                                  READY   STATUS              RESTARTS   AGE
+
+metering-operator-68dd64cfb6-pxh8v    2/2     Running             0          2m49s
+```
+
+if the metering operator is still not up and running. 
+Stop the script and do the process manually of installing the metering operator -
+
+
+```bash
+a. Run command "crc console" in terminal.
+b. Login using admin credentials for crc.
+c. Search Red Hat Metering under Operator Hub and Click Install. 
+d. Wait until Metering Operator pods are up and Running successfully.
+```
+
+Remove the steps that are done from the script. Rerun the script with the remaining steps.
+
+
+
+### Output after Installing Metering Stack / Metering Configuration for local OCP cluser
+
+Understanding [Metering Configuration](https://docs.openshift.com/container-platform/4.3/metering/configuring_metering/metering-about-configuring.html#metering-about-configuring)
+
+At a minimum, you need to configure persistent storage and configure the Hive metastore.[Refer Samples](https://docs.openshift.com/container-platform/4.3/metering/configuring_metering/metering-about-configuring.html#metering-about-configuring)
+
+```bash
+$ oc -n openshift-metering get pods
+NAME                                 READY   STATUS    RESTARTS   AGE
+hive-metastore-0                     2/2     Running   14         7d15h
+hive-server-0                        3/3     Running   21         7d15h
+metering-operator-86b95669bb-njp4q   2/2     Running   14         7d15h
+presto-coordinator-0                 2/2     Running   8          7d2h
+reporting-operator-978687d9c-vkzrl   2/2     Running   27         7d15h
+
+#if not, Wait few more mins until Componenets of metering stack are installed like hive metastore, presto database and reporting operator 
+```
+
+
+

Documentation/Installing_crc.md

@@ -18,26 +18,15 @@ Use the [CRC](https://access.redhat.com/documentation/en-us/red_hat_codeready_co
 
 Login using your redhat account and select OpenShift for Laptop & copy image pull Secret, this will be used later while installing CRC. 
 
-
 Lets configure CRC cluster with 7+vcpus &16+GB
 
-```bash
-crc config set cpus 7
-crc config set memory <memory-in-mb>
-# To view crc configuration 
-crc config view
-crc setup
-crc start
-# Deleting the code ready container 
-crc delete
-```
-
 Note:
 To enable configuration changes, you must delete the existing CRC virtual machine and create a new one.
 
 [CRC Version 1.6](https://github.com/code-ready/crc/releases/tag/1.6.0) download link 
 
-## Some Common issues
+
+## Some Common Issues
 
 #### Unable to login to crc cluster via web console. 
 
@@ -52,11 +41,4 @@ crc ip # This will give the Virtual Machine IP address
 <vm_ip> console-openshift-console.apps-crc.testing
 
 ```
-#### Error in starting Monitoring, Telemetry and Alerting
-```bash
-oc get clusterversion version -ojsonpath='{range .spec.overrides[*]}{.name}{"\n"}{end}' | nl -v 0
-#  Replace the unmanged-operator-index to [0 cluster-monitoring-operator]
-oc patch clusterversion/version --type='json' -p '[{"op":"remove", "path":"/spec/overrides/<unmanaged-operator-index>"}]' -oyaml
-
-```
 

README.md

@@ -8,7 +8,7 @@ More Details about Metering Operator [Metering Operator](https://docs.openshift.
 
 1. OpenShift Account as Cluster Administrator
 
-2. Locally running OpenShift Cluster [CRC](https://developers.redhat.com/products/codeready-containers). Refer this [CRC for Openshift Reporting Backend](https://github.com/dburugupalli/SSMT/blob/feature-1/Documentation/Installing_crc.md). 
+2. Locally downloaded OpenShift Cluster [CRC](https://developers.redhat.com/products/codeready-containers). Refer this [CRC for Openshift Reporting Backend](https://github.com/dburugupalli/SSMT/blob/feature-1/Documentation/Installing_crc.md). 
 
 3. Enable Alerting,monitoring, telemetry on CRC cluster using following commands
 
@@ -21,60 +21,24 @@ Note: if the above commands donot work, Please refer [CRC for Openshift Reportin
 
 ### Installation
 
-#### Metering Operator Installation for local OCP cluster. 
+1. Clone the repository in your local machine.
 
-``` bash
-# Login as the Cluster Administrator
- 
-a. Create a namespace openshift-metering 
-b. Label the namespace with `openshift.io/cluster-monitoring=true`
-c. Search Red Hat Metering under Operator Hub and Click Install. 
-d. Wait until Metering Operator pods are up and Running successfully.
-
-# Output after these steps
-NAME                                  READY   STATUS              RESTARTS   AGE
+2. Make the installation.sh and report.sh file executable using -
 
-metering-operator-68dd64cfb6-pxh8v    2/2     Running             0          2m49s
+``` bash
+chom +x <.sh file name>
 ```
 
-#### Installing Metering Stack / Metering Configuration for local OCP cluser
-
-Understanding [Metering Configuration](https://docs.openshift.com/container-platform/4.3/metering/configuring_metering/metering-about-configuring.html#metering-about-configuring)
+3. Run the installation script file with command -
 
-At a minimum, you need to configure persistent storage and configure the Hive metastore.[Refer Samples](https://docs.openshift.com/container-platform/4.3/metering/configuring_metering/metering-about-configuring.html#metering-about-configuring)
-
-
-```bash
-$ oc project openshift-metering
-$ oc create -f https://raw.githubusercontent.com/dburugupalli/SSMT/feature-1/openshift-metering-templates/configuration-templates/metering-configuration.yaml
- 
-# Wait until Componenets of metering stack are installed like hive metastore, presto database and 
-# reporting operator 
-
-$ oc -n openshift-metering get pods
-NAME                                 READY   STATUS    RESTARTS   AGE
-hive-metastore-0                     2/2     Running   14         7d15h
-hive-server-0                        3/3     Running   21         7d15h
-metering-operator-86b95669bb-njp4q   2/2     Running   14         7d15h
-presto-coordinator-0                 2/2     Running   8          7d2h
-reporting-operator-978687d9c-vkzrl   2/2     Running   27         7d15h
-# to view custom resource definations
-$ oc get crd | grep metering
-hivetables.metering.openshift.io                            2020-05-19T04:34:42Z
-meteringconfigs.metering.openshift.io                       2020-05-19T04:34:42Z
-prestotables.metering.openshift.io                          2020-05-19T04:34:42Z
-reportdatasources.metering.openshift.io                     2020-05-19T04:34:42Z
-reportqueries.metering.openshift.io                         2020-05-19T04:34:42Z
-reports.metering.openshift.io                               2020-05-19T04:34:42Z
-storagelocations.metering.openshift.io                      2020-05-19T04:34:42Z
+``` bash
+./installation.sh
 ```
 
-#### Verify Metering Stack / Configuration for local OCP cluster 
+Every steps tells you what it does and print the output of each command on terminal after it's executed.
+
+Expected output of few commands is mentioned here [Script Details](https://github.com/skanthed/SSMT/blob/bash-script/Documentation/Installation-script.md)
 
-```bash
-oc get reportdatasources -n openshift-metering | grep -v raw
-```
-Metering stack creates sample instances of reportdatasource and reportqueries custom resources. 
 
 ### Creating Reports 
 
@@ -83,15 +47,14 @@ For Now, lets use the pre-defined reportdatasources and reportqueries to generat
 ```bash
 $ oc project openshift-metering
 $ oc create -f https://raw.githubusercontent.com/dburugupalli/SSMT/feature-1/openshift-metering-templates/reports-templates/namespace-cpu-request-hourly.yaml
-$ meteringRoute="$(oc get routes metering -o jsonpath='{.spec.host}')"
-$ echo "$meteringRoute"
-$ token="$(oc whoami -t)"
-$ reportName=namespace-cpu-request-hourly
-$ reportFormat=json
-# Change reportForma=csv to get output in csv format
-$ curl --insecure -H "Authorization: Bearer ${token}" "https://${meteringRoute}/api/v1/reports/get?name=${reportName}&namespace=openshift-metering&format=$reportFormat"
+
 ```
 To view reports on the terminal. 
+Run report.sh file.
+
+``` bash
+./report.sh
+```
 
 ### Defining Report-Query and ReportDataSources to acheive specific functionality
 

installation.sh

@@ -7,6 +7,8 @@ sudo systemctl start NetworkManager
 echo "Starting libvrtd service"
 sudo systemctl start libvirtd
 
+echo "Lets configure CRC cluster with 7+vcpus &16+GB memory"
+
 read -p "Enter memory in MB : " mem
 read -p "Enter number of cpus : " cpu
 echo "Entered memory size $mem "
@@ -19,52 +21,53 @@ crc config set memory $mem
 echo "View the CRC config"
 crc config view
 crc setup
-echo "Start the CRC"
+echo "Starting the CRC, make sure you have the right path to pull-secret.txt file"
 crc start -p pull-secret.txt 
 
 
-echo "Openshift admin login"
+
+echo "Openshift login - Take the credentials from the output of previous command. Use admin credentials to login, as you need to install operators"
 oc login
 
 
 echo "Create openshift-metering namespace"
-oc create -f metering-namespace.yaml
+oc create -f https://github.com/skanthed/SSMT/blob/bash-script/openshift-metering-templates/configuration-templates/metering-namespace.yaml
 
 
 oc project openshift-metering
 
 
-echo "Get cluster version"
+echo "Get the cluster versions"
 oc get clusterversion version -ojsonpath='{range .spec.overrides[*]}{.name}{"\n"}{end}' | nl -v 0
 
 
-echo "Patch the cluster version"
+echo "Patch the cluster versions and Replace the unmanged-operator-index to [0 cluster-monitoring-operator]"
 read -p "Enter un-managed operator index : " umidx
 oc patch clusterversion/version --type='json' -p '[{"op":"remove", "path":"/spec/overrides/' + $umidx + '"}]' -oyaml
 sleep 1m
 
 
-echo "Scales the Openshift Monitoring"
+echo "Scaling the Openshift Monitoring"
 oc scale --replicas=1 statefulset --all -n openshift-monitoring; 
 oc scale --replicas=1 deployment --all -n openshift-monitoring
 
 
-echo "Create OperatorGroup object"
-oc create -f metering-og.yaml
+echo "Creating OperatorGroup object"
+oc create -f https://github.com/skanthed/SSMT/blob/bash-script/openshift-metering-templates/configuration-templates/metering-og.yaml
 
 
-echo "Install metering operator"
-oc create -f metering-sub.yaml
+echo "Installing metering operator"
+oc create -f https://github.com/skanthed/SSMT/blob/bash-script/openshift-metering-templates/configuration-templates/metering-sub.yaml
 
 
-echo "Waiting to complete the Metering Creation"
+echo "Waiting to complete the Metering Operator Creation"
 sleep 10m  # 10 mins pause
 
 
 oc get pods
 
 
-echo "Project the openshift metering"
+echo "Now using project the openshift metering"
 oc project openshift-metering
 
 
@@ -73,9 +76,10 @@ oc create -f https://raw.githubusercontent.com/dburugupalli/SSMT/feature-1/opens
 sleep 25m 
 
 
-echo "Get pods details"
+echo "See the status of all component of metering stack"
 oc -n openshift-metering get pods
 
 
-echo "See all the generated reports"
+echo "Verifying Metering Stack / Configuration for local OCP cluster "
+echo "Metering stack creates sample instances of reportdatasource and reportqueries custom resources. "
 oc get reportdatasources -n openshift-metering | grep -v raw

openshift-metering-templates/configuration-templates/metering-sub.yaml

@@ -1,3 +1,4 @@
+#Make sure to change the channel version to the latest version of metering operator
 apiVersion: operators.coreos.com/v1alpha1
 kind: Subscription
 metadata:

report.sh

@@ -1,14 +1,17 @@
 #!/bin/bash
 
+#To view reports on the terminal. 
+
 echo "Get into the openshift metering project"
 oc project openshift-metering
 
-echo "Get the lis of pods"
+echo "Get the list of all pods"
 oc -n openshift-metering get pods
 
 echo "See all the generated reports"
 oc get reportdatasources -n openshift-metering | grep -v raw
 
+
 echo " Setting meteringRoute"
 meteringRoute="$(oc get routes metering -o jsonpath='{.spec.host}')"
 echo "$meteringRoute"