Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: bitliu <[email protected]>
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,6 @@ Add styles or override variables from the theme here. | |
| */ | ||
|
|
||
| $primary: #280C53; | ||
| $secondary: #802A78; | ||
| $dark: #280C53; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| title: "Install egctl" | ||
| weight: -80 | ||
| --- | ||
|
|
||
| {{% alert title="What is egctl?" color="primary" %}} | ||
|
|
||
| `egctl` is a command line tool to provide additional functionality for Envoy Gateway users. | ||
|
|
||
| {{% /alert %}} | ||
|
|
||
|
|
||
| This guide shows how to install the egctl CLI. egctl can be installed either from source, or from pre-built binary releases. | ||
|
|
||
| ### From The Envoy Gateway Project | ||
|
|
||
| The Envoy Gateway project provides two ways to fetch and install egctl. These are the official methods to get egctl releases. Installation through those methods can be found below the official methods. | ||
|
|
||
| ### From the Binary Releases | ||
|
|
||
| Every [release](https://github.com/envoyproxy/gateway/releases) of egctl provides binary releases for a variety of OSes. These binary versions can be manually downloaded and installed. | ||
|
|
||
| 1. Download your [desired version](https://github.com/envoyproxy/gateway/releases) | ||
| 2. Unpack it (tar -zxvf egctl_latest_linux_amd64.tar.gz) | ||
| 3. Find the egctl binary in the unpacked directory, and move it to its desired destination (mv bin/linux/amd64/egctl /usr/local/bin/egctl) | ||
|
|
||
| From there, you should be able to run: `egctl help`. | ||
|
|
||
| ### From Script | ||
|
|
||
| `egctl` now has an installer script that will automatically grab the latest release version of egctl and install it locally. | ||
|
|
||
| You can fetch that script, and then execute it locally. It's well documented so that you can read through it and understand what it is doing before you run it. | ||
|
|
||
| ```shell | ||
| curl -fsSL -o get-egctl.sh https://gateway.envoyproxy.io/get-egctl.sh | ||
|
|
||
| chmod +x get-egctl.sh | ||
|
|
||
| # get help info of the | ||
| bash get-egctl.sh --help | ||
|
|
||
| # install the latest development version of egctl | ||
| bash VERSION=latest get-egctl.sh | ||
| ``` | ||
|
|
||
| Yes, you can just use the below command if you want to live on the edge. | ||
|
|
||
| ```shell | ||
| curl https://gateway.envoyproxy.io/get-egctl.sh | VERSION=latest bash | ||
| ``` | ||
|
|
||
| {{% alert title="Next Steps" color="warning" %}} | ||
|
|
||
| You can refer to [User Guides](../../user/egctl) to more details about egctl. | ||
|
|
||
| {{% /alert %}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| +++ | ||
| title = "Install with Helm" | ||
| weight = -100 | ||
| +++ | ||
|
|
||
| [Helm](https://helm.sh) is a package manager for Kubernetes that automates the release and management of software on Kubernetes. | ||
|
|
||
| Envoy Gateway can be installed via a Helm chart with a few simple steps, depending on if you are deploying for the first time, upgrading Envoy Gateway from an existing installation, or migrating from Envoy Gateway. | ||
|
|
||
| ## Before you begin | ||
|
|
||
| {{% alert title="Compatibility Matrix" color="warning" %}} | ||
| Refer to the [Version Compatibility Matrix](/blog/2022/10/01/versions/) to learn more. | ||
| {{% /alert %}} | ||
|
|
||
| The Envoy Gateway Helm chart is hosted by DockerHub. | ||
|
|
||
| It is published at `oci://docker.io/envoyproxy/gateway-helm`. | ||
|
|
||
| {{% alert title="Note" color="primary" %}} | ||
| We use `v0.0.0-latest` as the latest development version. | ||
|
|
||
| You can visit [Envoy Gateway Helm Chart](https://hub.docker.com/r/envoyproxy/gateway-helm/tags) for more releases. | ||
| {{% /alert %}} | ||
|
|
||
| ## Install with Helm | ||
|
|
||
| Envoy Gateway is typically deployed to Kubernetes from the command line. If you don't have Kubernetes, you should use `kind` to create one. | ||
|
|
||
| {{% alert title="Developer Guide" color="primary" %}} | ||
| Refer to the [Developer Guide](../../contributions/develop) to learn more. | ||
| {{% /alert %}} | ||
|
|
||
| When you run the Helm chart, it installs Envoy Gateway. | ||
|
|
||
| 1. Install the Gateway API CRDs and Envoy Gateway with the following command: | ||
|
|
||
| ``` shell | ||
| helm install eg oci://docker.io/envoyproxy/gateway-helm --version v0.0.0-latest -n envoy-gateway-system --create-namespace | ||
| ``` | ||
|
|
||
| 2. Next Steps | ||
|
|
||
| Envoy Gateway should now be successfully installed and running, but in order to experience more abilities of Envoy Gateway, you can refer to [User Guides](../../user). | ||
|
|
||
| For more advanced configuration and details about helm values, please see the [Helm Chart Values](../api). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| +++ | ||
| title = "Install with Kubernetes YAML" | ||
| weight = -99 | ||
| +++ | ||
|
|
||
| In this guide, we'll walk you through installing Envoy Gateway in your Kubernetes cluster. | ||
|
|
||
| The manual install process does not allow for as much control over configuration | ||
| as the [Helm install method](../install-helm), so if you need more control over your Envoy Gateway | ||
| installation, it is recommended that you use helm. | ||
|
|
||
| ## Before you begin | ||
|
|
||
| Envoy Gateway is designed to run in Kubernetes for production. The most essential requirements are: | ||
|
|
||
| * Kubernetes 1.25 or later | ||
| * The `kubectl` command-line tool | ||
|
|
||
| {{% alert title="Compatibility Matrix" color="warning" %}} | ||
| Refer to the [Version Compatibility Matrix](/blog/2022/10/01/versions/) to learn more. | ||
| {{% /alert %}} | ||
|
|
||
| ## Install with YAML | ||
|
|
||
| Envoy Gateway is typically deployed to Kubernetes from the command line. If you don't have Kubernetes, you should use `kind` to create one. | ||
|
|
||
| {{% alert title="Developer Guide" color="primary" %}} | ||
| Refer to the [Developer Guide](../../contributions/develop) to learn more. | ||
| {{% /alert %}} | ||
|
|
||
| 1. In your terminal, run the following command: | ||
|
|
||
| ```shell | ||
| kubectl apply -f https://github.com/envoyproxy/gateway/releases/download/latest/install.yaml | ||
| ``` | ||
|
|
||
| 2. Next Steps | ||
|
|
||
| Envoy Gateway should now be successfully installed and running, but in order to experience more abilities of Envoy Gateway, you can refer to [User Guides](../../user). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters