From 8a17ff4f61fcad28c3661071410a0dbf8854df47 Mon Sep 17 00:00:00 2001 From: Ramiro Algozino Date: Wed, 31 Jul 2024 11:44:42 +0200 Subject: [PATCH] docs: prepare release v0.3.0 udpate docs to release v0.3.0 --- README.md | 20 +++++++++++++------- docs/COMPATIBILITY_MATRIX.md | 1 + docs/releases/v0.3.0.md | 4 +++- katalog/gangplank/README.md | 2 +- 4 files changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 826eaab..44e6443 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ ![Slack](https://img.shields.io/badge/slack-@kubernetes/fury-yellow.svg?logo=slack&label=Slack) + **Kubernetes Fury Auth** provides Authentication Management for [Kubernetes Fury Distribution (KFD)][kfd-repo]. If you are new to KFD please refer to the [official documentation][kfd-docs] on how to get started with the distribution. @@ -22,11 +23,11 @@ If you are new to KFD please refer to the [official documentation][kfd-docs] on Kubernetes Fury Auth provides the following packages: -| Package | Version | Description | -| ----------------------------- | --------- | --------------------------------------------------------------------------------- | -| [Pomerium](katalog/pomerium) | `v0.25.0` | Identity-aware proxy that enables secure access to internal applications. | -| [Dex](katalog/dex) | `v2.38.0` | Dex is a Federated OpenID Connect Provider. | -| [Gangplank](katalog/gangplank)| `v1.1.0` | Enable authentication flows via OIDC for a kubernetes cluster. | +| Package | Version | Description | +| ------------------------------ | --------- | ------------------------------------------------------------------------- | +| [Pomerium](katalog/pomerium) | `v0.25.0` | Identity-aware proxy that enables secure access to internal applications. | +| [Dex](katalog/dex) | `v2.38.0` | Dex is a Federated OpenID Connect Provider. | +| [Gangplank](katalog/gangplank) | `v1.1.0` | Enable authentication flows via OIDC for a kubernetes cluster. | ## Compatibility @@ -48,13 +49,13 @@ Check the [compatibility matrix][compatibility-matrix] for additional informatio | [furyctl][furyctl-repo] | `>=0.6.0` | The recommended tool to download and manage KFD modules and their packages. To learn more about `furyctl` read the [official documentation][furyctl-repo]. | | [kustomize][kustomize-repo] | `>=3.5.0` | Packages are customized using `kustomize`. To learn how to create your customization layer with `kustomize`, please refer to the [repository][kustomize-repo]. | -### Deployment +### Deployment with legacy furyctl 1. List the packages you want to deploy and their version in a `Furyfile.yml`: ```yaml versions: - auth: "v0.3.0" + auth: "v0.3.0" bases: - name: auth/pomerium - name: auth/dex @@ -115,6 +116,7 @@ In particular: ### Screenshots + - Dex Login: @@ -130,6 +132,7 @@ In particular: + [furyctl-repo]: https://github.com/sighupio/furyctl [kfd-repo]: https://github.com/sighupio/fury-distribution [kustomize-repo]: https://github.com/kubernetes-sigs/kustomize @@ -137,9 +140,11 @@ In particular: [compatibility-matrix]: https://github.com/sighupio/fury-kubernetes-auth/blob/master/docs/COMPATIBILITY_MATRIX.md [pomerium-repo]: https://github.com/pomerium/pomerium [dex-repo]: https://github.com/dexidp/dex + + ## Contributing Before contributing, please read first the [Contributing Guidelines](docs/CONTRIBUTING.md). @@ -151,4 +156,5 @@ In case you experience any problems with the module, please [open a new issue](h ## License This module is open-source and it's released under the following [LICENSE](LICENSE) + diff --git a/docs/COMPATIBILITY_MATRIX.md b/docs/COMPATIBILITY_MATRIX.md index 7b4a09e..765849a 100644 --- a/docs/COMPATIBILITY_MATRIX.md +++ b/docs/COMPATIBILITY_MATRIX.md @@ -9,6 +9,7 @@ | v0.0.4 | | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | | | v0.1.0 | | | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | | v0.2.0 | | | | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| v0.3.0 | | | | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: Compatible diff --git a/docs/releases/v0.3.0.md b/docs/releases/v0.3.0.md index a00ffd8..82d285f 100644 --- a/docs/releases/v0.3.0.md +++ b/docs/releases/v0.3.0.md @@ -2,11 +2,13 @@ Welcome to the latest release of the Auth module for the Kubernetes Fury Distribution. +This release updates Gangplank to version 1.1.0 and adds a new custom branding to Dex. + ## Included packages | Package | Current Version | Previous Version | | ---------- | ------------------------------------------------------------------------- | ---------------- | -| `dex` | [`v2.38.0`](https://github.com/dexidp/dex/releases/tag/v2.38.0) | `v2.37.0` | +| `dex` | [`v2.38.0`](https://github.com/dexidp/dex/releases/tag/v2.38.0) | `v2.38.0` | | `gangplank`| [`v1.1.0`](https://github.com/sighupio/gangplank/releases/tag/v1.1.0) | `v1.0.0` | | `pomerium` | [`v0.25.0`](https://github.com/pomerium/pomerium/releases/tag/v0.25.0) | `v0.23.0` | diff --git a/katalog/gangplank/README.md b/katalog/gangplank/README.md index a7cf185..3da4737 100644 --- a/katalog/gangplank/README.md +++ b/katalog/gangplank/README.md @@ -16,7 +16,7 @@ Kubernetes supports OpenID Connect Tokens as a way to identify users who access ## Image repository and tag - Gangplank repository: -- Gangplank container image: `registry.sighup.io/fury/gangplank:1.0.0` +- Gangplank container image: `registry.sighup.io/fury/gangplank:1.1.0` ## Configuration