diff --git a/README.md b/README.md index 5c35f7f..273b080 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ -![Release](https://img.shields.io/badge/Latest%20Release-v2.3.3-blue) +![Release](https://img.shields.io/badge/Latest%20Release-v3.0.1-blue) ![License](https://img.shields.io/github/license/sighupio/fury-kubernetes-ingress?label=License) ![Slack](https://img.shields.io/badge/slack-@kubernetes/fury-yellow.svg?logo=slack&label=Slack) @@ -51,15 +51,20 @@ Kubernetes Fury Ingress provides the following packages: | Kubernetes Version | Compatibility | Notes | | ------------------ | :----------------: | --------------- | -| `1.26.x` | :white_check_mark: | No known issues | -| `1.27.x` | :white_check_mark: | No known issues | | `1.28.x` | :white_check_mark: | No known issues | | `1.29.x` | :white_check_mark: | No known issues | +| `1.30.x` | :white_check_mark: | No known issues | +| `1.31.x` | :white_check_mark: | No known issues | Check the [compatibility matrix][compatibility-matrix] for additional information on previous releases of the module. ## Usage +> [!NOTE] +> Instructions below are for deploying the module using furyctl legacy, that required manual intervention. +> +> Latest versions of furyctl automate the whole process and it is recommended to use the latest version of furyctl instead. + ### Prerequisites | Tool | Version | Description | @@ -118,9 +123,9 @@ To deploy the `cert-manager` package: ```yaml bases: - name: ingress/dual-nginx - version: "v2.3.3" + version: "v3.0.1" - name: ingress/cert-manager - version: "v2.3.3" + version: "v3.0.1" ``` 2. Execute `furyctl vendor -H` to download the packages @@ -179,7 +184,7 @@ Single Ingress: ```yaml bases: - name: ingress/nginx - version: "v2.3.3" + version: "v3.0.1" ``` Dual Ingress: @@ -189,9 +194,9 @@ Dual Ingress: ```yaml bases: - name: ingress/nginx - version: "v2.3.3" + version: "v3.0.1" - name: ingress/dual-nginx - version: "v2.3.3" + version: "v3.0.1" ``` > See `furyctl` [documentation][furyctl-repo] for additional details about `Furyfile.yml` format. @@ -263,11 +268,11 @@ To deploy the `forecastle` package: ```yaml bases: - name: ingress/dual-nginx - version: "v2.3.3" + version: "v3.0.1" - name: ingress/cert-manager - version: "v2.3.3" + version: "v3.0.1" - name: ingress/forecastle - version: "v2.3.3" + version: "v3.0.1" ``` 2. Execute `furyctl legacy vendor -H` to download the packages diff --git a/docs/COMPATIBILITY_MATRIX.md b/docs/COMPATIBILITY_MATRIX.md index 21d166c..b0a7a48 100644 --- a/docs/COMPATIBILITY_MATRIX.md +++ b/docs/COMPATIBILITY_MATRIX.md @@ -1,6 +1,6 @@ # Compatibility Matrix -| Module Version / Kubernetes Version | 1.23.X | 1.24.X | 1.25.X | 1.26.X | 1.27.X | 1.28.X | 1.29.X | 1.30.X | 1.31.X | +| Module Version / Kubernetes Version | 1.23.X | 1.24.X | 1.25.X | 1.26.X | 1.27.X | 1.28.X | 1.29.X | 1.30.X | 1.31.X | |-------------------------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------| | v2.0.0 | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | | | | | | v2.1.0 | | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | | | | @@ -10,6 +10,7 @@ | v2.3.2 | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | v2.3.3 | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | v3.0.0 | | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| v3.0.1 | | | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: Compatible diff --git a/docs/releases/v3.0.1.md b/docs/releases/v3.0.1.md new file mode 100644 index 0000000..e42aaca --- /dev/null +++ b/docs/releases/v3.0.1.md @@ -0,0 +1,48 @@ +# Kubernetes Fury Ingress Core Module Release 3.0.1 + +Welcome to the latest release of `Ingress` module of [`Kubernetes Fury Distribution`](https://github.com/sighupio/fury-distribution) maintained by team SIGHUP. + +This is a maintenance release including: + +- A fix to the NGINX Grafana dashboard to make it compatible with the latest version of the monitoring module. +- Improves the securityContext for Forecastle, making it compliant with the `restricted` Pod Security Standard. + +## Component versions 🚢 + +| Component | Supported Version | Previous Version | +| ------------------ | ---------------------------------------------------------------------------------------- | ---------------- | +| `cert-manager` | [`v1.16.1`](https://github.com/jetstack/cert-manager/releases/tag/v1.16.1) | `No update` | +| `external-dns` | [`v0.15.0`](https://github.com/kubernetes-sigs/external-dns/releases/tag/v0.15.0) | `No update` | +| `forecastle` | [`v1.0.145`](https://github.com/stakater/Forecastle/releases/tag/v1.0.145) | `No update` | +| `nginx` | [`v1.11.3`](https://github.com/kubernetes/ingress-nginx/releases/tag/controller-v1.11.3) | `No update` | +| `aws-cert-manager` | N.A. | `No update` | +| `aws-external-dns` | N.A. | `No update` | + +> Please refer the individual release notes to get a more detailed information on each release. + +## Upgrade Guide 🦮 + +> ⚠️ **WARNING** +> +> The previous release (`v3.0.0`) contains breaking changes that can break your installation. +> +> Please read carefully the [release notes for v3.0.0][v300-rn] before upgrading to this version if you are upgrading from versions < v3.0.0. + + + +> ℹ️ **INFO** +> +> This update guide is for users of the module and not of the Distribution or users still on furyctl legacy. +> If you are a KFD user, the update is performed automatically by furyctl. + +### Process + +To upgrade this core module from `v3.0.0` to `v3.0.1`, you need to download this new version and apply the instructions below. + +```bash +kustomize build | kubectl apply -f - --server-side +``` + +For the Terraform modules, run `terraform init -upgrade`, then apply the new version. + +[v300-rn]: https://github.com/sighupio/fury-kubernetes-ingress/blob/main/docs/releases/v3.0.0.md diff --git a/katalog/cert-manager/README.md b/katalog/cert-manager/README.md index 1d75bd8..f62a80f 100644 --- a/katalog/cert-manager/README.md +++ b/katalog/cert-manager/README.md @@ -33,9 +33,9 @@ To deploy the `cert-manager` package: ```yaml resources: - name: ingress/dual-nginx - version: "v2.3.3" + version: "v3.0.1" - name: ingress/cert-manager - version: "v2.3.3" + version: "v3.0.1" ``` 2. Execute `furyctl legacy vendor -H` to download the packages diff --git a/katalog/dual-nginx/README.md b/katalog/dual-nginx/README.md index 776786d..2956a96 100644 --- a/katalog/dual-nginx/README.md +++ b/katalog/dual-nginx/README.md @@ -33,9 +33,9 @@ Ingress NGINX Double is deployed with the following default configuration: ```yaml bases: - name: ingress/nginx - version: "v2.3.3" + version: "v3.0.1" - name: ingress/dual-nginx - version: "v2.3.3" + version: "v3.0.1" ``` > See `furyctl` [documentation][furyctl-repo] for additional details about `Furyfile.yml` format. diff --git a/katalog/nginx/README.md b/katalog/nginx/README.md index 9b712ad..302c3c1 100644 --- a/katalog/nginx/README.md +++ b/katalog/nginx/README.md @@ -33,7 +33,7 @@ Ingress NGINX single is deployed with the following default configuration: ```yaml bases: - name: ingress/nginx - version: "v2.3.3" + version: "v3.0.1" ``` > See `furyctl` [documentation][furyctl-repo] for additional details about `Furyfile.yml` format.