From 4497b45c861b1d14e47f4c188ca6271daa7b77b7 Mon Sep 17 00:00:00 2001 From: Giovanni Liva Date: Wed, 29 Nov 2023 09:27:03 +0100 Subject: [PATCH] docs: migrate old Keptn links to new URL Signed-off-by: Giovanni Liva --- docs/content/en/docs/guides/slo.md | 6 +++--- .../content/en/docs/migrate/metrics-observe.md | 18 +++++++++--------- docs/content/en/docs/migrate/strategy.md | 12 ++++++------ 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/content/en/docs/guides/slo.md b/docs/content/en/docs/guides/slo.md index 6ff87790852..f0952337271 100644 --- 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 index 1a6623e5028..a4268f56d5b 100644 --- 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 index 7ec18c0fe3a..c3450bfdcd8 100644 --- 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: