diff --git a/.github/scripts/generate-crd-docs/templates/gv_list.tpl b/.github/scripts/generate-crd-docs/templates/gv_list.tpl index bf35ee92cf..60afcb210d 100644 --- a/.github/scripts/generate-crd-docs/templates/gv_list.tpl +++ b/.github/scripts/generate-crd-docs/templates/gv_list.tpl @@ -8,6 +8,7 @@ description: Reference information about the KLT CRDs weight: 100 hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html --- + ## Packages {{- range $groupVersions }} @@ -19,3 +20,4 @@ hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.htm {{ end }} {{- end -}} + diff --git a/docs/content/en/docs/crd-ref/_index.md b/docs/content/en/docs/crd-ref/_index.md new file mode 100644 index 0000000000..0e625529bf --- /dev/null +++ b/docs/content/en/docs/crd-ref/_index.md @@ -0,0 +1,6 @@ +--- +title: API Reference +description: Reference information about the KLT CRDs +weight: 100 +hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html +--- diff --git a/docs/content/en/docs/crd-ref/lifecycle/_index.md b/docs/content/en/docs/crd-ref/lifecycle/_index.md new file mode 100644 index 0000000000..eb4a57e749 --- /dev/null +++ b/docs/content/en/docs/crd-ref/lifecycle/_index.md @@ -0,0 +1,6 @@ +--- +title: Lifecycle API +description: Reference information about the Lifecycle API +weight: 100 +hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html +--- diff --git a/docs/content/en/docs/crd-ref/lifecycle/v1alpha1/_index.md b/docs/content/en/docs/crd-ref/lifecycle/v1alpha1/_index.md new file mode 100644 index 0000000000..a564705fb2 --- /dev/null +++ b/docs/content/en/docs/crd-ref/lifecycle/v1alpha1/_index.md @@ -0,0 +1,769 @@ +--- +title: v1alpha1 +description: Reference information about the KLT CRDs +weight: 100 +hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html +--- + + +## Packages +- [lifecycle.keptn.sh/v1alpha1](#lifecyclekeptnshv1alpha1) + + +## lifecycle.keptn.sh/v1alpha1 + +Package v1alpha1 contains API Schema definitions for the lifecycle v1alpha1 API group + +### Resource Types +- [KeptnApp](#keptnapp) +- [KeptnAppList](#keptnapplist) +- [KeptnAppVersion](#keptnappversion) +- [KeptnAppVersionList](#keptnappversionlist) +- [KeptnEvaluation](#keptnevaluation) +- [KeptnEvaluationDefinition](#keptnevaluationdefinition) +- [KeptnEvaluationDefinitionList](#keptnevaluationdefinitionlist) +- [KeptnEvaluationList](#keptnevaluationlist) +- [KeptnEvaluationProvider](#keptnevaluationprovider) +- [KeptnEvaluationProviderList](#keptnevaluationproviderlist) +- [KeptnTask](#keptntask) +- [KeptnTaskDefinition](#keptntaskdefinition) +- [KeptnTaskDefinitionList](#keptntaskdefinitionlist) +- [KeptnTaskList](#keptntasklist) +- [KeptnWorkload](#keptnworkload) +- [KeptnWorkloadInstance](#keptnworkloadinstance) +- [KeptnWorkloadInstanceList](#keptnworkloadinstancelist) +- [KeptnWorkloadList](#keptnworkloadlist) + + + +#### ConfigMapReference + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) + +| Field | Description | +| --- | --- | +| `name` _string_ | | + + + + +#### EvaluationStatus + + + + + +_Appears in:_ +- [KeptnAppVersionStatus](#keptnappversionstatus) +- [KeptnWorkloadInstanceStatus](#keptnworkloadinstancestatus) + +| Field | Description | +| --- | --- | +| `evaluationDefinitionName` _string_ | | +| `evaluationName` _string_ | | +| `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#time-v1-meta)_ | | +| `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#time-v1-meta)_ | | + + +#### EvaluationStatusItem + + + + + +_Appears in:_ +- [KeptnEvaluationStatus](#keptnevaluationstatus) + +| Field | Description | +| --- | --- | +| `value` _string_ | | +| `message` _string_ | | + + +#### FunctionReference + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) + +| Field | Description | +| --- | --- | +| `name` _string_ | | + + +#### FunctionSpec + + + + + +_Appears in:_ +- [KeptnTaskDefinitionSpec](#keptntaskdefinitionspec) + +| Field | Description | +| --- | --- | +| `functionRef` _[FunctionReference](#functionreference)_ | | +| `inline` _[Inline](#inline)_ | | +| `httpRef` _[HttpReference](#httpreference)_ | | +| `configMapRef` _[ConfigMapReference](#configmapreference)_ | | +| `parameters` _[TaskParameters](#taskparameters)_ | | +| `secureParameters` _[SecureParameters](#secureparameters)_ | | + + +#### FunctionStatus + + + + + +_Appears in:_ +- [KeptnTaskDefinitionStatus](#keptntaskdefinitionstatus) + +| Field | Description | +| --- | --- | +| `configMap` _string_ | INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file | + + +#### HttpReference + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) + +| Field | Description | +| --- | --- | +| `url` _string_ | | + + +#### Inline + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) + +| Field | Description | +| --- | --- | +| `code` _string_ | | + + +#### KeptnApp + + + +KeptnApp is the Schema for the keptnapps API + +_Appears in:_ +- [KeptnAppList](#keptnapplist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnApp` +| `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` _[KeptnAppSpec](#keptnappspec)_ | | + + +#### KeptnAppList + + + +KeptnAppList contains a list of KeptnApp + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnAppList` +| `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` _[KeptnApp](#keptnapp) array_ | | + + +#### KeptnAppSpec + + + +KeptnAppSpec defines the desired state of KeptnApp + +_Appears in:_ +- [KeptnApp](#keptnapp) +- [KeptnAppVersionSpec](#keptnappversionspec) + +| Field | Description | +| --- | --- | +| `version` _string_ | | +| `workloads` _[KeptnWorkloadRef](#keptnworkloadref) array_ | | +| `preDeploymentTasks` _string array_ | | +| `postDeploymentTasks` _string array_ | | +| `preDeploymentEvaluations` _string array_ | | +| `postDeploymentEvaluations` _string array_ | | + + + + +#### KeptnAppVersion + + + +KeptnAppVersion is the Schema for the keptnappversions API + +_Appears in:_ +- [KeptnAppVersionList](#keptnappversionlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnAppVersion` +| `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` _[KeptnAppVersionSpec](#keptnappversionspec)_ | | + + +#### KeptnAppVersionList + + + +KeptnAppVersionList contains a list of KeptnAppVersion + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnAppVersionList` +| `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` _[KeptnAppVersion](#keptnappversion) array_ | | + + +#### KeptnAppVersionSpec + + + +KeptnAppVersionSpec defines the desired state of KeptnAppVersion + +_Appears in:_ +- [KeptnAppVersion](#keptnappversion) + +| Field | Description | +| --- | --- | +| `KeptnAppSpec` _[KeptnAppSpec](#keptnappspec)_ | | +| `appName` _string_ | | +| `previousVersion` _string_ | | +| `traceId` _object (keys:string, values:string)_ | | + + + + +#### KeptnEvaluation + + + +KeptnEvaluation is the Schema for the keptnevaluations API + +_Appears in:_ +- [KeptnEvaluationList](#keptnevaluationlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnEvaluation` +| `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` _[KeptnEvaluationSpec](#keptnevaluationspec)_ | | + + +#### KeptnEvaluationDefinition + + + +KeptnEvaluationDefinition is the Schema for the keptnevaluationdefinitions API + +_Appears in:_ +- [KeptnEvaluationDefinitionList](#keptnevaluationdefinitionlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnEvaluationDefinition` +| `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` _[KeptnEvaluationDefinitionSpec](#keptnevaluationdefinitionspec)_ | | + + +#### KeptnEvaluationDefinitionList + + + +KeptnEvaluationDefinitionList contains a list of KeptnEvaluationDefinition + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnEvaluationDefinitionList` +| `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` _[KeptnEvaluationDefinition](#keptnevaluationdefinition) array_ | | + + +#### KeptnEvaluationDefinitionSpec + + + +KeptnEvaluationDefinitionSpec defines the desired state of KeptnEvaluationDefinition + +_Appears in:_ +- [KeptnEvaluationDefinition](#keptnevaluationdefinition) + +| Field | Description | +| --- | --- | +| `source` _string_ | | +| `objectives` _[Objective](#objective) array_ | | + + + + +#### KeptnEvaluationList + + + +KeptnEvaluationList contains a list of KeptnEvaluation + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnEvaluationList` +| `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` _[KeptnEvaluation](#keptnevaluation) array_ | | + + +#### KeptnEvaluationProvider + + + +KeptnEvaluationProvider is the Schema for the keptnevaluationproviders API + +_Appears in:_ +- [KeptnEvaluationProviderList](#keptnevaluationproviderlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnEvaluationProvider` +| `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` _[KeptnEvaluationProviderSpec](#keptnevaluationproviderspec)_ | | + + +#### KeptnEvaluationProviderList + + + +KeptnEvaluationProviderList contains a list of KeptnEvaluationProvider + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnEvaluationProviderList` +| `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` _[KeptnEvaluationProvider](#keptnevaluationprovider) array_ | | + + +#### KeptnEvaluationProviderSpec + + + +KeptnEvaluationProviderSpec defines the desired state of KeptnEvaluationProvider + +_Appears in:_ +- [KeptnEvaluationProvider](#keptnevaluationprovider) + +| Field | Description | +| --- | --- | +| `targetServer` _string_ | | +| `secretName` _string_ | | + + + + +#### KeptnEvaluationSpec + + + +KeptnEvaluationSpec defines the desired state of KeptnEvaluation + +_Appears in:_ +- [KeptnEvaluation](#keptnevaluation) + +| Field | Description | +| --- | --- | +| `workload` _string_ | | +| `workloadVersion` _string_ | | +| `appName` _string_ | | +| `appVersion` _string_ | | +| `evaluationDefinition` _string_ | | +| `retries` _integer_ | | +| `retryInterval` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#duration-v1-meta)_ | | +| `failAction` _string_ | | +| `checkType` _CheckType_ | | + + + + +#### KeptnTask + + + +KeptnTask is the Schema for the keptntasks API + +_Appears in:_ +- [KeptnTaskList](#keptntasklist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnTask` +| `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` _[KeptnTaskSpec](#keptntaskspec)_ | | + + +#### KeptnTaskDefinition + + + +KeptnTaskDefinition is the Schema for the keptntaskdefinitions API + +_Appears in:_ +- [KeptnTaskDefinitionList](#keptntaskdefinitionlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnTaskDefinition` +| `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` _[KeptnTaskDefinitionSpec](#keptntaskdefinitionspec)_ | | + + +#### KeptnTaskDefinitionList + + + +KeptnTaskDefinitionList contains a list of KeptnTaskDefinition + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnTaskDefinitionList` +| `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` _[KeptnTaskDefinition](#keptntaskdefinition) array_ | | + + +#### KeptnTaskDefinitionSpec + + + +KeptnTaskDefinitionSpec defines the desired state of KeptnTaskDefinition + +_Appears in:_ +- [KeptnTaskDefinition](#keptntaskdefinition) + +| Field | Description | +| --- | --- | +| `function` _[FunctionSpec](#functionspec)_ | | + + + + +#### KeptnTaskList + + + +KeptnTaskList contains a list of KeptnTask + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnTaskList` +| `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` _[KeptnTask](#keptntask) array_ | | + + +#### KeptnTaskSpec + + + +KeptnTaskSpec defines the desired state of KeptnTask + +_Appears in:_ +- [KeptnTask](#keptntask) + +| Field | Description | +| --- | --- | +| `workload` _string_ | | +| `workloadVersion` _string_ | | +| `app` _string_ | | +| `appVersion` _string_ | | +| `taskDefinition` _string_ | | +| `context` _[TaskContext](#taskcontext)_ | | +| `parameters` _[TaskParameters](#taskparameters)_ | | +| `secureParameters` _[SecureParameters](#secureparameters)_ | | +| `checkType` _CheckType_ | | + + + + +#### KeptnWorkload + + + +KeptnWorkload is the Schema for the keptnworkloads API + +_Appears in:_ +- [KeptnWorkloadList](#keptnworkloadlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnWorkload` +| `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` _[KeptnWorkloadSpec](#keptnworkloadspec)_ | | + + +#### KeptnWorkloadInstance + + + +KeptnWorkloadInstance is the Schema for the keptnworkloadinstances API + +_Appears in:_ +- [KeptnWorkloadInstanceList](#keptnworkloadinstancelist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnWorkloadInstance` +| `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` _[KeptnWorkloadInstanceSpec](#keptnworkloadinstancespec)_ | | + + +#### KeptnWorkloadInstanceList + + + +KeptnWorkloadInstanceList contains a list of KeptnWorkloadInstance + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnWorkloadInstanceList` +| `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` _[KeptnWorkloadInstance](#keptnworkloadinstance) array_ | | + + +#### KeptnWorkloadInstanceSpec + + + +KeptnWorkloadInstanceSpec defines the desired state of KeptnWorkloadInstance + +_Appears in:_ +- [KeptnWorkloadInstance](#keptnworkloadinstance) + +| Field | Description | +| --- | --- | +| `KeptnWorkloadSpec` _[KeptnWorkloadSpec](#keptnworkloadspec)_ | | +| `workloadName` _string_ | | +| `previousVersion` _string_ | | +| `traceId` _object (keys:string, values:string)_ | | + + + + +#### KeptnWorkloadList + + + +KeptnWorkloadList contains a list of KeptnWorkload + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnWorkloadList` +| `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` _[KeptnWorkload](#keptnworkload) array_ | | + + +#### KeptnWorkloadRef + + + + + +_Appears in:_ +- [KeptnAppSpec](#keptnappspec) +- [WorkloadStatus](#workloadstatus) + +| Field | Description | +| --- | --- | +| `name` _string_ | | +| `version` _string_ | | + + +#### KeptnWorkloadSpec + + + +KeptnWorkloadSpec defines the desired state of KeptnWorkload + +_Appears in:_ +- [KeptnWorkload](#keptnworkload) +- [KeptnWorkloadInstanceSpec](#keptnworkloadinstancespec) + +| Field | Description | +| --- | --- | +| `app` _string_ | | +| `version` _string_ | | +| `preDeploymentTasks` _string array_ | | +| `postDeploymentTasks` _string array_ | | +| `preDeploymentEvaluations` _string array_ | | +| `postDeploymentEvaluations` _string array_ | | +| `resourceReference` _[ResourceReference](#resourcereference)_ | | + + + + +#### Objective + + + + + +_Appears in:_ +- [KeptnEvaluationDefinitionSpec](#keptnevaluationdefinitionspec) + +| Field | Description | +| --- | --- | +| `name` _string_ | | +| `query` _string_ | | +| `evaluationTarget` _string_ | | + + +#### ResourceReference + + + + + +_Appears in:_ +- [KeptnWorkloadSpec](#keptnworkloadspec) + +| Field | Description | +| --- | --- | +| `uid` _UID_ | | +| `kind` _string_ | | +| `name` _string_ | | + + +#### SecureParameters + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) +- [KeptnTaskSpec](#keptntaskspec) + +| Field | Description | +| --- | --- | +| `secret` _string_ | | + + +#### TaskContext + + + + + +_Appears in:_ +- [KeptnTaskSpec](#keptntaskspec) + +| Field | Description | +| --- | --- | +| `workloadName` _string_ | | +| `appName` _string_ | | +| `appVersion` _string_ | | +| `workloadVersion` _string_ | | +| `taskType` _string_ | | +| `objectType` _string_ | | + + +#### TaskParameters + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) +- [KeptnTaskSpec](#keptntaskspec) + +| Field | Description | +| --- | --- | +| `map` _object (keys:string, values:string)_ | | + + +#### TaskStatus + + + + + +_Appears in:_ +- [KeptnAppVersionStatus](#keptnappversionstatus) +- [KeptnWorkloadInstanceStatus](#keptnworkloadinstancestatus) + +| Field | Description | +| --- | --- | +| `taskDefinitionName` _string_ | | +| `taskName` _string_ | | +| `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#time-v1-meta)_ | | +| `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#time-v1-meta)_ | | + + +#### WorkloadStatus + + + + + +_Appears in:_ +- [KeptnAppVersionStatus](#keptnappversionstatus) + +| Field | Description | +| --- | --- | +| `workload` _[KeptnWorkloadRef](#keptnworkloadref)_ | | + + diff --git a/docs/content/en/docs/crd-ref/lifecycle/v1alpha2/_index.md b/docs/content/en/docs/crd-ref/lifecycle/v1alpha2/_index.md new file mode 100644 index 0000000000..36d18332fc --- /dev/null +++ b/docs/content/en/docs/crd-ref/lifecycle/v1alpha2/_index.md @@ -0,0 +1,752 @@ +--- +title: v1alpha2 +description: Reference information about the KLT CRDs +weight: 100 +hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html +--- + + +## Packages +- [lifecycle.keptn.sh/v1alpha2](#lifecyclekeptnshv1alpha2) + + +## lifecycle.keptn.sh/v1alpha2 + +Package v1alpha2 contains API Schema definitions for the lifecycle v1alpha2 API group + +### Resource Types +- [KeptnApp](#keptnapp) +- [KeptnAppList](#keptnapplist) +- [KeptnAppVersion](#keptnappversion) +- [KeptnAppVersionList](#keptnappversionlist) +- [KeptnEvaluation](#keptnevaluation) +- [KeptnEvaluationDefinition](#keptnevaluationdefinition) +- [KeptnEvaluationDefinitionList](#keptnevaluationdefinitionlist) +- [KeptnEvaluationList](#keptnevaluationlist) +- [KeptnEvaluationProvider](#keptnevaluationprovider) +- [KeptnEvaluationProviderList](#keptnevaluationproviderlist) +- [KeptnTask](#keptntask) +- [KeptnTaskDefinition](#keptntaskdefinition) +- [KeptnTaskDefinitionList](#keptntaskdefinitionlist) +- [KeptnTaskList](#keptntasklist) +- [KeptnWorkload](#keptnworkload) +- [KeptnWorkloadInstance](#keptnworkloadinstance) +- [KeptnWorkloadInstanceList](#keptnworkloadinstancelist) +- [KeptnWorkloadList](#keptnworkloadlist) + + + +#### ConfigMapReference + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) + +| Field | Description | +| --- | --- | +| `name` _string_ | | + + + + +#### EvaluationStatusItem + + + + + +_Appears in:_ +- [KeptnEvaluationStatus](#keptnevaluationstatus) + +| Field | Description | +| --- | --- | +| `value` _string_ | | +| `message` _string_ | | + + +#### FunctionReference + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) + +| Field | Description | +| --- | --- | +| `name` _string_ | | + + +#### FunctionSpec + + + + + +_Appears in:_ +- [KeptnTaskDefinitionSpec](#keptntaskdefinitionspec) + +| Field | Description | +| --- | --- | +| `functionRef` _[FunctionReference](#functionreference)_ | | +| `inline` _[Inline](#inline)_ | | +| `httpRef` _[HttpReference](#httpreference)_ | | +| `configMapRef` _[ConfigMapReference](#configmapreference)_ | | +| `parameters` _[TaskParameters](#taskparameters)_ | | +| `secureParameters` _[SecureParameters](#secureparameters)_ | | + + +#### FunctionStatus + + + + + +_Appears in:_ +- [KeptnTaskDefinitionStatus](#keptntaskdefinitionstatus) + +| Field | Description | +| --- | --- | +| `configMap` _string_ | INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file | + + +#### HttpReference + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) + +| Field | Description | +| --- | --- | +| `url` _string_ | | + + +#### Inline + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) + +| Field | Description | +| --- | --- | +| `code` _string_ | | + + +#### ItemStatus + + + + + +_Appears in:_ +- [KeptnAppVersionStatus](#keptnappversionstatus) +- [KeptnWorkloadInstanceStatus](#keptnworkloadinstancestatus) + +| Field | Description | +| --- | --- | +| `definitionName` _string_ | DefinitionName is the name of the EvaluationDefinition/TaskDefiniton | +| `name` _string_ | Name is the name of the Evaluation/Task | +| `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#time-v1-meta)_ | | +| `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#time-v1-meta)_ | | + + +#### KeptnApp + + + +KeptnApp is the Schema for the keptnapps API + +_Appears in:_ +- [KeptnAppList](#keptnapplist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnApp` +| `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` _[KeptnAppSpec](#keptnappspec)_ | | + + +#### KeptnAppList + + + +KeptnAppList contains a list of KeptnApp + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnAppList` +| `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` _[KeptnApp](#keptnapp) array_ | | + + +#### KeptnAppSpec + + + +KeptnAppSpec defines the desired state of KeptnApp + +_Appears in:_ +- [KeptnApp](#keptnapp) +- [KeptnAppVersionSpec](#keptnappversionspec) + +| Field | Description | +| --- | --- | +| `version` _string_ | | +| `revision` _integer_ | | +| `workloads` _[KeptnWorkloadRef](#keptnworkloadref) array_ | | +| `preDeploymentTasks` _string array_ | | +| `postDeploymentTasks` _string array_ | | +| `preDeploymentEvaluations` _string array_ | | +| `postDeploymentEvaluations` _string array_ | | + + + + +#### KeptnAppVersion + + + +KeptnAppVersion is the Schema for the keptnappversions API + +_Appears in:_ +- [KeptnAppVersionList](#keptnappversionlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnAppVersion` +| `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` _[KeptnAppVersionSpec](#keptnappversionspec)_ | | + + +#### KeptnAppVersionList + + + +KeptnAppVersionList contains a list of KeptnAppVersion + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnAppVersionList` +| `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` _[KeptnAppVersion](#keptnappversion) array_ | | + + +#### KeptnAppVersionSpec + + + +KeptnAppVersionSpec defines the desired state of KeptnAppVersion + +_Appears in:_ +- [KeptnAppVersion](#keptnappversion) + +| Field | Description | +| --- | --- | +| `KeptnAppSpec` _[KeptnAppSpec](#keptnappspec)_ | | +| `appName` _string_ | | +| `previousVersion` _string_ | | +| `traceId` _object (keys:string, values:string)_ | | + + + + +#### KeptnEvaluation + + + +KeptnEvaluation is the Schema for the keptnevaluations API + +_Appears in:_ +- [KeptnEvaluationList](#keptnevaluationlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnEvaluation` +| `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` _[KeptnEvaluationSpec](#keptnevaluationspec)_ | | + + +#### KeptnEvaluationDefinition + + + +KeptnEvaluationDefinition is the Schema for the keptnevaluationdefinitions API + +_Appears in:_ +- [KeptnEvaluationDefinitionList](#keptnevaluationdefinitionlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnEvaluationDefinition` +| `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` _[KeptnEvaluationDefinitionSpec](#keptnevaluationdefinitionspec)_ | | + + +#### KeptnEvaluationDefinitionList + + + +KeptnEvaluationDefinitionList contains a list of KeptnEvaluationDefinition + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnEvaluationDefinitionList` +| `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` _[KeptnEvaluationDefinition](#keptnevaluationdefinition) array_ | | + + +#### KeptnEvaluationDefinitionSpec + + + +KeptnEvaluationDefinitionSpec defines the desired state of KeptnEvaluationDefinition + +_Appears in:_ +- [KeptnEvaluationDefinition](#keptnevaluationdefinition) + +| Field | Description | +| --- | --- | +| `source` _string_ | | +| `objectives` _[Objective](#objective) array_ | | + + + + +#### KeptnEvaluationList + + + +KeptnEvaluationList contains a list of KeptnEvaluation + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnEvaluationList` +| `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` _[KeptnEvaluation](#keptnevaluation) array_ | | + + +#### KeptnEvaluationProvider + + + +KeptnEvaluationProvider is the Schema for the keptnevaluationproviders API + +_Appears in:_ +- [KeptnEvaluationProviderList](#keptnevaluationproviderlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnEvaluationProvider` +| `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` _[KeptnEvaluationProviderSpec](#keptnevaluationproviderspec)_ | | + + +#### KeptnEvaluationProviderList + + + +KeptnEvaluationProviderList contains a list of KeptnEvaluationProvider + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnEvaluationProviderList` +| `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` _[KeptnEvaluationProvider](#keptnevaluationprovider) array_ | | + + +#### KeptnEvaluationProviderSpec + + + +KeptnEvaluationProviderSpec defines the desired state of KeptnEvaluationProvider + +_Appears in:_ +- [KeptnEvaluationProvider](#keptnevaluationprovider) + +| Field | Description | +| --- | --- | +| `targetServer` _string_ | | +| `secretKeyRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#secretkeyselector-v1-core)_ | | + + + + +#### KeptnEvaluationSpec + + + +KeptnEvaluationSpec defines the desired state of KeptnEvaluation + +_Appears in:_ +- [KeptnEvaluation](#keptnevaluation) + +| Field | Description | +| --- | --- | +| `workload` _string_ | | +| `workloadVersion` _string_ | | +| `appName` _string_ | | +| `appVersion` _string_ | | +| `evaluationDefinition` _string_ | | +| `retries` _integer_ | | +| `retryInterval` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#duration-v1-meta)_ | | +| `failAction` _string_ | | +| `checkType` _CheckType_ | | + + + + +#### KeptnTask + + + +KeptnTask is the Schema for the keptntasks API + +_Appears in:_ +- [KeptnTaskList](#keptntasklist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnTask` +| `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` _[KeptnTaskSpec](#keptntaskspec)_ | | + + +#### KeptnTaskDefinition + + + +KeptnTaskDefinition is the Schema for the keptntaskdefinitions API + +_Appears in:_ +- [KeptnTaskDefinitionList](#keptntaskdefinitionlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnTaskDefinition` +| `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` _[KeptnTaskDefinitionSpec](#keptntaskdefinitionspec)_ | | + + +#### KeptnTaskDefinitionList + + + +KeptnTaskDefinitionList contains a list of KeptnTaskDefinition + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnTaskDefinitionList` +| `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` _[KeptnTaskDefinition](#keptntaskdefinition) array_ | | + + +#### KeptnTaskDefinitionSpec + + + +KeptnTaskDefinitionSpec defines the desired state of KeptnTaskDefinition + +_Appears in:_ +- [KeptnTaskDefinition](#keptntaskdefinition) + +| Field | Description | +| --- | --- | +| `function` _[FunctionSpec](#functionspec)_ | | + + + + +#### KeptnTaskList + + + +KeptnTaskList contains a list of KeptnTask + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnTaskList` +| `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` _[KeptnTask](#keptntask) array_ | | + + +#### KeptnTaskSpec + + + +KeptnTaskSpec defines the desired state of KeptnTask + +_Appears in:_ +- [KeptnTask](#keptntask) + +| Field | Description | +| --- | --- | +| `workload` _string_ | | +| `workloadVersion` _string_ | | +| `app` _string_ | | +| `appVersion` _string_ | | +| `taskDefinition` _string_ | | +| `context` _[TaskContext](#taskcontext)_ | | +| `parameters` _[TaskParameters](#taskparameters)_ | | +| `secureParameters` _[SecureParameters](#secureparameters)_ | | +| `checkType` _CheckType_ | | + + + + +#### KeptnWorkload + + + +KeptnWorkload is the Schema for the keptnworkloads API + +_Appears in:_ +- [KeptnWorkloadList](#keptnworkloadlist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnWorkload` +| `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` _[KeptnWorkloadSpec](#keptnworkloadspec)_ | | + + +#### KeptnWorkloadInstance + + + +KeptnWorkloadInstance is the Schema for the keptnworkloadinstances API + +_Appears in:_ +- [KeptnWorkloadInstanceList](#keptnworkloadinstancelist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnWorkloadInstance` +| `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` _[KeptnWorkloadInstanceSpec](#keptnworkloadinstancespec)_ | | + + +#### KeptnWorkloadInstanceList + + + +KeptnWorkloadInstanceList contains a list of KeptnWorkloadInstance + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnWorkloadInstanceList` +| `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` _[KeptnWorkloadInstance](#keptnworkloadinstance) array_ | | + + +#### KeptnWorkloadInstanceSpec + + + +KeptnWorkloadInstanceSpec defines the desired state of KeptnWorkloadInstance + +_Appears in:_ +- [KeptnWorkloadInstance](#keptnworkloadinstance) + +| Field | Description | +| --- | --- | +| `KeptnWorkloadSpec` _[KeptnWorkloadSpec](#keptnworkloadspec)_ | | +| `workloadName` _string_ | | +| `previousVersion` _string_ | | +| `traceId` _object (keys:string, values:string)_ | | + + + + +#### KeptnWorkloadList + + + +KeptnWorkloadList contains a list of KeptnWorkload + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2` +| `kind` _string_ | `KeptnWorkloadList` +| `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` _[KeptnWorkload](#keptnworkload) array_ | | + + +#### KeptnWorkloadRef + + + + + +_Appears in:_ +- [KeptnAppSpec](#keptnappspec) +- [WorkloadStatus](#workloadstatus) + +| Field | Description | +| --- | --- | +| `name` _string_ | | +| `version` _string_ | | + + +#### KeptnWorkloadSpec + + + +KeptnWorkloadSpec defines the desired state of KeptnWorkload + +_Appears in:_ +- [KeptnWorkload](#keptnworkload) +- [KeptnWorkloadInstanceSpec](#keptnworkloadinstancespec) + +| Field | Description | +| --- | --- | +| `app` _string_ | | +| `version` _string_ | | +| `preDeploymentTasks` _string array_ | | +| `postDeploymentTasks` _string array_ | | +| `preDeploymentEvaluations` _string array_ | | +| `postDeploymentEvaluations` _string array_ | | +| `resourceReference` _[ResourceReference](#resourcereference)_ | | + + + + +#### Objective + + + + + +_Appears in:_ +- [KeptnEvaluationDefinitionSpec](#keptnevaluationdefinitionspec) + +| Field | Description | +| --- | --- | +| `name` _string_ | | +| `query` _string_ | | +| `evaluationTarget` _string_ | | + + +#### ResourceReference + + + + + +_Appears in:_ +- [KeptnWorkloadSpec](#keptnworkloadspec) + +| Field | Description | +| --- | --- | +| `uid` _UID_ | | +| `kind` _string_ | | +| `name` _string_ | | + + +#### SecureParameters + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) +- [KeptnTaskSpec](#keptntaskspec) + +| Field | Description | +| --- | --- | +| `secret` _string_ | | + + +#### TaskContext + + + + + +_Appears in:_ +- [KeptnTaskSpec](#keptntaskspec) + +| Field | Description | +| --- | --- | +| `workloadName` _string_ | | +| `appName` _string_ | | +| `appVersion` _string_ | | +| `workloadVersion` _string_ | | +| `taskType` _string_ | | +| `objectType` _string_ | | + + +#### TaskParameters + + + + + +_Appears in:_ +- [FunctionSpec](#functionspec) +- [KeptnTaskSpec](#keptntaskspec) + +| Field | Description | +| --- | --- | +| `map` _object (keys:string, values:string)_ | | + + +#### WorkloadStatus + + + + + +_Appears in:_ +- [KeptnAppVersionStatus](#keptnappversionstatus) + +| Field | Description | +| --- | --- | +| `workload` _[KeptnWorkloadRef](#keptnworkloadref)_ | | + + diff --git a/docs/content/en/docs/crd-ref/metrics/_index.md b/docs/content/en/docs/crd-ref/metrics/_index.md new file mode 100644 index 0000000000..49c9e6d8c4 --- /dev/null +++ b/docs/content/en/docs/crd-ref/metrics/_index.md @@ -0,0 +1,6 @@ +--- +title: Metrics API +description: Reference information about the Metrics API +weight: 100 +hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html +--- diff --git a/docs/content/en/docs/crd-ref/metrics/v1alpha1/_index.md b/docs/content/en/docs/crd-ref/metrics/v1alpha1/_index.md new file mode 100644 index 0000000000..f6b3071a7e --- /dev/null +++ b/docs/content/en/docs/crd-ref/metrics/v1alpha1/_index.md @@ -0,0 +1,87 @@ +--- +title: v1alpha1 +description: Reference information about the KLT CRDs +weight: 100 +hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html +--- + + +## Packages +- [metrics.keptn.sh/v1alpha1](#metricskeptnshv1alpha1) + + +## metrics.keptn.sh/v1alpha1 + +Package v1alpha1 contains API Schema definitions for the metrics v1alpha1 API group + +### Resource Types +- [KeptnMetric](#keptnmetric) +- [KeptnMetricList](#keptnmetriclist) + + + +#### KeptnMetric + + + +KeptnMetric is the Schema for the keptnmetrics API + +_Appears in:_ +- [KeptnMetricList](#keptnmetriclist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `metrics.keptn.sh/v1alpha1` +| `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/v1alpha1` +| `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 | + + + + +#### ProviderRef + + + +ProviderRef represents the provider object + +_Appears in:_ +- [KeptnMetricSpec](#keptnmetricspec) + +| Field | Description | +| --- | --- | +| `name` _string_ | Name of the provider | + + diff --git a/docs/content/en/docs/crd-ref/options/_index.md b/docs/content/en/docs/crd-ref/options/_index.md new file mode 100644 index 0000000000..cdd38f2b1e --- /dev/null +++ b/docs/content/en/docs/crd-ref/options/_index.md @@ -0,0 +1,6 @@ +--- +title: Options API +description: Reference information about the Options API +weight: 100 +hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html +--- diff --git a/docs/content/en/docs/crd-ref/options/v1alpha1/_index.md b/docs/content/en/docs/crd-ref/options/v1alpha1/_index.md new file mode 100644 index 0000000000..a57851613b --- /dev/null +++ b/docs/content/en/docs/crd-ref/options/v1alpha1/_index.md @@ -0,0 +1,72 @@ +--- +title: v1alpha1 +description: Reference information about the KLT CRDs +weight: 100 +hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html +--- + + +## Packages +- [options.keptn.sh/v1alpha1](#optionskeptnshv1alpha1) + + +## options.keptn.sh/v1alpha1 + +Package v1alpha1 contains API Schema definitions for the options v1alpha1 API group + +### Resource Types +- [KeptnConfig](#keptnconfig) +- [KeptnConfigList](#keptnconfiglist) + + + +#### KeptnConfig + + + +KeptnConfig is the Schema for the keptnconfigs API + +_Appears in:_ +- [KeptnConfigList](#keptnconfiglist) + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `options.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnConfig` +| `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` _[KeptnConfigSpec](#keptnconfigspec)_ | | + + +#### KeptnConfigList + + + +KeptnConfigList contains a list of KeptnConfig + + + +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `options.keptn.sh/v1alpha1` +| `kind` _string_ | `KeptnConfigList` +| `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` _[KeptnConfig](#keptnconfig) array_ | | + + +#### KeptnConfigSpec + + + +KeptnConfigSpec defines the desired state of KeptnConfig + +_Appears in:_ +- [KeptnConfig](#keptnconfig) + +| Field | Description | +| --- | --- | +| `OTelCollectorUrl` _string_ | OTelCollectorUrl can be used to set the Open Telemetry collector that the operator should use | +| `keptnAppCreationRequestTimeout` _integer_ | KeptnAppCreationRequestTimeout is used to set the interval in which automatic app discovery searches for workload to put into the same auto-generated KeptnApp | + + + +