Skip to content

Commit

Permalink
Merge branch 'main' into gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mkoertgen committed Apr 24, 2022
2 parents 6aa665c + 805242f commit 77d9ec8
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 8 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/helm-release.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
name: Release Charts
name: helm-release

on:
push:
branches:
- main
paths:
- "charts/**"
# TODO: For now also enable manual runs
workflow_dispatch:
# # https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#release
# release:
# types:
Expand Down
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
[![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,8 +20,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
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]
2 changes: 1 addition & 1 deletion charts/azure-app-exporter/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: azure-app-exporter
description: Exposing Prometheus Metrics for Azure Service Principals
type: application
version: 0.1.0
appVersion: "0.1.0"
appVersion: "0.1.19"
keywords:
- azure
- prometheus
Expand Down

0 comments on commit 77d9ec8

Please sign in to comment.