Skip to content

Commit

Permalink
Merge pull request #187 from sighupio/docs/v3.3.0-release-notes
Browse files Browse the repository at this point in the history 
docs/v3.3.0: prepare docs for release
  • Loading branch information
@ralgozino
ralgozino authored Nov 18, 2024
2 parents fc1db61 + ca1eb56 commit dff093c
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 41 deletions.
42 changes: 21 additions & 21 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-v3.2.0-blue)
![Release](https://img.shields.io/badge/Latest%20Release-v3.3.0-blue)
![License](https://img.shields.io/github/license/sighupio/fury-kubernetes-monitoring?label=License)
![Slack](https://img.shields.io/badge/slack-@kubernetes/fury-yellow.svg?logo=slack&label=Slack)

Expand Down Expand Up @@ -48,19 +48,19 @@ Kubernetes Fury Monitoring provides the following packages:

| Package | Version | Description |
| ------------------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------- |
| [prometheus-operator](katalog/prometheus-operator) | `0.67.1` | Operator to deploy and manage Prometheus and related resources |
| [prometheus-operated](katalog/prometheus-operated) | `2.46.0` | Prometheus instance deployed with Prometheus Operator's CRD |
| [prometheus-operator](katalog/prometheus-operator) | `0.76.2` | Operator to deploy and manage Prometheus and related resources |
| [prometheus-operated](katalog/prometheus-operated) | `2.54.1` | Prometheus instance deployed with Prometheus Operator's CRD |
| [alertmanager-operated](katalog/alertmanager-operated) | `0.26.0` | Alertmanager instance deployed with Prometheus Operator's CRD |
| [blackbox-exporter](katalog/blackbox-exporter) | `0.24.0` | Prometheus exporter that allows blackbox probing of endpoints over HTTP, HTTPS, DNS, TCP, ICMP and gRPC. |
| [grafana](katalog/grafana) | `9.5.5` | Grafana deployment to query and visualize metrics collected by Prometheus |
| [blackbox-exporter](katalog/blackbox-exporter) | `0.25.0` | Prometheus exporter that allows blackbox probing of endpoints over HTTP, HTTPS, DNS, TCP, ICMP and gRPC. |
| [grafana](katalog/grafana) | `11.3.0` | Grafana deployment to query and visualize metrics collected by Prometheus |
| [karma](katalog/karma) | `0.113` | Karma deployment to visualize alerts sent by AlertManager |
| [kube-proxy-metrics](katalog/kube-proxy-metrics) | `0.14.0` | RBAC proxy to securely expose kube-proxy metrics |
| [kube-state-metrics](katalog/kube-state-metrics) | `2.9.2` | Service that generates metrics from Kubernetes API objects |
| [node-exporter](katalog/node-exporter) | `1.6.1` | Prometheus exporter for hardware and OS metrics exposed by \*NIX kernels |
| [prometheus-adapter](katalog/prometheus-adapter) | `0.11.1` | Kubernetes resource metrics, custom metrics, and external metrics APIs implementation. |
| [kube-proxy-metrics](katalog/kube-proxy-metrics) | `0.18.0` | RBAC proxy to securely expose kube-proxy metrics |
| [kube-state-metrics](katalog/kube-state-metrics) | `2.13.0` | Service that generates metrics from Kubernetes API objects |
| [node-exporter](katalog/node-exporter) | `1.8.2` | Prometheus exporter for hardware and OS metrics exposed by \*NIX kernels |
| [prometheus-adapter](katalog/prometheus-adapter) | `0.12.0` | Kubernetes resource metrics, custom metrics, and external metrics APIs implementation. |
| [thanos](katalog/thanos) (DEPRECATED) | `0.34.0` | Thanos is a high-availability Prometheus setup that provides long term storage via an external object store |
| [x509-exporter](katalog/x509-exporter) | `3.17.0` | Provides monitoring for certificates |
| [mimir](katalog/mimir) | `2.11.0` | Mimir is an open source, horizontally scalable, highly available, multi-tenant TSDB for long-term storage for Prometheus. |
| [mimir](katalog/mimir) | `2.14.0` | Mimir is an open source, horizontally scalable, highly available, multi-tenant TSDB for long-term storage for Prometheus. |
| [haproxy](katalog/haproxy) | `N.A.` | Grafana dashboards and prometheus rules (alerts) for HAproxy. |

### Integration with cloud providers
Expand All @@ -81,29 +81,29 @@ Please refer to the individual package documentation for further details.

| Kubernetes Version | Compatibility | Notes |
| ------------------ | :----------------: | --------------- |
| `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 about previous releases of the modules.

## Usage

### Prerequisites

| Tool | Version | Description |
| --------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tool | Version | Description |
| --------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [furyctl][furyctl-repo] | `>=0.25.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.3` | Packages are customized using `kustomize`. To learn how to create your customization layer with `kustomize`, please refer to the [repository][kustomize-repo]. |
| [kustomize][kustomize-repo] | `>=3.5.3` | 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 furyctl legacy

1. List the packages you want to deploy and their version in a `Furyfile.yml`

```yaml
versions:
monitoring: v3.2.0
monitoring: v3.3.0

bases:
- name: monitoring/prometheus-operator
Expand Down Expand Up @@ -177,34 +177,34 @@ service provider as follows:

- For AWS EKS

``` yaml
...
- ./vendor/katalog/monitoring/eks-sm

```yaml
```

- For GCP GKE

``` yaml
...
- ./vendor/katalog/monitoring/gke-sm

```yaml
```

- For Azure AKS

``` yaml
...
- ./vendor/katalog/monitoring/aks-sm

```yaml
```

- For on-premises and self-managed

``` yaml
...
- ./vendor/katalog/monitoring/kubeadm-sm

```yaml
```

5. To deploy the packages to your cluster, execute:
Expand Down
4 changes: 3 additions & 1 deletion docs/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Contributing

Rework in progress.
Please refer to the contributing section in [KFD's official documentation][kfd-contributing] to learn how to contribute.

[kfd-contributing]: https://docs.kubernetesfury.com/docs/contribute
46 changes: 27 additions & 19 deletions docs/releases/v3.3.0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,51 @@

Welcome to the latest release of the `monitoring` core module of the [`Kubernetes Fury Distribution`](https://github.com/sighupio/fury-distribution), maintained by team SIGHUP.

This release updates components across all packages bringing the latest features and bugfixes from upstream, and deprecates the Thanos package.

## Component Images 🚢

| Component | Supported Version | Previous Version |
| --------------------- | --------------------------------------------------------------------------------------------------- | ---------------- |
| `alertmanager` | [`v0.26.0`](https://github.com/prometheus/alertmanager/releases/tag/v0.26.0) | No Update |
| `blackbox-exporter` | [`v0.25.0`](https://github.com/prometheus/blackbox_exporter/releases/tag/v0.25.0) | v0.24.0 |
| `grafana` | [`v11.3.0`](https://github.com/grafana/grafana/releases/tag/v11.3.0) | v9.5.5 |
| `kube-rbac-proxy` | [`v0.18.1`](https://github.com/brancz/kube-rbac-proxy/releases/tag/v0.18.1) | v0.14.0 |
| `kube-state-metrics` | [`v2.13.0`](https://github.com/kubernetes/kube-state-metrics/releases/tag/v2.13.0) | v2.9.2 |
| `node-exporter` | [`v1.8.2`](https://github.com/prometheus/node_exporter/releases/tag/v1.8.2) | v1.6.1 |
| `prometheus-adapter` | [`v0.12.0`](https://github.com/kubernetes-sigs/prometheus-adapter/releases/tag/v0.12.0) | v0.11.1 |
| `prometheus-operator` | [`v0.76.2`](https://github.com/prometheus-operator/prometheus-operator/releases/tag/v0.76.2) | v0.67.1 |
| `prometheus` | [`v2.54.1`](https://github.com/prometheus/prometheus/releases/tag/v2.54.1) | v0.46.0 |
| `thanos` | [`v0.34.0`](https://github.com/thanos-io/thanos/releases/tag/v0.34.0) | No Update |
| `x509-exporter` | [`v3.12.0`](https://github.com/enix/x509-certificate-exporter/releases/tag/v3.12.0) | No Update |
| `karma` | [`v0.113`](https://github.com/prymitive/karma/releases/tag/v0.113) | No Update |
| `mimir` | [`v2.11.1`](https://github.com/grafana/mimir/releases/tag/mimir-2.11.10) | No Update |
| `minio-ha` | [`RELEASE.2024-02-09T21-25-16Z`](https://github.com/minio/minio/tree/RELEASE.2024-02-09T21-25-16Z) | No Update |
| Component | Supported Version | Previous Version |
| --------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------- |
| `alertmanager` | [`v0.26.0`](https://github.com/prometheus/alertmanager/releases/tag/v0.26.0) | No Update |
| `blackbox-exporter` | [`v0.25.0`](https://github.com/prometheus/blackbox_exporter/releases/tag/v0.25.0) | v0.24.0 |
| `grafana` | [`v11.3.0`](https://github.com/grafana/grafana/releases/tag/v11.3.0) | v9.5.5 |
| `kube-rbac-proxy` | [`v0.18.1`](https://github.com/brancz/kube-rbac-proxy/releases/tag/v0.18.1) | v0.14.0 |
| `kube-state-metrics` | [`v2.13.0`](https://github.com/kubernetes/kube-state-metrics/releases/tag/v2.13.0) | v2.9.2 |
| `node-exporter` | [`v1.8.2`](https://github.com/prometheus/node_exporter/releases/tag/v1.8.2) | v1.6.1 |
| `prometheus-adapter` | [`v0.12.0`](https://github.com/kubernetes-sigs/prometheus-adapter/releases/tag/v0.12.0) | v0.11.1 |
| `prometheus-operator` | [`v0.76.2`](https://github.com/prometheus-operator/prometheus-operator/releases/tag/v0.76.2) | v0.67.1 |
| `prometheus` | [`v2.54.1`](https://github.com/prometheus/prometheus/releases/tag/v2.54.1) | v0.46.0 |
| `thanos` | `v0.34.0` **DEPRECATED**: see below. | No Update |
| `x509-exporter` | [`v3.17.0`](https://github.com/enix/x509-certificate-exporter/releases/tag/v3.17.0) | v3.12.0 |
| `karma` | [`v0.113`](https://github.com/prymitive/karma/releases/tag/v0.113) | No Update |
| `mimir` | [`v2.14.0`](https://github.com/grafana/mimir/releases/tag/mimir-2.14.0) | v2.11.1 |
| `minio-ha` | [`RELEASE.2024-10-13T13-34-11Z`](https://github.com/minio/minio/releases/tag/RELEASE.2024-10-13T13-34-11Z) | RELEASE.2024-02-09T21-25-16Z |

> Please refer the individual release notes to get a detailed info on the releases.
## Features 💥

### HAproxy Alerting
### HAProxy Alerting

Remove HaproxyHttpSlowingDown alert rule
- Removed `HaproxyHttpSlowingDown` alert rule, it caused false positives adding only noise.

### prometheus-operated

- Introduced `scrapeConfigNamespaceSelector: {}` and `scrapeConfigSelector: {}` allowing to read all the `scrapeconfig` resources defined in the cluster without any specific annotation.

## Deprecation Notice ⚠️

The Thanos package has been deprecated and will be removed in the next release.

Refer to the Mimir package as a Thanos replacement for HA Prometheus deployments and long-term storage for metrics.

## Update Guide 🦮

### Process

To upgrade this core module from `v3.2.0` to `v3.3.0`, execute the following:

```bash
kustomize build <your-project-path> | kubectl apply -f -
kustomize build <your-project-path> | kubectl apply -f - --server-side
```

0 comments on commit dff093c

Please sign in to comment.