Skip to content

Latest commit

 

History

History
174 lines (117 loc) · 5.27 KB

04-local-test-setup.md

File metadata and controls

174 lines (117 loc) · 5.27 KB

Configure a Local Test Setup

Context

This tutorial shows how to configure a fully working e2e test setup including the following components:

  • Lifecycle Manager
  • Runtime Watcher on a remote cluster
  • template-operator on a remote cluster as an example

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)

Prerequisites

Install the following tooling in the versions defined in versions.yaml:

Procedure

Follow the steps using scripts from the project root.

1. Create Test Clusters

Create local test clusters for SKR and KCP.

K8S_VERSION=$(yq e '.k8s' ./versions.yaml)
CERT_MANAGER_VERSION=$(yq e '.certManager' ./versions.yaml)
./scripts/tests/create_test_clusters.sh --k8s-version $K8S_VERSION --cert-manager-version $CERT_MANAGER_VERSION

2. Install the Custom Resource Definitions

Install the Lifecycle Manager CRDs in the KCP cluster.

./scripts/tests/install_crds.sh

3. Deploy Lifecycle Manager

You can deploy Lifecycle Manager either from the registry or local sources. Choose one of the below options:

  1. Deploy a built image from the registry, for example, the latest image from the prod registry.

    REGISTRY=prod
TAG=latest
./scripts/tests/deploy_klm_from_registry.sh --image-registry $REGISTRY --image-tag $TAG

  2. Build a new image from the local sources, push it to the local KCP registry, and deploy it.

    ./scripts/tests/deploy_klm_from_sources.sh

4. Deploy a Kyma CR

SKR_HOST=host.k3d.internal
./scripts/tests/deploy_kyma.sh $SKR_HOST

5. Verify If the Kyma CR Becomes Ready

  1. Verify if the Kyma CR is in the Ready state in KCP. It takes roughly 1–2 minutes.

    kubectl config use-context k3d-kcp
kubectl get kyma/kyma-sample -n kcp-system

  2. Verify if the Kyma CR is in the Ready state in SKR. It takes roughly 1-2 minutes.

    kubectl config use-context k3d-skr
kubectl get kyma/default -n kyma-system

6. [OPTIONAL] Deploy the template-operator Module

Build the template-operator module from the local sources, push it to the local KCP registry, and deploy it.

cd <template-operator-repository>

make build-manifests
modulectl create --config-file ./module-config.yaml --registry http://localhost:5111 --insecure 

kubectl config use-context k3d-kcp
# repository URL is localhost:5111 on the host machine but must be k3d-kcp-registry.localhost:5000 within the cluster
yq e '.spec.descriptor.component.repositoryContexts[0].baseUrl = "k3d-kcp-registry.localhost:5000"' ./template.yaml | kubectl apply -f -

MT_VERSION=$(yq e '.spec.version' ./template.yaml)
cd <lifecycle-manager-repository>
./scripts/tests/deploy_modulereleasemeta.sh template-operator regular:$MT_VERSION

7. [OPTIONAL] Add the template-operator Module to the Kyma CR and Verify If It Becomes Ready

  1. Add the template-operator module to the Kyma CR spec.

    kubectl config use-context k3d-skr
kubectl get kyma/default -n kyma-system -o yaml | yq e '.spec.modules[0]={"name": "template-operator"}' | kubectl apply -f -

  2. Verify if the module becomes Ready. It takes roughly 1–2 minutes.

    kubectl config use-context k3d-skr
kubectl get kyma/default -n kyma-system -o wide

  3. Remove the module from the Kyma CR spec.

    kubectl config use-context k3d-skr
kubectl get kyma/default -n kyma-system -o yaml | yq e 'del(.spec.modules[0])' | kubectl apply -f -

8. [OPTIONAL] Verify Conditions

Check the conditions of the Kyma CR in the KCP cluster.

  • SKRWebhook to determine if the webhook has been installed to the SKR
  • ModuleCatalog to determine if the ModuleTemplate CRs and ModuleReleaseMeta CRs haven been synced to the SKR cluster
  • Modules to determine if the added modules are Ready
kubectl config use-context k3d-kcp
kubectl get kyma/kyma-sample -n kcp-system -o yaml | yq e '.status.conditions'

9. [OPTIONAL] Verify If Watcher Events Reach KCP

  1. Flick the channel to trigger an event.

    kubectl config use-context k3d-skr
kubectl get kyma/default -n kyma-system -o yaml | yq e '.spec.channel="regular"' | kubectl apply -f -
kubectl get kyma/default -n kyma-system -o yaml | yq e '.spec.channel="fast"' | kubectl apply -f -

  2. Verify if Lifecycle Manger received the event in KCP.

    kubectl config use-context k3d-kcp
kubectl logs deploy/klm-controller-manager -n kcp-system | grep "event received from SKR"

10. [OPTIONAL] Delete the Local Test Clusters

Remove the local SKR and KCP test clusters.

k3d cluster rm kcp skr