Skip to content

Commit

Permalink
move crd reference pages into reference top level section
Browse files Browse the repository at this point in the history
Signed-off-by: Moritz Wiesinger <[email protected]>
  • Loading branch information
mowies committed Nov 21, 2023
1 parent cd92a2f commit 715c694
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 45 deletions.
26 changes: 0 additions & 26 deletions docs/content/en/docs/components/metrics-operator/crd-ref/_index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: CRD Reference
description: CRD Reference for Keptn Lifecycle Operator
weight: 10
description: Reference pages for the manifest files that must be populated
weight: 100
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
---

## CRD Reference

This section provides comprehensive reference information about the
manifest files that must be populated for Keptn
[Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
Expand All @@ -14,7 +13,7 @@ Each CRD is an object of an API library.
In addition to the CRDs documented in this section,
Keptn populates many resources on its own.
For a comprehensive list of all Keptn resources, see
[API Reference](../crd-ref).
[API Reference](../../crd-ref).

For more information about CRDs and APIs, see the Kubernetes documentation:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ This `Analysis` resource:
will be substituted for this string.

For a full example of how to implement the Keptn Analysis feature, see the
[Analysis](../../../guides/slo.md)
[Analysis](../../guides/slo.md)
guide page.

## Files
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ when the app discovery feature generates the `KeptnApp` resource:
that failed to deploy, perhaps because a
`preDeploymentEvaluation` or `preDeploymentTask` failed.
See
[Restart an Application Deployment](../../../guides/restart-application-deployment.md)
[Restart an Application Deployment](../../guides/restart-application-deployment.md)
for a longer discussion of this.
- **workloads**
- **name** (required) -- name of this Kubernetes
Expand Down Expand Up @@ -121,10 +121,10 @@ into the repository of the deployment engine
and is then deployed by that deployment engine.

A `KeptnApp` resource is created automatically, using the
[automatic application discovery](../../../guides/auto-app-discovery.md)
[automatic application discovery](../../guides/auto-app-discovery.md)
feature to generate a `KeptnApp` resource
based on the
[basic annotations](../../../guides/integrate.md#basic-annotations)
[basic annotations](../../guides/integrate.md#basic-annotations)
that are applied to any of the workload resources.
This allows you to use the Keptn observability features for existing resources
without manually populating any Keptn related resources.
Expand Down Expand Up @@ -170,9 +170,9 @@ spec:

- [KeptnTaskDefinition](taskdefinition.md)
- [KeptnEvaluationDefinition](evaluationdefinition.md)
- [Working with tasks](../../../guides/tasks.md)
- [Architecture of KeptnWorkloads and KeptnTasks](../keptn-apps.md)
- [Pre- and post-deployment tasks](../../../guides/integrate.md#pre--and-post-deployment-checks)
- [Orchestrate deployment checks](../../../core-concepts/usecase-orchestrate.md)
- [Use Keptn automatic app discovery](../../../guides/auto-app-discovery.md)
- [Restart an Application Deployment](../../../guides/restart-application-deployment.md)
- [Working with tasks](../../guides/tasks.md)
- [Architecture of KeptnWorkloads and KeptnTasks](../../components/lifecycle-operator/keptn-apps.md)
- [Pre- and post-deployment tasks](../../guides/integrate.md#pre--and-post-deployment-checks)
- [Orchestrate deployment checks](../../core-concepts/usecase-orchestrate.md)
- [Use Keptn automatic app discovery](../../guides/auto-app-discovery.md)
- [Restart an Application Deployment](../../guides/restart-application-deployment.md)
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ spec:
or in the Keptn installation namespace.
* **context** (required) -- Contextual information about the task execution
* **appName** (required) -- Name of the
[KeptnApp](./app.md) resource
[KeptnApp](app.md) resource
for which the `KeptnTask` is being executed.
* **appVersion** (required) -- Version of the `KeptnApp` resource
for which the `KeptnTask` is being executed.
Expand Down Expand Up @@ -85,7 +85,7 @@ spec:
* **secureParameters** -- Secure parameters that are passed
to the job that executes the `KeptnTask`.
These are stored and accessed as Kubernetes `Secrets` in the cluster.
See [Working with secrets](../../../guides/tasks.md#working-with-secrets)
See [Working with secrets](../../guides/tasks.md#working-with-secrets)
for more information.
* **checkType** -- Defines whether task is part of pre- or post-deployment phase.
Keptn populates this field based on annotations
Expand Down Expand Up @@ -117,7 +117,7 @@ so `helloworldtask-1` becomes `helloworldtask-2`, etc.

For a full example of how to create a `KeptnTask` resource
to use for a deployment being done outside of Kubernetes, see
[Keptn for Non-Kubernetes Applications](../../../use-cases/non-k8s.md).
[Keptn for Non-Kubernetes Applications](../../use-cases/non-k8s.md).

## Files

Expand All @@ -131,4 +131,4 @@ in Keptn v0.8.0.
## See also

* [KeptnTaskDefinition](taskdefinition.md)
* [Keptn for Non-Kubernetes Applications](../../../use-cases/non-k8s.md)
* [Keptn for Non-Kubernetes Applications](../../use-cases/non-k8s.md)

0 comments on commit 715c694

Please sign in to comment.