Skip to content

Commit

Permalink
chore: Remove support for Helm 2 (#1376)
Browse files Browse the repository at this point in the history
Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
  • Loading branch information
tomkerkhove authored Nov 23, 2020
1 parent 4e8fd38 commit 29b2d25
Show file tree
Hide file tree
Showing 7 changed files with 73 additions and 39 deletions.
16 changes: 0 additions & 16 deletions build/azure-devops/agents-ci-scraper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -272,22 +272,6 @@ stages:
- template: templates/docker/push-image.yml
parameters:
imageName: '$(Image.TaggedName)'
- stage: Helm2
displayName: Helm Chart (2.x)
dependsOn: Docker
jobs:
- job: Helm2_x
displayName: Helm 2.x - Lint
condition: succeeded()
variables:
Helm.Version: '2.9.1'
pool:
vmImage: ubuntu-16.04
steps:
- template: templates/helm/lint-chart.yml
parameters:
helmVersion: '$(Helm.Version)'
chartName: '$(Chart.Scraper.Name)'
- template: templates/stages/helm-chart-verification.yml
parameters:
chartName: '$(Helm.Chart.Name)'
Expand Down
28 changes: 28 additions & 0 deletions changelog/content/deprecated/helm-2.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title:
subtitle: created on {{ now.Format "2020-11-23" }}
date: 2020-11-23T12:00:00+01:00
removal_date: 2020-11-23
weight:
version:
---

#### Helm 2.0

###### Deprecated as of v1.6 and will be removed in v2.0

Promitor provides Helm charts to simplify deployments on a Kubernetes cluster.

In November 2019, Helm 3 was announced which marked the end of Helm 2 which would be phased out in a year and no longer
supported. Learn more about it in the official [Helm deprecation timeline](https://helm.sh/blog/helm-v2-deprecation-timeline/).

Because of this deprecation, Promitor will no longer support Helm 2.0 deployments out-of-the-box. They might still be
working but won't be our focus for versions as of Promitor 2.0.

**Announcement:** [GitHub Issue](https://github.com/tomkerkhove/promitor/issues/1371)

**Impact:** Migration is required - Helm 2.0 deployments might still be working but is no longer supported.

**Alternative:** Use Helm 3.0 by following [Helm migration guide](https://helm.sh/docs/topics/v2_v3_migration/).

**Discussion:** [GitHub Discussions](https://github.com/tomkerkhove/promitor/discussions/1375)
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ Because of that we are removing support for the "legacy" Prometheus configuratio
We've added support for Prometheus metric sink while maintaining the legacy approach until
it's being removed.

**Announcement:** [GitHub Issue](https://github.com/tomkerkhove/promitor/issues/1032)

**Impact:** Migration is required - Prometheus legacy configuration will no longer be available.

**Alternative:** Use our new [metric sink concept](https://promitor.io/configuration/v1.x/runtime#prometheus-scraping-endpoint).

**Discussion:** [GitHub Issue #1032](https://github.com/tomkerkhove/promitor/issues/1032)
**Discussion:** [GitHub Discussions](https://github.com/tomkerkhove/promitor/discussions/1372)
5 changes: 4 additions & 1 deletion changelog/content/deprecated/swagger-2.0.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title:
subtitle: created on {{ now.Format "2020-01-07" }}
date: 2018-09-02T20:46:47+02:00
removal_date: 2020-01-07
Expand All @@ -17,8 +18,10 @@ with 3.0 instead of 2.0.
We've added support for OpenAPI 3.0 in Promitor v1.1 next to Swagger 2.0 so you
can migrate to it before we remove 2.0 in Promitor v2.0.

**Announcement:** [GitHub Issue](https://github.com/tomkerkhove/promitor/issues/782)

**Impact:** Migration is required - API documentation will no longer be available.

**Alternative:** Use API documentation provided in OpenAPI v3.0 format.

**Discussion:** [GitHub Issue #782](https://github.com/tomkerkhove/promitor/issues/782)
**Discussion:** [GitHub Discussions](https://github.com/tomkerkhove/promitor/discussions/1374)
4 changes: 3 additions & 1 deletion changelog/content/deprecated/swagger-ui-2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@ with 3.0 instead of 2.0.
We've added support for OpenAPI 3.0 in Promitor v1.1 next to Swagger 2.0 along with
OpenAPI UI 3.0.

**Announcement:** [GitHub Issue](https://github.com/tomkerkhove/promitor/issues/781)

**Impact:** Migration is required - Swagger UI 2.0 will no longer be available.

**Alternative:** Use OpenAPI UI 3.0.

**Discussion:** [GitHub Issue #781](https://github.com/tomkerkhove/promitor/issues/781)
**Discussion:** [GitHub Discussions](https://github.com/tomkerkhove/promitor/discussions/1373)
2 changes: 2 additions & 0 deletions changelog/content/experimental/unreleased.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ version:
| [FAQ](https://promitor.io/faq#why-does-my-multi-dimensional-metric-report-label-value-unknown-with-prometheus)).
- {{% tag removed %}} Support for Prometheus legacy configuration ([deprecation notice](https://changelog.promitor.io/#prometheus-legacy-configuration)
| [migration guide](https://promitor.io/walkthrough/migrate-from-1.x-to-2.x))
- {{% tag removed %}} Support for Helm 2.0 ([deprecation notice](https://changelog.promitor.io/#helm-2-0) |
[Helm migration guide](https://helm.sh/docs/topics/v2_v3_migration/))
- {{% tag removed %}} Support for Swagger UI 2.0 ([deprecation notice](https://changelog.promitor.io/#swagger-ui-2-0) |
[migration guide](https://promitor.io/walkthrough/migrate-from-1.x-to-2.x))
- {{% tag removed %}} Support for Swagger 2.0 ([deprecation notice](https://changelog.promitor.io/#swagger-2-0) |
Expand Down
53 changes: 33 additions & 20 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,26 @@ title: Frequently asked questions (FAQs)

Here are a list of questions you may have:

- [What Azure clouds are supported?](#what-azure-clouds-are-supported)
- [What operating systems are supported?](#what-operating-systems-are-supported)
- [Is scraping multiple subscriptions supported?](#is-scraping-multiple-subscriptions-supported)
- [Are multi-dimensional metrics supported?](#are-multi-dimensional-metrics-supported)
- [Is scraping multiple subscriptions supported?](#is-scraping-multiple-subscriptions-supported)
- [What Azure clouds are supported?](#what-azure-clouds-are-supported)
- [Why does Azure Blob & File Storage only report account-level information?](#why-does-azure-blob--file-storage-only-report-account-level-information)
- [Why does my multi-dimensional metric report label value `unknown` with Prometheus?](#why-does-my-multi-dimensional-metric-report-label-value-unknown-with-prometheus)
- [What Helm version is supported?](#what-helm-version-is-supported)
- [What operating systems are supported?](#what-operating-systems-are-supported)

## What Azure clouds are supported?

We support `Global` (default), `China`, `UsGov` & `Germany` Azure clouds.

This can be configured in the metric configuration under `azureMetadata`.
## Are multi-dimensional metrics supported?

For more information see our ['Metric Configuration' page](/configuration/v1.x/metrics/#metrics).
Yes, every scraper supports scraping multi-dimensional metrics except for
Azure Storage queues.

## What operating systems are supported?
You can configure the dimension you are interested in via
`azureMetricConfiguration.dimension.Name`, for more information see
our ['Metric Configuration' page](/configuration/v1.x/metrics/#metrics).

We support running on both Linux & Windows platforms.
However, you can only use it with metrics in Azure Monitor that support this,
for a complete overview we recommend reading the
[official documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported).

## Is scraping multiple subscriptions supported?

Expand All @@ -33,18 +35,13 @@ However, you can deploy multiple instances of Promitor that each scrape another
We have it on [our backlog](https://github.com/tomkerkhove/promitor/issues/761) to see if there is
enough demand for it, feel free to give a :+1:. If that is the case, we will reconsider this limitation.

## Are multi-dimensional metrics supported?
## What Azure clouds are supported?

Yes, every scraper supports scraping multi-dimensional metrics except for
Azure Storage queues.
We support `Global` (default), `China`, `UsGov` & `Germany` Azure clouds.

You can configure the dimension you are interested in via
`azureMetricConfiguration.dimension.Name`, for more information see
our ['Metric Configuration' page](/configuration/v1.x/metrics/#metrics).
This can be configured in the metric configuration under `azureMetadata`.

However, you can only use it with metrics in Azure Monitor that support this,
for a complete overview we recommend reading the
[official documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported).
For more information see our ['Metric Configuration' page](/configuration/v1.x/metrics/#metrics).

## Why does Azure Blob & File Storage only report account-level information?

Expand All @@ -60,4 +57,20 @@ When Promitor is unable to find a metric for a multi-dimensional metric, it will

You can read more about it in our [Prometheus sink documentation](/configuration/v2.x/runtime/scraper/#what-happens-when-metrics-are-unavailable-for-multi-dimensional-metrics).

## What Helm version is supported?

Promitor supports deployments with **Helm v3.0** for all versions.

Helm has [deprecated support for v2.0](https://helm.sh/blog/helm-v2-deprecation-timeline/) and is out of support.
Because of that, Promitor supported to remove support for Helm 2.0 as of Promitor 2.0.

However, while we don't support it out-of-the-box it is possible that it is still compatible with Helm 2.0 but we do
not provide support for it.

Join the discussion on our Helm v2.0 support deprecation on [GitHub Discussions](https://github.com/tomkerkhove/promitor/discussions/1375).

## What operating systems are supported?

We support running on both Linux & Windows platforms.

[&larr; back](/)

0 comments on commit 29b2d25

Please sign in to comment.