Merge branch 'main' into adapt-htmltest

# Conflicts: # Makefile # docs-new/docs/reference/api-reference/lifecycle/index.md # docs-new/docs/reference/api-reference/metrics/index.md # docs-new/docs/reference/api-reference/options/index.md
keptn · Dec 12, 2023 · 427715c · 427715c
2 parents 37ae91a + 928b546
commit 427715c
Show file tree

Hide file tree

Showing 20 changed files with 132 additions and 877 deletions.
diff --git a/docs-new/docs/components/index.md b/docs-new/docs/components/index.md
@@ -2,23 +2,9 @@
 
 ## Keptn Components
 
-Keptn consists of two main components:
+Keptn consists of the following main components:
 
-* Keptn Lifecycle Operator, which splits into two separate operators
-  in Release 0.7.0 and later:
-  * Lifecycle-Operator
-  * Metrics-Operator
-* Keptn Lifecycle Scheduler
-
-```mermaid
-graph TD;
-    KeptnComponents-->Operators;
-    KeptnComponents-->Scheduler
-   Operators-->Lifecycle-Operator
-   Operators-->Metrics-Operator
-style KeptnComponents fill:#006bb8,stroke:#fff,stroke-width:px,color:#fff
-style Operators fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8
-style Scheduler fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8
-style Lifecycle-Operator fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8
-style Metrics-Operator fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8
-```
+* [Keptn Lifecycle Operator](./lifecycle-operator/index.md)
+* [Keptn Metrics Operator](./metrics-operator.md)
+* [Keptn Scheduler](./scheduling.md)
+* [Keptn Certificate Manager](./certificate-operator.md)
diff --git a/docs-new/docs/getting-started/index.md b/docs-new/docs/getting-started/index.md
@@ -1 +1,5 @@
 # Get started
+
+This section provides tutorials to familiarize you
+with some basic Keptn features
+and point you to other documentation that has more comprehensive information.
diff --git a/docs-new/docs/guides/index.md b/docs-new/docs/guides/index.md
@@ -1 +1,3 @@
 # Guides
+
+This section provides comprehensive guides about specific features of Keptn.
diff --git a/docs-new/docs/guides/slo.md b/docs-new/docs/guides/slo.md
@@ -18,14 +18,14 @@ At the end of the analysis,
 the status returns whether your objective failed, passed,
 or passed with a warning.
 This is similar to the functionality provided by the Keptn v1
-[Quality Gates](https://keptn.sh/docs/1.0.x/define/quality-gates/)
+[Quality Gates](https://v1.keptn.sh/docs/1.0.x/define/quality-gates/)
 feature.
 
 Converters are provided to
 to migrate most Keptn v1
-[SLIs](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+[SLIs](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
 and
-[SLOs](https://keptn.sh/docs/1.0.x/reference/files/slo/)
+[SLOs](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/)
 to Keptn Analysis SLIs and SLOs.
 For more information,see:
 

diff --git a/docs-new/docs/index.md b/docs-new/docs/index.md
@@ -1,3 +1,20 @@
 # Keptn Documentation
 
 This is the documentation homepage.
+If you are new to Keptn, please check out the following sections:
+
+- [Core Concepts](./core-concepts/index.md) will help you understand what Keptn is all about
+- [Get Started](./getting-started/index.md) helps you get going with your first use cases for Keptn
+- [Installation](./installation/index.md) guides you through
+the installation procedure for Keptn
+and provides information about special configuration options
+that are available.
+- [Guides](guides/index.md) provides detailed and comprehensive how-to information
+for Keptn features and capabilities.
+- [Reference](reference/index.md) provides comprehensive information
+about the CRDs and APIs that define how Keptn behaves.
+- [Components](components/index.md) provides architectural information
+about how Keptn functionality is implemented
+for people who want a deeper understanding of Keptn
+or who need this information to troubleshoot their systems.
+It also includes information about updating and uninstalling Keptn.
diff --git a/docs-new/docs/installation/configuration/index.md b/docs-new/docs/installation/configuration/index.md
@@ -1 +1,4 @@
 # Configuration
+
+This section contains guides for specific configuration use cases for Keptn.
+Those will help you adjust settings that need to be set at installation time.
diff --git a/docs-new/docs/migrate/metrics-observe.md b/docs-new/docs/migrate/metrics-observe.md
@@ -10,9 +10,9 @@ appropriate Keptn facilities:
   [Keptn Evaluations](../guides/evaluations.md)
   to do a simple evaluation of the metrics data you capture.
   To implement this, transfer the information from the Keptn v1
-  [sli.yaml](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+  [sli.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
   and
-  [slo.yaml](https://keptn.sh/docs/1.0.x/reference/files/slo/)
+  [slo.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/)
   files into
   [KeptnEvaluationDefinition](../reference/crd-reference/evaluationdefinition.md)
   resources.
@@ -45,9 +45,9 @@ differs from that of Keptn v1 quality gates:
   and gives it a unique `name` that can be referenced
   for Keptn Metrics (which are also used for Evaluations) and Analysis.
 * Queries and objectives that are specified in your Keptn v1
-  [sli.yaml](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+  [sli.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
   and
-  [slo.yaml](https://keptn.sh/docs/1.0.x/reference/files/slo/)
+  [slo.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/)
   files are transferred/converted into Keptn resources.
 
 ## Transfer Keptn v1 SLIs/SLOs to evaluation resources
@@ -57,11 +57,11 @@ Simple comparisons of data can be implemented as
 To implement this:
 
 * Transfer the information from the Keptn v1
-  [sli.yaml](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+  [sli.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
   files into
   [KeptnMetric](../reference/crd-reference/metric.md) resources
 * Transfer the information from the Keptn v1
-  [slo.yaml](https://keptn.sh/docs/1.0.x/reference/files/slo/)
+  [slo.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/)
   files into
   [KeptnEvaluationDefinition](../reference/crd-reference/evaluationdefinition.md)
   resources.
@@ -70,7 +70,7 @@ To implement this:
 
 The Keptn Analysis feature provides capabilities
 similar to those of the Keptn v1
-[Quality Gates](https://keptn.sh/docs/1.0.x/define/quality-gates/)
+[Quality Gates](https://v1.keptn.sh/docs/1.0.x/define/quality-gates/)
 feature
 but it uses Kubernetes resources to define the analysis to be done
 rather than the configuration files used for Keptn v1.
@@ -90,7 +90,7 @@ The process is:
 1. Convert the SLIs to `AnalysisValueTemplates` resources
 
    The following command sequence converts a Keptn v1
-   [sli.yaml](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+   [sli.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
    file to a Keptn
    [AnalysisValueTemplate](../reference/crd-reference/analysisvaluetemplate.md)
    resource:
@@ -137,7 +137,7 @@ The process is:
 1. Convert the SLO to an `AnalysisDefinition` resource:
 
    The process of converting the Keptn v1
-   [slo.yaml](https://keptn.sh/docs/1.0.x/reference/files/slo/)
+   [slo.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/)
    files to
    [AnalysisDefinition](../reference/crd-reference/analysisdefinition.md)
    resources is similar to the process of converting the SLIs.

diff --git a/docs-new/docs/migrate/strategy.md b/docs-new/docs/migrate/strategy.md
@@ -36,7 +36,7 @@ Some key points:
   to configure SLIs/SLOs, tasks, and other elements
   that are part of the environment where the application deployment lives
   rather than using its own Git repo and its
-  [shipyard.yaml](https://keptn.sh/docs/1.0.x/reference/files/shipyard/)
+  [shipyard.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/shipyard/)
   file as Keptn v1 does.
   * See the
     [Lifecycle CRD Reference](../reference/crd-reference/index.md)
@@ -103,7 +103,7 @@ and identifies their possible disposition when you migrate to Keptn.
 
 A Keptn v1 project represents an arbitrary, higher-level grouping of services.
 A project is defined by a
-[shipyard.yaml](https://keptn.sh/docs/1.0.x/reference/files/shipyard/)
+[shipyard.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/shipyard/)
 file.
 
 Keptn does not recognize projects.
@@ -181,7 +181,7 @@ allowing a tool such as ArgoCD to handle promotion.
 
 A sequence is an ordered and user-defined sequence of tasks
 that are defined in a
-[shipyard.yaml](https://keptn.sh/docs/1.0.x/reference/files/shipyard/)
+[shipyard.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/shipyard/)
 file.
 The shipyard controller micro-service reads the shipyard file
 and (when the time is right),
@@ -260,7 +260,7 @@ whereas Keptn v1 sequences and tasks can not execute in parallel.
 ### SLIs
 
 Keptn v1
-[SLIs](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+[SLIs](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
 (Service Level Indicators)
 represent queries from the data provider
 such as Prometheus, Dynatrace, or Datadog,
@@ -297,7 +297,7 @@ resources
 ### SLOs
 
 Keptn v1
-[SLOs](https://keptn.sh/docs/1.0.x/reference/files/slo/).
+[SLOs](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/).
 can be implemented on Keptn as evaluations or analyses:
 
 * Simple evaluations of an SLI can be implemented as
@@ -321,7 +321,7 @@ can be implemented on Keptn as evaluations or analyses:
 ### Remediation
 
 Keptn does not currently support the same level of
-[remediations](https://keptn.sh/docs/1.0.x/reference/files/remediation/)
+[remediations](https://v1.keptn.sh/docs/1.0.x/reference/files/remediation/)
 as Keptn v1 does,
 but it does provide limited "Day 2" facilities:
 

diff --git a/docs-new/docs/reference/api-reference/lifecycle/index.md b/docs-new/docs/reference/api-reference/lifecycle/index.md
@@ -1,3 +1,3 @@
 # Lifecycle API
 
-Reference information about the Lifecycle API
+Reference information about the Lifecycle API.
diff --git a/docs-new/docs/reference/api-reference/metrics/index.md b/docs-new/docs/reference/api-reference/metrics/index.md
@@ -1,3 +1,3 @@
 # Metrics API
 
-Reference information about the Metrics API
+Reference information about the Metrics API.
diff --git a/docs-new/docs/reference/api-reference/options/index.md b/docs-new/docs/reference/api-reference/options/index.md
@@ -1,3 +1,3 @@
 # Options API
 
-Reference information about the Options API
+Reference information about the Options API.
diff --git a/docs-new/docs/reference/index.md b/docs-new/docs/reference/index.md
@@ -1,3 +1,11 @@
 # Reference
 
-This section of the Keptn documentation contains reference documentation.
+This section of the Keptn documentation contains reference documentation for the various APIs and CRDs that are used in Keptn.
+
+If you want to learn more about specific Custom Resource Definitions
+that you may need to populate to use Keptn,
+go to the
+[CRD Reference](./crd-reference/index.md) section.
+
+If you want to look up some specific object properties or want ot know more about the internal APIs of Keptn,
+Go to the [API Reference](./api-reference/index.md) section.
diff --git a/docs-new/docs/use-cases/index.md b/docs-new/docs/use-cases/index.md
@@ -1 +1,3 @@
 # Use Cases
+
+This section contains specific use cases and integration scenarios with other Cloud Native tools.
diff --git a/docs/content/en/docs/guides/slo.md b/docs/content/en/docs/guides/slo.md
@@ -22,14 +22,14 @@ At the end of the analysis,
 the status returns whether your objective failed, passed,
 or passed with a warning.
 This is similar to the functionality provided by the Keptn v1
-[Quality Gates](https://keptn.sh/docs/1.0.x/define/quality-gates/)
+[Quality Gates](https://v1.keptn.sh/docs/1.0.x/define/quality-gates/)
 feature.
 
 Converters are provided to
 to migrate most Keptn v1
-[SLIs](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+[SLIs](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
 and
-[SLOs](https://keptn.sh/docs/1.0.x/reference/files/slo/)
+[SLOs](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/)
 to Keptn Analysis SLIs and SLOs.
 For more information,see:
 

diff --git a/docs/content/en/docs/migrate/metrics-observe.md b/docs/content/en/docs/migrate/metrics-observe.md
@@ -14,9 +14,9 @@ appropriate Keptn facilities:
   [Keptn Evaluations](../guides/evaluations.md)
   to do a simple evaluation of the metrics data you capture.
   To implement this, transfer the information from the Keptn v1
-  [sli.yaml](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+  [sli.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
   and
-  [slo.yaml](https://keptn.sh/docs/1.0.x/reference/files/slo/)
+  [slo.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/)
   files into
   [KeptnEvaluationDefinition](../reference/crd-reference/evaluationdefinition.md)
   resources.
@@ -49,9 +49,9 @@ differs from that of Keptn v1 quality gates:
   and gives it a unique `name` that can be referenced
   for Keptn Metrics (which are also used for Evaluations) and Analysis.
 * Queries and objectives that are specified in your Keptn v1
-  [sli.yaml](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+  [sli.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
   and
-  [slo.yaml](https://keptn.sh/docs/1.0.x/reference/files/slo/)
+  [slo.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/)
   files are transferred/converted into Keptn resources.
 
 ## Transfer Keptn v1 SLIs/SLOs to evaluation resources
@@ -61,11 +61,11 @@ Simple comparisons of data can be implemented as
 To implement this:
 
 * Transfer the information from the Keptn v1
-  [sli.yaml](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+  [sli.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
   files into
   [KeptnMetric](../reference/crd-reference/metric.md) resources
 * Transfer the information from the Keptn v1
-  [slo.yaml](https://keptn.sh/docs/1.0.x/reference/files/slo/)
+  [slo.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/)
   files into
   [KeptnEvaluationDefinition](../reference/crd-reference/evaluationdefinition.md)
   resources.
@@ -74,7 +74,7 @@ To implement this:
 
 The Keptn Analysis feature provides capabilities
 similar to those of the Keptn v1
-[Quality Gates](https://keptn.sh/docs/1.0.x/define/quality-gates/)
+[Quality Gates](https://v1.keptn.sh/docs/1.0.x/define/quality-gates/)
 feature
 but it uses Kubernetes resources to define the analysis to be done
 rather than the configuration files used for Keptn v1.
@@ -94,7 +94,7 @@ The process is:
 1. Convert the SLIs to `AnalysisValueTemplates` resources
 
    The following command sequence converts a Keptn v1
-   [sli.yaml](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+   [sli.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
    file to a Keptn
    [AnalysisValueTemplate](../reference/crd-reference/analysisvaluetemplate.md)
    resource:
@@ -141,7 +141,7 @@ The process is:
 1. Convert the SLO to an `AnalysisDefinition` resource:
 
    The process of converting the Keptn v1
-   [slo.yaml](https://keptn.sh/docs/1.0.x/reference/files/slo/)
+   [slo.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/)
    files to
    [AnalysisDefinition](../reference/crd-reference/analysisdefinition.md)
    resources is similar to the process of converting the SLIs.

diff --git a/docs/content/en/docs/migrate/strategy.md b/docs/content/en/docs/migrate/strategy.md
@@ -41,7 +41,7 @@ Some key points:
   to configure SLIs/SLOs, tasks, and other elements
   that are part of the environment where the application deployment lives
   rather than using its own Git repo and its
-  [shipyard.yaml](https://keptn.sh/docs/1.0.x/reference/files/shipyard/)
+  [shipyard.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/shipyard/)
   file as Keptn v1 does.
   * See the
     [Lifecycle CRD Reference](../reference/crd-reference)
@@ -108,7 +108,7 @@ and identifies their possible disposition when you migrate to Keptn.
 
 A Keptn v1 project represents an arbitrary, higher-level grouping of services.
 A project is defined by a
-[shipyard.yaml](https://keptn.sh/docs/1.0.x/reference/files/shipyard/)
+[shipyard.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/shipyard/)
 file.
 
 Keptn does not recognize projects.
@@ -186,7 +186,7 @@ allowing a tool such as ArgoCD to handle promotion.
 
 A sequence is an ordered and user-defined sequence of tasks
 that are defined in a
-[shipyard.yaml](https://keptn.sh/docs/1.0.x/reference/files/shipyard/)
+[shipyard.yaml](https://v1.keptn.sh/docs/1.0.x/reference/files/shipyard/)
 file.
 The shipyard controller micro-service reads the shipyard file
 and (when the time is right),
@@ -265,7 +265,7 @@ whereas Keptn v1 sequences and tasks can not execute in parallel.
 ### SLIs
 
 Keptn v1
-[SLIs](https://keptn.sh/docs/1.0.x/reference/files/sli/)
+[SLIs](https://v1.keptn.sh/docs/1.0.x/reference/files/sli/)
 (Service Level Indicators)
 represent queries from the data provider
 such as Prometheus, Dynatrace, or Datadog,
@@ -302,7 +302,7 @@ resources
 ### SLOs
 
 Keptn v1
-[SLOs](https://keptn.sh/docs/1.0.x/reference/files/slo/).
+[SLOs](https://v1.keptn.sh/docs/1.0.x/reference/files/slo/).
 can be implemented on Keptn as evaluations or analyses:
 
 * Simple evaluations of an SLI can be implemented as
@@ -326,7 +326,7 @@ can be implemented on Keptn as evaluations or analyses:
 ### Remediation
 
 Keptn does not currently support the same level of
-[remediations](https://keptn.sh/docs/1.0.x/reference/files/remediation/)
+[remediations](https://v1.keptn.sh/docs/1.0.x/reference/files/remediation/)
 as Keptn v1 does,
 but it does provide limited "Day 2" facilities:
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		# Guides

		This section provides comprehensive guides about specific features of Keptn.
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		# Use Cases

		This section contains specific use cases and integration scenarios with other Cloud Native tools.