-
Notifications
You must be signed in to change notification settings - Fork 1
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
chore: azure registry docs #190
Open
yashmehrotra
wants to merge
1
commit into
main
Choose a base branch
from
azure-and-pb
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
# Azure | ||
|
||
The Azure helm chart installs a [catalog scraper](/config-db/scrapers/azure) | ||
|
||
## Setup | ||
|
||
```sh | ||
helm repo add flanksource https://flanksource.github.io/charts | ||
helm repo update | ||
helm install mission-control-aws flanksource/mission-control-azure | ||
``` | ||
|
||
After running `helm install` you should get a success message: | ||
|
||
```sh | ||
NAME: mission-control-azure | ||
LAST DEPLOYED: Thu Feb 14 19:00:32 2024 | ||
NAMESPACE: default | ||
STATUS: deployed | ||
REVISION: 1 | ||
TEST SUITE: None | ||
NOTES: | ||
Azure scraper added | ||
``` | ||
|
||
When you go to the catalog now, you can now see all the Azure Resources | ||
|
||
![Azure Catalog](/img/azure-registry-catalog-scraper.png) | ||
|
||
|
||
## Prerequisites | ||
|
||
1. Connection to Azure must be authenticated via Workload Identity for Service Accounts or Client ID and Secret. | ||
|
||
2. The role should have permissions to fetch the Azure Resources | ||
|
||
### Values | ||
|
||
This document provides an overview of configurable values for deploying Mission Control Registry on Azure using Helm. | ||
|
||
## Configuration | ||
|
||
The following table lists the configurable parameters and their default values: | ||
|
||
| Parameter | Description | Schema | Default | | ||
| --- | --- | --- | --- | | ||
| `labels` | Additional labels to apply to resources| map[string]string | {} | | ||
| `scraper.name` | Name of the Azure scraper | string | "azure" | | ||
| `subscriptionID` | Azure Subscription ID | string | "" | | ||
| `tenantID` | Azure Tenant ID | string | "" | | ||
Comment on lines
+49
to
+50
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think these are required and should be in the helm install commands |
||
|
||
### Connection Details | ||
|
||
| Parameter | Description | Schema | Default | | ||
| --- | --- | --- | --- | | ||
| `connectionDetails.connection` | Azure connection details. | string | "" | | ||
| `connectionDetails.clientID` | Azure Client ID | <CommonLink to="secrets">*EnvVar*</CommonLink> | "" | | ||
| `connectionDetails.clientSecret` | Azure Client Secret | <CommonLink to="secrets">*EnvVar*</CommonLink> | "" | | ||
|
||
:::info | ||
If you have setup Workload Identity Roles for Service Account, you do not have to do anything else. If you do not have that setup, you can use Client ID and Client Secret | ||
|
||
Example: | ||
```yaml title="values.yaml" | ||
connectionDetails: | ||
clientID: | ||
valueFrom: | ||
secretKeyRef: | ||
name: azure-credentials | ||
key: CLIENT_ID | ||
clientSecret: | ||
valueFrom: | ||
secretKeyRef: | ||
name: azure-credentials | ||
key: CLIENT_SECRET | ||
``` | ||
|
||
::: | ||
|
||
|
||
### Exclusions | ||
|
||
Certain items can be excluded from being scraped | ||
|
||
| Parameter | Description | Default | | ||
| --- | --- | --- | | ||
| `exclusions.activityLogs` | List of activity logs resources to exclude (Example: `['Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action']`) | [] | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we specify the roles ?