-
Notifications
You must be signed in to change notification settings - Fork 183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes in documentation #1084
Changes in documentation #1084
Conversation
vagrant/README.md
Outdated
```bash | ||
/sumologic/vagrant/Makefile build | ||
sumo-make build | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
keep the old one as alternative as well ... or ...
(2 snippets)
vagrant/README.md
Outdated
```bash | ||
/sumologic/vagrant/Makefile upgrade | ||
sumo-make upgrade | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto
vagrant/README.md
Outdated
```bash | ||
/sumologic/vagrant/Makefile clean | ||
sumo-make clean | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto
vagrant/README.md
Outdated
|
||
## Test | ||
|
||
To quickly test whether sumo-kubernetes-collection works receiver-mock can be used. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
🤷🏻
vagrant/README.md
Outdated
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 | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Empty lines around snippet backticks
vagrant/README.md
Outdated
sumo-make clean | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sumo-make clean | |
sumo-make clean |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
redundant empty line
d10afb5
to
17e80dd
Compare
vagrant/README.md
Outdated
@@ -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 is synced with the virtual machine. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NOTICE: The directory with sumo-kubernetes-collection repository is synced with the virtual machine. | |
NOTICE: The directory with sumo-kubernetes-collection repository on the host is synced with `/sumologic/` directory on the virtual machine. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ping @kkujawa-sumo
@pmalek-sumo please take another look |
|
||
``` | ||
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 | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could add those commands as new targets to the Makefile
. Not necessary in this PR :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could add those commands as new targets to the
Makefile
. Not necessary in this PR :)
I'll add this in a new PR
Description
Testing performed