Skip to content

Commit

Permalink
docs: update upgrade notes (#4651)
Browse files Browse the repository at this point in the history
* update upgrade notes

Signed-off-by: Arko Dasgupta <arko@tetrate.io>

* lint

Signed-off-by: Arko Dasgupta <arko@tetrate.io>

---------

Signed-off-by: Arko Dasgupta <arko@tetrate.io>
  • Loading branch information
arkodg authored Nov 7, 2024
1 parent f7e1600 commit 7f03dd5
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 39 deletions.
4 changes: 4 additions & 0 deletions site/content/en/docs/install/install-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ consideration when debugging.

[`quickstart.yaml`]: https://github.com/envoyproxy/gateway/releases/download/{{< yaml-version >}}/quickstart.yaml

## Upgrading from a previous version

Follow the steps outlined in [this](./install-yaml.md#upgrading-from-v1.1) section if you're upgrading from a previous version.

## Helm chart customizations

Some of the quick ways of using the helm install command for envoy gateway installation are below.
Expand Down
19 changes: 6 additions & 13 deletions site/content/en/docs/install/install-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ installation, it is recommended that you use helm.

Envoy Gateway is designed to run in Kubernetes for production. The most essential requirements are:

* Kubernetes 1.27 or later
* Kubernetes 1.28 or later
* The `kubectl` command-line tool

{{% alert title="Compatibility Matrix" color="warning" %}}
Expand All @@ -38,15 +38,12 @@ Refer to the [Developer Guide](../../contributions/develop) to learn more.

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).

## Upgrading from v1.0
## Upgrading from v1.1

Due to breaking changes in Gateway API v1.1, some manual migration steps are required to upgrade Envoy Gateway to v1.1.
Some manual migration steps are required to upgrade Envoy Gateway to v1.2.

1. Delete `BackendTLSPolicy` CRD (and resources):

```shell
kubectl delete crd backendtlspolicies.gateway.networking.k8s.io
```
1. Update your `GRPCRoute` and `ReferenceGrant` resources if the storage version being used is `v1alpha2`.
Follow the steps in Gateway-API [v1.2 Upgrade Notes](https://gateway-api.sigs.k8s.io/guides/#v12-upgrade-notes)

2. Update Gateway-API and Envoy Gateway CRDs:

Expand All @@ -56,11 +53,7 @@ kubectl apply --force-conflicts --server-side -f ./gateway-helm/crds/gatewayapi-
kubectl apply --force-conflicts --server-side -f ./gateway-helm/crds/generated
```

3. Update your `BackendTLSPolicy` and `GRPCRoute` resources according to Gateway-API [v1.1 Upgrade Notes](https://gateway-api.sigs.k8s.io/guides/#v11-upgrade-notes)

4. Update your Envoy Gateway xPolicy resources: remove the namespace section from targetRef.

5. Install Envoy Gateway {{< yaml-version >}}:
3. Install Envoy Gateway {{< yaml-version >}}:

```shell
helm upgrade eg oci://docker.io/envoyproxy/gateway-helm --version {{< yaml-version >}} -n envoy-gateway-system
Expand Down
4 changes: 4 additions & 0 deletions site/content/en/latest/install/install-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ consideration when debugging.

[`quickstart.yaml`]: https://github.com/envoyproxy/gateway/releases/download/{{< yaml-version >}}/quickstart.yaml

## Upgrading from a previous version

Follow the steps outlined in [this](./install-yaml.md#upgrading-from-v1.1) section if you're upgrading from a previous version.

## Helm chart customizations

Some of the quick ways of using the helm install command for envoy gateway installation are below.
Expand Down
19 changes: 6 additions & 13 deletions site/content/en/latest/install/install-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ installation, it is recommended that you use helm.

Envoy Gateway is designed to run in Kubernetes for production. The most essential requirements are:

* Kubernetes 1.27 or later
* Kubernetes 1.28 or later
* The `kubectl` command-line tool

{{% alert title="Compatibility Matrix" color="warning" %}}
Expand All @@ -38,15 +38,12 @@ Refer to the [Developer Guide](../../contributions/develop) to learn more.

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).

## Upgrading from v1.0
## Upgrading from v1.1

Due to breaking changes in Gateway API v1.1, some manual migration steps are required to upgrade Envoy Gateway to v1.1.
Some manual migration steps are required to upgrade Envoy Gateway to v1.2.

1. Delete `BackendTLSPolicy` CRD (and resources):

```shell
kubectl delete crd backendtlspolicies.gateway.networking.k8s.io
```
1. Update your `GRPCRoute` and `ReferenceGrant` resources if the storage version being used is `v1alpha2`.
Follow the steps in Gateway-API [v1.2 Upgrade Notes](https://gateway-api.sigs.k8s.io/guides/#v12-upgrade-notes)

2. Update Gateway-API and Envoy Gateway CRDs:

Expand All @@ -56,11 +53,7 @@ kubectl apply --force-conflicts --server-side -f ./gateway-helm/crds/gatewayapi-
kubectl apply --force-conflicts --server-side -f ./gateway-helm/crds/generated
```

3. Update your `BackendTLSPolicy` and `GRPCRoute` resources according to Gateway-API [v1.1 Upgrade Notes](https://gateway-api.sigs.k8s.io/guides/#v11-upgrade-notes)

4. Update your Envoy Gateway xPolicy resources: remove the namespace section from targetRef.

5. Install Envoy Gateway {{< yaml-version >}}:
3. Install Envoy Gateway {{< yaml-version >}}:

```shell
helm upgrade eg oci://docker.io/envoyproxy/gateway-helm --version {{< yaml-version >}} -n envoy-gateway-system
Expand Down
4 changes: 4 additions & 0 deletions site/content/en/v1.2/install/install-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ consideration when debugging.

[`quickstart.yaml`]: https://github.com/envoyproxy/gateway/releases/download/{{< yaml-version >}}/quickstart.yaml

## Upgrading from a previous version

Follow the steps outlined in [this](./install-yaml.md#upgrading-from-v1.1) section if you're upgrading from a previous version.

## Helm chart customizations

Some of the quick ways of using the helm install command for envoy gateway installation are below.
Expand Down
19 changes: 6 additions & 13 deletions site/content/en/v1.2/install/install-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ installation, it is recommended that you use helm.

Envoy Gateway is designed to run in Kubernetes for production. The most essential requirements are:

* Kubernetes 1.27 or later
* Kubernetes 1.28 or later
* The `kubectl` command-line tool

{{% alert title="Compatibility Matrix" color="warning" %}}
Expand All @@ -38,15 +38,12 @@ Refer to the [Developer Guide](../../contributions/develop) to learn more.

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).

## Upgrading from v1.0
## Upgrading from v1.1

Due to breaking changes in Gateway API v1.1, some manual migration steps are required to upgrade Envoy Gateway to v1.1.
Some manual migration steps are required to upgrade Envoy Gateway to v1.2.

1. Delete `BackendTLSPolicy` CRD (and resources):

```shell
kubectl delete crd backendtlspolicies.gateway.networking.k8s.io
```
1. Update your `GRPCRoute` and `ReferenceGrant` resources if the storage version being used is `v1alpha2`.
Follow the steps in Gateway-API [v1.2 Upgrade Notes](https://gateway-api.sigs.k8s.io/guides/#v12-upgrade-notes)

2. Update Gateway-API and Envoy Gateway CRDs:

Expand All @@ -56,11 +53,7 @@ kubectl apply --force-conflicts --server-side -f ./gateway-helm/crds/gatewayapi-
kubectl apply --force-conflicts --server-side -f ./gateway-helm/crds/generated
```

3. Update your `BackendTLSPolicy` and `GRPCRoute` resources according to Gateway-API [v1.1 Upgrade Notes](https://gateway-api.sigs.k8s.io/guides/#v11-upgrade-notes)

4. Update your Envoy Gateway xPolicy resources: remove the namespace section from targetRef.

5. Install Envoy Gateway {{< yaml-version >}}:
3. Install Envoy Gateway {{< yaml-version >}}:

```shell
helm upgrade eg oci://docker.io/envoyproxy/gateway-helm --version {{< yaml-version >}} -n envoy-gateway-system
Expand Down

0 comments on commit 7f03dd5

Please sign in to comment.