Skip to content

Commit

Permalink
Modify vagrant readme, add commands with Makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
kasia-kujawa committed Nov 12, 2020
1 parent 5fe486b commit d10afb5
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions vagrant/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ On the virtual machine, to perform docker image build and to run tests please us
sumo-make build
```

or

```
/sumologic/vagrant/Makefile build
```

## Collector

To install or upgrade collector please type:
Expand All @@ -48,31 +54,46 @@ To install or upgrade collector please type:
sumo-make upgrade
```

or

```bash
/sumologic/vagrant/Makefile upgrade
```

This command will prepare environment (namespaces, receiver-mock, etc.)
and after that it will install/upgrade collector in the vagrant environment.

To remove collector please use:

```bash
sumo-make clean

```

List of other useful options for `sumo-make`:
or

```bash
/sumologic/vagrant/Makefile clean
```

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

To quickly test whether sumo-kubernetes-collection works receiver-mock can be used.
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
```

0 comments on commit d10afb5

Please sign in to comment.