Skip to content

Commit

Permalink
Merge pull request #111 from sighupio/release-1-25-4
Browse files Browse the repository at this point in the history
docs: add 1.25.4 release docs
  • Loading branch information
alessiodionisi authored Jul 5, 2023
2 parents 009396c + bf0b21f commit 2fe55ec
Show file tree
Hide file tree
Showing 8 changed files with 183 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
<p align="center">Kubernetes Fury Distribution (KFD) is a certified battle-tested Kubernetes distribution based purely on upstream Kubernetes.</p>
<!-- markdownlint-enable MD033 -->

[![Build Status](http://ci.sighup.io/api/badges/sighupio/fury-distribution/status.svg?ref=refs/tags/v1.25.3)](http://ci.sighup.io/sighupio/fury-distribution)
[![Release](https://img.shields.io/badge/release-v1.25.3-blue?label=FuryDistributionRelease)](https://github.com/sighupio/fury-distribution/releases/latest)
[![Build Status](http://ci.sighup.io/api/badges/sighupio/fury-distribution/status.svg?ref=refs/tags/v1.25.4)](http://ci.sighup.io/sighupio/fury-distribution)
[![Release](https://img.shields.io/badge/release-v1.25.4-blue?label=FuryDistributionRelease)](https://github.com/sighupio/fury-distribution/releases/latest)
[![Slack](https://img.shields.io/badge/slack-@kubernetes/fury-yellow.svg?logo=slack)](https://kubernetes.slack.com/archives/C0154HYTAQH)
[![License](https://img.shields.io/github/license/sighupio/fury-distribution)](https://github.com/sighupio/fury-distribution/blob/main/LICENSE)

Expand Down Expand Up @@ -95,18 +95,18 @@ Current supported versions of KFD are:

| KFD Version | Kubernetes Version |
| :----------------------------------------------------------------------------: | :----------------: |
| [`1.25.3`](https://github.com/sighupio/fury-distribution/releases/tag/v1.25.3) | `1.25.x` |
| [`1.25.4`](https://github.com/sighupio/fury-distribution/releases/tag/v1.25.4) | `1.25.x` |
| [`1.24.1`](https://github.com/sighupio/fury-distribution/releases/tag/v1.24.1) | `1.24.x` |
| [`1.23.4`](https://github.com/sighupio/fury-distribution/releases/tag/v1.23.3) | `1.23.x` |

| Installer / KFD Version | 1.25.3 | 1.24.1 | 1.23.4 |
| Installer / KFD Version | 1.25.4 | 1.24.1 | 1.23.4 |
| ---------------------------------------------------------------------- | :----------------: | :----------------: | :----------------: |
| [on-premises](https://github.com/sighupio/fury-kubernetes-on-premises) | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [EKS](https://github.com/sighupio/fury-eks-installer) | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [GKE](https://github.com/sighupio/fury-gke-installer) | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [AKS](https://github.com/sighupio/fury-aks-installer) | :white_check_mark: | :white_check_mark: | :white_check_mark: |

Check the [compatibility matrix][compatibility-matrix] for additional information about previous releases of the Distribution.
Check the [compatibility matrix][compatibility-matrix] for additional information about previous releases of the Distribution and the compatibility with `furyctl`.

Also, check the [versioning documentation file][versioning] to know more about the versioning scheme of the distribution and the upgrade path.

Expand Down
11 changes: 11 additions & 0 deletions docs/COMPATIBILITY_MATRIX.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ For a complete list of all KFD releases and their compatibility with Kubernetes

| KFD / Kubernetes Version | 1.25.X | 1.24.X | 1.23.X |
| ----------------------------------------------------------------------------- | :----------------: | :----------------: | :----------------: |
| [v1.25.4](https://github.com/sighupio/fury-distribution/releases/tag/v1.25.4) | :white_check_mark: | | |
| [v1.25.3](https://github.com/sighupio/fury-distribution/releases/tag/v1.25.3) | :white_check_mark: | | |
| [v1.25.2](https://github.com/sighupio/fury-distribution/releases/tag/v1.25.2) | :white_check_mark: | | |
| [v1.25.1](https://github.com/sighupio/fury-distribution/releases/tag/v1.25.1) | :white_check_mark: | | |
Expand All @@ -28,6 +29,16 @@ For a complete list of all KFD releases and their compatibility with Kubernetes
| :warning: | Has known issues |
| :x: | Incompatible |

### Furyctl and KFD compatibility

| Furyctl / KFD | 1.25.4 | 1.25.3 | 1.25.2 |
| -------------- | ------------------ | ------------------ | ------------------ |
| 0.25.0 | :white_check_mark: | | |
| 0.25.0-beta.0 | | :white_check_mark: | |
| 0.25.0-alpha.1 | | | :white_check_mark: |

See [Furyctl](https://github.com/sighupio/furyctl) repository for more informations on it's usage.

### Warnings

- :x: version `v1.23.0` has a known bug that breaks upgrades. Do not use.
Expand Down
18 changes: 18 additions & 0 deletions docs/releases/v1.25.4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Kubernetes Fury Distribution Release v1.25.4

Welcome to KFD release `v1.25.4`.

The distribution is maintained with ❤️ by the team [SIGHUP](https://sighup.io/) it is battle tested in production environments.

With this release, we have added a new provider called KFDDistribution that allows installing the Fury distribution on any Kubernetes cluster.
We have also added the ability to enable and disable certain features of the distribution.

## New Features since `v1.25.3`

- [#107](https://github.com/sighupio/fury-distribution/pull/107) Added apply and delete script templates to enhance the apply phase for all the manifests
- [#108](https://github.com/sighupio/fury-distribution/pull/108) Some of the modules/packages can now be disabled or configured with the new configuration property `type`
- [#95](https://github.com/sighupio/fury-distribution/pull/95) Added schema to support the new `KFDDistribution` kind

## Upgrade procedure

Check the [v1.25.3-to-v1.25.4 upgrade guide](../upgrades/v1.25.3-to-v1.25.4.md) for the detailed procedure.
34 changes: 34 additions & 0 deletions docs/upgrades/v1.25.3-to-v1.25.4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Kubernetes Fury Distribution v1.25.3 to 1.25.4 Upgrade Guide

This guide describes the steps to follow to upgrade the Kubernetes Fury Distribution (KFD) from v1.25.3 to 1.25.4.

If you are running a custom set of modules, or different versions than the ones included with each release of KFD, please refer to each module's release notes.

Notice that the guide will not cover changes related to the cloud provider, ingresses or pod placement changes. Only changes related to KFD and its modules.

> ⛔️ **IMPORTANT**
> we strongly recommend reading the whole guide before starting the upgrade process to identify possible blockers.
## Upgrade procedure

### 1. Using furyctl

Change `.spec.distributionVersion` on your `furyctl.yaml` file with the new `v1.25.4`.

Validate the schema using the new `v0.25.0` `furyctl` version:

```bash
furyctl validate config
```

Add the new fields that are now required, for example `.spec.distribution.modules.dr.type`.

Apply the new configuration on the cluster with:

```bash
furyctl create cluster
```

### 2. Using KFD directly

There are no changes on the modules since the version v1.25.3.
2 changes: 1 addition & 1 deletion kfd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file.

version: v1.25.3
version: v1.25.4
modules:
auth: v0.0.3
aws: v3.0.0
Expand Down
29 changes: 29 additions & 0 deletions releases/v1.25.4/Furyfile.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Copyright (c) 2022 SIGHUP s.r.l All rights reserved.
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file.

---
versions:
auth: v0.0.3
aws: v3.0.0
dr: v2.0.0
ingress: v2.0.0
logging: v3.1.3
monitoring: v2.1.0
opa: v1.8.0
networking: v1.13.0

bases:
- name: auth
- name: aws
- name: dr
- name: ingress
- name: logging
- name: monitoring
- name: networking
- name: opa

modules:
- name: aws
- name: dr
- name: ingress
40 changes: 40 additions & 0 deletions releases/v1.25.4/kfd.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Copyright (c) 2017-present SIGHUP s.r.l All rights reserved.
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file.

version: v1.25.4
modules:
auth: v0.0.3
aws: v3.0.0
dr: v2.0.0
ingress: v2.0.0
logging: v3.1.3
monitoring: v2.1.0
opa: v1.8.0
networking: v1.13.0
kubernetes:
eks:
version: 1.25
installer: v2.0.0
furyctlSchemas:
eks:
- apiVersion: kfd.sighup.io/v1alpha2
kind: EKSCluster
kfddistribution:
- apiVersion: kfd.sighup.io/v1alpha2
kind: KFDDistribution
tools:
common:
furyagent:
version: 0.3.0
kubectl:
version: 1.25.8
kustomize:
version: 3.10.0
terraform:
version: 1.4.6
yq:
version: 4.34.1
eks:
awscli:
version: 2.8.12
45 changes: 45 additions & 0 deletions releases/v1.25.4/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Copyright (c) 2017-present SIGHUP s.r.l All rights reserved.
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file.

---
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

# NB: This is a starting point for a kustomization.yaml file. It is not meant to be used in production as is.

resources:
# Networking
- ./vendor/katalog/networking/calico
# OPA
- ./vendor/katalog/opa/gatekeeper/core
- ./vendor/katalog/opa/gatekeeper/rules/templates
- ./vendor/katalog/opa/gatekeeper/rules/config
- ./vendor/katalog/opa/gatekeeper/gpm
# Monitoring
- ./vendor/katalog/monitoring/prometheus-operator
- ./vendor/katalog/monitoring/prometheus-operated
- ./vendor/katalog/monitoring/grafana
- ./vendor/katalog/monitoring/kubeadm-sm
- ./vendor/katalog/monitoring/kube-proxy-metrics
- ./vendor/katalog/monitoring/kube-state-metrics
- ./vendor/katalog/monitoring/node-exporter
- ./vendor/katalog/monitoring/prometheus-adapter
- ./vendor/katalog/monitoring/alertmanager-operated
# Logging
- ./vendor/katalog/logging/opensearch-single
- ./vendor/katalog/logging/opensearch-dashboards
- ./vendor/katalog/logging/cerebro
- ./vendor/katalog/logging/logging-operator
- ./vendor/katalog/logging/logging-operated
- ./vendor/katalog/logging/minio-ha
- ./vendor/katalog/logging/loki-distributed
- ./vendor/katalog/logging/configs
# Ingress
- ./vendor/katalog/ingress/cert-manager
- ./vendor/katalog/ingress/nginx
- ./vendor/katalog/ingress/forecastle
# DR
- ./vendor/katalog/dr/velero/velero-on-prem
- ./vendor/katalog/dr/velero/velero-schedules
- ./vendor/katalog/dr/velero/velero-restic

0 comments on commit 2fe55ec

Please sign in to comment.