Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Editorial changes for walkthrough for managed identity #1584

Merged
merged 11 commits into from
Apr 5, 2021
Merged
39 changes: 39 additions & 0 deletions changelog/content/deprecated/authentication-modes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title:
subtitle: created on {{ now.Format "2021-04-05" }}
date: 2021-04-05T01:00:00+01:00
#removal_date: 2021-04-1
weight:
version:
---

#### Service Principle identity is moved to runtime configuration

###### Deprecated as of April 5th, 2021 and will be removed in new major version

Promitor has been using service principle authentication from its inception where the identity inforation was configured through the following environment variables:

- `PROMITOR_AUTH_APPKEY`
- `PROMITOR_AUTH_APPID`

However, as of Promitor Scraper v2.2.0 & Resource Discovery v0.3.0, users can choose how agents authenticate to Microsoft
Azure by declaring the authentication mode in the server configuration:

```yaml
authentication:
# Options are ServicePrincipal, SystemAssigedManagedIdentity, UserAssigedManagedIdentity.
mode: ServicePrincipal
identityId: xxxx-xxxx-xxxx
```

With this new approach, users can use Managed Identity authentication leveraging no-secret authentication or keep on
using Service Principle authentication.

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

**Impact:** Migration is required - Use the [authentication configuration](https://promitor.io/configuration/v2.x/azure-authentication#supported-authentication-mechanisms)
to specify Service Principle authentication and configure the identity id in the server configuration.

**Alternative:** None

**Discussion:** [GitHub Discussions](https://github.com/tomkerkhove/promitor/discussions/1583)
29 changes: 0 additions & 29 deletions changelog/content/deprecated/helm-chart-registry.md

This file was deleted.

8 changes: 2 additions & 6 deletions changelog/content/experimental/unreleased.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,8 @@ version:

#### Scraper

- {{% tag added %}} Support for managed identity authentication
([docs](https://promitor.io/configuration/v2.x/azure-authentication#supported-authentication-mechanisms) | [#444](https://github.com/tomkerkhove/promitor/issues/444)
| Contributed by [@Mimetis](https://github.com/Mimetis) 🎉)
None.

#### Resource Discovery

- {{% tag added %}} Support for managed identity authentication
([docs](https://promitor.io/configuration/v2.x/azure-authentication#supported-authentication-mechanisms) | [#444](https://github.com/tomkerkhove/promitor/issues/444)
| Contributed by [@Mimetis](https://github.com/Mimetis) 🎉)
None.
11 changes: 11 additions & 0 deletions changelog/content/released/v0.3.0-resource-discovery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
subtitle: "released on 2021-04-05"
date: 2021-04-05T10:38:47+02:00
weight: 1003
version: Resource Discovery - v0.3.0
---

- {{% tag added %}} Support for Manage Identity authentication ([docs](https://promitor.io/configuration/v2.x/azure-authentication#supported-authentication-mechanisms) | [walkthrough](https://promitor.io/walkthrough/use-promitor-with-managed-identity) | [#444](https://github.com/tomkerkhove/promitor/issues/444)
| Contributed by [@Mimetis](https://github.com/Mimetis) 🎉)

Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/ResourceDiscovery-v0.3.0).
11 changes: 11 additions & 0 deletions changelog/content/released/v2.2.0-scraper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
subtitle: "released on 2021-04-05"
date: 2021-04-05T10:38:47+02:00
weight: 1002
version: Scraper - v2.2.0
---

- {{% tag added %}} Support for Manage Identity authentication ([docs](https://promitor.io/configuration/v2.x/azure-authentication#supported-authentication-mechanisms) | [walkthrough](https://promitor.io/walkthrough/use-promitor-with-managed-identity) | [#444](https://github.com/tomkerkhove/promitor/issues/444)
| Contributed by [@Mimetis](https://github.com/Mimetis) 🎉)

Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/Scraper-v2.2.0).
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ and vote for features!
- [System](operations#system)
- **Walkthroughs**
- [Deploying Promitor, Prometheus, and Grafana on an AKS Cluster](/walkthrough/scrape-promitor-with-prometheus-on-azure-kubernetes-service)
- [Using Managed Identity with Promitor on an AKS Cluster](/walkthrough/use-promitor-with-managed-identity)
- [Migrate from Promitor Scraper 1.x to 2.x](/walkthrough/migrate-from-1.x-to-2.x)
- [**Frequently asked questions (FAQs)**](/faq)

Expand Down
Loading