Skip to content

Commit

Permalink
docs: renames user guides to tasks (#3104)
Browse files Browse the repository at this point in the history
  • Loading branch information
Eitan Suez authored Apr 9, 2024
1 parent cb04431 commit ff5a0b1
Show file tree
Hide file tree
Showing 65 changed files with 155 additions and 152 deletions.
4 changes: 2 additions & 2 deletions site/content/en/latest/contributions/DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ There are many other endpoints on the [Envoy admin interface][] that may be help
### JWT Testing

An example [JSON Web Token (JWT)][jwt] and [JSON Web Key Set (JWKS)][jwks] are used for the [request authentication][]
user guide. The JWT was created by the [JWT Debugger][], using the `RS256` algorithm. The public key from the JWTs
task. The JWT was created by the [JWT Debugger][], using the `RS256` algorithm. The public key from the JWTs
verify signature was copied to [JWK Creator][] for generating the JWK. The JWK Creator was configured with matching
settings, i.e. `Signing` public key use and the `RS256` algorithm. The generated JWK was wrapped in a JWKS structure
and is hosted in the repo.
Expand All @@ -158,6 +158,6 @@ and is hosted in the repo.
[Envoy admin interface]: https://www.envoyproxy.io/docs/envoy/latest/operations/admin#operations-admin-interface
[jwt]: https://tools.ietf.org/html/rfc7519
[jwks]: https://tools.ietf.org/html/rfc7517
[request authentication]: ../user/security/jwt-authentication
[request authentication]: ../tasks/security/jwt-authentication
[JWT Debugger]: https://jwt.io/
[JWK Creator]: https://russelldavies.github.io/jwk-creator/
9 changes: 6 additions & 3 deletions site/content/en/latest/contributions/RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ description: "This section tells the release process of Envoy Gateway."
This document guides maintainers through the process of creating an Envoy Gateway release.

- [Release Candidate](#release-candidate)
- [Prerequisites](#prerequisites)
- [Setup cherry picker action](#setup-cherry-picker-action)
- [Minor Release](#minor-release)
- [Prerequisites](#prerequisites-1)
- [Announce the Release](#announce-the-release)

## Release Candidate
Expand Down Expand Up @@ -65,7 +68,7 @@ export GITHUB_REMOTE=origin
13. Confirm that the [release workflow][] completed successfully.
14. Confirm that the Envoy Gateway [image][] with the correct release tag was published to Docker Hub.
15. Confirm that the [release][] was created.
16. Note that the [Quickstart Guide][] references are __not__ updated for release candidates. However, test
16. Note that the [Quickstart][] references are __not__ updated for release candidates. However, test
the quickstart steps using the release candidate by manually updating the links.
17. [Generate][] the GitHub changelog.
18. Ensure you check the "This is a pre-release" checkbox when editing the GitHub release.
Expand Down Expand Up @@ -203,7 +206,7 @@ export GITHUB_REMOTE=origin
10. Confirm that the [release workflow][] completed successfully.
11. Confirm that the Envoy Gateway [image][] with the correct release tag was published to Docker Hub.
12. Confirm that the [release][] was created.
13. Confirm that the steps in the [Quickstart Guide][] work as expected.
13. Confirm that the steps in the [Quickstart][] work as expected.
14. [Generate][] the GitHub changelog and include the following text at the beginning of the release page:

```console
Expand Down Expand Up @@ -239,7 +242,7 @@ It's important that the world knows about the release. Use the following steps t
[release notes]: https://github.com/envoyproxy/gateway/tree/main/release-notes
[Pull Request]: https://github.com/envoyproxy/gateway/pulls
[Quickstart Guide]: https://github.com/envoyproxy/gateway/blob/main/docs/user/quickstart.md
[Quickstart]: https://github.com/envoyproxy/gateway/blob/main/docs/user/quickstart.md
[Build and Test]: https://github.com/envoyproxy/gateway/blob/main/.github/workflows/build_and_test.yaml
[release GitHub action]: https://github.com/envoyproxy/gateway/blob/main/.github/workflows/release.yaml
[release workflow]: https://github.com/envoyproxy/gateway/actions/workflows/release.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -172,5 +172,5 @@ patches will work.
[EnvoyGateway]: ../../api/extension_types#envoygateway
[Extending the Control Plane]: ./extending-envoy-gateway
[EnvoyFilter]: https://istio.io/latest/docs/reference/config/networking/envoy-filter
[egctl x translate]: ../../user/operations/egctl#egctl-experimental-translate
[Bootstrap configuration using EnvoyProxy API]: ../../user/operations/customize-envoyproxy#customize-envoyproxy-bootstrap-config
[egctl x translate]: ../../tasks/operations/egctl#egctl-experimental-translate
[Bootstrap configuration using EnvoyProxy API]: ../../tasks/operations/customize-envoyproxy#customize-envoyproxy-bootstrap-config
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ Extending Envoy Gateway by using an external extension server which makes use of
[Envoy specific configuration (xDS)]: https://www.envoyproxy.io/docs/envoy/v1.25.1/configuration/configuration
[v1]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1
[rate limiting]: ./rate-limit
[authentication]: ../../user/security/jwt-authentication
[authentication]: ../../tasks/security/jwt-authentication
[HTTPRoute]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute
[GRPCRoute]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1alpha2.GRPCRoute
[EnvoyGateway config]: ../../api/extension_types/#envoygateway
Expand Down
4 changes: 2 additions & 2 deletions site/content/en/latest/install/custom-cert.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ weight: -70

Envoy Gateway establishes a secure TLS connection for control plane communication between Envoy Gateway pods and the Envoy Proxy fleet. The TLS Certificates used here are self signed and generated using a job that runs before envoy gateway is created, and these certs and mounted on to the envoy gateway and envoy proxy pods.

In this guide, we'll walk you through configuring custom certs for control plane auth.
This task will walk you through configuring custom certs for control plane auth.

## Before you begin

We use Cert-Manager to manage the certificates. You can install it by following the [official guide](https://cert-manager.io/docs/installation/kubernetes/).

## Configure custom certs for control plane

1. First you need to set up the CA issuer, in this guide, we use the `selfsigned-issuer` as an example.
1. First you need to set up the CA issuer, in this task, we use the `selfsigned-issuer` as an example.

*You should not use the self-signed issuer in production, you should use a real CA issuer.*

Expand Down
4 changes: 2 additions & 2 deletions site/content/en/latest/install/install-egctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ weight: -80
{{% /alert %}}


This guide shows how to install the egctl CLI. egctl can be installed either from source, or from pre-built binary releases.
This task 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

Expand Down Expand Up @@ -52,6 +52,6 @@ curl -fsSL https://gateway.envoyproxy.io/get-egctl.sh | VERSION=latest bash

{{% alert title="Next Steps" color="warning" %}}

You can refer to [User Guides](../user/operations/egctl) to more details about egctl.
You can refer to the [Use egctl task](../tasks/operations/egctl) for more details about egctl.

{{% /alert %}}
2 changes: 1 addition & 1 deletion site/content/en/latest/install/install-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,5 +140,5 @@ These are the ports used by Envoy Gateway and the managed Envoy Proxy.
| Heath Check | 0.0.0.0 | 19001 |

{{% alert title="Next Steps" color="warning" %}}
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).
Envoy Gateway should now be successfully installed and running. To experience more abilities of Envoy Gateway, refer to [Tasks](../tasks).
{{% /alert %}}
4 changes: 2 additions & 2 deletions site/content/en/latest/install/install-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title = "Install with Kubernetes YAML"
weight = -99
+++

In this guide, we'll walk you through installing Envoy Gateway in your Kubernetes cluster.
This task walks 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
Expand Down Expand Up @@ -36,4 +36,4 @@ Refer to the [Developer Guide](/latest/contributions/develop) to learn more.

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](/latest/user).
Envoy Gateway should now be successfully installed and running, but in order to experience more abilities of Envoy Gateway, you can refer to [Tasks](/latest/tasks).
5 changes: 5 additions & 0 deletions site/content/en/latest/tasks/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Tasks"
weight: 2
description: Learn Envoy Gateway hands-on through tasks
---
5 changes: 5 additions & 0 deletions site/content/en/latest/tasks/extensibility/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Extensibility"
weight: 4
description: This section includes Extensibility tasks.
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Envoy Patch Policy"
---

This guide explains the usage of the [EnvoyPatchPolicy][] API.
This task explains the usage of the [EnvoyPatchPolicy][] API.
__Note:__ This API is meant for users extremely familiar with Envoy [xDS][] semantics.
Also before considering this API for production use cases, please be aware that this API
is unstable and the outcome may change across versions. Use at your own risk.
Expand All @@ -22,7 +22,7 @@ not exposed by Envoy Gateway APIs today.

### Prerequisites

* Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
* Follow the steps from the [Quickstart](../../quickstart) task to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

### Enable EnvoyPatchPolicy
Expand Down
5 changes: 5 additions & 0 deletions site/content/en/latest/tasks/observability/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Observability"
weight: 4
description: This section includes Observability tasks.
---
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The project also provides example dashboard for visualising the metrics using Gr

## Prerequisites

Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

Run the following commands to install the metrics stack, with the Gateway API State Metrics configuration, on your kubernetes cluster:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title: "Visualising metrics using Grafana"
---

Envoy Gateway provides support for exposing Envoy Proxy metrics to a Prometheus instance.
This guide shows you how to visualise the metrics exposed to prometheus using grafana.
This task shows you how to visualise the metrics exposed to prometheus using grafana.

## Prerequisites

Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

Follow the steps from the [Proxy Observability](../proxy-observability#Metrics) to enable prometheus metrics.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title: "Proxy Observability"
---

Envoy Gateway provides observability for the ControlPlane and the underlying EnvoyProxy instances.
This guide show you how to config proxy observability, includes metrics, logs, and traces.
This task show you how to config proxy observability, includes metrics, logs, and traces.

## Prerequisites

Follow the steps from the [Quickstart Guide](../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

[FluentBit](https://fluentbit.io/) is used to collect logs from the EnvoyProxy instances and forward them to Loki. Install FluentBit:
Expand Down
5 changes: 5 additions & 0 deletions site/content/en/latest/tasks/operations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Operations"
weight: 4
description: This section includes Operations tasks.
---
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Service. To learn more about GatewayClass and ParametersRef, please refer to [Ga

## Installation

Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Add GatewayClass ParametersRef
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 1
description: Get started with Envoy Gateway in a few simple steps.
---

This guide will help you get started with Envoy Gateway in a few simple steps.
This "quick start" will help you get started with Envoy Gateway in a few simple steps.

## Prerequisites

Expand Down Expand Up @@ -85,7 +85,7 @@ curl --verbose --header "Host: www.example.com" http://$GATEWAY_HOST/get

## Clean-Up

Use the steps in this section to uninstall everything from the quickstart guide.
Use the steps in this section to uninstall everything from the quickstart.

Delete the GatewayClass, Gateway, HTTPRoute and Example App:

Expand Down
5 changes: 5 additions & 0 deletions site/content/en/latest/tasks/security/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Security"
weight: 2
description: This section includes Security tasks.
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "Backend TLS: Gateway to Backend"
---

This guide demonstrates how TLS can be achieved between the Gateway and a backend. The guide uses a self-signed CA, so it should be used for
testing and demonstration purposes only.
This task demonstrates how TLS can be achieved between the Gateway and a backend.
This task uses a self-signed CA, so it should be used for testing and demonstration purposes only.

Envoy Gateway supports the Gateway-API defined [BackendTLSPolicy][].

Expand All @@ -13,7 +13,7 @@ Envoy Gateway supports the Gateway-API defined [BackendTLSPolicy][].

## Installation

Follow the steps from the [Quickstart Guide](../../quickstart) to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.

## TLS Certificates

Expand Down Expand Up @@ -235,4 +235,4 @@ Inspect the output and see that the response contains the details of the TLS han
}
```

[BackendTLSPolicy]: https://gateway-api.sigs.k8s.io/api-types/backendtlspolicy/
[BackendTLSPolicy]: https://gateway-api.sigs.k8s.io/api-types/backendtlspolicy/
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Basic Authentication"
---

This guide provides instructions for configuring [HTTP Basic authentication][http Basic authentication].
This task provides instructions for configuring [HTTP Basic authentication][http Basic authentication].
HTTP Basic authentication checks if an incoming request has a valid username and password before routing the request to
a backend service.

Expand All @@ -12,7 +12,7 @@ This instantiated resource can be linked to a [Gateway][Gateway], [HTTPRoute][HT

## Prerequisites

Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Configuration
Expand Down Expand Up @@ -45,7 +45,7 @@ kubectl create secret tls example-cert --key=www.example.com.key --cert=www.exam
```

### Enable HTTPS
Update the Gateway from the Quickstart guide to include an HTTPS listener that listens on port `443` and references the
Update the Gateway from the Quickstart to include an HTTPS listener that listens on port `443` and references the
`example-cert` Secret:

```shell
Expand Down Expand Up @@ -128,7 +128,7 @@ kubectl get securitypolicy/basic-auth-example -o yaml

## Testing

Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) is set. If not, follow the
Quickstart instructions to set the variable.

```shell
Expand Down Expand Up @@ -176,7 +176,7 @@ The request should be allowed and you should see the response from the backend s

## Clean-Up

Follow the steps from the [Quickstart](../../quickstart) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to uninstall Envoy Gateway and the example manifest.

Delete the SecurityPolicy and the secret

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "CORS"
---

This guide provides instructions for configuring [Cross-Origin Resource Sharing (CORS)][cors] on Envoy Gateway.
This task provides instructions for configuring [Cross-Origin Resource Sharing (CORS)][cors] on Envoy Gateway.
CORS defines a way for client web applications that are loaded in one domain to interact with resources in a different
domain.

Expand All @@ -11,7 +11,7 @@ This instantiated resource can be linked to a [Gateway][Gateway], [HTTPRoute][HT

## Prerequisites

Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

## Configuration
Expand Down Expand Up @@ -57,7 +57,7 @@ kubectl get securitypolicy/cors-example -o yaml

## Testing

Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) is set. If not, follow the
Quickstart instructions to set the variable.

```shell
Expand Down Expand Up @@ -122,7 +122,7 @@ filter to work. Otherwise, the OPTIONS request won't match the routes and the CO

## Clean-Up

Follow the steps from the [Quickstart](../../quickstart) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to uninstall Envoy Gateway and the example manifest.

Delete the SecurityPolicy:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "External Authorization"
---

This guide provides instructions for configuring external authentication.
This task provides instructions for configuring external authentication.

External authorization calls an external HTTP or gRPC service to check whether an incoming HTTP request is authorized
or not. If the request is deemed unauthorized, then the request will be denied with a 403 (Forbidden) response. If the
Expand All @@ -13,7 +13,7 @@ This instantiated resource can be linked to a [Gateway][Gateway] and [HTTPRoute]

## Prerequisites

Follow the steps from the [Quickstart](../../quickstart) guide to install Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

Verify the Gateway status:
Expand Down Expand Up @@ -97,7 +97,7 @@ kubectl get securitypolicy/ext-auth-example -o yaml

### Testing

Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) is set. If not, follow the
Quickstart instructions to set the variable.

```shell
Expand Down Expand Up @@ -252,7 +252,7 @@ kubectl get backendtlspolicy/grpc-ext-auth-btls -o yaml
### Testing
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) guide is set. If not, follow the
Ensure the `GATEWAY_HOST` environment variable from the [Quickstart](../../quickstart) is set. If not, follow the
Quickstart instructions to set the variable.
```shell
Expand Down Expand Up @@ -290,7 +290,7 @@ curl -v -H "Host: www.example.com" -H "Authorization: Bearer token1" "http://${G
## Clean-Up
Follow the steps from the [Quickstart](../../quickstart) guide to uninstall Envoy Gateway and the example manifest.
Follow the steps from the [Quickstart](../../quickstart) to uninstall Envoy Gateway and the example manifest.
Delete the demo auth services, HTTPRoute, SecurityPolicy and BackendTLSPolicy:
Expand Down
Loading

0 comments on commit ff5a0b1

Please sign in to comment.