From 218c4f4d5cc75fc9ceebe1948714bae8e9a3c235 Mon Sep 17 00:00:00 2001 From: Benjamin Lindner Date: Wed, 16 Oct 2024 17:08:39 +0200 Subject: [PATCH] adapts docs and fix version patches for specific testcases in config-file --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- .../action.yml | 4 ++-- .github/actions/deploy-template-operator/action.yml | 4 ++-- docs/contributor/03-config-private-registry.md | 2 +- docs/contributor/04-local-test-setup.md | 5 ++--- docs/contributor/resources/03-moduletemplate.md | 2 +- 6 files changed, 9 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 72f278e996..05fee4791d 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -43,7 +43,7 @@ body: value: | Kubernetes Version: x.y.z Docker Version: x.y.z - Kyma CLI Version: x.y.z + modulectl Version: x.y.z If used - k3d/k3s/minikube versions validations: required: true diff --git a/.github/actions/deploy-template-operator-with-modulereleasemeta/action.yml b/.github/actions/deploy-template-operator-with-modulereleasemeta/action.yml index d8b857e602..57a775f000 100644 --- a/.github/actions/deploy-template-operator-with-modulereleasemeta/action.yml +++ b/.github/actions/deploy-template-operator-with-modulereleasemeta/action.yml @@ -148,7 +148,7 @@ runs: run: | echo "name: kyma-project.io/module/template-operator-misconfigured channel: regular - version: v1.1.1 + version: 1.1.1 manifest: template-operator.yaml security: sec-scanners-config.yaml defaultCR: ./config/samples/default-sample-cr.yaml @@ -216,7 +216,7 @@ runs: make build-manifests echo "name: kyma-project.io/module/template-operator channel: regular - version: v1.0.0 + version: 1.0.0 manifest: template-operator.yaml security: sec-scanners-config.yaml annotations: diff --git a/.github/actions/deploy-template-operator/action.yml b/.github/actions/deploy-template-operator/action.yml index 197e3ab0e3..8646d44ff9 100644 --- a/.github/actions/deploy-template-operator/action.yml +++ b/.github/actions/deploy-template-operator/action.yml @@ -105,7 +105,7 @@ runs: run: | echo "name: kyma-project.io/module/template-operator-misconfigured channel: regular - version: v1.1.1 + version: 1.1.1 manifest: template-operator.yaml security: sec-scanners-config.yaml defaultCR: ./config/samples/default-sample-cr.yaml @@ -155,7 +155,7 @@ runs: make build-manifests echo "name: kyma-project.io/module/template-operator channel: regular - version: v1.0.0 + version: 1.0.0 manifest: template-operator.yaml security: sec-scanners-config.yaml annotations: diff --git a/docs/contributor/03-config-private-registry.md b/docs/contributor/03-config-private-registry.md index 42edc0167f..5c0286ef81 100644 --- a/docs/contributor/03-config-private-registry.md +++ b/docs/contributor/03-config-private-registry.md @@ -43,7 +43,7 @@ Before you proceed, prepare your registry credentials. Check also how to deal wi The `oci-registry-cred` label in a ModuleTemplate CR allows Lifecycle Manager to parse the Secret label selector and propagate it to the Manifest CR so that Lifecycle Manager knows which credentials Secret to look up. -To support the ModuleTemplate CR with the `oci-registry-cred` label, use Kyma CLI with the `registry-cred-selector` flag for creating a module command. +To support the ModuleTemplate CR with the `oci-registry-cred` label, use modulectl with the `registry-cred-selector` flag for creating a module command. For example, you can run the following command to push your module image and generate a ModuleTemplate CR with the `oci-registry-cred` label: diff --git a/docs/contributor/04-local-test-setup.md b/docs/contributor/04-local-test-setup.md index 2c567123b9..dcd3f96ccc 100644 --- a/docs/contributor/04-local-test-setup.md +++ b/docs/contributor/04-local-test-setup.md @@ -91,7 +91,7 @@ This setup is deployed with the following security features enabled: -5. Create a ModuleTemplate CR using [Kyma CLI](https://github.com/kyma-project/cli). +5. Create a ModuleTemplate CR using [modulectl](https://github.com/kyma-project/modulectl). The ModuleTemplate CR includes component descriptors for module installations. In this tutorial, we will create a ModuleTemplate CR from the [`template-operator`](https://github.com/kyma-project/template-operator) repository. @@ -104,8 +104,7 @@ This setup is deployed with the following security features enabled: make build-manifests # create the a ModuleTemplate CR and save it to the template.yaml file - kyma alpha create module -p ./ --version 1.2.3 \ - --registry k3d-registry.localhost:5111 --insecure --module-config-file ./module-config.yaml + modulectl create --module-config-file ./module-config.yaml --registry http://k3d-registry.localhost:5111 --insecure ``` 6. Verify images pushed to the local registry: diff --git a/docs/contributor/resources/03-moduletemplate.md b/docs/contributor/resources/03-moduletemplate.md index 570d6f66d1..b01c621b0b 100644 --- a/docs/contributor/resources/03-moduletemplate.md +++ b/docs/contributor/resources/03-moduletemplate.md @@ -145,7 +145,7 @@ In this scenario, the `Ready` state will only be reached if both `module.state.f The core of any ModuleTemplate CR, the descriptor can be one of the schemas mentioned in the latest version of the [OCM Software Specification](https://ocm.software/docs/overview/specification/). While it is a `runtime.RawExtension` in the Go types, it will be resolved via ValidatingWebhook into an internal descriptor with the help of the official [OCM library](https://github.com/open-component-model/ocm). -By default, it will most likely be easiest to use [Kyma CLI](https://github.com/kyma-project/cli/tree/main) and its `create module` command to create a template with a valid descriptor, but it can also be generated manually, for example using [OCM CLI](https://github.com/open-component-model/ocm/tree/main/cmds/ocm). +By default, it will most likely be easiest to use [modulectl](https://github.com/kyma-project/modulectl/tree/main) and its `create` command to create a template with a valid descriptor, but it can also be generated manually, for example using [OCM CLI](https://github.com/open-component-model/ocm/tree/main/cmds/ocm). ### **.spec.mandatory**