Skip to content

Commit

Permalink
Add artifacthub metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
mkoertgen committed Apr 24, 2022
1 parent 94626a1 commit 805c665
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
[![azure-app-exporter](https://github.com/mkoertgen/azure-app-exporter/actions/workflows/azure-app-exporter.yml/badge.svg)](https://github.com/mkoertgen/azure-app-exporter/actions/workflows/azure-app-exporter.yml)

[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/azure-app-exporter)](https://artifacthub.io/packages/search?repo=azure-app-exporter)

# azure-app-exporter

Exposing Prometheus Metrics for Azure App Registration useful for alerting on expiring Service Principal Credentials.

See [Documentation](_docs/index.md) for more information.

Contribute on the [Project page](https://github.com/users/mkoertgen/projects/1/)

## Quick Start

Install using Docker of Helm (see `docker-compose.yml` or `./charts`).
Install using Docker or Helm (see `docker-compose.yml` or `./charts`).

The service authenticates against Azure using [Environmental Credentials](https://docs.microsoft.com/en-us/python/api/azure-identity/azure.identity.environmentcredential?view=azure-python), i.e.

Expand All @@ -17,10 +21,3 @@ The service authenticates against Azure using [Environmental Credentials](https:
- AZURE_CLIENT_SECRET: one of the service principal's client secrets

The Service Principal should have at least API permission `Application.Read.All` (Graph & Active Directory)

## TODOs

- Periodically update metrics by scraping `/apps`, e.g. using [Fast API - Repeated Tasks](https://fastapi-utils.davidmontague.xyz/user-guide/repeated-tasks/)
- Publish helm chart using [Chart Releaser Action](https://helm.sh/docs/howto/chart_releaser_action/)
- Add [helm testing](https://github.com/marketplace/actions/helm-chart-testing)
- Add [kind deploy](https://github.com/marketplace/actions/kind-cluster)
5 changes: 5 additions & 0 deletions artifacthub-repo.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# https://github.com/artifacthub/hub/blob/master/docs/metadata/artifacthub-repo.yml
repositoryID: 0ff66d32-280b-4a3c-b7a1-fa2399549cf6
owners: # (optional, used to claim repository ownership)
- name: mkoertgen
email: [email protected]

0 comments on commit 805c665

Please sign in to comment.