From 48b66ae9ff85ed1d186d8c9850eb06695670627c Mon Sep 17 00:00:00 2001 From: grego952 Date: Fri, 13 Oct 2023 11:47:52 +0200 Subject: [PATCH 1/2] Improve the AC module documentation --- README.md | 5 ----- docs/user/02-20-enable-kyma-with-runtime-agent.md | 8 +------- .../05-10-application-connector-chart.md | 13 ------------- 3 files changed, 1 insertion(+), 25 deletions(-) delete mode 100644 docs/user/technical-reference/05-10-application-connector-chart.md diff --git a/README.md b/README.md index 5d01e3b8..34409647 100644 --- a/README.md +++ b/README.md @@ -34,15 +34,10 @@ metadata: app.kuberentes.io/managed-by: kustomize app.kubernetes.io/created-by: application-connector-manager name: applicationconnector-sample -spec: - disableLegacyConnectivity : "false" ``` Any update to this CR is intercepted by Application Connector Manager and applied to the Application Connector binaries. -> **NOTE:** At this stage of development, the ApplicationConnector Custom Resource Definition (CRD) contains only one parameter for testing. -> The ApplicationConnector CRD will be extended during further development. - See also: - [Lifecycle Manager documentation](https://github.com/kyma-project/lifecycle-manager#lifecycle-manager) - [Application Connector module documentation](docs/user/README.md) diff --git a/docs/user/02-20-enable-kyma-with-runtime-agent.md b/docs/user/02-20-enable-kyma-with-runtime-agent.md index 9690ddbe..9784d7ce 100644 --- a/docs/user/02-20-enable-kyma-with-runtime-agent.md +++ b/docs/user/02-20-enable-kyma-with-runtime-agent.md @@ -2,12 +2,6 @@ [Runtime Agent](00-30-runtime-agent-overview.md) is a part of the Application Connector module that is used in the [Compass mode](README.md) of Application Connectivity. By default, Kyma uses the [standalone Application Connectivity mode](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} -``` +Because of this, on installation, you must 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). >**TIP:** Read more about how to [change Kyma settings](https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/operations/03-change-kyma-config-values.md) and [install Kyma with specific components](https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/operations/02-install-kyma.md#install-specific-components). \ No newline at end of file diff --git a/docs/user/technical-reference/05-10-application-connector-chart.md b/docs/user/technical-reference/05-10-application-connector-chart.md deleted file mode 100644 index 9ef55969..00000000 --- a/docs/user/technical-reference/05-10-application-connector-chart.md +++ /dev/null @@ -1,13 +0,0 @@ -# Application Connector chart - -To configure the Application Connector (AC) chart, override the default values of its [`values.yaml`](https://github.com/kyma-project/kyma/blob/main/resources/application-connector/values.yaml) file. This document describes parameters that you can configure. - ->**TIP:** See how to [change Kyma settings](https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/operations/03-change-kyma-config-values.md). - -## Configurable parameters - -This table lists the configurable parameters, their descriptions, and default values: - -| Parameter | Description | Default value | -|-----------|-------------|---------------| -| **global.disableLegacyConnectivity** | Disables the default standalone (legacy) connectivity components and enables the Compass mode. | `false` | \ No newline at end of file From b30b1190714c9f5758407635b827fd917d8c6d32 Mon Sep 17 00:00:00 2001 From: grego952 Date: Fri, 13 Oct 2023 12:45:32 +0200 Subject: [PATCH 2/2] apply suggestions from koala7659 review --- README.md | 1 + docs/user/02-20-enable-kyma-with-runtime-agent.md | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 34409647..7978e938 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,7 @@ metadata: app.kuberentes.io/managed-by: kustomize app.kubernetes.io/created-by: application-connector-manager name: applicationconnector-sample +spec: {} ``` Any update to this CR is intercepted by Application Connector Manager and applied to the Application Connector binaries. diff --git a/docs/user/02-20-enable-kyma-with-runtime-agent.md b/docs/user/02-20-enable-kyma-with-runtime-agent.md index 9784d7ce..f0f1f769 100644 --- a/docs/user/02-20-enable-kyma-with-runtime-agent.md +++ b/docs/user/02-20-enable-kyma-with-runtime-agent.md @@ -2,6 +2,5 @@ [Runtime Agent](00-30-runtime-agent-overview.md) is a part of the Application Connector module that is used in the [Compass mode](README.md) of Application Connectivity. By default, Kyma uses the [standalone Application Connectivity mode](README.md), which does not support integration with Compass. -Because of this, on installation, you must 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). >**TIP:** Read more about how to [change Kyma settings](https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/operations/03-change-kyma-config-values.md) and [install Kyma with specific components](https://github.com/kyma-project/kyma/blob/main/docs/04-operation-guides/operations/02-install-kyma.md#install-specific-components). \ No newline at end of file