Changes in documentation

deploy/README.md

@@ -27,7 +27,7 @@ The diagram below illustrates the components of the Kubernetes collection soluti
 * **Controller Manager.** Makes Controller Manager metrics available on an HTTP metrics port.
 * **node-exporter.** The `node_exporter` add-on exposes node metrics, including CPU, memory, disk, and network utilization.
 * **kube-state-metrics.** Listens to the Kubernetes API server; generates metrics about the state of the deployments, nodes, and pods in the cluster; and exports the metrics as plaintext on an HTTP endpoint listen port.
-* **Prometheus deployment.** Scrapes the metrics exposed by the `node-exporter` add-on for Kubernetes and the `kube-state-metric`s component; writes metrics to a port on the Fluentd deployment.
+* **Prometheus deployment.** Scrapes the metrics exposed by the `node-exporter` add-on for Kubernetes and the `kube-state-metrics` component; writes metrics to a port on the Fluentd deployment.
 * **Fluentd deployment.** Forwards logs and metrics to HTTP sources on a hosted collector. Includes multiple Fluentd plugins that parse and format the metrics and enrich them with metadata.
 * **Events Fluentd deployment.** Forwards events to an HTTP source on a hosted collector.
 

vagrant/README.md

@@ -30,18 +30,32 @@ After successfull installation you can ssh to the virtual machine with:
 vagrant ssh
 ```
 
+NOTICE: The directory with sumo-kubernetes-collection repository on the host is synced with `/sumologic/` directory on the virtual machine.
+
 ## Build
 
-To perform docker image build and to run tests please use `build` target:
+On the virtual machine, to perform docker image build and to run tests please use `build` target:
 
 ```bash
+sumo-make build
+```
+
+or
+
+```
 /sumologic/vagrant/Makefile build
 ```
 
 ## Collector
 
 To install or upgrade collector please type:
 
+```bash
+sumo-make upgrade
+```
+
+or
+
 ```bash
 /sumologic/vagrant/Makefile upgrade
 ```
@@ -51,12 +65,34 @@ and after that it will install/upgrade collector in the vagrant environment.
 
 To remove collector please use:
 
+```bash
+sumo-make clean
+```
+
+or
+
 ```bash
 /sumologic/vagrant/Makefile clean
 ```
 
-List of other useful commands in the Makefile:
+List of other useful targets:
 
 - `expose-prometheus` - exposes prometheus on port 9090 of virtual machine
 - `expose-grafana` - exposes grafana on port 8080 of virtual machine
 - `apply-avalanche` - run one pod deployment of avalanche (metrics generator)
+
+## Test
+
+In order to quickly test whether sumo-kubernetes-collection works, one can use `receiver-mock` for that purpose.
+
+To check receiver-mock logs please use:
+
+```
+kubectl logs $(kubectl get pod -l app=receiver-mock -o jsonpath="{.items[0].metadata.name}"  -n receiver-mock) -n receiver-mock
+```
+
+To check metrics exposed by receiver-mock please use:
+
+```
+kubectl exec $(kubectl get pod -l app=receiver-mock -o jsonpath="{.items[0].metadata.name}"  -n receiver-mock) -it -n receiver-mock -- curl http://localhost:3000/metrics
+```