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

Add CLI description to the help.sap.com portal #2370

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 17 additions & 10 deletions docs/user/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
> **TIP:** Apart from the {Module Name} heading, you can use your own titles for the remaining sections. You can also add more module-specific sections.
# Kyma CLI

# {Module Name}
> Modify the title and insert the name of your module. Use Heading 1 (H1).
## What is Kyma CLI?

## Overview
> Provide a description of your module and its components. Describe its features and functionalities. Mention the scope and add information on the CustomResourceDefinitions (CRDs).
> You can divide this section to the relevant subsections.
The Kyma CLI is a command-line interface tool designed to simplify the use of the Kyma ecosystem. It allows you to manage Kyma modules and applications, deploy simple applications, and more. With Kyma CLI, you can perform complex tasks with simple commands, accelerating development cycles.

## Useful Links (Optional)
> Provide links to the most relevant module documentation (tutorials, technical references, resources, etc.).
In addition, you can build, push, and deploy an application to a Kyma cluster with a single command. It automatically detects the Dockerfile in the current directory, builds and pushes the image to the in-cluster registry, and applies the necessary Kubernetes resources.

## Feedback (Optional)
> Describe how users can provide feedback.
Kyma CLI also provides a set of commands to manage Kyma modules efficiently. You can manage, deploy, and configure modules seamlessly. With Kyma CLI module commands, you can list available and installed modules, add or delete them, and configure their settings. Modules can be deployed with the default or custom configuration.
## Features
The Kyma CLI provides the following features:

- Simplified module management.
- Automated deployments.
- Built-in extensibility.
- Integrated service management.
- Commands providing useful automation.

## Related Information

- [Kyma CLI tutorials](tutorials/README.md)
9 changes: 8 additions & 1 deletion docs/user/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
Use this file to create an unordered list of documents you want to display on the [Kyma website](https://kyma-project.io). The list serves to navigate through the user documentation. For more information, visit the [User documentation](https://github.com/kyma-project/community/blob/main/docs/guidelines/content-guidelines/01-user-docs.md) guide.
<!-- markdown-link-check-disable -->
* [Back to Kyma Home](/)
* [Kyma CLI](/cli/user/README.md)
* [Tutorials](/cli/user/tutorials/README.md)
* [Adding and Deleting a Kyma Module Using Kyma CLI](/cli/user/tutorials/01-10-add-delete-modules)
* [Setting Your Module to the Managed and Unmanaged State in Kyma CLI](/cli/user/tutorials/01-11-manage-unmanage-modules)
* [Commands](/cli/user/gen-docs/README.md)
<!-- markdown-link-check-enable -->
30 changes: 30 additions & 0 deletions docs/user/tutorials/01-10-add-delete-modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Adding and Deleting a Kyma Module Using Kyma CLI
This tutorial shows how you can add and delete a new module using Kyma CLI.

> [!WARNING]
> Modules added without any specified form of the custom resource have the policy field set to `Ignore`.
## Procedure

### Adding a New Module

To add a new module with the default policy set to `CreateAndDelete`, use the following command:

```
kyma alpha module add {MODULE-NAME} --default-cr
```
To add a module with a different CR, use the `--cr-path={CR-FILEPATH}` flag:
```
kyma alpha module add {MODULE-NAME} --cr-path={CR-PATH-FILEPATH}
```

You can also specify which channel the module should use with the `-c {CHANNEL-NAME}` flag:
```
kyma alpha module add {MODULE-NAME} -c {CHANNEL-NAME} --default-cr
```
### Deleting an Existing Module

To delete an existing module, use the following command:

```
kyma alpha module delete {MODULE-NAME}
```
32 changes: 32 additions & 0 deletions docs/user/tutorials/01-11-manage-unmanage-modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Setting Your Module to the Managed and Unmanaged State in Kyma CLI

In some cases, for example, for testing, you may need to modify your module beyond what is supported by its configuration. By default, when a module is in the managed state, Kyma Control Plane governs its Kubernetes resources, reverting any manual changes during the next reconciliation loop.

To modify Kubernetes objects directly without them being reverted, you must set the module to the unmanaged state. In this state, reconciliation is disabled, ensuring your manual changes are preserved.

> [!CAUTION]
> Setting your module to the unmanaged state may lead to instability and data loss within your cluster. It may also be impossible to revert the changes. In addition, we don't guarantee any service level agreement (SLA) or provide updates and maintenance for the module.


## Procedure

### Setting a Module to the Managed State


To set a module to the managed state, use the following command:

```
kyma alpha module manage {MODULE-NAME}
```
Even if the module is already in the managed state, you can change its policy by adding the optional flag ``--policy {POLICY-NAME}``. The default policy is ``CreateAndDelete``.

### Setting a Module to the Unmanaged State

To set a module to the unmanaged state, use the following command:

```
kyma alpha module unmanage {MODULE-NAME}
```

> [!CAUTION]
> Depending on the introduced changes, bringing back the module to the managed state might not be possible.
3 changes: 3 additions & 0 deletions docs/user/tutorials/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Tutorials

This section will help you understand Kyma CLI and how to use it in different scenarios.
Loading