Skip to content

Commit

Permalink
chore: Use [email protected] (#1938)
Browse files Browse the repository at this point in the history
* chore: Use [email protected]

* use version hash

* fix links

* fix remaining dead links
  • Loading branch information
c-pius authored Oct 9, 2024
1 parent 00de055 commit 1618c51
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 20 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/lint-markdown-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gaurav-nelson/github-action-markdown-link-check@v1
# Relates to version 1.0.15. Sha is used as this is this is the allow-listed value
- uses: gaurav-nelson/github-action-markdown-link-check@d53a906aa6b22b8979d33bc86170567e619495ec
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'no'
Expand Down
2 changes: 1 addition & 1 deletion api/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Lifecycle Manager API

To see Lifecycle Manager API documentation, go to the [Lifecycle Manager API](/docs/technical-reference/api/README.md) document in the `/docs` folder.
To see Lifecycle Manager API documentation, go to the [Lifecycle Manager API](/docs/contributor/resources/README.md) document in the `/docs` folder.
2 changes: 1 addition & 1 deletion docs/contributor/01-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Apart from the custom resources, Lifecycle Manager uses also Kyma, Manifest, and
* [Purge controller](../../internal/controller/purge/controller.go) - reconciles the Kyma CRs that are marked for deletion longer than the grace period, which means purging all the resources deployed by Lifecycle Manager in the target SKR cluster.
* [Watcher controller](../../internal/controller/watcher/controller.go) - reconciles the Watcher CR which means creating Istio Virtual Service resources in KCP when a Watcher CR is created and removing the same resources when the Watcher CR is deleted. This is done to configure the routing of the messages that come from the watcher agent, installed on each Kyma runtime, and go to a listener agent deployed in KCP.

For more details about Lifecycle Manager controllers, read the [Controllers](controllers.md) document.
For more details about Lifecycle Manager controllers, read the [Controllers](./02-controllers.md) document.

## Read More

Expand Down
2 changes: 1 addition & 1 deletion docs/contributor/02-controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ it propagates changes from the ModuleTemplate CR to the Manifest CR. The mandato
## Manifest Controller

[Manifest controller](../../internal/controller/manifest/controller.go) deals with the reconciliation and installation of data desired through a Manifest CR, a representation of a single module desired in a cluster.
Since it mainly is a delegation to the [declarative reconciliation library](../../internal/declarative/README.md) with certain [internal implementation additions](../../internal/manifest/README.md), please look at the respective documentation for these parts to understand them more.
Since it mainly is a delegation to the [declarative reconciliation library](../../internal/declarative/) with certain [internal implementation additions](../../internal/manifest/README.md), please look at the respective documentation for these parts to understand them more.

## Purge Controller

Expand Down
5 changes: 0 additions & 5 deletions docs/contributor/04-local-test-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,6 @@ This setup is deployed with the following security features enabled:
* Strict mTLS connection between Kyma Control Plane (KCP) and SKR clusters
* SAN Pinning (SAN of client TLS certificate needs to match the DNS annotation of a corresponding Kyma CR)

> **NOTE:** If you want to use remote clusters instead of a local k3d setup or external registries, please refer to the following guides for the cluster and registry setup:
>
> * [Provision cluster and OCI registry](provision-cluster-and-registry.md)
> * [Create a test environment on Google Container Registry (GCR)](prepare-gcr-registry.md)
## Procedure

### KCP Cluster Setup
Expand Down
4 changes: 2 additions & 2 deletions docs/contributor/05-api-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ The v1beta1 to v1beta2 version change introduced the following changes to Lifecy

The main change introduced to the Kyma CRD is the removal of the **.spec.sync** attribute. As a result, the v1beta1 **.spec.sync** sub-attributes handling changes as described:

* **.sync.enabled** - replaced by the `operator.kyma-project.io/sync` label in a Kyma CR. For details, read the [Kyma CR synchronization labels](kyma-cr.md#operatorkyma-projectio-labels) document.
* **.sync.moduleCatalog** - replaced by a combination the `operator.kyma-project.io/sync`, `operator.kyma-project.io/internal`, and `operator.kyma-project.io/beta` labels in Kyma and ModuleTemplate CRs. For details, read the [Kyma CR synchronization labels](kyma-cr.md#operatorkyma-projectio-labels) document.
* **.sync.enabled** - replaced by the `operator.kyma-project.io/sync` label in a Kyma CR. For details, read the [Kyma CR synchronization labels](./resources/01-kyma.md#operatorkyma-projectio-labels) document.
* **.sync.moduleCatalog** - replaced by a combination the `operator.kyma-project.io/sync`, `operator.kyma-project.io/internal`, and `operator.kyma-project.io/beta` labels in Kyma and ModuleTemplate CRs. For details, read the [Kyma CR synchronization labels](./resources/01-kyma.md#operatorkyma-projectio-labels) document.
* **.sync.namespace** - replaced with a `sync-namespace` command-line flag for Lifecycle Manager. It means that a user can no longer configure the Namespace synchronized with a particular Kyma CR. The Namespace is the same for all Kyma CRs in a given Lifecycle Manager instance, and a user can't change it.
* **.sync.noModuleCopy** - removed. Currently, the **.spec.modules[]** for a remote Kyma CR is always initialized as empty.

Expand Down
4 changes: 2 additions & 2 deletions docs/contributor/resources/02-manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ looks for a Secret with the same `operator.kyma-project.io/kyma-name` label and

The config reference uses an image layer reference that contains configuration data that can be used to further
influence any potential rendering process while the resources are processed by
the [declarative library](../../../internal/declarative/README.md#resource-rendering). It is resolved through a
the [declarative library](../../../internal/declarative/). It is resolved through a
translation of the ModuleTemplate CR to the Manifest CR during
the [resolution of the modules](../../../internal/manifest/parser/template_to_module.go) in the Kyma CR control loop.

Expand Down Expand Up @@ -76,7 +76,7 @@ spec:

### **.spec.install**

The installation layer contains the relevant data required to determine the resources for the [renderer during the manifest reconciliation](../../../internal/declarative/README.md#resource-rendering).
The installation layer contains the relevant data required to determine the resources for the [renderer during the manifest reconciliation](../../../internal/declarative/).

It is mapped from an access type layer in the descriptor:

Expand Down
6 changes: 3 additions & 3 deletions docs/contributor/resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ The v1beta2 API introduces three groups of modules:

By default, without any labels configured on Kyma and ModuleTemplate CRs, a ModuleTemplate CR is synchronized with remote clusters.

**NOTE:** The ModuleTemplate CRs synchronization is enabled only when Lifecycle Manager runs in the [control-plane mode](../running-modes.md). Lifecycle Manager running in the single-cluster mode, doesn't require any CR synchronization.
**NOTE:** The ModuleTemplate CRs synchronization is enabled only when Lifecycle Manager runs in the control-plane mode. Lifecycle Manager running in the single-cluster mode, doesn't require any CR synchronization.

**NOTE:** Disabling synchronization for already synchronized ModuleTemplates CRs doesn't remove them from remote clusters. The CRs remain as they are, but any subsequent changes to these ModuleTemplate CRs in the Control Plane are not synchronized.

For more information, see [the Kyma CR synchronization labels](kyma-cr.md#operatorkyma-projectio-labels) and [the ModuleTemplate CR synchronization labels](moduleTemplate-cr.md#operatorkyma-projectio-labels).
For more information, see [the Kyma CR synchronization labels](./01-kyma.md#operatorkyma-projectio-labels) and [the ModuleTemplate CR synchronization labels](./03-moduletemplate.md#operatorkyma-projectio-labels).

## Stability

Expand All @@ -38,4 +38,4 @@ See the list of CRs involved in Lifecycle Manager's workflow and their stability
| v1beta2 | [Manifest](/api/v1beta2/manifest_types.go) | Beta-Grade - no breaking changes without API incrementation. Use for automation and watch upstream as close as possible for deprecations or new versions. Alpha API is deprecated and converted via webhook. |
| v1beta2 | [Watcher](/api/v1beta2/watcher_types.go) | Beta-Grade - no breaking changes without API incrementation. Use for automation and watch upstream as close as possible for deprecations or new versions. Alpha API is deprecated and converted via webhook. |

For more information on changes introduced by an API version, see [API Changelog](../api-changelog.md).
For more information on changes introduced by an API version, see [API Changelog](../05-api-changelog.md).
4 changes: 2 additions & 2 deletions internal/controller/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Controllers used within Lifecycle Manager

This package contains all controllers that can be registered within the Lifecycle Manager.
For more details, read [Lifecycle Manager Controllers](/docs/technical-reference/controllers.md) in the `/docs` folder.
For more information on how the API behaves after the controller finishes up the synchronization, please look at the [Lifecycle Manager API](/docs/technical-reference/api/README.md) document.
For more details, read [Lifecycle Manager Controllers](/docs/contributor/02-controllers.md) in the `/docs` folder.
For more information on how the API behaves after the controller finishes up the synchronization, please look at the [Lifecycle Manager API](/docs/contributor/resources/README.md) document.
2 changes: 1 addition & 1 deletion internal/manifest/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Internal Manifest Library

This package contains internal reference coding that is used for translating and implementing the Manifest Reconciler parts that are not generically solved by the [declarative library](../declarative/README.md).
This package contains internal reference coding that is used for translating and implementing the Manifest Reconciler parts that are not generically solved by the [declarative library](../declarative/).

It contains various aspects to:

Expand Down
2 changes: 1 addition & 1 deletion tests/e2e/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ See the [Run the e2e tests locally](#run-the-e2e-tests-locally) section for deta

## Run the e2e tests locally

1. Set up your local environment using steps 1 to 3 from [this guide](/docs/developer-tutorials/local-test-setup.md). Create a cluster, and install Istio CRDs and `cert-manager`. Skip all the remaining steps from the guide.
1. Set up your local environment using steps 1 to 3 from [this guide](/docs/contributor/04-local-test-setup.md). Create a cluster, and install Istio CRDs and `cert-manager`. Skip all the remaining steps from the guide.
2. Export the following K8s configurations as environment variables:
```shell
export KCP_KUBECONFIG=$(k3d kubeconfig write kcp-local)
Expand Down

0 comments on commit 1618c51

Please sign in to comment.