From 48e51ae0197b28376fcd15c41b65e909c1472d31 Mon Sep 17 00:00:00 2001 From: Moritz Wiesinger Date: Tue, 18 Apr 2023 14:20:13 +0200 Subject: [PATCH] generate metrics v1alpha2 Signed-off-by: Moritz Wiesinger --- .../docs/crd-ref/metrics/v1alpha2/_index.md | 137 ++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100644 docs/content/en/docs/crd-ref/metrics/v1alpha2/_index.md diff --git a/docs/content/en/docs/crd-ref/metrics/v1alpha2/_index.md b/docs/content/en/docs/crd-ref/metrics/v1alpha2/_index.md new file mode 100644 index 0000000000..c1a3dd0180 --- /dev/null +++ b/docs/content/en/docs/crd-ref/metrics/v1alpha2/_index.md @@ -0,0 +1,137 @@ +--- +title: v1alpha2 +description: Reference information for metrics.keptn.sh/v1alpha2 +--- + + +## 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 | + +