Merge pull request #207 from grego952/ra-warning-note

Add warning note to the RA docs in the AC module documentation
kyma-project · Mar 22, 2024 · d274a36 · d274a36
2 parents d9dc361 + 619355d
commit d274a36
Show file tree

Hide file tree

Showing 13 changed files with 67 additions and 5 deletions.
diff --git a/docs/user/00-30-runtime-agent-overview.md b/docs/user/00-30-runtime-agent-overview.md
@@ -1,8 +1,34 @@
 # Runtime Agent
 
-Runtime Agent is a part of the Application Connector module that connects to [Compass](https://github.com/kyma-incubator/compass). It is managed by the Application Connector module operator. It is an integral part of every Kyma Runtime in the [Compass mode](README.md), and it fetches the latest configuration from Compass. It also provides Runtime-specific information that is displayed in the Compass UI, such as Runtime UI URL, and it provides Compass with Runtime configuration, such as Event Gateway URL, that should be passed to an Application. To learn more, read the section on [configuring the Runtime](technical-reference/07-20-configuring-runtime.md).
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality. 
+
+Runtime Agent is a Kyma component that connects to [Compass](https://github.com/kyma-incubator/compass). It is an integral part of every Kyma Runtime in the [Compass mode](README.md) and it fetches the latest configuration from Compass. It also provides Runtime-specific information that is displayed in the Compass UI, such as Runtime UI URL, and it provides Compass with Runtime configuration, such as Event Gateway URL, that should be passed to an Application. To learn more, read the section on [configuring the Runtime](technical-reference/07-20-configuring-runtime.md).
 
 The main responsibilities of the component are:
-- Establishing a trusted connection between the Kyma runtime and Compass
-- Renewing a trusted connection between the Kyma runtime and Compass
-- Synchronizing with the [Director](https://github.com/kyma-incubator/compass/blob/master/docs/compass/02-01-components.md#director) by fetching new Applications from the Director, creating them in the Runtime, and removing from the Kyma runtime Applications that no longer exist in the Director.
+- Establishing a trusted connection between the Kyma Runtime and Compass
+- Renewing a trusted connection between the Kyma Runtime and Compass
+- Synchronizing with the [Director](https://github.com/kyma-incubator/compass/blob/master/docs/compass/02-01-components.md#director) by fetching new Applications from the Director and creating them in the Runtime, and removing from the Runtime Applications that no longer exist in the Director.
+
+## Useful Links
+
+If you're interested in learning more about Runtime Agent, follow these links to:
+
+- Perform some simple and more advanced tasks:
+
+    - [Enable Kyma with Runtime Agent](02-20-enable-kyma-with-runtime-agent.md)
+    - [Establish a secure connection with Compass](tutorials/01-60-establish-secure-connection-with-compass.md)
+    - [Maintain a secure connection with Compass](tutorials/01-70-maintain-secure-connection-with-compass.md)
+    - [Revoke a client certificate (RA)](tutorials/01-80-revoke-client-certificate.md)
+    - [Configure Runtime Agent with Compass](tutorials/01-90-configure-runtime-agent-with-compass.md)
+    - [Reconnect Runtime Agent with Compass](tutorials/01-100-reconnect-runtime-agent-with-compass.md)
+
+- Analyze Runtime Agent specification and configuration files:
+
+    - [Compass Connection](resources/06-20-compassconnection.md) custom resource (CR)
+    - [Connection with Compass](technical-reference/05-20-connection-with-compass.md) 
+
+- Understand technicalities behind the Runtime Agent implementation:
+
+    - [Runtime Agent workflow](technical-reference/04-30-runtime-agent-workflow.md)
+    - [Configuring the Runtime](technical-reference/07-20-configuring-runtime.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
@@ -1,4 +1,7 @@
 # Enable Kyma with Runtime Agent
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 [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.
diff --git a/docs/user/README.md b/docs/user/README.md
@@ -14,6 +14,9 @@ Depending on your use case, Application Connectivity works in one of the two mod
 - **Standalone mode** (default) - a standalone mode where Kyma is not connected to [Compass](https://github.com/kyma-incubator/compass)
 - **Compass mode** - using [Runtime Agent](00-30-runtime-agent-overview.md) and integration with [Compass](https://github.com/kyma-incubator/compass) to automate connection and registration of services using mTLS certificates
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 ## Application Connector module
 
 The Application Connector module allows you to install, uninstall, and configure all features of Kyma's Application Connector on your Kubernetes cluster using the Application Connector Manager service.

diff --git a/docs/user/resources/06-10-application.md b/docs/user/resources/06-10-application.md
@@ -33,6 +33,9 @@ spec:
 
 This table lists all the possible parameters of a given resource together with their descriptions:
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 | Parameter   |      Required      |  Description |
 |----------|:-------------:|------|
 | **metadata.name** | Yes | Specifies the name of the CR. |

diff --git a/docs/user/resources/06-20-compassconnection.md b/docs/user/resources/06-20-compassconnection.md
@@ -1,5 +1,8 @@
 # CompassConnection
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 The `compassconnections.compass.kyma-project.io` CustomResourceDefinition (CRD) 
 is a detailed description of the kind of data and the format used to preserve 
 the status of the connection between the Runtime Agent and Compass. 

diff --git a/docs/user/technical-reference/04-30-runtime-agent-workflow.md b/docs/user/technical-reference/04-30-runtime-agent-workflow.md
@@ -1,5 +1,8 @@
 # Runtime Agent Architecture
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 > [!WARNING] 
 > Runtime Agent is used in the [Compass mode](../README.md) of Application Connectivity. To learn how to install Compass and integrate with it, refer to the [Compass documentation](https://github.com/kyma-incubator/compass/blob/master/docs/compass/04-01-installation.md) or to the [Director GraphQL schema](https://github.com/kyma-incubator/compass/blob/master/components/director/pkg/graphql/schema.graphql) directly. 
 

diff --git a/docs/user/technical-reference/05-20-connection-with-compass.md b/docs/user/technical-reference/05-20-connection-with-compass.md
@@ -1,4 +1,7 @@
-# Connection with Compass
+# Runtime Agent Connection with Compass
+
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
 
 Runtime Agent connects to Compass using a one-time token from the Connector and exchanges it for a certificate, which is later used to fetch Applications from the Director.
 

diff --git a/docs/user/technical-reference/07-20-configuring-runtime.md b/docs/user/technical-reference/07-20-configuring-runtime.md
@@ -1,5 +1,8 @@
 # Configuring the Runtime
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 > [!NOTE] 
 > To represent API and Event Definitions of the Applications connected to a Runtime, we recommend that you use the Open Service Broker API.
 

diff --git a/docs/user/tutorials/01-100-reconnect-runtime-agent-with-compass.md b/docs/user/tutorials/01-100-reconnect-runtime-agent-with-compass.md
@@ -1,5 +1,8 @@
 # Reconnect Runtime Agent with Compass
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 This tutorial shows how to reconnect Runtime Agent with Compass after the established connection was lost.
 
 ## Prerequisites

diff --git a/docs/user/tutorials/01-60-establish-secure-connection-with-compass.md b/docs/user/tutorials/01-60-establish-secure-connection-with-compass.md
@@ -1,5 +1,8 @@
 # Establish a Secure Connection with Compass
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 To establish a secure connection with Compass and generate the client certificate, follow this tutorial.
 
 ## Prerequisites

diff --git a/docs/user/tutorials/01-70-maintain-secure-connection-with-compass.md b/docs/user/tutorials/01-70-maintain-secure-connection-with-compass.md
@@ -1,5 +1,8 @@
 # Maintain a Secure Connection with Compass
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 After you have established a secure connection with Compass, you can fetch the configuration details and renew the client certificate before it expires. To renew the client certificate, follow the steps in this tutorial.
 
 ## Prerequisites

diff --git a/docs/user/tutorials/01-80-revoke-client-certificate.md b/docs/user/tutorials/01-80-revoke-client-certificate.md
@@ -1,5 +1,8 @@
 # Revoke a Client Certificate (RA)
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 After you have established a secure connection with Compass and generated a client certificate, you may want to revoke this certificate at some point. To revoke a client certificate, follow the steps in this tutorial.
 
 > [!NOTE] 

diff --git a/docs/user/tutorials/01-90-configure-runtime-agent-with-compass.md b/docs/user/tutorials/01-90-configure-runtime-agent-with-compass.md
@@ -1,5 +1,8 @@
 # Configure Runtime Agent with Compass
 
+> [!WARNING]
+> Runtime Agent is currently not integrated into the Application Connector module. Proceed with caution and consult the respective documentation for the Application Connector module's current configuration and functionality.
+
 This tutorial shows how to configure Runtime Agent with Compass.
 
 ## Prerequisites