Skip to content

feat: add docs for custom Azure cloud support #69

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.

Sign up for GitHub

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

Merged
tomkerkhove merged 6 commits into from
Feb 21, 2025
Merged

feat: add docs for custom Azure cloud support #69

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
468b3f8
feat: add docs for custom Azure cloud support
Suraiya-Hameed Feb 12, 2025
f90dd05
Remove the deprecated tags_file option
Suraiya-Hameed Feb 12, 2025
acd2284
skip 403 for external link
Suraiya-Hameed Feb 12, 2025
cc51eb5
Upsate example with custom cloud endpoints
Suraiya-Hameed Feb 12, 2025
b056e24
fix: Use appropriate cloud sample
tomkerkhove Feb 18, 2025
5db3c9f
update sample resource discovery
Suraiya-Hameed Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
10 changes: 9 additions & 1 deletion docs/resource-discovery/declaring-resource-discovery-groups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,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

Expand Down
12 changes: 11 additions & 1 deletion docs/scraping/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Comment thread
Suraiya-Hameed marked this conversation as resolved.
- `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

Expand Down
2 changes: 1 addition & 1 deletion docs/tags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Following is a list of relevant tags:

[TAGS]
<!-- material/tags -->
4 changes: 2 additions & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down