Skip to content
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

Added install instructions to README and simplified provided config structure #89

Merged
merged 3 commits into from
Jul 23, 2020

Conversation

itzg
Copy link
Contributor

@itzg itzg commented Jul 23, 2020

Resolves

https://jira.rax.io/browse/SALUS-963

What

The Envoy README was missing installation instructions.

How

  • Added an installation instructions section with specifics for Debian variants and Redhat variants
  • Simplified the config file step by avoiding the template file part by having package install just drop the file in final location
  • Updated the package-installed config file to match the "auth_token" update

How to test

Do a local make snapshot, copy the deb/rpm over to a VM, and use the install procedure.

To copy the file over I used gcloud's scp subcommand, such as:

gcloud beta compute scp --zone "$ZONE" --project "$PROJECT_ID" dist/telemetry-envoy_0.17.0-SNAPSHOT-093313a_Linux_x86_64.rpm $VM_NAME:

Copy link
Contributor

@jjbuchan jjbuchan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

README.md Outdated

### Debian / Ubuntu

> This installation process is supported on Debian 8 / Ubuntu 15.04 and newer
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

15 sounded old and I found this

As a non-LTS release, 15.04 has a 9-month month support cycle and, as such, the support period is now nearing its end and Ubuntu 15.04 will reach end of life on Thursday, February 4th

That's from 2016. Even if it technically works for 15, is it safer just to put 16.04 which has another year of support?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was listing the bare minimum systemd supported versions from

https://en.wikipedia.org/wiki/Systemd#Adoption

however, since this section could easily imply OS versions we support then I like the idea of 16.04 being there.

Enable and start the service using:
```shell script
sudo systemctl enable telemetry-envoy
sudo systemctl start telemetry-envoy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is systemctl on all debian things? or is this one of those that will be on some and not others?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's on all the versions listed above, as you'll see in the wiki link.


The service logs can be viewed using:
```shell script
journalctl -f -u telemetry-envoy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

journalctl is a new command for me

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, it's systemctl's friend for syslog viewing.

json:
bind: localhost:8094
lineProtocol:
bind: ""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this and lumberjack be commented out initially instead?

I keep forgetting what lumberjack is but I don't think we use it most of the time?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really lumberjack needs to be ripped out since it was intended for log file gathering, but we have never fully retrofitted for it after the etcd->sql switch.

As for removing it, I would need to look closer at how the defaults are working. Viper config stuff is annoying to interpret.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...and line protocol is there to allow for customers to proxy their own metrics envoy if they want. I think I found how to default these to "", so I'll do that for both.

@itzg itzg requested a review from jjbuchan July 23, 2020 18:41
@itzg itzg merged commit ebd46f1 into master Jul 23, 2020
@itzg itzg deleted the itzg/add-install-instructions branch July 23, 2020 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants