Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: migrate old Keptn links to new URL #2604

Merged
merged 2 commits into from
Dec 11, 2023
Merged

docs: migrate old Keptn links to new URL #2604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c750aa3
docs: migrate old Keptn links to new URL
thisthat Nov 29, 2023
c0cbc72
update links in new docs engine
thisthat Dec 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs-new/docs/guides/slo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
18 changes: 9 additions & 9 deletions docs-new/docs/migrate/metrics-observe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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:
Expand Down Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs-new/docs/migrate/strategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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),
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand All @@ -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:

Expand Down
6 changes: 3 additions & 3 deletions docs/content/en/docs/guides/slo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
thisthat marked this conversation as resolved.
Show resolved Hide resolved
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:

Expand Down
18 changes: 9 additions & 9 deletions docs/content/en/docs/migrate/metrics-observe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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:
Expand Down Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs/content/en/docs/migrate/strategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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),
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand All @@ -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:

Expand Down
Loading