Skip to content

Commit

Permalink
docs: manifests ref section, edits to ref section intros (keptn#1800)
Browse files Browse the repository at this point in the history
Co-authored-by: Moritz Wiesinger <[email protected]>
  • Loading branch information
StackScribe and mowies authored Jul 31, 2023
1 parent 8a90145 commit 604876f
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 25 deletions.
39 changes: 30 additions & 9 deletions docs/content/en/docs/crd-ref/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,44 @@ weight: 100
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
---

This section provides comprehensive reference information about the
This section provides comprehensive reference information about all
[Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
that are defined for the Keptn Lifecycle Toolkit.

> **Note**
This section is under development.
Information that is published here has been reviewed for technical accuracy
but the format and content is still evolving.
We welcome your input!**
This section is auto-generated from source code.

Each CRD is an object of an API library.
Keptn APIs follow the Kubernetes API versioning scheme.
and are themselves composed of objects and sub-objects.
By introducing CRDs, Keptn is extending the base Kubernetes API with new objects and functionality.
The Keptn CRDs extend the base Kubernetes API
with new objects and functionality.
Keptn APIs follow API versioning conventions recommended by Kubernetes.

For more information, see the Kubernetes documentation:
Keptn generates most of the resources it needs
without requiring manual input.
[Manifest CRD Reference](../yaml-crd-ref)
contains reference pages for the manifests
that must be populated manually.

Use `kubectl` to inspect the current contents of any Keptn resource:

1. List all resources of the specified type within a certain namespace.
For example, to list all the `KeptnApp` resources
in the `namespace1` namespace, the command is:

```shell
kubectl get keptnapps -n namespace1
```

1. Get the current manifest for the specified resource.
For example, to view the manifest for the `my-keptn-app` resource
in the `namespace1` namespace, the command is:

```shell
kubectl get keptnapp -n <namespace> my-keptn-app -oyaml
```

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

* [API Overview](https://kubernetes.io/docs/reference/using-api/)

Expand Down
26 changes: 10 additions & 16 deletions docs/content/en/docs/yaml-crd-ref/_index.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,22 @@
---
title: CRD YAML Reference
description: Reference pages for the YAML files that define the KLT CRDs
title: CRD Reference
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
---

This section provides comprehensive reference information about the
YAML files used to define the Keptn Lifecycle Toolkit
[Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
that are defined for the Keptn Lifecycle Toolkit.

> **Note**
This section is under development.
Information that is published here has been reviewed for technical accuracy
but the format and content is still evolving.
We welcome your input!**
manifest files that must be populated
for the Keptn Lifecycle Toolkit
[Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).

Each CRD is an object of an API library.
Keptn APIs follow the Kubernetes API versioning scheme.
and are themselves composed of objects and sub-objects.
By introducing CRDs, Keptn is extending the base Kubernetes API with new objects and functionality.
Keptn APIs follow API versioning conventions recommended by Kubernetes.
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).

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

* [API Overview](https://kubernetes.io/docs/reference/using-api/)

Expand Down

0 comments on commit 604876f

Please sign in to comment.