Skip to content
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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
87 changes: 87 additions & 0 deletions mission-control/docs/registry/azure.md
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
Copy link
Member

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 ?


### 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
Copy link
Member

Choose a reason for hiding this comment

The 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']`) | [] |
2 changes: 1 addition & 1 deletion mission-control/docs/registry/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ We provide ready to use helm charts for setting up:

- [Kubernetes](/registry/kubernetes)
- [AWS](/registry/aws)
- Azure
- [Azure](/registry/azure)
- Prometheus
5 changes: 5 additions & 0 deletions mission-control/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -926,6 +926,11 @@ const sidebars = {
type: 'doc',
id: 'registry/kubernetes',
label: 'Kubernetes'
},
{
type: 'doc',
id: 'registry/azure',
label: 'Azure'
}
],
reference: [
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.