Skip to content

Commit

Permalink
add module manage unmanage tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
FilipRudy committed Feb 26, 2025
1 parent f4d89f3 commit 04bfaa6
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/user/tutorials/01-10-manage-unmanage-modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Setting Your Module to the Managed/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.

## Steps

### Setting a Module to the Managed State


1. To set Module to the Managed state, use the command below:

```
kyma alpha module manage {MODULE-NAME}
```
2. Even if the Module is already Managed, you can change it's policy by adding optional flag ``--policy {POLICY-NAME}``. The default policy is ``CreateAndDelete``.
### Setting a Module to the Unmanaged State
1. To set Module to the Unmanaged state, use the command below:
```
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 how Kyma CLI and how to use it in different scenarios.

0 comments on commit 04bfaa6

Please sign in to comment.