From 2f97d4366551ebcdd1a0161cf1b7c92f1f1de676 Mon Sep 17 00:00:00 2001 From: Jayendran Arumugam <25414541+jayendranarumugam@users.noreply.github.com> Date: Sun, 1 Dec 2024 18:48:26 +0530 Subject: [PATCH 1/2] fix docs link --- docs/faq.md | 2 +- docs/operations/discovery.md | 2 +- docs/operations/integrations.md | 4 ++-- .../declaring-resource-discovery-groups.md | 4 ++-- docs/scraping/overview.md | 2 +- docs/scraping/providers/generic-azure-resource.md | 2 +- docs/scraping/providers/network-interface.md | 2 +- docs/scraping/providers/redis-cache.md | 2 +- docs/security/azure-authentication.md | 8 ++++---- ...romitor-with-prometheus-on-azure-kubernetes-service.md | 2 +- docs/walkthroughs/use-promitor-with-managed-identity.md | 8 ++++---- 11 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index c0124b47..fbb932d3 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -21,7 +21,7 @@ our ['Metrics Declaration' page](scraping/overview.md#metrics). 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). +[official documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported). ## How does Promitor handle deleted resources? diff --git a/docs/operations/discovery.md b/docs/operations/discovery.md index 68edb158..9cd34a83 100644 --- a/docs/operations/discovery.md +++ b/docs/operations/discovery.md @@ -17,7 +17,7 @@ It provides the following tags with more information: - `tenant_id` - Id of the Azure tenant - `subscription_name` - Name of the Azure subscription - `subscription_id` - Id of the Azure subscription -- `state` - Indication of the state of the subscription ([docs](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/subscription-states)) +- `state` - Indication of the state of the subscription ([docs](https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/subscription-states)) - `spending_limit` - Indication whether or not there is a spending limit - `quota_id` - Id of the Azure subscription used to manage quotas - `authorization` - Type of authorization that is being used diff --git a/docs/operations/integrations.md b/docs/operations/integrations.md index 603677a6..fce0457c 100644 --- a/docs/operations/integrations.md +++ b/docs/operations/integrations.md @@ -31,7 +31,7 @@ promitor_ratelimit_arm_throttled{tenant_id="e0372f7f-a362-47fb-9631-74a5c4ba8bbf promitor_ratelimit_arm_throttled{tenant_id="e0372f7f-a362-47fb-9631-74a5c4ba8bbf",subscription_id="0f9d7fea-99e8-4768-8672-06a28514f77e",app_id="ceb249a3-44ce-4c90-8863-6776336f5b7e"} 0 1629719532626 ``` -You can read more about the Azure Resource Manager limitations on [docs.microsoft.com](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits). +You can read more about the Azure Resource Manager limitations on [docs.microsoft.com](https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits). ## Azure Resource Graph @@ -64,7 +64,7 @@ promitor_ratelimit_resource_graph_remaining{tenant_id="e0372f7f-a362-47fb-9631-7 promitor_ratelimit_resource_graph_throttled{tenant_id="e0372f7f-a362-47fb-9631-74a5c4ba8bbf",cloud="Global",auth_mode="ServicePrincipal",app_id="67882a00-21d3-4ee7-b32a-430ea0768cd3"} 0 1629719863738 ``` -You can read more about the Azure Resource Graph throttling on [docs.microsoft.com](https://docs.microsoft.com/en-us/azure/governance/resource-graph/overview#throttling). +You can read more about the Azure Resource Graph throttling on [docs.microsoft.com](https://learn.microsoft.com/en-us/azure/governance/resource-graph/overview#throttling). ## Azure Monitor diff --git a/docs/resource-discovery/declaring-resource-discovery-groups.md b/docs/resource-discovery/declaring-resource-discovery-groups.md index de1fafe8..815081ce 100644 --- a/docs/resource-discovery/declaring-resource-discovery-groups.md +++ b/docs/resource-discovery/declaring-resource-discovery-groups.md @@ -11,7 +11,7 @@ As part of the resource discovery group declaration, you can choose to filter re - **Subscription** - Defines a subset of subscriptions defined in the Azure landscape - **Resource Group** - Defines a list of resource groups which contains the resources. -- **Tags** - Defines a list of [Azure tags](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources) +- **Tags** - Defines a list of [Azure tags](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources) with which the resources have to be annotated. - **Regions** - Defines a list of Azure regions in which the regions the resources are located. @@ -75,6 +75,6 @@ As of now, we only allow to define criteria that resources have to meet before t - `subscriptions` - A list of subscription(s) in which the resource is allowed to be located. - `resourceGroups` - A list of resource group(s) in which the resource is allowed to be located. -- `tags` - A list of [Azure tags](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources) +- `tags` - A list of [Azure tags](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources) and the expected values (exact or regular expression) with which the resources have to be annotated. (Uses `or`) - `regions` - A list of Azure region(s) in which the resource is allowed to be located. diff --git a/docs/scraping/overview.md b/docs/scraping/overview.md index eefa83a3..b2ffa558 100644 --- a/docs/scraping/overview.md +++ b/docs/scraping/overview.md @@ -123,7 +123,7 @@ Additionally, the following fields are optional: be used to scrape a multi-dimensional metric in Azure Monitor. - ☝ *Promitor simply acts as a proxy and will not validate if the given dimensions are supported or not, we recommend verifying that they are in the - [official documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported)* + [official documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported)* - `labels` - Defines a set of custom labels to include for a given metric. - `scraping.schedule` - A scraping schedule for the individual metric; overrides the the one specified in `metricDefaults` diff --git a/docs/scraping/providers/generic-azure-resource.md b/docs/scraping/providers/generic-azure-resource.md index 4a223688..a42356b8 100644 --- a/docs/scraping/providers/generic-azure-resource.md +++ b/docs/scraping/providers/generic-azure-resource.md @@ -21,7 +21,7 @@ Optional fields : - `resourceGroupName` - the resource group for this resource. It overrides the one defined in `azureMetadata`. - `subscriptionId` - the subscription ID for this resource. It overrides the one defined in `azureMetadata`. - `filter` - The filter to use to have fine-grained metrics. Example: `EntityName eq 'orders'`. - See [Azure Monitor REST API Filter Syntax](https://docs.microsoft.com/en-us/rest/api/monitor/filter-syntax). + See [Azure Monitor REST API Filter Syntax](https://learn.microsoft.com/en-us/rest/api/monitor/filter-syntax). ## Example diff --git a/docs/scraping/providers/network-interface.md b/docs/scraping/providers/network-interface.md index f5801424..dae08784 100644 --- a/docs/scraping/providers/network-interface.md +++ b/docs/scraping/providers/network-interface.md @@ -9,7 +9,7 @@ tags: ![Availability Badge](https://img.shields.io/badge/Available%20Starting-v1.0-green.svg)![Resource Discovery Support Badge](https://img.shields.io/badge/Support%20for%20Resource%20Discovery-Yes-green.svg) -You can declare to scrape an [Azure Network Interface](https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-network-interface) +You can declare to scrape an [Azure Network Interface](https://learn.microsoft.com/en-us/azure/virtual-network/virtual-network-network-interface) via the `NetworkInterface` resource type. When using declared resources, the following fields need to be provided: diff --git a/docs/scraping/providers/redis-cache.md b/docs/scraping/providers/redis-cache.md index 8a52c283..6be8672f 100644 --- a/docs/scraping/providers/redis-cache.md +++ b/docs/scraping/providers/redis-cache.md @@ -21,7 +21,7 @@ When using declared resources, the following fields need to be provided: All supported metrics are documented in the official [Azure Monitor documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported#microsoftcacheredis). You can find more documentation on each metric in the Azure Cache for Redis -[monitoring documentation](https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/cache-how-to-monitor#available-metrics-and-reporting-intervals). +[monitoring documentation](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-how-to-monitor#available-metrics-and-reporting-intervals). ## Example diff --git a/docs/security/azure-authentication.md b/docs/security/azure-authentication.md index c0c8f2ca..2e2a8a5a 100644 --- a/docs/security/azure-authentication.md +++ b/docs/security/azure-authentication.md @@ -14,14 +14,14 @@ Here is an overview of our Promitor agents and their integrations: Each agent needs an Azure AD identity to authenticate with to Microsoft Azure. -In order to achieve this, you'll need to [create an Azure AD Application](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#create-an-azure-active-directory-application), +In order to achieve this, you'll need to [create an Azure AD Application](https://learn.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#create-an-azure-active-directory-application), ## Supported Authentication Mechanisms Our agents provide the following authentication mechanisms: - **Service principle** - Use application id & secret of the Azure AD entity that has been pre-created to authenticate with -- **Managed Identity** - Use zero-secret authentication by letting Microsoft handle the authentication for you ([docs](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview)) +- **Managed Identity** - Use zero-secret authentication by letting Microsoft handle the authentication for you ([docs](https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview)) For details how to configure the authentication, we recommend reading our agent configuration documentation. @@ -63,7 +63,7 @@ When using Managed Identity, you can use one of the following scenarios: Identities that are used to integrate with Azure Monitor need to have `Monitoring Reader` permission on the subscription, resource group and/or resources that will be queried. -More information can be found [here](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-roles-permissions-security). +More information can be found [here](https://learn.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-roles-permissions-security). ### Required permissions for Azure Resource Graph @@ -73,6 +73,6 @@ subscription, resource group and/or resources that will be queried. > ⚠ If you are re-using this identity to integrate with Azure Monitor, make sure to grant the required permissions to reflect that as well. -More information can be found [here](https://docs.microsoft.com/en-us/azure/governance/resource-graph/overview#permissions-in-azure-resource-graph). +More information can be found [here](https://learn.microsoft.com/en-us/azure/governance/resource-graph/overview#permissions-in-azure-resource-graph). [← back](../index.md) diff --git a/docs/walkthroughs/scrape-promitor-with-prometheus-on-azure-kubernetes-service.md b/docs/walkthroughs/scrape-promitor-with-prometheus-on-azure-kubernetes-service.md index 0b4debc9..f0488188 100644 --- a/docs/walkthroughs/scrape-promitor-with-prometheus-on-azure-kubernetes-service.md +++ b/docs/walkthroughs/scrape-promitor-with-prometheus-on-azure-kubernetes-service.md @@ -39,7 +39,7 @@ we're monitoring. ## Prerequisites -- The [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) +- The [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/), the Kubernetes command-line tool. It can also be installed via the Azure CLI with `az aks install-cli`. - [Helm](https://helm.sh/docs/using_helm/#installing-the-helm-client), a Kubernetes diff --git a/docs/walkthroughs/use-promitor-with-managed-identity.md b/docs/walkthroughs/use-promitor-with-managed-identity.md index 87157108..fb779178 100644 --- a/docs/walkthroughs/use-promitor-with-managed-identity.md +++ b/docs/walkthroughs/use-promitor-with-managed-identity.md @@ -2,13 +2,13 @@ ## Introduction -This walkthrough will allow you to deploy Promitor that uses [Managed Identity](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview) +This walkthrough will allow you to deploy Promitor that uses [Managed Identity](https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview) on an Azure Kubernetes Service cluster to scrape Azure Service Bus metrics, using no-password authentication. In order to achieve this, we will use the [AAD Pod Identity project](https://github.com/Azure/aad-pod-identity) to manage the identities and authentication. -> ⚠ This only works with Azure Kubernetes Service - Learn more about [Managed Identity in Azure Kubernetes Service](https://docs.microsoft.com/en-us/azure/aks/use-managed-identity) +> ⚠ This only works with Azure Kubernetes Service - Learn more about [Managed Identity in Azure Kubernetes Service](https://learn.microsoft.com/en-us/azure/aks/use-managed-identity) > in the official Microsoft documentation. ## Table of Contents @@ -38,13 +38,13 @@ In order to achieve this, we will use the [AAD Pod Identity project](https://git ## Prerequisites -- [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest), +- [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest), to be able to deploy resources through the command line. - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/), the Kubernetes command-line tool. It can also be installed via the Azure CLI with `az aks install-cli`. - [Helm](https://helm.sh/docs/using_helm/#installing-the-helm-client), a Kubernetes deployment manager. -- [WSL](https://docs.microsoft.com/en-us/windows/wsl/), if you are using a Windows machine to deploy your whole solution. +- [WSL](https://learn.microsoft.com/en-us/windows/wsl/), if you are using a Windows machine to deploy your whole solution. ## Deploying the Azure Infrastructure From 5bc473ad0b2cf838f8668a9f7cad66fa4180f611 Mon Sep 17 00:00:00 2001 From: Jayendran Arumugam <25414541+jayendranarumugam@users.noreply.github.com> Date: Sun, 1 Dec 2024 18:52:40 +0530 Subject: [PATCH 2/2] fix link --- docs/deployment/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deployment/index.md b/docs/deployment/index.md index ef4dc0e7..638fd337 100644 --- a/docs/deployment/index.md +++ b/docs/deployment/index.md @@ -25,6 +25,6 @@ _(Alternative could be to use [image digest pinning](https://docs.docker.com/eng You can also pin to a specific digest of an image to ensure that you are running the same image across your infrastructure. However, you will not receive security -patches unless you use a tool like [Renovate to keep them up-to-date](https://www.mend.io/free-developer-tools/blog/overcoming-dockers-mutable-image-tags/). +patches unless you use a tool like [Renovate to keep them up-to-date](https://www.mend.io/blog/overcoming-dockers-mutable-image-tags/). [← back](../index.md)