docs: Editorial changes for walkthrough for managed identity (#1584)

* docs: Provide walkthrough for managed identity (#1578) Co-authored-by: Tom Kerkhove <[email protected]> * Rename walkthrough Signed-off-by: Tom Kerkhove <[email protected]> * Reshuffle intro Signed-off-by: Tom Kerkhove <[email protected]> * Change title Signed-off-by: Tom Kerkhove <[email protected]> * Current TOC Signed-off-by: Tom Kerkhove <[email protected]> * Create & auth to cluster Signed-off-by: Tom Kerkhove <[email protected]> * Deprecate feature Signed-off-by: Tom Kerkhove <[email protected]> * Finalize Signed-off-by: Tom Kerkhove <[email protected]> * System assigned Signed-off-by: Tom Kerkhove <[email protected]> * Linting Signed-off-by: Tom Kerkhove <[email protected]> Co-authored-by: Sébastien Pertus <[email protected]>
tomkerkhove · Apr 5, 2021 · 4a57df9 · 4a57df9
1 parent 8df82a6
commit 4a57df9
Show file tree

Hide file tree

Showing 7 changed files with 553 additions and 35 deletions.
diff --git a/changelog/content/deprecated/authentication-modes.md b/changelog/content/deprecated/authentication-modes.md
@@ -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)
diff --git a/changelog/content/deprecated/helm-chart-registry.md b/changelog/content/deprecated/helm-chart-registry.md
diff --git a/changelog/content/experimental/unreleased.md b/changelog/content/experimental/unreleased.md
@@ -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.
diff --git a/changelog/content/released/v0.3.0-resource-discovery.md b/changelog/content/released/v0.3.0-resource-discovery.md
@@ -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).
diff --git a/changelog/content/released/v2.2.0-scraper.md b/changelog/content/released/v2.2.0-scraper.md
@@ -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).
diff --git a/docs/index.md b/docs/index.md
@@ -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)