Skip to content

Commit

Permalink
docs: prepare for release v3.0.1
Browse files Browse the repository at this point in the history 
- Update documentation preparing for releasing v3.0.1
- Add release notes for v3.0.1
  • Loading branch information
@ralgozino
ralgozino committed Nov 18, 2024
1 parent ff943f3 commit 61ea74b
Show file tree
Hide file tree
Showing 6 changed files with 71 additions and 17 deletions.
27 changes: 16 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</h1>
<!-- markdownlint-enable MD033 -->

![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)

Expand Down Expand Up @@ -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 |
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -179,7 +184,7 @@ Single Ingress:
```yaml
bases:
- name: ingress/nginx
version: "v2.3.3"
version: "v3.0.1"
```

Dual Ingress:
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/COMPATIBILITY_MATRIX.md
View file
Original file line number Diff line number Diff line change
@@ -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: | | | | | |
Expand All @@ -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

Expand Down
48 changes: 48 additions & 0 deletions docs/releases/v3.0.1.md
View file
Original file line number Diff line number Diff line change
@@ -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.
<!-- spacer -->

> ℹ️ **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 <your-project-path> | 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
4 changes: 2 additions & 2 deletions katalog/cert-manager/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions katalog/dual-nginx/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion katalog/nginx/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 61ea74b

Please sign in to comment.