-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Moritz Wiesinger <[email protected]>
- Loading branch information
Showing
1 changed file
with
137 additions
and
0 deletions.
There are no files selected for viewing
137 changes: 137 additions & 0 deletions
137
docs/content/en/docs/crd-ref/metrics/v1alpha2/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
--- | ||
title: v1alpha2 | ||
description: Reference information for metrics.keptn.sh/v1alpha2 | ||
--- | ||
<!-- markdownlint-disable --> | ||
|
||
## Packages | ||
- [metrics.keptn.sh/v1alpha2](#metricskeptnshv1alpha2) | ||
|
||
|
||
## metrics.keptn.sh/v1alpha2 | ||
|
||
Package v1alpha2 contains API Schema definitions for the metrics v1alpha2 API group | ||
|
||
### Resource Types | ||
- [KeptnMetric](#keptnmetric) | ||
- [KeptnMetricList](#keptnmetriclist) | ||
- [KeptnMetricsProvider](#keptnmetricsprovider) | ||
- [KeptnMetricsProviderList](#keptnmetricsproviderlist) | ||
|
||
|
||
|
||
#### KeptnMetric | ||
|
||
|
||
|
||
KeptnMetric is the Schema for the keptnmetrics API | ||
|
||
_Appears in:_ | ||
- [KeptnMetricList](#keptnmetriclist) | ||
|
||
| Field | Description | | ||
| --- | --- | | ||
| `apiVersion` _string_ | `metrics.keptn.sh/v1alpha2` | ||
| `kind` _string_ | `KeptnMetric` | ||
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | ||
| `spec` _[KeptnMetricSpec](#keptnmetricspec)_ | | | ||
|
||
|
||
#### KeptnMetricList | ||
|
||
|
||
|
||
KeptnMetricList contains a list of KeptnMetric | ||
|
||
|
||
|
||
| Field | Description | | ||
| --- | --- | | ||
| `apiVersion` _string_ | `metrics.keptn.sh/v1alpha2` | ||
| `kind` _string_ | `KeptnMetricList` | ||
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | ||
| `items` _[KeptnMetric](#keptnmetric) array_ | | | ||
|
||
|
||
#### KeptnMetricSpec | ||
|
||
|
||
|
||
KeptnMetricSpec defines the desired state of KeptnMetric | ||
|
||
_Appears in:_ | ||
- [KeptnMetric](#keptnmetric) | ||
|
||
| Field | Description | | ||
| --- | --- | | ||
| `provider` _[ProviderRef](#providerref)_ | Provider represents the provider object | | ||
| `query` _string_ | Query represents the query to be run | | ||
| `fetchIntervalSeconds` _integer_ | FetchIntervalSeconds represents the update frequency in seconds that is used to update the metric | | ||
|
||
|
||
|
||
|
||
#### KeptnMetricsProvider | ||
|
||
|
||
|
||
KeptnMetricsProvider is the Schema for the keptnmetricsproviders API | ||
|
||
_Appears in:_ | ||
- [KeptnMetricsProviderList](#keptnmetricsproviderlist) | ||
|
||
| Field | Description | | ||
| --- | --- | | ||
| `apiVersion` _string_ | `metrics.keptn.sh/v1alpha2` | ||
| `kind` _string_ | `KeptnMetricsProvider` | ||
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | ||
| `spec` _[KeptnMetricsProviderSpec](#keptnmetricsproviderspec)_ | | | ||
|
||
|
||
#### KeptnMetricsProviderList | ||
|
||
|
||
|
||
KeptnMetricsProviderList contains a list of KeptnMetricsProvider | ||
|
||
|
||
|
||
| Field | Description | | ||
| --- | --- | | ||
| `apiVersion` _string_ | `metrics.keptn.sh/v1alpha2` | ||
| `kind` _string_ | `KeptnMetricsProviderList` | ||
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | ||
| `items` _[KeptnMetricsProvider](#keptnmetricsprovider) array_ | | | ||
|
||
|
||
#### KeptnMetricsProviderSpec | ||
|
||
|
||
|
||
KeptnMetricsProviderSpec defines the desired state of KeptnMetricsProvider | ||
|
||
_Appears in:_ | ||
- [KeptnMetricsProvider](#keptnmetricsprovider) | ||
|
||
| Field | Description | | ||
| --- | --- | | ||
| `targetServer` _string_ | | | ||
| `secretKeyRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#secretkeyselector-v1-core)_ | | | ||
|
||
|
||
|
||
|
||
#### ProviderRef | ||
|
||
|
||
|
||
ProviderRef represents the provider object | ||
|
||
_Appears in:_ | ||
- [KeptnMetricSpec](#keptnmetricspec) | ||
|
||
| Field | Description | | ||
| --- | --- | | ||
| `name` _string_ | Name of the provider | | ||
|
||
|