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.

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

Support for updated Module Catalog #2251

Open
4 of 6 tasks
kwiatekus opened this issue Nov 21, 2024 · 2 comments
Open
4 of 6 tasks

Support for updated Module Catalog #2251

kwiatekus opened this issue Nov 21, 2024 · 2 comments
Labels

Comments

@kwiatekus
Copy link
Contributor

kwiatekus commented Nov 21, 2024

Description

The recent changes required by the Community Modules story enable us to start working on the module related commands in kyma CLI. Multiple changes were introduced to the API of Kyma Lifecycle Manager, and thus, the new planned commands for module management should go along with them.

kyma module list <--installed/--available/--managed>
kyma module describe <MODULE_NAME> <--crds/--description/...>
kyma module deploy <MODULE_NAME> #<--namespace>
kyma module undeploy <MODULE_NAME> #<--namespace>
kyma module enable <MODULE_NAME> <--unmanaged> #<--namespace>
kyma module disable <MODULE_NAME> #<--namespace>
kyma module configure <MODULE_NAME> <FLAGS_FROM_CONFIGMAP> #<--namespace>
kyma module inspect <MODULE_NAME> <FLAGS_FROM_CONFIGMAP> <--output=text/json/yaml> #<--namespace>

Reasons

We want to have a set of convenient kyma CLI commands to interact with Kyma Module Catalog.

Changes in Licecycle management API

  • ModuleTemplate CRD:
    • .spec.channel field was deprecated
    • .spec.info introduced, it includes basic information on the Module that can be displayed in Busola, such as repo/docu links, icons
    • .spec.resources introduced, it contains a reference to all the resources that need to be installed in order for the Module to be operational (used for manual installation)
    • spec.associatedResources introduced, it contains a list of all module-related CRDs
    • .spec.manager introduced, contains a reference to the Module manager, which can be used to determine whether manually installed module is operational or not
  • ModuleReleaseMeta CRD introduced
    • It contains ties between module versions and channels used

Acceptance criteria
User of managed cluster should be able to discover modules w/o enabling them, for example:

  • discover available modules from catalog
  • read details about the module (what API does it offer)

User of managed cluster should be able to manage modules on his managed cluster, for example:

  • enable managed module (with default module CR)
  • enable managed module (with custom module CR)
  • disable managed module
  • unmanage module (keep module resources and API, but do not keep them managed by LFM )

Attachments
We have been provided with sample moduletemplates and ModuleReleaseMeta objects on development environment
kyma-project/lifecycle-manager#2007 (comment)

@mmitoraj
Copy link
Contributor

Having the new Kyma CLI ready, we have to remember to update tutorials, including these in the Discovery Center missions. Please add it to the Definitions of Done for the epic.

@kwiatekus
Copy link
Contributor Author

Having the new Kyma CLI ready, we have to remember to update tutorials, including these in the Discovery Center missions. Please add it to the Definitions of Done for the epic.

Done here. thx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants