From fa2e3fc41f41e33ba4a9c2e6e55a115f0a34cc14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C5=82gorzata=20=C5=9Awieca?= Date: Fri, 8 Dec 2023 12:56:54 +0100 Subject: [PATCH 1/5] Fix broken links (#18471) * Fix broken links * Spelling --- docs/03-tutorials/README.md | 4 ---- docs/glossary.md | 2 +- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/03-tutorials/README.md b/docs/03-tutorials/README.md index 8909bed0c3c9..3550bde0d57f 100644 --- a/docs/03-tutorials/README.md +++ b/docs/03-tutorials/README.md @@ -16,7 +16,3 @@ Dive in deeper and explore the functionalities that Kyma provides for various us ### Observability * [Observability](00-observability.md) - -### Service Management - -* [Deploy an SAP BTP service in your Kyma cluster](00-service-management/smgt-01-deploy-service.md) diff --git a/docs/glossary.md b/docs/glossary.md index 6c1f083fb111..7db43c529c09 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -21,6 +21,6 @@ Here's a list of the most commonly used terms that you may come across when brow | Pod | Pod is the smallest and simplest Kubernetes object that represents a set of containers running on your cluster. | | | Role | Access to every cluster is managed by the roles assigned. Roles give the assigned users a different level of permissions suitable for different purposes. | [Authorization in Kyma](./04-operation-guides/security/sec-02-authorization-in-kyma.md) | | Service | A Service in Kubernetes is an abstract way to expose an application running on a set of Pods as a network service.

In Kyma documentation, we use `Service` to refer to the Kubernetes term, and `service` to refer to a software functionality in general. | [Kubernetes - Service](https://kubernetes.io/docs/concepts/services-networking/service/) | -| Service operator | Service Management in Kyma uses service operators. A service operator is a piece of software that provides a set of all necessary resources (such as CustomResourceDefinition and controllers) needed to provision third-party services in your Kubernetes cluster. | [OperatorHub.io](https://operatorhub.io/) & [What is Service Management in Kyma?](./01-overview/service-management) | +| Service operator | Service Management in Kyma uses service operators. A service operator is a piece of software that provides a set of all necessary resources (such as CustomResourceDefinition and controllers) needed to provision third-party services in your Kubernetes cluster. | [OperatorHub.io](https://operatorhub.io/) & [SAP BTP Operator Module](https://kyma-project.io/#/btp-manager/user/README) | >**TIP:** To learn the basic Kubernetes terminology, read the [Kubernetes glossary](https://kubernetes.io/docs/reference/glossary). From 81e8f1b9bfa4a3ba270b80ca3583d4fefdcaca74 Mon Sep 17 00:00:00 2001 From: Grzegorz Karaluch Date: Fri, 8 Dec 2023 13:14:52 +0100 Subject: [PATCH 2/5] Change serverless link in sidebar (#18470) * change serverless link in sidebar * change index.html --- docs/_sidebar.md | 2 +- docs/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 074eeb902264..50c304701df0 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -37,7 +37,7 @@ * [SAP BTP Operator](/btp-manager/user/README.md) * [Application Connector](/application-connector-manager/user/README.md) * [Keda](/keda-manager/user/README.md) - * [Serverless](/serverless-manager/user/README.md) + * [Serverless](/serverless/user/README.md) * [Telemetry](/telemetry-manager/user/README.md) * [NATS](/nats-manager/user/README.md) * [Eventing](/eventing-manager/user/README.md) diff --git a/docs/index.html b/docs/index.html index 4f483f309262..67f3fc7a20db 100644 --- a/docs/index.html +++ b/docs/index.html @@ -36,7 +36,7 @@ '/btp-manager/(.*)': 'https://raw.githubusercontent.com/kyma-project/btp-manager/main/docs/$1', '/application-connector-manager/(.*)': 'https://raw.githubusercontent.com/kyma-project/application-connector-manager/main/docs/$1', '/keda-manager/(.*)': 'https://raw.githubusercontent.com/kyma-project/keda-manager/main/docs/$1', - '/serverless-manager/(.*)': 'https://raw.githubusercontent.com/kyma-project/serverless-manager/main/docs/$1', + '/serverless/(.*)': 'https://raw.githubusercontent.com/kyma-project/serverless/main/docs/$1', '/telemetry-manager/(.*)': 'https://raw.githubusercontent.com/kyma-project/telemetry-manager/main/docs/$1', '/istio/(.*)': 'https://raw.githubusercontent.com/kyma-project/istio/main/docs/$1', '/nats-manager/(.*)': 'https://raw.githubusercontent.com/kyma-project/nats-manager/main/docs/$1', From c3326dc2ee90961453daf43bbe5bbb594f72c189 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C5=82gorzata=20=C5=9Awieca?= Date: Fri, 8 Dec 2023 14:40:53 +0100 Subject: [PATCH 3/5] Remove component documents (#18466) * Removed docs/02-get-started/08-install-uninstall-upgrade-kyma-module.md * Remove component documents * Remove old get started guides * Restore backup and logs docs * Removed Goat's tech-ref docs * Apply review suggestion --- docs/01-overview/README.md | 5 +- docs/01-overview/_sidebar1.md | 5 - docs/01-overview/api-exposure/README.md | 5 - docs/01-overview/api-exposure/metadata.yaml | 1 - docs/01-overview/metadata.yaml | 1 - docs/01-overview/serverless/README.md | 5 - docs/01-overview/serverless/metadata.yaml | 1 - docs/01-overview/service-mesh/README.md | 5 - docs/01-overview/service-mesh/metadata.yaml | 1 - docs/01-overview/telemetry/README.md | 5 - docs/01-overview/telemetry/metadata.yaml | 1 - docs/02-get-started/01-quick-install.md | 105 ++++---- .../02-deploy-expose-function.md | 156 ------------ .../03-deploy-expose-microservice.md | 228 ------------------ .../04-trigger-workload-with-event.md | 205 ---------------- ...8-install-uninstall-upgrade-kyma-module.md | 101 -------- .../08-uninstall-upgrade-kyma-module.md | 33 +++ docs/02-get-started/README.md | 38 +-- docs/02-get-started/_sidebar1.md | 7 - docs/03-tutorials/_sidebar1.md | 6 - docs/04-operation-guides/_sidebar1.md | 5 - .../operations/01-install-kyma-CLI.md | 71 ------ .../operations/02-install-kyma.md | 141 ----------- .../03-change-kyma-config-values.md | 45 ---- .../operations/05-upgrade-kyma.md | 20 -- .../operations/07-uninstall-kyma.md | 9 - docs/04-operation-guides/operations/README.md | 7 +- .../operations/_sidebar1.md | 10 - .../operations/metadata.yaml | 1 - .../ra-01-enable-kyma-with-runtime-agent.md | 15 -- .../00-api-overview/README.md | 12 +- .../00-cli-commands/README.md | 7 - .../00-cli-commands/metadata.yaml | 1 - ...pix-01-config-authorizations-apigateway.md | 87 ------- docs/_redirects | 22 +- docs/_sidebar.md | 39 +-- 36 files changed, 135 insertions(+), 1271 deletions(-) delete mode 100644 docs/01-overview/_sidebar1.md delete mode 100644 docs/01-overview/api-exposure/README.md delete mode 100644 docs/01-overview/api-exposure/metadata.yaml delete mode 100644 docs/01-overview/metadata.yaml delete mode 100644 docs/01-overview/serverless/README.md delete mode 100644 docs/01-overview/serverless/metadata.yaml delete mode 100644 docs/01-overview/service-mesh/README.md delete mode 100644 docs/01-overview/service-mesh/metadata.yaml delete mode 100644 docs/01-overview/telemetry/README.md delete mode 100644 docs/01-overview/telemetry/metadata.yaml delete mode 100644 docs/02-get-started/02-deploy-expose-function.md delete mode 100644 docs/02-get-started/03-deploy-expose-microservice.md delete mode 100644 docs/02-get-started/04-trigger-workload-with-event.md delete mode 100644 docs/02-get-started/08-install-uninstall-upgrade-kyma-module.md create mode 100644 docs/02-get-started/08-uninstall-upgrade-kyma-module.md delete mode 100644 docs/02-get-started/_sidebar1.md delete mode 100644 docs/03-tutorials/_sidebar1.md delete mode 100644 docs/04-operation-guides/_sidebar1.md delete mode 100644 docs/04-operation-guides/operations/01-install-kyma-CLI.md delete mode 100644 docs/04-operation-guides/operations/02-install-kyma.md delete mode 100644 docs/04-operation-guides/operations/03-change-kyma-config-values.md delete mode 100644 docs/04-operation-guides/operations/05-upgrade-kyma.md delete mode 100644 docs/04-operation-guides/operations/07-uninstall-kyma.md delete mode 100644 docs/04-operation-guides/operations/_sidebar1.md delete mode 100644 docs/04-operation-guides/operations/metadata.yaml delete mode 100644 docs/04-operation-guides/operations/ra-01-enable-kyma-with-runtime-agent.md delete mode 100644 docs/05-technical-reference/00-cli-commands/README.md delete mode 100644 docs/05-technical-reference/00-cli-commands/metadata.yaml delete mode 100644 docs/05-technical-reference/apix-01-config-authorizations-apigateway.md diff --git a/docs/01-overview/README.md b/docs/01-overview/README.md index 66855b885281..706b942bb4c5 100644 --- a/docs/01-overview/README.md +++ b/docs/01-overview/README.md @@ -4,7 +4,4 @@ title: Kyma components Classic Kyma offered a fixed set of preconfigured components whose development rhythm is synchronized and determined by the release schedule. -See the list of Kyma components that have not been transformed into modules yet: - -- [Service Mesh](../01-overview/service-mesh/README.md) -- [User Interfaces](../01-overview/ui/README.md) +All the components have become independent modules. For more details, read [Modules](../06-modules/README.md). diff --git a/docs/01-overview/_sidebar1.md b/docs/01-overview/_sidebar1.md deleted file mode 100644 index 57642abfd93f..000000000000 --- a/docs/01-overview/_sidebar1.md +++ /dev/null @@ -1,5 +0,0 @@ -* [Home](/) - -* [Kyma Components](/01-overview/README.md) - * [User Interfaces](/01-overview/ui/README.md) - diff --git a/docs/01-overview/api-exposure/README.md b/docs/01-overview/api-exposure/README.md deleted file mode 100644 index ace54d48adf3..000000000000 --- a/docs/01-overview/api-exposure/README.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: What is API Exposure in Kyma? ---- - -This content has been moved to: [API Gateway module](https://kyma-project.io/#/api-gateway/user/README) \ No newline at end of file diff --git a/docs/01-overview/api-exposure/metadata.yaml b/docs/01-overview/api-exposure/metadata.yaml deleted file mode 100644 index 6909e06f15db..000000000000 --- a/docs/01-overview/api-exposure/metadata.yaml +++ /dev/null @@ -1 +0,0 @@ -displayName: API Exposure diff --git a/docs/01-overview/metadata.yaml b/docs/01-overview/metadata.yaml deleted file mode 100644 index bf30d7ee4d89..000000000000 --- a/docs/01-overview/metadata.yaml +++ /dev/null @@ -1 +0,0 @@ -displayName: Overview diff --git a/docs/01-overview/serverless/README.md b/docs/01-overview/serverless/README.md deleted file mode 100644 index e1960891663c..000000000000 --- a/docs/01-overview/serverless/README.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: What is Serverless in Kyma? ---- - -This content has been moved to: [Serverless module](https://kyma-project.io/#/serverless-manager/user/README). \ No newline at end of file diff --git a/docs/01-overview/serverless/metadata.yaml b/docs/01-overview/serverless/metadata.yaml deleted file mode 100644 index 57aa1215abc4..000000000000 --- a/docs/01-overview/serverless/metadata.yaml +++ /dev/null @@ -1 +0,0 @@ -displayName: Serverless diff --git a/docs/01-overview/service-mesh/README.md b/docs/01-overview/service-mesh/README.md deleted file mode 100644 index e77460cdc38b..000000000000 --- a/docs/01-overview/service-mesh/README.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: What is Service Mesh in Kyma? ---- - -This content has been moved to: [What is Istio in Kyma?](https://kyma-project.io/#/istio/user/README.md) diff --git a/docs/01-overview/service-mesh/metadata.yaml b/docs/01-overview/service-mesh/metadata.yaml deleted file mode 100644 index 6f7946f48055..000000000000 --- a/docs/01-overview/service-mesh/metadata.yaml +++ /dev/null @@ -1 +0,0 @@ -- displayName: Service Mesh \ No newline at end of file diff --git a/docs/01-overview/telemetry/README.md b/docs/01-overview/telemetry/README.md deleted file mode 100644 index 6604f370281c..000000000000 --- a/docs/01-overview/telemetry/README.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: What is Telemetry in Kyma? ---- - -This content has been moved to: [What is Telemetry in Kyma?](https://kyma-project.io/#/telemetry-manager/user/README). diff --git a/docs/01-overview/telemetry/metadata.yaml b/docs/01-overview/telemetry/metadata.yaml deleted file mode 100644 index 51b9831545a4..000000000000 --- a/docs/01-overview/telemetry/metadata.yaml +++ /dev/null @@ -1 +0,0 @@ -displayName: Telemetry diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index ea8655d47f6a..936c25d7b6f3 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -1,65 +1,86 @@ ---- -title: Quick install ---- +# Quick install -To get started with Kyma, let's quickly install it first. +To get started with Kyma, let's quickly install it with specific modules first. -The Kyma project is currently in the transition phase from classic to modular Kyma. You can either install classic Kyma with its components, or available modules. To see the list of Kyma modules, go to [Overview](../01-overview/README.md). To learn how to install Kyma with a module, go to [Install, uninstall and upgrade Kyma with a module](08-install-uninstall-upgrade-kyma-module.md). +> **NOTE:** This guide describes installation of standalone Kyma with specific modules. If you are using SAP BTP, Kyma runtime (SKR), read [Enable and Disable a Kyma Module](https://help.sap.com/docs/btp/sap-business-technology-platform/enable-and-disable-kyma-module?locale=en-US&version=Cloud) instead. -> **CAUTION:** Components transformed into modules aren't installed as part of preconfigured classic Kyma. +## Prerequisites -## Install Kyma +- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) +- Kubernetes cluster, or [k3d](https://k3d.io) (v5.x or higher) for local installation +- `kyma-system` Namespace created -To install Kyma on a local k3d cluster, run: +## Steps -```bash -kyma provision k3d -kyma deploy -``` +1. Provision a k3d cluster, run: -When asked whether to install the Kyma certificate, confirm. + ```bash + kyma provision k3d + ``` -> **NOTE:** Check out [more installation options for Kyma](../04-operation-guides/operations/02-install-kyma.md). + When asked whether to install the Kyma certificate, confirm. -### Verify the installation +2. Choose a module, deploy its module manager, and apply the module configuration. The operation installs a Kyma module of your choice on a Kubernetes cluster. See the already available Kyma modules with their quick installation steps and links to their GitHub repositories: -Now let's verify that the installation was successful. Run: + [**Application Connector**](https://github.com/kyma-project/application-connector-manager) -```bash -kubectl get deployments -n kyma-system -``` + ```bash + kubectl apply -f https://github.com/kyma-project/application-connector-manager/releases/latest/download/application-connector-manager.yaml + kubectl apply -f https://github.com/kyma-project/application-connector-manager/releases/latest/download/default_application_connector_cr.yaml -n kyma-system + ``` -The installation succeeded if all the Deployments returned are in status `READY`. + [**Keda**](https://github.com/kyma-project/keda-manager) -### Export your cluster domain + ```bash + kubectl apply -f https://github.com/kyma-project/keda-manager/releases/latest/download/keda-manager.yaml + kubectl apply -f https://github.com/kyma-project/keda-manager/releases/latest/download/keda-default-cr.yaml -n kyma-system + ``` -For convenience, expose the domain of the cluster as an environment variable now. -We will use it later in the guides. + [**SAP BTP Operator**](https://github.com/kyma-project/btp-manager) -```bash -export CLUSTER_DOMAIN={YOUR_CLUSTER_DOMAIN} -``` + ```bash + kubectl apply -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-manager.yaml + kubectl apply -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-operator-default-cr.yaml -n kyma-system + ``` -> **NOTE:** For local installation, the cluster domain is `local.kyma.dev`. + > **CAUTION:** The CR is in the `Warning` state and the message is `Secret resource not found reason: MissingSecret`. To create a Secret, follow the instructions in the [`btp-manager`](https://github.com/kyma-project/btp-manager/blob/main/docs/user/02-10-usage.md#create-and-install-secret) repository. -## Open Kyma Dashboard + [**Serverless**](https://github.com/kyma-project/serverless-manager) -To manage Kyma via GUI, open Kyma Dashboard: + ```bash + kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/latest/download/serverless-operator.yaml + kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/latest/download/default-serverless-cr.yaml -n kyma-system + ``` -```bash -kyma dashboard -``` - -This command takes you to your Kyma Dashboard under [`http://localhost:3001/`](http://localhost:3001/). + [**Telemetry**](https://github.com/kyma-project/telemetry-manager) -## Check the list of Deployments via Dashboard + ```bash + kubectl apply -f https://github.com/kyma-project/telemetry-manager/releases/latest/download/telemetry-manager.yaml + kubectl apply -f https://github.com/kyma-project/telemetry-manager/releases/latest/download/telemetry-default-cr.yaml -n kyma-system + ``` -Now let's check the list of deployments using the Dashboard. + [**NATS**](https://github.com/kyma-project/nats-manager) -1. Navigate to **Namespaces**. -2. Click on the `kyma-system` Namespace. - > **NOTE:** The system Namespaces are hidden by default. - > To see `kyma-system` and other hidden Namespaces, go to your Dashboard profile in the top-right corner, choose **Preferences** > **Clusters**, and activate the **Show Hidden Namespaces** toggle. -3. Go to **Workloads** > **Deployments**. + ```bash + kubectl apply -f https://github.com/kyma-project/nats-manager/releases/latest/download/nats-manager.yaml + kubectl apply -f https://github.com/kyma-project/nats-manager/releases/latest/download/nats_default_cr.yaml -n kyma-system + ``` -This gives you the same list of deployments as you got earlier via `kubectl`, just in a nicer visual packaging. + [**API Gateway**](https://github.com/kyma-project/api-gateway) + + ```bash + kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/api-gateway-manager.yaml + kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/apigateway-default-cr.yaml + ``` + +3. To manage Kyma using graphical user interface (GUI), open Kyma Dashboard: + + ```bash + kyma dashboard + ``` + + This command takes you to your Kyma Dashboard under [`http://localhost:3001/`](http://localhost:3001/). + +## Related links + +To see the list of all available Kyma modules, go to [Kyma modules](../06-modules/README.md). diff --git a/docs/02-get-started/02-deploy-expose-function.md b/docs/02-get-started/02-deploy-expose-function.md deleted file mode 100644 index 3af52a113f73..000000000000 --- a/docs/02-get-started/02-deploy-expose-function.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: Deploy and expose a Function ---- - -Now that you've installed Kyma, let's deploy your first Function. We'll call it `hello-world`. - -## Create a Function - -First, let's create the Function and apply it. - - - -#### **Kyma Dashboard** - -1. In Kyma Dashboard, go to the `default` Namespace. -2. Go to **Workloads** > **Functions**. -3. Click on **Create Function**. -4. Name the Function `hello-world`. -5. From the **Language** dropdown, choose `JavaScript`. -6. From the **Runtime** dropdown, choose one of the available `nodejs`. -7. Keep the sample Function code. -8. Click **Create**. - -#### **kubectl** - -Run: - -```bash -cat < - -### Verify the Function deployment - -Now let's make sure that the Function has been deployed successfully. - - - -#### **Kyma Dashboard** - -The operation was successful if the Function **Status** changed to `RUNNING`. - -> **NOTE:** You might need to wait a few seconds for the status to change. - -#### **kubectl** - -Run: - -```bash -kubectl get functions hello-world -``` - -The operation was successful if the statuses for **CONFIGURED**, **BUILT**, and **RUNNING** are `True`. - - - -## Expose the Function - -After we've got our `hello-world` Function deployed, we might want to expose it outside our cluster so that it's available for other external services. - -> **CAUTION:** Exposing a workload to the outside world is always a potential security vulnerability, so tread carefully. In a production environment, always secure the workload you expose with [OAuth2](https://kyma-project.io/#/api-gateway/user/tutorials/01-50-expose-and-secure-a-workload/01-50-expose-and-secure-workload-oauth2) or [JWT](https://kyma-project.io/#/api-gateway/user/tutorials/01-50-expose-and-secure-a-workload/01-52-expose-and-secure-workload-jwt). - -First, let's create an [APIRule](https://kyma-project.io/#/api-gateway/user/custom-resources/apirule/04-10-apirule-custom-resource) for the Function. - - - -#### **Kyma Dashboard** - -1. Go to **Discovery and Network** > **API Rules**. -2. Click on **Create API Rule**. -3. Provide the **Name** (`hello-world`). -4. From the **Service Name** dropdown, select `hello-world`. -5. Provide your Service **Port** (`80`). -6. Choose your host from the **Host** dropdown and replace the asterisk (*) with the name of your subdomain (`hello-world`). - -#### **kubectl** - -Run: - -```bash -cat < - -### Verify the Function exposure - -Now let's verify that the Function has been exposed successfully. - - - -#### **Kyma Dashboard** - -In your Function's **Configuration** tab, click on the APIRule's **Host**. -This opens the Function's external address as a new page. - -> **NOTE:** Alternatively, from the left navigation go to **API Rules**, and click on the **Host** URL there. - -The operation was successful if the page says `Hello World from the Kyma Function hello-world running on nodejs18!`. - -#### **kubectl** - -Run: - -```bash -curl https://hello-world.$CLUSTER_DOMAIN -``` - -The operation was successful if the call returns `Hello World from the Kyma Function hello-world running on nodejs18!`. - - - -> **NOTE:** Local installation provides the self-signed certificates out of the box, but if you want to access your API through your browser, you must add them to your local trust store. -To do this, call the `kyma import certs` command with proper permissions. For more information, read [Kyma import certs](https://github.com/kyma-project/cli/blob/main/docs/gen-docs/kyma_import_certs.md). diff --git a/docs/02-get-started/03-deploy-expose-microservice.md b/docs/02-get-started/03-deploy-expose-microservice.md deleted file mode 100644 index 38cb82f73381..000000000000 --- a/docs/02-get-started/03-deploy-expose-microservice.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -title: Deploy and expose a microservice ---- - -You already know how to [deploy](02-deploy-expose-function.md#create-a-function) and [expose a Function](02-deploy-expose-function.md#expose-the-function). Let's now do the same with a container microservice. -We'll use the Kyma example [`orders-service`](https://github.com/kyma-project/examples/blob/master/orders-service/README.md) for this. - -## Deploy the microservice - -First, let's create a Deployment that provides the microservice definition and lets you run it on the cluster. - - - -#### **Kyma Dashboard** - -1. From the left navigation, go to **Workloads > Deployments**. -2. Click on **Create Deployment**. -3. Go to **Advanced** and provide the following parameters: - - **Name**: `orders-service` - - **Docker Image**: `eu.gcr.io/kyma-project/develop/orders-service:68a58069` - - _Optionally_, to save resources, modify these parameters: - - **Memory requests**: `10Mi` - - **Memory limits**: `32Mi` - - **CPU requests (m)**: `16m` - - **CPU limits (m)**: `20m` - -4. Click **Create**. - -The operation was successful if you can see `1/1` Pods running in the Deployment's view. - -#### **kubectl** - -Run: - -```bash -cat < **NOTE:** You might need to wait a few seconds for the replica to be ready and return the status. - - - -### Create the Service - -Now that we have the Deployment, let's deploy the [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/) to allow other Kubernetes resources to communicate with your microservice. - - - -#### **Kyma Dashboard** - -1. From the left navigation, go to **Discovery and Network > Services**. -2. Click on **Create Service**. -3. In the **Create Service** view, paste the following values to your YAML file: - - ```yaml - apiVersion: v1 - kind: Service - metadata: - name: orders-service - spec: - selector: - app: orders-service - ports: - - protocol: TCP - port: 80 - targetPort: 8080 - ``` - -4. Click **Create**. - -#### **kubectl** - -Run: - -```bash -cat < - -## Expose the microservice - -We have created the Service. Let's now expose it outside the cluster. - -> **CAUTION:** Exposing a workload to the outside world is always a potential security vulnerability, so tread carefully. In a production environment, always secure the workload you expose with [OAuth2](https://kyma-project.io/#/api-gateway/user/tutorials/01-50-expose-and-secure-a-workload/01-50-expose-and-secure-workload-oauth2) or [JWT](https://kyma-project.io/#/api-gateway/user/tutorials/01-50-expose-and-secure-a-workload/01-52-expose-and-secure-workload-jwt). - -To expose our microservice, we must create an [APIRule CR](https://kyma-project.io/#/api-gateway/user/custom-resources/apirule/04-10-apirule-custom-resource), just like when we [exposed our Function](02-deploy-expose-function.md#expose-the-function). - - - -#### **Kyma Dashboard** - -1. Go to **Discovery and Network** > **API Rules**, and click on **Create API Rule**. -2. Provide the **Name** (`orders-service`) -3. Choose `orders-service` from the **Service Name** dropdown. -4. Provide your Service **Port** (`80`). -5. Choose your host from the **Host** dropdown and replace the asterisk (*) with the name of your subdomain (`orders-service`). -6. Click **Create**. - -#### **kubectl** - -Run: - -```bash -cat < - -### Verify the microservice exposure - -Now let's check that the microservice has been exposed successfully. - - - -#### **Kyma Dashboard** - -1. From your Service's view, get the APIRule's **Host**. - - > **NOTE:** Alternatively, from the left navigation go to **API Rules** and get the **Host** URL from there. - -2. Paste this **Host** in your browser and add the `/orders` suffix to the end of it, like this: `{HOST}/orders`. Open it. - -The operation was successful if the page shows the (possibly empty `[]`) list of orders. - -#### **kubectl** - -Run: - -```bash -curl https://orders-service.$CLUSTER_DOMAIN/orders -``` - -The operation was successful if the command returns the (possibly empty `[]`) list of orders. - - diff --git a/docs/02-get-started/04-trigger-workload-with-event.md b/docs/02-get-started/04-trigger-workload-with-event.md deleted file mode 100644 index f6c05b4d49cd..000000000000 --- a/docs/02-get-started/04-trigger-workload-with-event.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -title: Trigger a workload with an event ---- - -We already know how to create and expose a workload ([Function](02-deploy-expose-function.md) and [microservice](03-deploy-expose-microservice.md)). -Now it's time to actually use an event to trigger a workload. - -## Create a Function - -First, create a sample Function that prints out the received event to console: - - - -#### **Kyma Dashboard** - -1. Go to **Namespaces** and select the `default` Namespace. -2. Go to **Workloads** > **Functions** and click **Create Function +**. -3. Name the Function `lastorder`. -4. From the **Language** dropdown, choose `JavaScript`. -5. From the **Runtime** dropdown, choose one of the available `nodejs`. -6. In the **Source** section, replace its source with the following code: - ```js - module.exports = { - main: async function (event, context) { - console.log("Received event:", event.data); - return; - } - } - ``` -7. Click **Create**. -8. Wait a few seconds for the Function to have the status `RUNNING`. - -#### **kubectl** - -Run: - -```bash -cat < **NOTE:** You might need to wait a few seconds for the Function to be ready. - - - -## Create a Subscription - -Next, to subscribe to events, we need a Subscription custom resource. We're going to subscribe to events of the type `order.received.v1`. -All the published events of this type are then forwarded to an HTTP endpoint called `Sink`. You can define this endpoint in the Subscription's spec. - - - -#### **Kyma Dashboard** - -1. Go to **Namespaces** and select the `default` Namespace. -2. Go to **Configuration** > **Subscriptions** and click **Create Subscription+**. -3. Provide the following parameters: - - **Subscription name**: `lastorder-sub` - - **Types**: `order.received.v1` - - **Service**: `lastorder` (The sink field will be populated automatically.) - - **Type matching**: `standard` - - **Source**: `myapp` - -4. Click **Create**. -5. Wait a few seconds for the Subscription to have status `READY`. - -#### **kubectl** - -Run: -```bash -cat < - -## Trigger the workload with an event - -We created the `lastorder` Function and subscribed to the `order.received.v1` event by creating a Subscription CR. Now it's time to publish your event and trigger the Function. In this example, we'll port-forward the Kyma Eventing Service to localhost. - -1. Port-forward the Kyma Eventing Service to localhost. We will use port `3000`. In your terminal, run: - ```bash - kubectl -n kyma-system port-forward service/eventing-publisher-proxy 3000:80 - ``` -2. Now publish an event to trigger your Function. In another terminal window, run: - - - -#### **curl** - - ```bash - curl -v -X POST \ - -H "ce-specversion: 1.0" \ - -H "ce-type: order.received.v1" \ - -H "ce-source: myapp" \ - -H "ce-eventtypeversion: v1" \ - -H "ce-id: 759815c3-b142-48f2-bf18-c6502dc0998f" \ - -H "content-type: application/json" \ - -d "{\"orderCode\":\"3211213\"}" \ - http://localhost:3000/publish - ``` - - #### **CloudEvents Conformance Tool** - - ```bash - cloudevents send http://localhost:3000/publish \ - --type order.received.v1 \ - --id 759815c3-b142-48f2-bf18-c6502dc0998f \ - --source myapp \ - --datacontenttype application/json \ - --data "{\"orderCode\":\"3211213\"}" \ - --yaml - ``` - - - -## Verify the event delivery - -To verify that the event was properly delivered, check the logs of the Function: - - - -#### **Kyma Dashboard** - -1. In Kyma Dashboard, return to the view of your `lastorder` Function. -2. In the **Code** view, find the **Replicas of the Function** section. -3. Click the name of your replica. -4. Locate the **Containers** section and click on **View Logs**. -5. You see the received event in the logs: - ``` - Received event: { orderCode: '3211213' } - ``` - -#### **kubectl** - -Run: - -```bash -kubectl logs \ - -n default \ - -l serverless.kyma-project.io/function-name=lastorder,serverless.kyma-project.io/resource=deployment \ - -c function -``` - -You see the received event in the logs: -``` -Received event: { orderCode: '3211213' } -``` - - - -That's it! - -Go ahead and dive a little deeper into the Kyma documentation for [tutorials](../03-tutorials), [operation guides](../04-operation-guides), and [technical references](../05-technical-reference), as well as information on the [main areas in Kyma](../01-overview/). Happy Kyma-ing! diff --git a/docs/02-get-started/08-install-uninstall-upgrade-kyma-module.md b/docs/02-get-started/08-install-uninstall-upgrade-kyma-module.md deleted file mode 100644 index 87925850cf43..000000000000 --- a/docs/02-get-started/08-install-uninstall-upgrade-kyma-module.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Install, uninstall and upgrade Kyma with a module ---- - -This guide shows how to quickly install, uninstall or upgrade Kyma with specific modules. To see the list of all available and planned Kyma modules, go to [Kyma modules](../README.md#kyma-modules). - -> **NOTE:** This guide describes installation of standalone Kyma with specific modules. If you are using SAP BTP, Kyma runtime (SKR), read [Enable and Disable a Kyma Module](https://help.sap.com/docs/btp/sap-business-technology-platform/enable-and-disable-kyma-module?locale=en-US&version=Cloud) instead. - -## Install Kyma with a module - -To install a module, deploy its module manager and apply the module configuration. The operation installs a Kyma module of your choice on a Kubernetes cluster. See the already available Kyma modules with their quick installation steps and links to their GitHub repositories: - -### Prerequisites - -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) -- Kubernetes cluster, or [k3d](https://k3d.io) (v5.x or higher) for local installation -- `kyma-system` Namespace created - -### Steps - -#### [Application Connector](https://github.com/kyma-project/application-connector-manager) - -```bash -kubectl apply -f https://github.com/kyma-project/application-connector-manager/releases/latest/download/application-connector-manager.yaml -kubectl apply -f https://github.com/kyma-project/application-connector-manager/releases/latest/download/default_application_connector_cr.yaml -n kyma-system -``` - -#### [Keda](https://github.com/kyma-project/keda-manager) - -```bash -kubectl apply -f https://github.com/kyma-project/keda-manager/releases/latest/download/keda-manager.yaml -kubectl apply -f https://github.com/kyma-project/keda-manager/releases/latest/download/keda-default-cr.yaml -n kyma-system -``` - -#### [SAP BTP Operator](https://github.com/kyma-project/btp-manager) - -```bash -kubectl apply -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-manager.yaml -kubectl apply -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-operator-default-cr.yaml -n kyma-system -``` - -> **CAUTION:** The CR is in the `Warning` state and the message is `Secret resource not found reason: MissingSecret`. To create a Secret, follow the instructions in the [`btp-manager`](https://github.com/kyma-project/btp-manager/blob/main/docs/user/02-10-usage.md#create-and-install-secret) repository. - -#### [Serverless](https://github.com/kyma-project/serverless-manager) - -```bash -kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/latest/download/serverless-operator.yaml -kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/latest/download/default-serverless-cr.yaml -n kyma-system -``` - -#### [Telemetry](https://github.com/kyma-project/telemetry-manager) - -```bash -kubectl apply -f https://github.com/kyma-project/telemetry-manager/releases/latest/download/telemetry-manager.yaml -kubectl apply -f https://github.com/kyma-project/telemetry-manager/releases/latest/download/telemetry-default-cr.yaml -n kyma-system -``` - -#### [NATS](https://github.com/kyma-project/nats-manager) - -```bash -kubectl apply -f https://github.com/kyma-project/nats-manager/releases/latest/download/nats-manager.yaml -kubectl apply -f https://github.com/kyma-project/nats-manager/releases/latest/download/nats_default_cr.yaml -n kyma-system -``` - -#### [API Gateway](https://github.com/kyma-project/api-gateway) - -```bash -kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/api-gateway-manager.yaml -kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/apigateway-default-cr.yaml -``` - -#### [Istio](https://github.com/kyma-project/istio) - -```bash -kubectl apply -f https://github.com/kyma-project/istio/releases/latest/download/istio-manager.yaml -kubectl apply -f https://github.com/kyma-project/istio/releases/latest/download/istio-default-cr.yaml -``` - -## Uninstall Kyma with a module - -You uninstall Kyma with a module using the `kubectl delete` command. - -1. Find out the paths for the module you want to disable; for example, from the [Install Kyma with a module](#install-kyma-with-a-module) section. - -2. Delete the module configuration: - - ```bash - kubectl delete {PATH_TO_THE_MODULE_CUSTOM_RESOURCE} - ``` - -3. To avoid leaving some resources behind, wait for the module custom resource deletion to be complete. - -4. Delete the module manager: - - ```bash - kubectl delete {PATH_TO_THE_MODULE_MANAGER_YAML_FILE} - ``` - -## Upgrade a Kyma module - -To upgrade a Kyma module to the latest version, run the same `kubectl` commands used for its installation. diff --git a/docs/02-get-started/08-uninstall-upgrade-kyma-module.md b/docs/02-get-started/08-uninstall-upgrade-kyma-module.md new file mode 100644 index 000000000000..c9f9f523437e --- /dev/null +++ b/docs/02-get-started/08-uninstall-upgrade-kyma-module.md @@ -0,0 +1,33 @@ +# Uninstall and upgrade Kyma with a module + +This guide shows how to quickly uninstall or upgrade Kyma with specific modules. + +> **NOTE:** This guide describes uninstallation and upgrade of standalone Kyma with specific modules. If you are using SAP BTP, Kyma runtime (SKR), read [Enable and Disable a Kyma Module](https://help.sap.com/docs/btp/sap-business-technology-platform/enable-and-disable-kyma-module?locale=en-US&version=Cloud) instead. + +## Uninstall Kyma with a module + +You uninstall Kyma with a module using the `kubectl delete` command. + +1. Find out the paths for the module you want to disable; for example, from the [Install Kyma with a module](./01-quick-install.md#steps) document. + +2. Delete the module configuration: + + ```bash + kubectl delete {PATH_TO_THE_MODULE_CUSTOM_RESOURCE} + ``` + +3. To avoid leaving some resources behind, wait for the module custom resource deletion to be complete. + +4. Delete the module manager: + + ```bash + kubectl delete {PATH_TO_THE_MODULE_MANAGER_YAML_FILE} + ``` + +## Upgrade a Kyma module + +To upgrade a Kyma module to the latest version, run the same `kubectl` commands used for its [installation](./01-quick-install.md). + +## Related links + +To see the list of all available Kyma modules, go to [Kyma modules](../06-modules/README.md). diff --git a/docs/02-get-started/README.md b/docs/02-get-started/README.md index f8bc58e0aed2..652fc9418a08 100644 --- a/docs/02-get-started/README.md +++ b/docs/02-get-started/README.md @@ -1,37 +1,3 @@ ---- -title: Get Started ---- +# Get Started -This set of Get Started guides shows you how to set sail with Kyma and demonstrates its main use cases. - -All guides, whenever possible, demonstrate the steps in both kubectl and Kyma Dashboard. -All the steps are performed in the `default` Namespace. - -## Prerequisites - -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) (v1.26 or higher) -- [curl](https://github.com/curl/curl) -- [k3d](https://k3d.io) (v5.4.9 or higher with [a Kubernetes version supported by Kyma](../04-operation-guides/operations/02-install-kyma.md)) -- [Kyma CLI](../04-operation-guides/operations/01-install-kyma-CLI.md) -- [The Serverless module enabled](08-install-uninstall-upgrade-kyma-module.md) -- [The API Gateway module enabled](08-install-uninstall-upgrade-kyma-module.md) -- Minimum Docker resources: 4 CPUs and 8 GB RAM - > **NOTE:** Learn how to adjust these Docker values on [Mac](https://docs.docker.com/desktop/settings/mac/#resources), [Windows](https://docs.docker.com/desktop/settings/windows/#resources), or [Linux](https://docs.docker.com/desktop/settings/linux/#resources). -- (Optional) [CloudEvents Conformance Tool](https://github.com/cloudevents/conformance) for [triggering workloads with events](./04-trigger-workload-with-event.md) - ```bash - go install github.com/cloudevents/conformance/cmd/cloudevents@latest - ``` - - Alternatively, you can just use `curl` to publish events. -- Istio sidecar injection enabled in the `default` Namespace - >**NOTE:** Read about [Istio sidecars in Kyma and why you want them](https://kyma-project.io/#/istio/user/00-30-overview-istio-sidecars). Then, check how to [enable automatic Istio sidecar proxy injection](https://kyma-project.io/#/istio/user/operation-guides/02-20-enable-sidecar-injection). For more details, see [Default Istio setup in Kyma](https://kyma-project.io/#/istio/user/00-40-overview-istio-setup). - -## Steps - -These guides cover the following steps: - -1. [Deploy and expose a Function](02-deploy-expose-function.md), which shows how to deploy a sample function in a matter of seconds and how to expose it through the APIRule custom resource (CR) on HTTP endpoints. This way it will be available for other services outside the cluster. -2. [Deploy and expose a microservice](03-deploy-expose-microservice.md), which demonstrates how to create a sample microservice and, as before, how to expose it so that it is available for other services outside the cluster. -3. [Trigger your workload with an event](04-trigger-workload-with-event.md), which shows how to trigger your Function or microservice with a sample event. - -Let's get started! + diff --git a/docs/02-get-started/_sidebar1.md b/docs/02-get-started/_sidebar1.md deleted file mode 100644 index 2a4dddb1d963..000000000000 --- a/docs/02-get-started/_sidebar1.md +++ /dev/null @@ -1,7 +0,0 @@ -* [Home](/) -* [Module quick install](08-install-uninstall-upgrade-kyma-module.md) -* [Get Started](README.md) - * [Kyma quick install](01-quick-install.md) - * [Deploy and expose a Function](02-deploy-expose-function.md) - * [Deploy and expose a microservice](03-deploy-expose-microservice.md) - * [Trigger a workload with an event](04-trigger-workload-with-event.md) diff --git a/docs/03-tutorials/_sidebar1.md b/docs/03-tutorials/_sidebar1.md deleted file mode 100644 index ee751089c99c..000000000000 --- a/docs/03-tutorials/_sidebar1.md +++ /dev/null @@ -1,6 +0,0 @@ -* [Home](/) - -* [Developer Tutorials](/03-tutorials/README.md) - * [Application Connectivity](/03-tutorials/00-application-connectivity/README.md) - * [Observability](/03-tutorials/00-observability.md) - diff --git a/docs/04-operation-guides/_sidebar1.md b/docs/04-operation-guides/_sidebar1.md deleted file mode 100644 index e42f38554a7d..000000000000 --- a/docs/04-operation-guides/_sidebar1.md +++ /dev/null @@ -1,5 +0,0 @@ -* [Home](/) -* [Operation Guides](README.md) - * [Operations](operations/README.md) - * [Security](security/README.md) - * [Troubleshooting](troubleshooting/README.md) diff --git a/docs/04-operation-guides/operations/01-install-kyma-CLI.md b/docs/04-operation-guides/operations/01-install-kyma-CLI.md deleted file mode 100644 index e2c0466c42f3..000000000000 --- a/docs/04-operation-guides/operations/01-install-kyma-CLI.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Install Kyma CLI ---- - -You can easily install Kyma CLI on macOS, Linux, or Windows. To do so, perform the instructions described in the respective section. - - - -#### **macOS** - -To install Kyma CLI on macOS, run: - -```bash -curl -Lo kyma.tar.gz "https://github.com/kyma-project/cli/releases/download/$(curl -s https://api.github.com/repos/kyma-project/cli/releases/latest | grep tag_name | cut -d '"' -f 4)/kyma_Darwin_x86_64.tar.gz" \ -&& mkdir kyma-release && tar -C kyma-release -zxvf kyma.tar.gz && chmod +x kyma-release/kyma && sudo mv kyma-release/kyma /usr/local/bin \ -&& rm -rf kyma-release kyma.tar.gz -``` - -### Homebrew - -To install Kyma CLI using Homebrew, run: - -```bash -brew install kyma-cli -``` - -If the Homebrew team does not update the Homebrew formula of the CLI within three days of the release, follow this [guide](https://github.com/Homebrew/brew/blob/master/docs/How-To-Open-a-Homebrew-Pull-Request.md) to update it manually to the most recent version. For a sample Homebrew Kyma CLI formula version bump, see [this PR](https://github.com/Homebrew/homebrew-core/pull/52375). - -#### **Linux** - -To install Kyma CLI on Linux, run: - -```bash -curl -Lo kyma.tar.gz "https://github.com/kyma-project/cli/releases/download/$(curl -s https://api.github.com/repos/kyma-project/cli/releases/latest | grep tag_name | cut -d '"' -f 4)/kyma_Linux_x86_64.tar.gz" \ -&& mkdir kyma-release && tar -C kyma-release -zxvf kyma.tar.gz && chmod +x kyma-release/kyma && sudo mv kyma-release/kyma /usr/local/bin \ -&& rm -rf kyma-release kyma.tar.gz -``` - -#### **Windows** - -To install Kyma CLI on Windows, download and unzip the [release artifact](https://github.com/kyma-project/cli/releases). Change the path to point to the desired version and architecture (`x86_64` or `i386`). - -```PowerShell -Invoke-WebRequest -OutFile kyma.zip https://github.com/kyma-project/cli/releases/download/${KYMA_VERSION}/kyma_Windows_${ARCH}.zip - -Expand-Archive -Path kyma.zip -DestinationPath .\kyma-cli - -cd kyma-cli -``` - -### Chocolatey (Windows) - -To install Kyma CLI on Windows using [Chocolatey](https://www.chocolatey.org), run: - -```PowerShell -choco install kyma-cli -``` - -You don't have to bump Kyma CLI Chocolatey package manually with each new release, as it includes a script that automatically checks for new releases and updates the package to the latest one. - -Still, the package requires some maintenance to keep its dedicated [site](https://chocolatey.org/packages/kyma-cli) at`chocolatey.org` up to date. This means you should regularly update the description, details, screenshots, etc. To keep the site up to date, submit a pull request to [Chocolatey's GitHub repository](https://github.com/dgalbraith/chocolatey-packages/tree/master/automatic/kyma-cli). - -#### **other** - -To install a different release version, change the path to point to the desired version and architecture: - -```bash -curl -Lo kyma.tar.gz https://github.com/kyma-project/cli/releases/download/${KYMA_VERSION}/kyma_${ARCH}.tar.gz -``` - - diff --git a/docs/04-operation-guides/operations/02-install-kyma.md b/docs/04-operation-guides/operations/02-install-kyma.md deleted file mode 100644 index 5c9df3f74cf5..000000000000 --- a/docs/04-operation-guides/operations/02-install-kyma.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: Install Kyma ---- - ->**NOTE:** This guide shows how to install classic Kyma with a set of predefined components. To learn how to install Kyma with a module, go to [Install, uninstall and upgrade Kyma with a module](../../02-get-started/08-install-uninstall-upgrade-kyma-module.md#install-kyma-with-a-module). - -You can simply use the default Kyma installation, or modify it as it fits your purposes. - -Meet the prerequisites, provision a k3d cluster, and use the `deploy` command to run Kyma locally. - -## Prerequisites - ->**CAUTION:** As of version 1.20, [Kubernetes deprecated Docker](https://kubernetes.io/blog/2020/12/02/dont-panic-kubernetes-and-docker/) as a container runtime in favor of [containerd](https://containerd.io/). Due to a different way in which containerd handles certificate authorities, Kyma's built-in Docker registry does not work correctly on clusters running with a self-signed TLS certificate on top of Kubernetes installation where containerd is used as a container runtime. If that is your case, either upgrade the cluster to use Docker instead of containerd, generate a valid TLS certificate for your Kyma instance or [configure an external Docker registry](https://kyma-project.io/#/serverless-manager/user/00-20-configure-serverless?id=configure-docker-registry). - -- [Kubernetes](https://kubernetes.io/docs/setup/) (supported version 1.26) - - [k3d](https://k3d.io) (for local installation only, v5.0.0 or higher) -- [Kyma CLI](https://github.com/kyma-project/cli) -- Minimum Docker resources: 4 CPUs and 8 GB RAM (learn how to adjust the values on [Mac](https://docs.docker.com/desktop/settings/mac/#resources), [Windows](https://docs.docker.com/desktop/settings/windows/#resources), or [Linux](https://docs.docker.com/desktop/settings/linux/#resources)). - -## Provision and install - -> **CAUTION:** Installation on a local k3d cluster currently does not work on Apple M1 SoC. - -You can either use an out-of-the-box k3d cluster or choose any other cluster provider. To quickly provision a k3d cluster, run: - - ```bash - kyma provision k3d - ``` - - But you can do more. To define the name of your k3d cluster and pass arguments to the Kubernetes API server, for example, to log to stderr, run: - - ```bash - kyma provision k3d --name='{CUSTOM_NAME}' --k3s-arg='--alsologtostderr@server:0' - ``` - -> **NOTE:** If you're on Linux and provisioning k3d fails, follow the [troubleshooting guide](../troubleshooting/01-k3d-fails-on-linux.md). - -## Default installation - -Use the `deploy` command to install Kyma. - - ```bash - kyma deploy - ``` - -With Kyma installed on a local k3d cluster, access Kyma Dashboard using `kyma dashboard`. The command opens a browser and takes you to localhost with the web-based administrative UI for Kyma. Use the same command to access Kyma installed on a remote cluster. - -## Choose resource consumption - -By default, Kyma is installed with the default chart values defined in the `values.yaml` files. You can also control the allocation of resources, such as memory and CPU, that the components consume by installing Kyma with the following pre-defined profiles: - -- **Evaluation** needs limited resources and is suited for trial purposes. -- **Production** is configured for high availability and scalability. It requires more resources than the evaluation profile but is a better choice for production workload. - -For example, to install Kyma with the evaluation profile, run the following command: - - ```bash - kyma deploy -p evaluation - ``` - ->**NOTE:** You can check the values used for each component in respective folders of the [`resources`](https://github.com/kyma-project/kyma/tree/main/resources) directory. The `profile-evaluation.yaml` and `profile-production.yaml` files contain values used for the evaluation and production profiles respectively. If the component doesn't have files for the given profiles, the profile values are the same as default chart values defined in the `values.yaml` file. - -A profile is defined globally for the whole Kyma installation. It's not possible to install a profile only for the selected components. However, you can [change the settings](03-change-kyma-config-values.md) by overriding the values set for the profile. The profile values have precedence over the default chart values, and override values have precedence over the applied profile. - -## Install specific configuration values - -- To install Kyma with different configuration values, use the `--values-file` and the `--value` flags. For details, see [Change Kyma settings](03-change-kyma-config-values.md). - -## Install with custom domain - -If you install Kyma on a remote cluster, you can use the out-of-the box `kyma.example.com` domain. All you need to do is get your load balancer IP address and add the following line to the `hosts` file: - - ```bash - {load_balancer_IP} oauth2.kyma.example.com registry.kyma.example.com connector-service.kyma.example.com gateway.kyma.example.com - ``` - -To install Kyma using your own domain name, you must provide the certificate and key as files. If you don't have a certificate yet, you can create a self-signed certificate and key: - - ```bash - openssl req -x509 -newkey rsa:4096 -keyout key.pem -out crt.pem -days 365 - ``` - - When prompted, provide your credentials, such as your name and your domain, as wildcard: `*.$DOMAIN`. - - Then, pass the certificate files to the `deploy` command: - - ```bash - kyma deploy --domain {DOMAIN} --value global.ingress.domainName={DOMAIN} --tls-crt crt.pem --tls-key key.pem - ``` - -## Install from a specific source - -Optionally, you can specify from which source you want to deploy Kyma. For example, you can choose the `main` branch (or any other branch on the Kyma repository), a specific PR, or a release version. For more details, see the documentation for the `deploy` command. - -For example, to install Kyma from a specific version, such as `1.19.1`, run: - - ```bash - kyma deploy --source=1.19.1 - ``` - -- Alternatively, to build Kyma from your local sources and deploy it on a remote cluster, run: - - ```bash - kyma deploy --source=local - ``` - - >**NOTE:** By default, Kyma expects to find local sources in the `$GOPATH/src/github.com/kyma-project/kyma` folder. To adjust the path, set the `-w ${PATH_TO_KYMA_SOURCES}` parameter. - -## Install specific components - -To deploy Kyma with only specific components, run: - - ```bash - kyma deploy --components-file {COMPONENTS_FILE_PATH} - ``` - - `{COMPONENTS_FILE_PATH}` is the path to a YAML file containing the desired component list to be installed. In the following example, only seven components are deployed on the cluster: - - ```yaml -prerequisites: - - name: "istio" - namespace: "istio-system" - - name: "certificates" - namespace: "istio-system" -components: - - name: "eventing" - ``` - -- Alternatively, you can specify single components instead of a file: - - ```bash - kyma deploy --component {COMPONENT_NAME@NAMESPACE} - ``` - - If you provide no Namespace, the default Namespace called `kyma-system` is used. For example, to install the `eventing` component in the default Namespace and the `istio` component in the `istio-system` Namespace, run: - - ```bash - kyma deploy --component eventing --component istio@istio-system - ``` - ->**TIP:** To see a complete list of all Kyma components, go to the [`components.yaml`](https://github.com/kyma-project/kyma/blob/main/installation/resources/components.yaml) file. diff --git a/docs/04-operation-guides/operations/03-change-kyma-config-values.md b/docs/04-operation-guides/operations/03-change-kyma-config-values.md deleted file mode 100644 index 70e6099cd3b0..000000000000 --- a/docs/04-operation-guides/operations/03-change-kyma-config-values.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Change Kyma settings ---- - -To change your Kyma settings, you simply deploy the same Kyma version that you're currently using, just with different configuration values. - -You can use the `--values-file` and the `--value` flag. - -- To override the standard Kyma configuration, run: - - ```bash - kyma deploy --values-file {VALUES_FILE_PATH} - ``` - - In the following example, `{VALUES_FILE_PATH}` is the path to a YAML file containing the desired configuration: - - - For `global`, the values of `images.istio_pilot.version`, `images.istio_pilot.directory` and `containerRegistry.path` will be overridden to `1.11.4`, `istio` and `docker.io` respectively. - - ```yaml - global: - containerRegistry: - path: docker.io - images: - istio_pilot: - version: 1.11.4 - directory: "istio" - ``` - -- You can also provide multiple values files at the same time: - - ```bash - kyma deploy --values-file {VALUES_FILE_1_PATH} --values-file {VALUES_FILE_2_PATH} - ``` - -> **NOTE:** If a value is defined in several files, the value of the last file in the list is used. - -- Alternatively, you can specify single values instead of a file: - - ```bash - kyma deploy - --value global.images.istio_pilot.version=1.11.4 \ - --value global.images.istio_pilot.directory="istio" - ``` - -> **NOTE:** If a value is defined several times, the last value definition in the list is used. The `--value` flag also overrides any conflicting value that is defined with a `--value-file` flag. diff --git a/docs/04-operation-guides/operations/05-upgrade-kyma.md b/docs/04-operation-guides/operations/05-upgrade-kyma.md deleted file mode 100644 index 3fb9f748ddc1..000000000000 --- a/docs/04-operation-guides/operations/05-upgrade-kyma.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Upgrade or Downgrade Kyma ---- - -## Upgrade - -You can use the `deploy` command not only to install Kyma, but also to upgrade the Kyma version on the cluster. For example, you can specify the sources, components, and configuration values you want to use. - -For code examples, see [Install Kyma](02-install-kyma.md). - -> **NOTE:** If you upgrade from one Kyma release to a newer one, the automatic compatibility check compares your current version and the new release.
-The compatibility check only works with release versions. If you installed Kyma from a PR, branch, revision, or local version, the compatibility cannot be checked. - -> **CAUTION:** Zero-downtime upgrades are not supported. - -## Downgrade - -Downgrading your Kyma version is not supported. - -> **NOTE:** To learn how to upgrade a Kyma module go to [Install, uninstall and upgrade a Kyma module](../../02-get-started/08-install-uninstall-upgrade-kyma-module.md#upgrade-a-kyma-module). diff --git a/docs/04-operation-guides/operations/07-uninstall-kyma.md b/docs/04-operation-guides/operations/07-uninstall-kyma.md deleted file mode 100644 index 97378448548f..000000000000 --- a/docs/04-operation-guides/operations/07-uninstall-kyma.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Uninstall Kyma or components ---- - -To remove Kyma from a running Kubernetes cluster, use the `kyma undeploy` Kyma CLI command. - -If you only want to remove single components, go to your [Helm](https://helm.sh/) client and modify the components as you need them. - -> **NOTE:** To learn how to uninstall a Kyma module go to [Install, uninstall and upgrade Kyma with a module](../../02-get-started/08-install-uninstall-upgrade-kyma-module.md#uninstall-kyma-with-a-module). diff --git a/docs/04-operation-guides/operations/README.md b/docs/04-operation-guides/operations/README.md index 323ef2982502..305aa101ce50 100644 --- a/docs/04-operation-guides/operations/README.md +++ b/docs/04-operation-guides/operations/README.md @@ -2,14 +2,9 @@ title: Operations --- -Here you can find general instructions on how to install and maintain Kyma. This includes instructions on how to install, upgrade, and uninstall Kyma, how to change the default Kyma configuration, and how to create a backup. +Here you can find general instructions on how to maintain Kyma. This is a complete list of Kyma operation guides: -* [Install Kyma CLI](01-install-kyma-CLI.md) -* [Install Kyma](02-install-kyma.md) -* [Change Kyma settings](03-change-kyma-config-values.md) -* [Uninstall Kyma or components](07-uninstall-kyma.md) * [Back up Kyma](10-backup-kyma.md) * [Access Kyma application logs](obsv-01-access-logs.md) -* [Enable Kyma with Runtime Agent](ra-01-enable-kyma-with-runtime-agent.md) \ No newline at end of file diff --git a/docs/04-operation-guides/operations/_sidebar1.md b/docs/04-operation-guides/operations/_sidebar1.md deleted file mode 100644 index d712a2405cee..000000000000 --- a/docs/04-operation-guides/operations/_sidebar1.md +++ /dev/null @@ -1,10 +0,0 @@ -* [Home](/) -* [Operation Guides](../README.md) -* [Operations](README.md) - * [Install Kyma CLI](01-install-kyma-CLI.md) - * [Install Kyma](02-install-kyma.md) - * [Change Kyma settings](03-change-kyma-config-values.md) - * [Uninstall Kyma or components](07-uninstall-kyma.md) - * [Back up Kyma](10-backup-kyma.md) - * [Access Kyma application logs](obsv-01-access-logs.md) - * [Enable Kyma with Runtime Agent](ra-01-enable-kyma-with-runtime-agent.md) \ No newline at end of file diff --git a/docs/04-operation-guides/operations/metadata.yaml b/docs/04-operation-guides/operations/metadata.yaml deleted file mode 100644 index fbb5effd5885..000000000000 --- a/docs/04-operation-guides/operations/metadata.yaml +++ /dev/null @@ -1 +0,0 @@ -displayName: Operations diff --git a/docs/04-operation-guides/operations/ra-01-enable-kyma-with-runtime-agent.md b/docs/04-operation-guides/operations/ra-01-enable-kyma-with-runtime-agent.md deleted file mode 100644 index d94760515d0d..000000000000 --- a/docs/04-operation-guides/operations/ra-01-enable-kyma-with-runtime-agent.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Enable Kyma with Runtime Agent ---- - -[Runtime Agent](../../01-overview/application-connectivity/ra-01-runtime-agent-overview.md) is a component that is used in the [Compass mode](../../01-overview/application-connectivity/README.md) of Application Connectivity. -By default, Kyma uses the [standalone Application Connectivity mode](../../01-overview/application-connectivity/README.md), which does not support integration with Compass. -Because of this, on installation, you must: -- Disable the components used in the standalone mode by setting the **global.disableLegacyConnectivity** value to `true`, and -- Add the `compass-runtime-agent` module in the `kyma-system` Namespace to the [list of components](https://github.com/kyma-project/kyma/blob/main/installation/resources/components.yaml) - -```yaml -kyma deploy --value global.disableLegacyConnectivity="true" --components-file {YOUR_COMPONENTS_FILE_PATH} -``` - ->**TIP:** Read more about how to [change Kyma settings](03-change-kyma-config-values.md) and [install Kyma with specific components](02-install-kyma.md#install-specific-components). \ No newline at end of file diff --git a/docs/05-technical-reference/00-api-overview/README.md b/docs/05-technical-reference/00-api-overview/README.md index 82e8557eb831..3272f825a227 100644 --- a/docs/05-technical-reference/00-api-overview/README.md +++ b/docs/05-technical-reference/00-api-overview/README.md @@ -1,10 +1,10 @@ ---- -title: API Overview ---- +# API Overview Kyma API versioning and deprecation closely follows the Kubernetes API versioning and deprecation policy. Hence, this document is based on the Kubernetes official documentation. -## API versioning (derived from [API Overview](https://kubernetes.io/docs/reference/using-api/#api-versioning)) +## API versioning + +(Derived from [API Overview](https://kubernetes.io/docs/reference/using-api/#api-versioning)) Different API versions indicate different levels of stability and support. @@ -30,7 +30,9 @@ Here's a summary of each level: - The version name is `vX`, where `X` is an integer. - The stable versions of features appear in released software for many subsequent versions. -## Deprecating parts of the API (derived from [Kubernetes Deprecation Policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecating-parts-of-the-api)) +## Deprecating parts of the API + +(Derived from [Kubernetes Deprecation Policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecating-parts-of-the-api)) API versions fall into 3 main tracks. Each of the tracks has different policies for deprecation: diff --git a/docs/05-technical-reference/00-cli-commands/README.md b/docs/05-technical-reference/00-cli-commands/README.md deleted file mode 100644 index acad8cf87d7c..000000000000 --- a/docs/05-technical-reference/00-cli-commands/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: CLI commands ---- - -This section contains the list of all commands provided by Kyma CLI, together with their synopsis and flags. - -See [the full list of commands and flags](https://github.com/kyma-project/cli/tree/main/docs/gen-docs). diff --git a/docs/05-technical-reference/00-cli-commands/metadata.yaml b/docs/05-technical-reference/00-cli-commands/metadata.yaml deleted file mode 100644 index 85c0e5a45a62..000000000000 --- a/docs/05-technical-reference/00-cli-commands/metadata.yaml +++ /dev/null @@ -1 +0,0 @@ -displayName: CLI commands diff --git a/docs/05-technical-reference/apix-01-config-authorizations-apigateway.md b/docs/05-technical-reference/apix-01-config-authorizations-apigateway.md deleted file mode 100644 index ee72ae06c5f8..000000000000 --- a/docs/05-technical-reference/apix-01-config-authorizations-apigateway.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Configure Authorization (OAuth2, JWT) ---- - -With the API Gateway Controller, you can secure the services you expose in the following ways: - -- with OAuth2 tokens -- with JWT tokens -- with both OAuth2 and JWT tokens - -If you secure a service with either OAuth2 or JWT tokens, by default, you must include a valid OAuth2 or JWT token in the `Authorization` header of the call to the service. - -If you secure a service with both OAuth2 and JWT, by default, the Oathkeeper proxy expects OAuth2 tokens in the `Authorization` header of incoming calls. For endpoints secured with JWT, you must define the header from which the system extracts the JWT token for every **accessStrategy** you define. Set the **token_from.location** parameter to `header:{NAME}` to extract the JWT token from a specific header. You can use any header name different from `Authorization`. - -Alternatively, you can set the **token_from.location** parameter to `query_parameter:{NAME}` to extract the token from a specific query parameter. - ->**TIP:** You can define the location of OAuth2 token through the **token_from.location** parameter. However, by default, OAuth2 tokens are extracted from the `Authorization` header. - -## Examples - -See these sample excerpts from APIRule custom resources that show the **rules** attribute for services secured with OAuth2, JWT, and an OAuth2 and JWT combination. - - -
-
- - OAuth2 - - - ```yaml - rules: - - path: /.* - methods: ["GET"] - mutators: [] - accessStrategy: - - handler: oauth2_introspection - config: - required_scope: ["read"] - ``` - - -
-
- - JWT - - - ```yaml - rules: - - path: /.* - methods: ["GET"] - mutators: [] - accessStrategy: - - handler: jwt - config: - trusted_issuers: - - {issuer URL of your custom OpenID Connect-compliant identity provider} - ``` - -
-
- - OAuth2 and JWT - - - ```yaml - rules: - - path: /.* - methods: ["GET"] - mutators: [] - accessStrategy: - - handler: oauth2_introspection - config: - required_scope: ["read"] - - handler: jwt - config: - trusted_issuers: - - {issuer URL of your custom OpenID Connect-compliant identity provider} - token_from: - header: ID-Token - ``` - -
- -
- ->**TIP:** To learn more, read about the [APIRule custom resource](https://kyma-project.io/#/api-gateway/user/custom-resources/apirule/04-10-apirule-custom-resource). You can also follow the [tutorials](https://kyma-project.io/#/api-gateway/user/tutorials/README) to learn how to expose and secure services. diff --git a/docs/_redirects b/docs/_redirects index da8c8bcde5bd..962712f89681 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -34,6 +34,8 @@ /docs/kyma/latest/05-technical-reference/00-custom-resources/telemetry-01-logpipeline /#/telemetry-manager/user/resources/02-logpipeline 301 /docs/kyma/latest/05-technical-reference/00-custom-resources/telemetry-02-logparser /#/telemetry-manager/user/resources/03-logparser 301 /docs/kyma/latest/05-technical-reference/00-custom-resources/telemetry-03-tracepipeline /#/telemetry-manager/user/resources/04-tracepipeline 301 +/#/01-overview/telemetry/README /#/telemetry-manager/user/README 301 +/#/01-overview/observability/README /#/telemetry-manager/user/README 301 # Serverless /docs/kyma/latest/01-overview/serverless/* /#/serverless-manager/user/README 301 @@ -49,14 +51,16 @@ /docs/kyma/latest/05-technical-reference/svls-05-exposing-functions /#/serverless-manager/user/technical-reference/README 301 /docs/kyma/latest/05-technical-reference/svls-06-function-configuration-file /#/serverless-manager/user/technical-reference/07-60-function-configuration-file 301 /docs/kyma/latest/05-technical-reference/svls-08-available-presets /#/serverless-manager/user/technical-reference/07-80-available-presets 301 +/#/01-overview/serverless/README /#/serverless-manager/user/README 301 # Istio -/docs/kyma/latest/01-overview/service-mesh/smsh-02-default-istio-setup-in-kyma /#/istio/user/00-overview/00-40-overview-istio-setup 301 -/docs/kyma/latest/01-overview/service-mesh/* /#/istio/user/00-overview/README 301 -/docs/kyma/latest/04-operation-guides/operations/smsh-01-istio-enable-sidecar-injection.md /#/istio/user/02-operation-guides/operations/02-20-enable-sidecar-injection 301 -/docs/kyma/latest/04-operation-guides/troubleshooting/service-mesh/* /#/istio/user/02-operation-guides/troubleshooting/README 301 -/docs/kyma/latest/05-technical-reference/00-configuration-parameters/smsh-01-istio-chart /#/istio/user/03-technical-reference/configuration-parameters/01-10-istio-controller-parameters 301 -/docs/kyma/latest/05-technical-reference/00-custom-resources/oper-01-istio /#/istio/user/03-technical-reference/istio-custom-resource/01-30-istio-custom-resource 301 +/docs/kyma/latest/01-overview/service-mesh/smsh-02-default-istio-setup-in-kyma /#/istio/user/00-40-overview-istio-setup 301 +/docs/kyma/latest/01-overview/service-mesh/* /#/istio/user/README 301 +/docs/kyma/latest/04-operation-guides/operations/smsh-01-istio-enable-sidecar-injection.md /#/istio/user/operation-guides/operations/02-20-enable-sidecar-injection 301 +/docs/kyma/latest/04-operation-guides/troubleshooting/service-mesh/* /#/istio/user/troubleshooting/README 301 +/docs/kyma/latest/05-technical-reference/00-configuration-parameters/smsh-01-istio-chart /#/istio/user/technical-reference//05-00-istio-controller-parameters 301 +/docs/kyma/latest/05-technical-reference/00-custom-resources/oper-01-istio /#/istio/user/04-00-istio-custom-resource 301 +/#/01-overview/service-mesh/README /#/istio/user/README 301 # API Gateway /docs/kyma/latest/01-overview/api-exposure/apix-03-api-gateway-limitations.md /#/api-gateway/user/00-20-overview-api-rule-controller?id=controller-limitations @@ -64,12 +68,14 @@ /docs/kyma/latest/03-tutorials/00-api-exposure/* /#/api-gateway/user/tutorials/README 301 /docs/kyma/latest/04-operation-guides/troubleshooting/* /#/api-gateway/user/troubleshooting-guides/README /docs/kyma/latest/05-technical-reference/00-custom-resources/apix-01-apirule /#/api-gateway/user/custom-resources/apirule/04-10-apirule-custom-resource +/#/01-overview/api-exposure/README /#/api-gateway/user/README 301 # Eventing /docs/kyma/latest/01-overview/eventing/* /#/eventing-manager/user/README /docs/kyma/latest/03-tutorials/00-eventing/* /#/eventing-manager/user/tutorials/evnt-01-prerequisites /docs/kyma/latest/05-technical-reference/00-custom-resources/evnt-01-subscription.md /#/eventing-manager/user/resources/evnt-cr-subscription /docs/kyma/latest/04-operation-guides/troubleshooting/eventing /#/eventing-manager/user/troubleshooting/evnt-01-eventing-troubleshooting +/#/01-overview/eventing/README /#/eventing-manager/user/README 301 # Application Connector /docs/kyma/latest/01-overview/application-connectivity/README.md /#/application-connector-manager/user/README @@ -78,6 +84,10 @@ /docs/kyma/latest/03-tutorials/00-application-connectivity/* /#/application-connector-manager/user/tutorials/README /docs/kyma/latest/05-technical-reference/00-custom-resources/ac-01-application.md /#/application-connector-manager/user/resources/06-10-application /docs/kyma/latest/05-technical-reference/ac-01-application-gateway-details.md /#/application-connector-manager/user/technical-reference/07-10-application-gateway-details +/#/01-overview/application-connectivity/README /#/application-connector-manager/user/README 301 + +# Service Management +/#/01-overview/service-management/README /#/btp-manager/user/README 301 # General /docs/root/* / 302 diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 50c304701df0..9b232b756f67 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,15 +1,17 @@ * [Kyma Home](/README.md) -* [Kyma Components](/01-overview/README.md) - * [API Exposure](/01-overview/api-exposure/README.md) - * [Service Management](/01-overview/service-management/README.md) - * [User Interfaces](/01-overview/ui/README.md) -* [Get Started](/02-get-started/README.md) - * [Module quick install](08-install-uninstall-upgrade-kyma-module.md) - * [Kyma quick install](01-quick-install.md) - * [Deploy and expose a Function](02-deploy-expose-function.md) - * [Deploy and expose a microservice](03-deploy-expose-microservice.md) - * [Trigger a workload with an event](04-trigger-workload-with-event.md) +* [Quick install](/02-get-started/01-quick-install.md) +* [Modules](/06-modules/README.md) + * [SAP BTP Operator](/btp-manager/user/README.md) + * [Application Connector](/application-connector-manager/user/README.md) + * [Keda](/keda-manager/user/README.md) + * [Serverless](/serverless/user/README.md) + * [Telemetry](/telemetry-manager/user/README.md) + * [NATS](/nats-manager/user/README.md) + * [Eventing](/eventing-manager/user/README.md) + * [API Gateway](/api-gateway/user/README.md) + * [Istio](/istio/user/README.md) +* [User Interfaces](/01-overview/ui/README.md) * [Developer Tutorials](/03-tutorials/README.md) * [Application Connectivity](/03-tutorials/00-application-connectivity/README.md) * [Establish a secure connection with Compass](ra-01-establish-secure-connection-with-compass.md) @@ -17,31 +19,14 @@ * [Revoke a client certificate (RA)](ra-03-revoke-client-certificate.md) * [Configure Runtime Agent with Compass](ra-04-configure-runtime-agent-with-compass.md) * [Reconnect Runtime Agent with Compass](ra-05-reconnect-runtime-agent-with-compass.md) - * [Observability](/03-tutorials/00-observability.md) - * [Service Management](/03-tutorials/00-service-management/smgt-01-deploy-service.md) * [Operation Guides](/04-operation-guides/README.md) * [Operations](/04-operation-guides/operations/README.md) * [Security](/04-operation-guides/security/README.md) * [Troubleshooting](/04-operation-guides/troubleshooting/README.md) * [Technical Reference](/05-technical-reference/README.md) * [API Overview](/05-technical-reference/00-api-overview/README.md) - * [Runtime Agent Architecture](/05-technical-reference/00-architecture/ra-01-runtime-agent-workflow.md) - * [CLI Commands](/05-technical-reference/00-cli-commands/README.md) * [Runtime Agent Connection with Compass](/05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md) * [CompassConnection CR](/05-technical-reference/00-custom-resources/ra-01-compassconnection.md) - * [Configure Authorization (OAuth2, JWT)](/05-technical-reference/apix-01-config-authorizations-apigateway.md) - * [Allowed domains in API Gateway Controller](/05-technical-reference/apix-02-whitelisted-domains.md) - * [Blocked services in API Gateway Controller](/05-technical-reference/apix-03-blacklisted-services.md) * [Configure the runtime](/05-technical-reference/ra-01-configuring-runtime.md) -* [Kyma Modules](/06-modules/README.md) - * [SAP BTP Operator](/btp-manager/user/README.md) - * [Application Connector](/application-connector-manager/user/README.md) - * [Keda](/keda-manager/user/README.md) - * [Serverless](/serverless/user/README.md) - * [Telemetry](/telemetry-manager/user/README.md) - * [NATS](/nats-manager/user/README.md) - * [Eventing](/eventing-manager/user/README.md) - * [API Gateway](/api-gateway/user/README.md) - * [Istio](/istio/user/README.md) * [Glossary](/glossary.md) From 9dac1577be859d5aebd3b2672ead40a89f4f96b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C5=82gorzata=20=C5=9Awieca?= Date: Fri, 8 Dec 2023 14:50:51 +0100 Subject: [PATCH 4/5] Uninstall reference (#18472) --- docs/02-get-started/01-quick-install.md | 3 ++- docs/04-operation-guides/operations/README.md | 5 +++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index 936c25d7b6f3..3eb44e5eb922 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -83,4 +83,5 @@ To get started with Kyma, let's quickly install it with specific modules first. ## Related links -To see the list of all available Kyma modules, go to [Kyma modules](../06-modules/README.md). +- To see the list of all available Kyma modules, go to [Kyma modules](../06-modules/README.md). +- To learn how to [uinstall and upgrade Kyma with a module](./08-uninstall-upgrade-kyma-module.md). diff --git a/docs/04-operation-guides/operations/README.md b/docs/04-operation-guides/operations/README.md index 305aa101ce50..d5a9afe67ee3 100644 --- a/docs/04-operation-guides/operations/README.md +++ b/docs/04-operation-guides/operations/README.md @@ -6,5 +6,6 @@ Here you can find general instructions on how to maintain Kyma. This is a complete list of Kyma operation guides: -* [Back up Kyma](10-backup-kyma.md) -* [Access Kyma application logs](obsv-01-access-logs.md) +* [Back up Kyma](./10-backup-kyma.md) +* [Access Kyma application logs](./obsv-01-access-logs.md) +* [Uninstall and upgrade Kyma with a module](../../02-get-started/08-uninstall-upgrade-kyma-module.md) From c2382ee9829d6c75cc09997d7665104650de9d6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C5=82gorzata=20=C5=9Awieca?= Date: Fri, 8 Dec 2023 15:10:53 +0100 Subject: [PATCH 5/5] Spelling (#18473) --- docs/02-get-started/01-quick-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index 3eb44e5eb922..1cab846f3aa4 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -84,4 +84,4 @@ To get started with Kyma, let's quickly install it with specific modules first. ## Related links - To see the list of all available Kyma modules, go to [Kyma modules](../06-modules/README.md). -- To learn how to [uinstall and upgrade Kyma with a module](./08-uninstall-upgrade-kyma-module.md). +- To learn how to [uninstall and upgrade Kyma with a module](./08-uninstall-upgrade-kyma-module.md).