feat: add docs for custom Azure cloud support (#69)

Co-authored-by: amirschw <[email protected]>
Co-authored-by: Tom Kerkhove <[email protected]>

Author: 3 people

docs/faq.md

@@ -54,11 +54,11 @@ We have it on [our backlog](https://github.com/tomkerkhove/promitor/issues/761)
 
 ## What Azure clouds are supported?
 
-We support `Global` (default), `China`, `UsGov` & `Germany` Azure clouds.
+We support `Global` (default), `China`, `UsGov`, `Germany` & `Custom` Azure clouds.
 
-This can be configured in the metric configuration under `azureMetadata`.
+This can be configured in the metric configuration under `azureMetadata` and in resource discovery configuration under `azureLandscape`
 
-For more information see our ['Metric Configuration' page](scraping/overview.md).
+For more information see our ['Metric Configuration' page](scraping/overview.md) and [`Resource Discovery` page](resource-discovery/declaring-resource-discovery-groups.md).
 
 ## Why does Azure Blob & File Storage only report account-level information?
 

docs/resource-discovery/declaring-resource-discovery-groups.md

@@ -15,7 +15,7 @@ As part of the resource discovery group declaration, you can choose to filter re
  with which the resources have to be annotated.
 - **Regions** - Defines a list of Azure regions in which the regions the resources are located.
 
-Here is an example of a full declaration:
+Here is an example of a full declaration using a custom cloud:
 
 ```yaml
 version: v1
@@ -25,7 +25,14 @@ azureLandscape:
   - SUBSCRIPTON-ID-ABC
   - SUBSCRIPTON-ID-DEF
   - SUBSCRIPTON-ID-GHI
-  cloud: China
+  cloud: Custom
+  endpoints:
+    authenticationEndpoint: https://custom-authentication-endpoint
+    managementEndpoint: https://custom-management-endpoint
+    resourceManagerEndpoint: https://custom-resource-manager-endpoint
+    graphEndpoint: https://custom-graph-endpoint
+    storageEndpointSuffix: custom-storage-endpoint-suffix
+    keyVaultSuffix: custom-key-vault-suffix
 resourceDiscoveryGroups:
 - name: container-registry-landscape
   type: ContainerRegistry
@@ -58,7 +65,15 @@ values are `v1`. *(Required)*
 
 - `azureLandscape.tenantId` - The id of the Azure tenant that will be queried. *(Required)*
 - `azureLandscape.subscriptions` - List of Azure subscriptions in the Azure tenant to discover resources in. *(Required)*
-- `azureLandscape.cloud` - The name of the Azure cloud to use. Options are `Global` (default), `China`, `UsGov` & `Germany`.
+- `azureLandscape.cloud` - The name of the Azure cloud to use. Options are `Global`
+ (default), `China`, `UsGov`, `Germany`, & `Custom`.
+- `azureLandscape.endpoints` - Required when `azureLandscape.cloud` is set to `Custom`. Defines the custom endpoints to use:
+    - `authenticationEndpoint` - The custom authentication endpoint.
+    - `managementEndpoint` - The custom service management endpoint.
+    - `resourceManagerEndpoint` - The custom Azure ARM resource management endpoint.
+    - `graphEndpoint` - The custom Active Directory graph endpoint.
+    - `storageEndpointSuffix` - The custom storage service url suffix.
+    - `keyVaultSuffix` - The custom Key Vault service url suffix.
 
 ### Resource Discovery Groups
 

docs/scraping/overview.md

@@ -75,7 +75,17 @@ values are `v1`. *(Required)*
 - `azureMetadata.subscriptionId` - The id of the default subscription to query.
 - `azureMetadata.resourceGroupName` - The name of the default resource group to query.
 - `azureMetadata.cloud` - The name of the Azure cloud to use. Options are `Global`
- (default), `China`, `UsGov` & `Germany`.
+ (default), `China`, `UsGov`, `Germany`, & `Custom`.
+- `azureMetadata.endpoints` - Required when `azureMetadata.cloud` is set to `Custom`. Defines the custom endpoints to use:
+    - `authenticationEndpoint` - The custom authentication endpoint.
+    - `managementEndpoint` - The custom service management endpoint.
+    - `resourceManagerEndpoint` - The custom Azure ARM resource management endpoint.
+    - `graphEndpoint` - The custom Active Directory graph endpoint.
+    - `storageEndpointSuffix` - The custom storage service url suffix.
+    - `keyVaultSuffix` - The custom Key Vault service url suffix.
+    - `metricsQueryAudience` - The custom audiences available for metrics query.
+    - `metricsClientAudience` - The custom audiences available for metrics client.
+    - `logAnalyticsEndpoint` - The custom log analytics endpoint. *(Required only if Azure Log Analytics resource is configured for scraping)*
 
 ### Metric Defaults
 
@@ -130,17 +140,26 @@ Additionally, the following fields are optional:
 
 ### Example
 
-Here is an example of how you can scrape two Azure Service Bus queues  in different
+Here is an example of how you can scrape two Azure Service Bus queues in different
 resource groups, one in the `promitor` resource group and one on the `promitor-dev`
-resource group:
+resource group. This example also shows custom cloud endpoints configuration:
 
 ```yaml
 version: v1
 azureMetadata:
   tenantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
   subscriptionId: yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
   resourceGroupName: promitor
-  cloud: China
+  cloud: Custom
+  endpoints:
+    authenticationEndpoint: https://custom.auth.endpoint.com
+    managementEndpoint: https://custom.svc.management.endpoint.com
+    resourceManagerEndpoint: https://custom.resource.management.endpoint.com
+    graphEndpoint: https://custom.graph.endpoint.com
+    storageEndpointSuffix: custom.windows.net
+    keyVaultSuffix: custom.vault.azure.net
+    metricsQueryAudience: https://custom.metric.query.endpoint.com
+    metricsClientAudience: https://custom.metric.client.endpoint.com
 metricDefaults:
   aggregation:
     interval: 00:05:00

docs/tags.md

@@ -2,4 +2,4 @@
 
 Following is a list of relevant tags:
 
-[TAGS]
+<!-- material/tags -->

mkdocs.yml

@@ -68,8 +68,7 @@ plugins:
   - mike:
       version_selector: true   # set to false to leave out the version selector
   - search
-  - tags:
-      tags_file: tags.md
+  - tags
   - htmlproofer:
       enabled: True
       raise_error: True
@@ -78,6 +77,7 @@ plugins:
         404: ['https://www.nuget.org/packages/NetEscapades.Configuration.Yaml'] # No idea why this is failing, but it is.
         405: ['*']
         520: ['*']
+        403: ['https://www.mend.io/free-developer-tools/blog/overcoming-dockers-mutable-image-tags/']
 
 # Customization
 extra: