From 58f0fed5859d143c429563c505971b5a10d627df Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Thu, 31 Dec 2020 13:37:36 +0100 Subject: [PATCH 1/2] Cleanup old registry Signed-off-by: Tom Kerkhove --- .tours/repo-overview.tour | 6 +---- development-guide.md | 24 ++----------------- docs/deployment/resource-discovery/index.md | 2 +- docs/deployment/scraper/index.md | 2 +- ...-prometheus-on-azure-kubernetes-service.md | 2 +- 5 files changed, 6 insertions(+), 30 deletions(-) diff --git a/.tours/repo-overview.tour b/.tours/repo-overview.tour index 6c034039b..eb7c1cb10 100644 --- a/.tours/repo-overview.tour +++ b/.tours/repo-overview.tour @@ -7,16 +7,12 @@ }, { "directory": "build", - "description": "### build\n\nThe build folder contains any files needed for Promitor's CI configuration. This includes the Azure DevOps pipelines used for validating PRs and building releases, along with other things like scripts used to publish Promitor to the Helm registry." + "description": "### build\n\nThe build folder contains any files needed for Promitor's CI configuration. This includes the Azure DevOps pipelines used for validating PRs, building releases and more." }, { "directory": "changelog", "description": "### changelog\n\nThe `changelog` folder contains the files needed to generate . Information about new changes should be added to the `content` folder, which is split into the following sections:\n\n- `deprecated` - any deprecated functionality that we need to make users aware of.\n- `experimental` - any new changes that have not been released yet. This is typically where you should add information.\n- `released` - changes that are part of a stable release." }, - { - "directory": "charts", - "description": "### charts\n\nThe charts directory contains the [Helm](https://helm.sh/) chart for Promitor." - }, { "directory": "config", "description": "### config\n\nThe `config` directory contains example configuration files for Promitor, along with some related applications like Prometheus and Grafana." diff --git a/development-guide.md b/development-guide.md index a26aac80a..501728460 100644 --- a/development-guide.md +++ b/development-guide.md @@ -13,7 +13,6 @@ The promitor repository is made up of a number of different directories: - `/.vscode` - contains shared configuration files for [VS Code](https://code.visualstudio.com/). - `/build` - contains the configuration files for Promitor's CI process. - `/changelog` - contains the source code for building -- `/charts` - contains Promitor's [Helm](https://helm.sh/) chart. - `/config` - contains the configuration to run Promitor locally or in the CI - `/deploy` - contains the automation that is being used to manage Promitor, such as the automated updates concerning new Docker images in a pull request. @@ -24,27 +23,8 @@ The promitor repository is made up of a number of different directories: ## Helm Chart -The code for Promitor's Helm chart can be found in [charts/promitor-agent-scraper](charts/promitor-agent-scraper). - -To work on the Helm chart, you need the following tools: - -- [Helm](https://helm.sh). -- A working Kubernetes cluster. For local development you can use [Docker Desktop](https://www.docker.com/products/docker-desktop) - which has an option to install a local cluster for you, or a tool such as [Minikube](https://github.com/kubernetes/minikube) - or [kind](https://kind.sigs.k8s.io/). - -The chart's README contains information about how to install the chart in your Kubernetes -cluster. For local development, you can substitute the relative path to the chart -instead of using the chart name, for example: - -```shell -helm install --name promitor-agent-scraper ./charts/promitor-agent-scraper \ - --set azureAuthentication.appId='' \ - ... -``` - -Please follow Helm's [Best Practices](https://helm.sh/docs/chart_best_practices/#the-chart-best-practices-guide) -when developing the chart. +The code for Promitor's Helm chart can be found on [promitor/charts](https://github.com/promitor/charts) which is also + hosting the Helm chart registry. ## Documentation diff --git a/docs/deployment/resource-discovery/index.md b/docs/deployment/resource-discovery/index.md index cd40f2ea1..fb99050c9 100644 --- a/docs/deployment/resource-discovery/index.md +++ b/docs/deployment/resource-discovery/index.md @@ -28,7 +28,7 @@ Kubernetes cluster. Install the Promitor Chart repository: ```shell -❯ helm repo add promitor https://promitor.azurecr.io/helm/v1/repo +❯ helm repo add promitor https://charts.promitor.io/ ``` Refresh your local Chart repositories: diff --git a/docs/deployment/scraper/index.md b/docs/deployment/scraper/index.md index 9644483bc..68fd2d837 100644 --- a/docs/deployment/scraper/index.md +++ b/docs/deployment/scraper/index.md @@ -30,7 +30,7 @@ Kubernetes cluster. Install the Promitor Chart repository: ```shell -❯ helm repo add promitor https://promitor.azurecr.io/helm/v1/repo +❯ helm repo add promitor https://charts.promitor.io/ ``` Refresh your local Chart repositories: diff --git a/docs/walkthrough/scrape-promitor-with-prometheus-on-azure-kubernetes-service.md b/docs/walkthrough/scrape-promitor-with-prometheus-on-azure-kubernetes-service.md index 8ed84f610..7fa538e3d 100644 --- a/docs/walkthrough/scrape-promitor-with-prometheus-on-azure-kubernetes-service.md +++ b/docs/walkthrough/scrape-promitor-with-prometheus-on-azure-kubernetes-service.md @@ -194,7 +194,7 @@ metrics: To deploy, we'll first add the Promitor chart repository to helm: ```bash -helm repo add promitor https://promitor.azurecr.io/helm/v1/repo +helm repo add promitor https://charts.promitor.io/ helm repo update ``` From 65cade1a7d671e274cba5ec86cc0b6f966771ae7 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Thu, 31 Dec 2020 13:39:57 +0100 Subject: [PATCH 2/2] docs: Add badge for Artifact Hub Signed-off-by: Tom Kerkhove --- README.md | 2 +- docs/index.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a83a8d64..76bf9490c 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Docker Pulls Build Status Docker Stars -CodeFactor +Artifact Hub Donate

diff --git a/docs/index.md b/docs/index.md index 5f189b93c..697c69ef8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,6 +7,7 @@ title: Promitor - Bringing Azure Monitor metrics where you need them [![Build Status](https://img.shields.io/azure-devops/build/tomkerkhove/promitor/50/master.svg?label=Scraper%20Agent%20-%20CI&style=flat-square)](https://dev.azure.com/tomkerkhove/Promitor/_build/latest?definitionId=50&branchName=master) [![Docker Pulls](https://img.shields.io/docker/pulls/tomkerkhove/promitor-agent-scraper.svg?style=flat-square)](https://hub.docker.com/r/tomkerkhove/promitor-agent-scraper/) [![Docker Stars](https://img.shields.io/docker/stars/tomkerkhove/promitor-agent-scraper.svg?style=flat-square)](https://hub.docker.com/r/tomkerkhove/promitor-agent-scraper/) +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/promitor?style=flat-square)](https://artifacthub.io/packages/search?repo=promitor) [![Donate](https://img.shields.io/badge/Donate%20via-GitHub-blue.svg?style=flat-square)](https://github.com/users/tomkerkhove/sponsorship) **Promitor** is an Azure Monitor scraper which makes the metrics available