Skip to content

Commit e033227

Browse files
authored
Moved module description to Kyma modules (#18319)
* Moved module description to Kyma modules * Update link * Fix formatting * Update link * Add NATS installation steps
1 parent 00d7ddf commit e033227

File tree

5 files changed

+35
-29
lines changed

5 files changed

+35
-29
lines changed

docs/02-get-started/08-install-uninstall-upgrade-kyma-module.md

+7
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,13 @@ kubectl apply -f https://github.com/kyma-project/telemetry-manager/releases/late
4848
kubectl apply -f https://github.com/kyma-project/telemetry-manager/releases/latest/download/telemetry-default-cr.yaml -n kyma-system
4949
```
5050

51+
#### [NATS](https://github.com/kyma-project/nats-manager)
52+
53+
```bash
54+
kubectl apply -f https://github.com/kyma-project/nats-manager/releases/latest/download/nats-manager.yaml
55+
kubectl apply -f https://github.com/kyma-project/nats-manager/releases/latest/download/nats_default_cr.yaml -n kyma-system
56+
```
57+
5158
## Uninstall Kyma with a module
5259

5360
You uninstall Kyma with a module using the `kubectl delete` command.

docs/02-get-started/_sidebar.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
* [Home](/)
2-
* [Modular Kyma](08-install-uninstall-upgrade-kyma-module.md)
2+
* [Module quick install](08-install-uninstall-upgrade-kyma-module.md)
33
* [Get Started](README.md)
4-
* [Quick install](01-quick-install.md)
4+
* [Kyma quick install](01-quick-install.md)
55
* [Deploy and expose a Function](02-deploy-expose-function.md)
66
* [Deploy and expose a microservice](03-deploy-expose-microservice.md)
77
* [Trigger a workload with an event](04-trigger-workload-with-event.md)

docs/06-modules/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Kyma modules
2+
3+
Classic Kyma offered a fixed set of preconfigured components whose development rhythm is synchronized and determined by the release schedule.
4+
5+
With the modular approach, Kyma components become modules, each providing one functionality developed independently of the other ones. Each module has its own custom resource that holds the desired configuration and the operator that reconciles the configuration.
6+
7+
The Kyma project is currently in the transition phase. Some components are already independent modules, but others are still part of the big Kyma release and are installed with the `kyma deploy` command. With each successive release, fewer components will be available within preconfigured Kyma, but more and more will be offered as independent modules.
8+
9+
You can enable modules at any time. Give them a try! If you decide that some of them are not needed for your use case, you can disable them and free the resources. Learn how to [install, uninstall, and upgrade Kyma with a module](../02-get-started/08-install-uninstall-upgrade-kyma-module.md).
10+
11+
The table of Kyma modules:
12+
13+
> **NOTE:** The entries marked with "*" are still components that will be modularized soon.
14+
15+
| Module | Purpose |
16+
|---|---|
17+
| [SAP BTP Operator](https://kyma-project.io/#/btp-manager/user/README.md) | Within the SAP BTP Operator module, BTP Manager installs SAP BTP Service Operator that allows you to consume SAP BTP services from your Kubernetes cluster using Kubernetes-native tools. |
18+
| [Keda](https://kyma-project.io//#/keda-manager/user/README.md) | The Keda module comes with Keda Manager, an extension to Kyma that allows you to install [KEDA (Kubernetes Event Driven Autoscaler)](https://keda.sh/). |
19+
| [Serverless](https://kyma-project.io/#/serverless-manager/user/README.md) | With the Serverless module, you can define simple code snippets (Functions) with minimal implementation effort. |
20+
| [Telemetry](https://kyma-project.io/#/telemetry-manager/user/README.md) | Enable telemetry agents to easily collect application logs and distributed traces for your application and dispatch them to backends.|
21+
| [NATS](https://kyma-project.io/#/nats-manager/user/README.md) | NATS deploys a NATS cluster within the Kyma cluster. You can use it as a backend for Kyma Eventing. |
22+
| [Eventing*](https://github.com/kyma-project/eventing-manager) | Eventing provides functionality to publish and subscribe to CloudEvents. <br> At the moment, the SAP Event Mesh default plan and NATS (provided by the NATS module) are supported. |
23+
| [Application Connector*](https://github.com/kyma-project/application-connector-manager) | Application Connector allows you to connect with external solutions. No matter if you want to integrate an on-premise or a cloud system, the integration process doesn't change, which allows you to avoid any configuration or network-related problems. |
24+
| [API Gateway*](https://github.com/kyma-project/api-gateway) | API Gateway provides functionalities that allow you to expose and secure APIs. |
25+
| [Istio*](https://github.com/kyma-project/istio) | Istio is a service mesh with the Kyma-specific configuration. |

docs/README.md

-26
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,6 @@ It is the open path to the SAP ecosystem supporting business scenarios end-to-en
77

88
Kyma is an actively maintained open-source project supported by SAP. The Kyma project is also a foundation of SAP BTP, Kyma runtime which is a part of SAP Business Technology Platform (BTP). You can use Kyma modules in your own Kubernetes cluster, or try the managed version from SAP BTP with a ready-to-use Kubernetes cluster powered by Gardener.
99

10-
## Kyma modules
11-
12-
Classic Kyma offered a fixed set of preconfigured components whose development rhythm is synchronized and determined by the release schedule.
13-
14-
With the modular approach, Kyma components become modules, each providing one functionality developed independently of the other ones. Each module has its own custom resource that holds the desired configuration and the operator that reconciles the configuration.
15-
16-
The Kyma project is currently in the transition phase. Some components are already independent modules, but others are still part of the big Kyma release and are installed with the `kyma deploy` command. With each successive release, fewer components will be available within preconfigured Kyma, but more and more will be offered as independent modules.
17-
18-
You can enable modules at any time. Give them a try! If you decide that some of them are not needed for your use case, you can disable them and free the resources. Learn how to [install, uninstall, and upgrade Kyma with a module](./02-get-started/08-install-uninstall-upgrade-kyma-module.md).
19-
20-
The table of Kyma modules:
21-
22-
> **NOTE:** The entries marked with "*" are still components that will be modularized soon.
23-
24-
| Module | Purpose |
25-
|---|---|
26-
| [SAP BTP Operator](https://kyma-project.io/#/btp-manager/user/README.md) | Within the SAP BTP Operator module, BTP Manager installs SAP BTP Service Operator that allows you to consume SAP BTP services from your Kubernetes cluster using Kubernetes-native tools. |
27-
| [Keda](https://kyma-project.io//#/keda-manager/user/README.md) | The Keda module comes with Keda Manager, an extension to Kyma that allows you to install [KEDA (Kubernetes Event Driven Autoscaler)](https://keda.sh/). |
28-
| [Serverless](https://kyma-project.io/#/serverless-manager/user/README.md) | With the Serverless module, you can define simple code snippets (Functions) with minimal implementation effort. |
29-
| [Telemetry](https://kyma-project.io/#/telemetry-manager/user/README.md) | Enable telemetry agents to easily collect application logs and distributed traces for your application and dispatch them to backends.|
30-
| [NATS](https://kyma-project.io/#/nats-manager/user/README.md) | NATS deploys a NATS cluster within the Kyma cluster. You can use it as a backend for Kyma Eventing. |
31-
| [Eventing*](https://github.com/kyma-project/eventing-manager) | Eventing provides functionality to publish and subscribe to CloudEvents. <br> At the moment, the SAP Event Mesh default plan and NATS (provided by the NATS module) are supported. |
32-
| [Application Connector*](https://github.com/kyma-project/application-connector-manager) | Application Connector allows you to connect with external solutions. No matter if you want to integrate an on-premise or a cloud system, the integration process doesn't change, which allows you to avoid any configuration or network-related problems. |
33-
| [API Gateway*](https://github.com/kyma-project/api-gateway) | API Gateway provides functionalities that allow you to expose and secure APIs. |
34-
| [Istio*](https://github.com/kyma-project/istio) | Istio is a service mesh with the Kyma-specific configuration. |
35-
3610
## Kyma's strengths
3711

3812
Kyma is built upon leading cloud-native, open-source projects and open standards, such as Istio, NATS, Cloud Events, and Open Telemetry. We created an opinionated set of modules you can easily enable in your Kubernetes cluster to speed up cloud application development and operations. With Kyma, you save the time to pick the right tools and the effort to keep them secure and up to date. Also, you can use the modules you need from Kyma and complement them with other Kubernetes tools.

docs/_sidebar.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* [Developer Tutorials](/03-tutorials/README.md)
66
* [Operation Guides](/04-operation-guides/README.md)
77
* [Technical Reference](05-technical-reference/README.md)
8-
* Kyma Modules
8+
* [Kyma Modules](06-modules/README.md)
99
* [SAP BTP Operator](/btp-manager/user/README.md)
1010
* [Keda](/keda-manager/user/README.md)
1111
* [Serverless](/serverless-manager/user/README.md)

0 commit comments

Comments
 (0)