Skip to content

Commit

Permalink
Add useful information to vagrant readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kasia-kujawa committed Nov 12, 2020
1 parent 2354715 commit 5fe486b
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions vagrant/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,22 @@ After successfull installation you can ssh to the virtual machine with:
vagrant ssh
```

NOTICE: The directory with sumo-kubernetes-collection repository is synced with 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
/sumologic/vagrant/Makefile build
sumo-make build
```

## Collector

To install or upgrade collector please type:

```bash
/sumologic/vagrant/Makefile upgrade
sumo-make upgrade
```

This command will prepare environment (namespaces, receiver-mock, etc.)
Expand All @@ -52,11 +54,25 @@ and after that it will install/upgrade collector in the vagrant environment.
To remove collector please use:

```bash
/sumologic/vagrant/Makefile clean
sumo-make clean
```

List of other useful commands in the Makefile:
List of other useful options for `sumo-make`:

- `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.

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 5fe486b

Please sign in to comment.