tetratelabs-attic/getenvoy.io

Source for the GetEnvoy website

Building

❗ Prerequisites

You need to have the latest/LTS node and npm versions installed.

Next step, clone this repository and run:

npm install

This will take some time and will install all packages necessary to run the website.

👷 Development

While developing the website, use:

npm start

or for developing the website with hugo server --buildDrafts --buildFuture, use:

npm run preview

Then visit http://localhost:3000/ - or a new browser windows popped-up already - to preview your new website. Webpack Dev Server will automatically reload the CSS or refresh the whole page, when stylesheets or content changes.

getenvoy.io's Issues

Getting started tutorials linked in installation pages.

Similar to the see also section in the Istio docs, but specifically targetted at getting started with Envoy tutorials.

Add indicator to copy button in code box

As suggested in #104 , need to add an indicator to the code box copy button, to indicate that the button is clickable. This can be happening when somebody hovers on that button.

Document and Blog about CLI

Installation

• Binary via Github
• Homebrew
• Docker (tetratelabs/func-e#49)

Getting Started

• CLI vs Envoy page
• Envoy Subsection
• CLI Subsection

Other

• Sidebar docs
• Sidebar envs
• Homepage
• Blog post
• Autogenerate Commandline Docs
• Test for deadlinks

Copy functionality on code boxes

Similar to Istio docs.

Repo list section detailing the repo structure

• GetEnvoy.io
• Envoy-Package
• GetEnvoy

Turn blog functionality back on

• Single page (should mostly be done)
• List of posts
• Ability to add a publish on time
• Link to blog list nav bar

Document any requirements and the list supported OS version for CentOS/RHEL

glibc versions, etc.

Should be at the top of the installation pages.

Have links and references to GetEnvoy.io on EnvoyProxy.io

Also, update dates on getenvoy.io blog posts.

Host the download script here

Right now, there's a confusingly named file in the getenvoy repository https://raw.githubusercontent.com/tetratelabs/getenvoy/master/godownloader.sh

The name only makes sense if you have used godownloader before. Otherwise, it appears that this is likely to be a way to download go.

This file should be moved here, renamed to something more sensible, like download_getenvoy and updated as since 2019 there must have been glitch fixes.

Disable automatic copy-pasting on code boxes

What is incorrect, confusing or missing: Highlighting text on e.g. https://www.getenvoy.io/platforms/envoy/ubuntu/ copies the text automatically to the clipboard

Suggested fix: Change this to be a button next to the text, or disable the feature altogether

---

Background: The way that this has been implemented (in #9) has a few challenges:

• It will overwrite the user's clipboard without asking. This is rather impolite and could potentially lead to data loss (what if the user has some very critical text/password in the clipboard and selects text on this web page by accident?)

• It will deselect the text after copying, which means that if you as a user will press Ctrl-C after selecting (like you normally do when you want to copy-paste text from a web page), this is not even possible. To me, this feels confusing and annoying, since it essentially breaks an existing feature in the web browser.

• The implementation has flaws; if you double click, then continue selecting, you might end up with parts of the "Copied command to clipboard" text in your clipboard.

For me personally, this feature does much more harm than good. I would be fine with a button for copying the command to the clipboard (like some web pages do it; can't find any good example of it right now). It can even be overlaid on top of the <pre> element if we want to avoid affecting other content on the page.

All things considered, thanks for a great project - I am very thankful for what the work you have done thus far. 👍 👍 👍

Document any requirements and the list supported OS version for MacOS

glibc versions, xcode, etc.

Should be at the top of the installation pages.

Document any requirements and the list supported OS version for Ubuntu/Debian

glibc versions, etc.

Should be at the top of the installation pages.

Tutorial for a Front Proxy for two services running on a single VM

This but with Envoy and the two services running as processes, not in containers.

Fix and verify mobile rendering on all pages

https://files.slack.com/files-pri/TB9P88K1N-FKD6F76H3/screenshot_20190607-213742.png

Document CentOS and RHEL installation

getenvoy.io does not forward to www.getenvoy.io

@liamawhite or maybe @ZackButcher this is probably worth fixing.

Form collection for GetEnvoy

@ZackButcher and @gusreiber agree that it is a good idea to try to collect lead data, but at the moment, we don't have a service to collect the emails nor do we have a platform on which we could build our own form capture.

The quickest answer would be to upgrade our existing MailChimp account to $10/month basic account so we can add seats and a second list/site.

@zinuga @pragashj if you agree it is worth it, we need to add a payment method to the MailChimp account or find another way.

Update standalone binary installation docs for Ubuntu/debian that refer to 'bintray'

What is incorrect, confusing or missing:

The current documentation here and here, refer to the repository hosted in bintray: https://dl.bintray.com/tetrate/getenvoy-deb which is being sunset on May 1st 2021 https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/

Suggested fix:
This commit seems to suggest that the binaries have been migrated to clousmith: tetratelabs/func-e@18ec725

The installation docs for Ubuntu/debian should be updated to reflect the same.

systemd service file example for start|reload|stop envoy

What is incorrect, confusing or missing:

What I find to be missing is an example systemd service file for the common ops of administrating envoy, such as start, stop, reload.
That would be of great help for an envoy newbie such as myself and others I assume.

Suggested fix:

Following our conversation in Slack, would you be so kind to document an example of
a systemd service file for starting, reloading, stopping envoy when installed using get envoy.io ?

Verified build might be a better way than certified build

Certification as a process doesn't exist yet for Envoy. This may be misleading to end-users.

Add "installation" page for Docker usage

This should have an intro at the top containing information about the what and why of distroless.

Tutorials list page

Similar to the list page for platforms but for the Tutorials. Would also be good if it was under the header of the sub category.

e.g.

Getting Started

• Getting started with Envoy as a basic front proxy
  ...

Fold this into https://github.com/tetratelabs/getenvoy

Especially after builds migrate upstream, this repo will only describe the CLI at https://github.com/tetratelabs/getenvoy

Having this split apart has caused needless memory and navigation, including synchronizing files across multiple repos to publish the "latest" version of envoy, confusion about why the download script doesn't exist in the same place as it is published (#157) and even things like markdown generation (tetratelabs/func-e#205)

When you consider the this repo will only describe a CLI with not even 10 commands, the complexity of splitting this into a separate repository is questionable and largely ensures work takes longer and can miss more steps.

I implore us to start hating complexity by allowing this repo to merge with https://github.com/tetratelabs/getenvoy either by a subdir/monorepo style or in worst case gh-pages branch

Detailed blog on envoy extenstions and how to write/use them

As part of GetEnvoy launch, we would like to have a couple of good technical blogs around Envoy, its extensions. Assigning this one to Lizan.

Cross post Envoy basics and extensibility

From here -> https://www.tetrate.io/blog/envoybasicsandextensibility/

Document RHEL installation

404s for favicon.png and reset.css

While reset.css probably not necessary anymore

Open source getenvoy-package and getenvoy.io

Depends on #49 and tetratelabs-attic/getenvoy-package#7.

• Add issue template (here)
• Add issue template (package)
• Open them up!

Launch Blog for GetEnvoy

Cover the following the blog.

• Intro to Envoy and Why Envoy
• Problems in build, fetch, patch
• Introducing GetEnvoy
• Cover hybrid and multi cloud
• Works with all clouds - AWS, GCP and Azure
• Cover features
• Works with Traffic Director
• Provide links to end to end example a developer can try.

Syntax highlighting

https://gohugo.io/content-management/syntax-highlighting/

Document getting started with Envoy Binaries

Should cover the use case of basic front proxy pointing to Google.

Repo READMEs all detail the repo structure.

Readmes for each repository detail the repository structure.

Apt repository missing builds previously available on bintray

I use Hashicorp Consul, which has specific compatibility of versions of Envoy (https://www.consul.io/docs/connect/proxies/envoy#supported-versions). Versions that were previously available on bintray are no longer available on the new repository host.

For example, these latest patch builds for the 16, 17 and 18 minor versions are missing:
getenvoy-envoy_1.16.4.p0.gbf5d0eb-1p74.gbb8060d_amd64.deb
getenvoy-envoy_1.17.3.p0.g46bf743-1p74.gbb8060d_amd64.deb
getenvoy-envoy_1.18.3.p0.g98c1c9e-1p77.gb76c773_amd64.deb

Oddly the version history on the Envoy docs do not list these, though they are tagged in github source. https://www.envoyproxy.io/docs/envoy/latest/version_history/version_history

CentOS 7 `GLIBC_2.18' not found

Describe the bug
On CentOS 7 Envoy fails with error:

 /usr/local/bin/versions/1.16.4/bin/envoy --help
/usr/local/bin/versions/1.16.4/bin/envoy: /lib64/libc.so.6: version `GLIBC_2.18' not found (required by /usr/local/bin/versions/1.16.4/bin/envoy)

To Reproduce
Steps to reproduce the behavior:

1. Install func-e on CentOS 7 curl -L https://getenvoy.io/install.sh | bash -s -- -b /usr/local/bin
2. Install Envoy: /usr/local/bin/func-e --home-dir /usr/local/bin use 1.16.4
3. See error

Expected behavior
Help message to be displayed.

Screenshots
If applicable, add screenshots to help explain your problem.

# more /etc/redhat-release 
CentOS Linux release 7.3.1611 (Core) 
# /usr/local/bin/versions/1.16.4/bin/envoy --help
/usr/local/bin/versions/1.16.4/bin/envoy: /lib64/libc.so.6: version `GLIBC_2.18' not found (required by /usr/local/bin/versions/1.16.4/bin/envoy)

Environment (please complete the relevant information):

• OS: CentOS Linux release 7.3.1611
• Envoy Version: 1.16.4

Additional context
The removal of the yum repository was unfortunate.

The removal of the RPM instruction page without forwarding was also unfortunate.

The lack of explanation for the changes to the installation methods in a place which is easy to find is super unfortunate.

Perhaps someone could clarify if the rpm.dl.getenvoy.io yum repository will be supported for a time as a legacy source for CentOS 7? Instructions for the repository were on the website yesterday but have been removed without explanation. Perhaps the lack of explanation could be corrected?

Document getting started with Traffic Director

Ready for co-launch with Traffic Director.