Skip to content

feat: Add support for custom endpoints and airgap deployment mode #193

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Add support for custom endpoints and airgap deployment mode #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
181 changes: 109 additions & 72 deletions docs/index.yaml
View file
Open in desktop

Large diffs are not rendered by default.

Binary file added docs/promitor-agent-resource-discovery-0.15.0.tgz
View file
Open in desktop
Binary file not shown.
Binary file added docs/promitor-agent-scraper-2.15.0.tgz
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion promitor-agent-resource-discovery/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
apiVersion: v2
version: 0.14.1
version: 0.15.0
appVersion: 0.14.1
type: application
name: promitor-agent-resource-discovery
Expand Down
3 changes: 3 additions & 0 deletions promitor-agent-resource-discovery/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,16 @@ their default values.

| Parameter | Description | Default |
|:---------------------------|:-------------------------|:---------------------|
| `airgap` | Flag to enable airgap deployment mode | `false` |
| `cacrtPath` | Path for CA certificates in Mariner OS | `/etc/pki/tls/certs` |
| `image.repository` | Repository which provides the image | `containers.promitor.io/tomkerkhove/promitor-agent-resource-discovery` |
| `image.tag` | Tag of image to use | None, chart app version is used by default |
| `image.pullPolicy` | Policy to pull image | `Always` |
| `image.pullSecrets` | ImagePullSecrets for the pod | `[]` |
| `azureLandscape.cloud` | Azure Cloud to discover resources in. Options are `Global` (default), `China`, `UsGov` & `Germany` | `Global` |
| `azureLandscape.tenantId` | Id of Azure tenant to discover resources in | |
| `azureLandscape.subscriptions` | List of Azure subscription ids to discover resources in | `[]` |
| `azureLandscape.endpoints` | Custom Azure ARM endpoints to use. Can contain `resourceManager` and `activeDirectory` keys with corresponding endpoint URLs | `{}` |
| `resourceDiscoveryGroups` | List of resource discovery groups to configured following the [resource discovery declaration docs](https://promitor.io/configuration/v2.x/resource-discovery) | |
| `azureAuthentication.appId` | [Deprecated] Use `azureAuthentication.identity.id` instead | |
| `azureAuthentication.appKey` | [Deprecated] Use `azureAuthentication.identity.key` instead | |
Expand Down
6 changes: 6 additions & 0 deletions promitor-agent-resource-discovery/templates/configmap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,11 @@ data:
{{ tpl $subscriptions . | indent 6 }}
{{- end }}
cloud: {{ .Values.azureLandscape.cloud }}
{{- if .Values.azureLandscape.endpoints }}
endpoints:
{{- range $key, $value := .Values.azureLandscape.endpoints }}
{{ $key }}: {{ $value }}
{{- end }}
{{- end }}
resourceDiscoveryGroups:
{{ tpl $resourceDiscoveryGroups . | indent 4 }}
11 changes: 11 additions & 0 deletions promitor-agent-resource-discovery/templates/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,11 @@ spec:
- name: tmp
mountPath: /tmp/
{{- end }}
{{- if .Values.airgap}}
- name: cacrt-host
mountPath: {{ .Values.cacrtPath }}
readOnly: true
{{- end }}
{{- if .Values.extraVolumeMounts }}
{{ toYaml .Values.extraVolumeMounts | indent 10 }}
{{- end }}
Expand Down Expand Up @@ -134,6 +139,12 @@ spec:
- emptyDir: { }
name: tmp
{{- end }}
{{- if .Values.airgap }}
- name: cacrt-host
hostPath:
type: File
path: {{ .Values.cacrtPath }}
{{- end }}
{{- if .Values.extraVolumes }}
{{ toYaml .Values.extraVolumes | indent 8 }}
{{- end }}
9 changes: 9 additions & 0 deletions promitor-agent-resource-discovery/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@

replicaCount: 1

# Flag to enable airgap deployment mode
airgap: false
Copy link
Member

@tomkerkhove tomkerkhove Sep 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need an "airgap" flag? This is Microsoft specific and looks to be used only for ca cert path.

Instead, use a certificates.ca.useCustom option that requires certificates.ca.crtPath

# Path for CA certificates in Mariner OS
cacrtPath: "/etc/pki/tls/certs"

nameOverride: ""
fullnameOverride: ""

Expand Down Expand Up @@ -52,6 +57,10 @@ azureLandscape:
subscriptions: []
# This field is deprecated, use subscriptions instead please
subscriptionIds: []
# endpoints:
# resourceManager: https://management.azure.com/
# activeDirectory: https://login.microsoftonline.com/
# # Add any additional custom endpoints as needed

resourceDiscoveryGroups: []
# Sample resource discovery group configuration below
Expand Down
2 changes: 1 addition & 1 deletion promitor-agent-scraper/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
apiVersion: v2
version: 2.14.1
version: 2.15.0
appVersion: 2.14.1
type: application
name: promitor-agent-scraper
Expand Down
3 changes: 3 additions & 0 deletions promitor-agent-scraper/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ their default values.

| Parameter | Description | Default |
|:---------------------------|:-------------------------|:---------------------|
| `airgap` | Flag to enable airgap deployment mode | `false` |
| `cacrtHostPath` | Path for CA certificates in Mariner OS | `/etc/pki/tls/certs` |
| `image.repository` | Repository which provides the image | `containers.promitor.io/tomkerkhove/promitor-agent-scraper` |
| `image.tag` | Tag of image to use | None, chart app version is used by default |
| `image.pullPolicy` | Policy to pull image | `Always` |
Expand Down Expand Up @@ -108,6 +110,7 @@ their default values.
| `azureMetadata.subscriptionId` | Id of Azure subscription | |
| `azureMetadata.resourceGroupName` | Name of resource group | `promitor` |
| `azureMetadata.cloud` | Azure Cloud to authenticated and scraping metrics from. Options are Global (default), China, UsGov & Germany | `Global` |
| `azureMetadata.endpoints` | Custom Azure ARM endpoints to use. Can contain `resourceManager` and `activeDirectory` keys with corresponding endpoint URLs | `{}` |
| `metricDefaults.aggregation.interval` | Default interval which defines over what period measurements of a metric should be aggregated | `00:05:00` |
| `metricDefaults.scraping.schedule` | Cron expression that controls the fequency in which all the configured metrics will be scraped from Azure Monitor | `*/5 * * * *` |
| `metrics` | List of metrics to scrape configured following the [metric declaration docs](https://promitor.io/configuration/metrics/) | |
Expand Down
6 changes: 6 additions & 0 deletions promitor-agent-scraper/templates/configmap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,12 @@ data:
subscriptionId: {{ .Values.azureMetadata.subscriptionId }}
resourceGroupName: {{ .Values.azureMetadata.resourceGroupName }}
cloud: {{ .Values.azureMetadata.cloud }}
{{- if .Values.azureMetadata.endpoints }}
endpoints:
{{- range $key, $value := .Values.azureMetadata.endpoints }}
{{ $key }}: {{ $value }}
{{- end }}
{{- end }}
metricDefaults:
aggregation:
interval: {{ .Values.metricDefaults.aggregation.interval }}
Expand Down
11 changes: 11 additions & 0 deletions promitor-agent-scraper/templates/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,11 @@ spec:
- name: tmp
mountPath: /tmp/
{{- end }}
{{- if .Values.airgap}}
- name: cacrt-host
mountPath: {{ .Values.cacrtHostPath }}
readOnly: true
{{- end }}
{{- if .Values.extraVolumeMounts }}
{{ toYaml .Values.extraVolumeMounts | indent 10 }}
{{- end }}
Expand Down Expand Up @@ -145,6 +150,12 @@ spec:
- emptyDir: {}
name: tmp
{{- end }}
{{- if .Values.airgap }}
- name: cacrt-host
hostPath:
type: File
path: {{ .Values.cacrtHostPath }}
{{- end }}
{{- if .Values.extraVolumes }}
{{ toYaml .Values.extraVolumes | indent 8 }}
{{- end }}
9 changes: 9 additions & 0 deletions promitor-agent-scraper/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@

replicaCount: 1

# Flag to enable airgap deployment mode
airgap: false
# Path for CA certificates in Mariner OS
cacrtHostPath: "/etc/pki/tls/certs"

nameOverride: ""
fullnameOverride: ""

Expand Down Expand Up @@ -91,6 +96,10 @@ azureMetadata:
subscriptionId: ""
resourceGroupName: promitor
cloud: "Global"
# endpoints:
# resourceManager: https://management.azure.com/
# activeDirectory: https://login.microsoftonline.com/
# # Add any additional custom endpoints as needed
metricDefaults:
aggregation:
interval: 00:05:00
Expand Down
Loading