Skip to content

Commit

Permalink
Fix the type of endpoint params (#1029)
Browse files Browse the repository at this point in the history
Signed-off-by: Pete Wall <pete.wall@grafana.com>
  • Loading branch information
petewall authored Dec 21, 2024
1 parent 2dadc32 commit 1707198
Show file tree
Hide file tree
Showing 21 changed files with 5,434 additions and 24 deletions.
4 changes: 2 additions & 2 deletions charts/k8s-monitoring/destinations/loki-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ auth:
# -- Raw config for accessing the client ID
# @section -- Authentication - OAuth2
clientIdFrom: ""
# -- Prometheus OAuth2 client secret
# -- OAuth2 client secret
# @section -- Authentication - OAuth2
clientSecret: ""
# -- The key for the client secret property in the secret
Expand All @@ -106,7 +106,7 @@ auth:
# -- File containing the OAuth2 client secret.
# @section -- Authentication - OAuth2
clientSecretFile: ""
# -- Prometheus OAuth2 endpoint parameters
# -- OAuth2 endpoint parameters
# @section -- Authentication - OAuth2
endpointParams: {}
# -- HTTP proxy to send requests through.
Expand Down
4 changes: 2 additions & 2 deletions charts/k8s-monitoring/destinations/otlp-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ auth:
# -- Raw config for accessing the client ID
# @section -- Authentication - OAuth2
clientIdFrom: ""
# -- Prometheus OAuth2 client secret
# -- OAuth2 client secret
# @section -- Authentication - OAuth2
clientSecret: ""
# -- The key for the client secret property in the secret
Expand All @@ -116,7 +116,7 @@ auth:
# -- File containing the OAuth2 client secret.
# @section -- Authentication - OAuth2
clientSecretFile: ""
# -- Prometheus OAuth2 endpoint parameters
# -- OAuth2 endpoint parameters
# @section -- Authentication - OAuth2
endpointParams: {}
# -- HTTP proxy to send requests through.
Expand Down
4 changes: 2 additions & 2 deletions charts/k8s-monitoring/destinations/prometheus-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ auth:
# -- Raw config for accessing the client ID
# @section -- Authentication - OAuth2
clientIdFrom: ""
# -- Prometheus OAuth2 client secret
# -- OAuth2 client secret
# @section -- Authentication - OAuth2
clientSecret: ""
# -- The key for the client secret property in the secret
Expand All @@ -115,7 +115,7 @@ auth:
# -- File containing the OAuth2 client secret.
# @section -- Authentication - OAuth2
clientSecretFile: ""
# -- Prometheus OAuth2 endpoint parameters
# -- OAuth2 endpoint parameters
# @section -- Authentication - OAuth2
endpointParams: {}
# -- HTTP proxy to send requests through.
Expand Down
4 changes: 2 additions & 2 deletions charts/k8s-monitoring/destinations/pyroscope-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ auth:
# -- Raw config for accessing the client ID
# @section -- Authentication - OAuth2
clientIdFrom: ""
# -- Prometheus OAuth2 client secret
# -- OAuth2 client secret
# @section -- Authentication - OAuth2
clientSecret: ""
# -- The key for the client secret property in the secret
Expand All @@ -94,7 +94,7 @@ auth:
# -- File containing the OAuth2 client secret.
# @section -- Authentication - OAuth2
clientSecretFile: ""
# -- Prometheus OAuth2 endpoint parameters
# -- OAuth2 endpoint parameters
# @section -- Authentication - OAuth2
endpointParams: {}
# -- HTTP proxy to send requests through.
Expand Down
4 changes: 2 additions & 2 deletions charts/k8s-monitoring/docs/destinations/loki.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ This defines the options for defining a destination for logs that use the Loki p
| auth.oauth2.clientId | string | `""` | OAuth2 client ID |
| auth.oauth2.clientIdFrom | string | `""` | Raw config for accessing the client ID |
| auth.oauth2.clientIdKey | string | `"clientId"` | The key for the client ID property in the secret |
| auth.oauth2.clientSecret | string | `""` | Prometheus OAuth2 client secret |
| auth.oauth2.clientSecret | string | `""` | OAuth2 client secret |
| auth.oauth2.clientSecretFile | string | `""` | File containing the OAuth2 client secret. |
| auth.oauth2.clientSecretFrom | string | `""` | Raw config for accessing the client secret |
| auth.oauth2.clientSecretKey | string | `"clientSecret"` | The key for the client secret property in the secret |
| auth.oauth2.endpointParams | object | `{}` | Prometheus OAuth2 endpoint parameters |
| auth.oauth2.endpointParams | object | `{}` | OAuth2 endpoint parameters |
| auth.oauth2.noProxy | string | `""` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. |
| auth.oauth2.proxyConnectHeader | object | `{}` | Specifies headers to send to proxies during CONNECT requests. |
| auth.oauth2.proxyFromEnvironment | bool | `false` | Use the proxy URL indicated by environment variables. |
Expand Down
4 changes: 2 additions & 2 deletions charts/k8s-monitoring/docs/destinations/otlp.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ This defines the options for defining a destination for OpenTelemetry data that
| auth.oauth2.clientId | string | `""` | OAuth2 client ID |
| auth.oauth2.clientIdFrom | string | `""` | Raw config for accessing the client ID |
| auth.oauth2.clientIdKey | string | `"clientId"` | The key for the client ID property in the secret |
| auth.oauth2.clientSecret | string | `""` | Prometheus OAuth2 client secret |
| auth.oauth2.clientSecret | string | `""` | OAuth2 client secret |
| auth.oauth2.clientSecretFile | string | `""` | File containing the OAuth2 client secret. |
| auth.oauth2.clientSecretFrom | string | `""` | Raw config for accessing the client secret |
| auth.oauth2.clientSecretKey | string | `"clientSecret"` | The key for the client secret property in the secret |
| auth.oauth2.endpointParams | object | `{}` | Prometheus OAuth2 endpoint parameters |
| auth.oauth2.endpointParams | object | `{}` | OAuth2 endpoint parameters |
| auth.oauth2.noProxy | string | `""` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. |
| auth.oauth2.proxyConnectHeader | object | `{}` | Specifies headers to send to proxies during CONNECT requests. |
| auth.oauth2.proxyFromEnvironment | bool | `false` | Use the proxy URL indicated by environment variables. |
Expand Down
4 changes: 2 additions & 2 deletions charts/k8s-monitoring/docs/destinations/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ This defines the options for defining a destination for metrics that use the Pro
| auth.oauth2.clientId | string | `""` | OAuth2 client ID |
| auth.oauth2.clientIdFrom | string | `""` | Raw config for accessing the client ID |
| auth.oauth2.clientIdKey | string | `"clientId"` | The key for the client ID property in the secret |
| auth.oauth2.clientSecret | string | `""` | Prometheus OAuth2 client secret |
| auth.oauth2.clientSecret | string | `""` | OAuth2 client secret |
| auth.oauth2.clientSecretFile | string | `""` | File containing the OAuth2 client secret. |
| auth.oauth2.clientSecretFrom | string | `""` | Raw config for accessing the client secret |
| auth.oauth2.clientSecretKey | string | `"clientSecret"` | The key for the client secret property in the secret |
| auth.oauth2.endpointParams | object | `{}` | Prometheus OAuth2 endpoint parameters |
| auth.oauth2.endpointParams | object | `{}` | OAuth2 endpoint parameters |
| auth.oauth2.noProxy | string | `""` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. |
| auth.oauth2.proxyConnectHeader | object | `{}` | Specifies headers to send to proxies during CONNECT requests. |
| auth.oauth2.proxyFromEnvironment | bool | `false` | Use the proxy URL indicated by environment variables. |
Expand Down
4 changes: 2 additions & 2 deletions charts/k8s-monitoring/docs/destinations/pyroscope.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ This defines the options for defining a destination for profiles that use the Py
| auth.oauth2.clientId | string | `""` | OAuth2 client ID |
| auth.oauth2.clientIdFrom | string | `""` | Raw config for accessing the client ID |
| auth.oauth2.clientIdKey | string | `"clientId"` | The key for the client ID property in the secret |
| auth.oauth2.clientSecret | string | `""` | Prometheus OAuth2 client secret |
| auth.oauth2.clientSecret | string | `""` | OAuth2 client secret |
| auth.oauth2.clientSecretFile | string | `""` | File containing the OAuth2 client secret. |
| auth.oauth2.clientSecretFrom | string | `""` | Raw config for accessing the client secret |
| auth.oauth2.clientSecretKey | string | `"clientSecret"` | The key for the client secret property in the secret |
| auth.oauth2.endpointParams | object | `{}` | Prometheus OAuth2 endpoint parameters |
| auth.oauth2.endpointParams | object | `{}` | OAuth2 endpoint parameters |
| auth.oauth2.noProxy | string | `""` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. |
| auth.oauth2.proxyConnectHeader | object | `{}` | Specifies headers to send to proxies during CONNECT requests. |
| auth.oauth2.proxyFromEnvironment | bool | `false` | Use the proxy URL indicated by environment variables. |
Expand Down
56 changes: 56 additions & 0 deletions charts/k8s-monitoring/docs/examples/auth/oauth2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!--
(NOTE: Do not edit README.md directly. It is a generated file!)
( To make changes, please modify values.yaml or description.txt and run `make examples`)
-->
# OAuth2 Authentication

This example demonstrates how to use OAuth2 for authentication.

## Values

```yaml
cluster:
name: oauth2-auth-example

destinations:
- name: otel-endpoint
type: otlp
url: "grpc.my.otel.endpoint:443"
auth:
type: oauth2
oauth2:
tokenURL: "https://my.idp/application/o/token/"
clientId: "my-client-id"
clientSecretFile: "/var/run/secrets/kubernetes.io/serviceaccount/token"
endpointParams:
grant_type: ["client_credentials"]
client_assertion_type: ["urn:ietf:params:oauth:client-assertion-type:jwt-bearer"]
logs: {enabled: true}
metrics: {enabled: true}
traces: {enabled: true}

clusterMetrics:
enabled: true

clusterEvents:
enabled: true

podLogs:
enabled: true

nodeLogs:
enabled: true

prometheusOperatorObjects:
enabled: true

annotationAutodiscovery:
enabled: true

alloy-logs:
enabled: true
alloy-metrics:
enabled: true
alloy-singleton:
enabled: true
```
Loading

0 comments on commit 1707198

Please sign in to comment.