From eda64c0bbdeaa0e534db0b4f192a17998f2d2796 Mon Sep 17 00:00:00 2001 From: grego952 Date: Wed, 20 Mar 2024 14:50:54 +0100 Subject: [PATCH] Remove Runtime Agent docs --- .../application-connectivity/README.md | 3 - .../application-connectivity/metadata.yaml | 1 - .../ra-01-runtime-agent-overview.md | 8 -- .../ra-02-useful-links.md | 22 ---- .../00-application-connectivity/README.md | 3 - .../00-application-connectivity/metadata.yaml | 1 - ...stablish-secure-connection-with-compass.md | 102 ------------------ ...maintain-secure-connection-with-compass.md | 78 -------------- .../ra-03-revoke-client-certificate.md | 33 ------ ...04-configure-runtime-agent-with-compass.md | 33 ------ ...05-reconnect-runtime-agent-with-compass.md | 18 ---- docs/03-tutorials/README.md | 8 -- .../00-architecture/README.md | 4 - .../ra-01-runtime-agent-workflow.md | 20 ---- .../ra-01-connection-with-compass.md | 26 ----- .../00-custom-resources/README.md | 6 +- .../ra-01-compassconnection.md | 94 ---------------- .../ra-01-configuring-runtime.md | 23 ---- docs/_sidebar.md | 9 -- 19 files changed, 1 insertion(+), 491 deletions(-) delete mode 100644 docs/01-overview/application-connectivity/README.md delete mode 100644 docs/01-overview/application-connectivity/metadata.yaml delete mode 100644 docs/01-overview/application-connectivity/ra-01-runtime-agent-overview.md delete mode 100644 docs/01-overview/application-connectivity/ra-02-useful-links.md delete mode 100644 docs/03-tutorials/00-application-connectivity/README.md delete mode 100644 docs/03-tutorials/00-application-connectivity/metadata.yaml delete mode 100644 docs/03-tutorials/00-application-connectivity/ra-01-establish-secure-connection-with-compass.md delete mode 100644 docs/03-tutorials/00-application-connectivity/ra-02-maintain-secure-connection-with-compass.md delete mode 100644 docs/03-tutorials/00-application-connectivity/ra-03-revoke-client-certificate.md delete mode 100644 docs/03-tutorials/00-application-connectivity/ra-04-configure-runtime-agent-with-compass.md delete mode 100644 docs/03-tutorials/00-application-connectivity/ra-05-reconnect-runtime-agent-with-compass.md delete mode 100644 docs/05-technical-reference/00-architecture/ra-01-runtime-agent-workflow.md delete mode 100644 docs/05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md delete mode 100644 docs/05-technical-reference/00-custom-resources/ra-01-compassconnection.md delete mode 100644 docs/05-technical-reference/ra-01-configuring-runtime.md diff --git a/docs/01-overview/application-connectivity/README.md b/docs/01-overview/application-connectivity/README.md deleted file mode 100644 index 5b795be97bc5..000000000000 --- a/docs/01-overview/application-connectivity/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# What Is Application Connectivity in Kyma? - -This content has been moved to: [Application Connector module](https://kyma-project.io/#/application-connector-manager/user/README). \ No newline at end of file diff --git a/docs/01-overview/application-connectivity/metadata.yaml b/docs/01-overview/application-connectivity/metadata.yaml deleted file mode 100644 index d901e85d3c0e..000000000000 --- a/docs/01-overview/application-connectivity/metadata.yaml +++ /dev/null @@ -1 +0,0 @@ -displayName: Application Connectivity diff --git a/docs/01-overview/application-connectivity/ra-01-runtime-agent-overview.md b/docs/01-overview/application-connectivity/ra-01-runtime-agent-overview.md deleted file mode 100644 index 043dc6d571c1..000000000000 --- a/docs/01-overview/application-connectivity/ra-01-runtime-agent-overview.md +++ /dev/null @@ -1,8 +0,0 @@ -# Runtime Agent - -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](../../05-technical-reference/ra-01-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 and creating them in the Runtime, and removing from the Runtime Applications that no longer exist in the Director. diff --git a/docs/01-overview/application-connectivity/ra-02-useful-links.md b/docs/01-overview/application-connectivity/ra-02-useful-links.md deleted file mode 100644 index a90ad309ff49..000000000000 --- a/docs/01-overview/application-connectivity/ra-02-useful-links.md +++ /dev/null @@ -1,22 +0,0 @@ -# Runtime Agent - 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](https://kyma-project.io/#/application-connector-manager/user/02-20-enable-kyma-with-runtime-agent) - - [Establish a secure connection with Compass](../../03-tutorials/00-application-connectivity/ra-01-establish-secure-connection-with-compass.md) - - [Maintain a secure connection with Compass](../../03-tutorials/00-application-connectivity/ra-02-maintain-secure-connection-with-compass.md) - - [Revoke a client certificate (RA)](../../03-tutorials/00-application-connectivity/ra-03-revoke-client-certificate.md) - - [Configure Runtime Agent with Compass](../../03-tutorials/00-application-connectivity/ra-04-configure-runtime-agent-with-compass.md) - - [Reconnect Runtime Agent with Compass](../../03-tutorials/00-application-connectivity/ra-05-reconnect-runtime-agent-with-compass.md) - -- Analyze Runtime Agent specification and configuration files: - - - [Compass Connection](../../05-technical-reference/00-custom-resources/ra-01-compassconnection.md) custom resource (CR) - - [Connection with Compass](../../05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md) - -- Understand technicalities behind the Runtime Agent implementation: - - - [Runtime Agent workflow](../../05-technical-reference/00-architecture/ra-01-runtime-agent-workflow.md) - - [Configuring the Runtime](../../05-technical-reference/ra-01-configuring-runtime.md) \ No newline at end of file diff --git a/docs/03-tutorials/00-application-connectivity/README.md b/docs/03-tutorials/00-application-connectivity/README.md deleted file mode 100644 index b0e3ac9339f6..000000000000 --- a/docs/03-tutorials/00-application-connectivity/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Application Connectivity - Tutorials - -Browse the tutorials for Application Connectivity to learn how to use it step-by-step in different scenarios. diff --git a/docs/03-tutorials/00-application-connectivity/metadata.yaml b/docs/03-tutorials/00-application-connectivity/metadata.yaml deleted file mode 100644 index d901e85d3c0e..000000000000 --- a/docs/03-tutorials/00-application-connectivity/metadata.yaml +++ /dev/null @@ -1 +0,0 @@ -displayName: Application Connectivity diff --git a/docs/03-tutorials/00-application-connectivity/ra-01-establish-secure-connection-with-compass.md b/docs/03-tutorials/00-application-connectivity/ra-01-establish-secure-connection-with-compass.md deleted file mode 100644 index 764840909770..000000000000 --- a/docs/03-tutorials/00-application-connectivity/ra-01-establish-secure-connection-with-compass.md +++ /dev/null @@ -1,102 +0,0 @@ -# Establish a Secure Connection with Compass - -To establish a secure connection with Compass and generate the client certificate, follow this tutorial. - -## Prerequisites - -- [OpenSSL toolkit](https://www.openssl.org/source/) to create a Certificate Signing Request (CSR), keys, and certificates which meet high security standards -- [Compass](https://github.com/kyma-incubator/compass) -- Registered Application -- Runtime connected to Compass - -## Steps - -1. Get the Connector URL and the one-time token. - - To get the Connector URL and the one-time token which allow you to fetch the required configuration details, use the Compass Console. - - >[!NOTE] - > To access the Compass Console, go to the `https://compass.{CLUSTER_DOMAIN}` URL and enter your Kyma credentials. - - Alternatively, make a call to the Director including the `Tenant` header with Tenant ID and `authorization` header with the Bearer token issued by your custom OpenID Connect-compliant identity provider. Use the following mutation: - - ```graphql - mutation { - result: requestOneTimeTokenForApplication(id: "{APPLICATION_ID}") { - token - connectorURL - } - } - ``` - - > [!NOTE] - > The one-time token expires after 5 minutes. - -2. Get the CSR information and configuration details from Kyma using the one-time token. - - To get the CSR information and configuration details, send this GraphQL query to the Connector URL. - You must include the `connector-token` header containing the one-time token when making the call. - - ```graphql - query { - result: configuration { - token { - token - } - certificateSigningRequestInfo { - subject - keyAlgorithm - } - managementPlaneInfo { - directorURL - certificateSecuredConnectorURL - } - } - } - ``` - - A successful call returns the data requested in the query including a new one-time token. - -3. Generate a key and a Certificate Signing Request (CSR). - - Generate a CSR with the following command. **{SUBJECT}** is the certificate subject data returned with the CSR information as `subject`. - - ```bash - export KEY_LENGTH=4096 - openssl genrsa -out compass-app.key $KEY_LENGTH - openssl req -new -sha256 -out compass-app.csr -key compass-app.key -subj "{SUBJECT}" - ``` - > [!NOTE] - > The key length is configurable, however, 4096 is the recommended value. - -4. Sign the CSR and get a client certificate. - - Encode the obtained CSR with base64: - ```bash - openssl base64 -in compass-app.csr - ``` - - To get the CSR signed, use the encoded CSR in this GraphQL mutation: - ```graphql - mutation { - result: signCertificateSigningRequest(csr: "{BASE64_ENCODED_CSR}") { - certificateChain - caCertificate - clientCertificate - } - } - ``` - - Send the modified GraphQL mutation to the Connector URL. You must include the `connector-token` header containing the one-time token fetched with the configuration. - - The response contains a certificate chain, a valid client certificate signed by the Kyma Certificate Authority (CA), and the CA certificate. - -5. Decode the certificate chain. - - After you receive the certificates, decode the certificate chain with the base64 method and use it in your application: - ```bash - base64 -d {CERTIFICATE_CHAIN} - ``` - -> [!NOTE] -> See how to [maintain a secure connection with Compass and renew a client certificate](ra-02-maintain-secure-connection-with-compass.md). diff --git a/docs/03-tutorials/00-application-connectivity/ra-02-maintain-secure-connection-with-compass.md b/docs/03-tutorials/00-application-connectivity/ra-02-maintain-secure-connection-with-compass.md deleted file mode 100644 index cbd3cb2786d5..000000000000 --- a/docs/03-tutorials/00-application-connectivity/ra-02-maintain-secure-connection-with-compass.md +++ /dev/null @@ -1,78 +0,0 @@ -# Maintain a Secure Connection with Compass - -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 - -- [OpenSSL toolkit](https://www.openssl.org/source/) to create a Certificate Signing Request (CSR), keys, and certificates which meet high security standards -- [Compass](https://github.com/kyma-incubator/compass) -- Registered Application -- Runtime connected to Compass -- [Established secure connection with Compass](ra-01-establish-secure-connection-with-compass.md) - -## Steps - -1. Get the CSR information with the configuration details. - - To fetch the configuration, make a call to the Certificate-Secured Connector URL using the client certificate. - The Certificate-Secured Connector URL is the `certificateSecuredConnectorURL` obtained when establishing a secure connection with Compass. - Send this query with the call: - - ```graphql - query { - result: configuration { - certificateSigningRequestInfo { - subject - keyAlgorithm - } - managementPlaneInfo { - directorURL - } - } - } - ``` - - A successful call returns the requested configuration details. - -2. Generate a key and a Certificate Signing Request (CSR). - - Generate a CSR with this command using the certificate subject data obtained with the CSR information: - ``` - export KEY_LENGTH=4096 - openssl genrsa -out compass-app.key $KEY_LENGTH - openssl req -new -sha256 -out compass-app.csr -key compass-app.key -subj "{SUBJECT}" - ``` - > [!NOTE] - > The key length is configurable, however, 4096 is the recommended value. - -3. Sign the CSR and renew the client certificate. - - Encode the obtained CSR with base64: - ```bash - openssl base64 -in compass-app.csr - ``` - - Send the following GraphQL mutation with the encoded CSR to the Certificate-Secured Connector URL: - ```graphql - mutation { - result: signCertificateSigningRequest(csr: "{BASE64_ENCODED_CSR}") { - certificateChain - caCertificate - clientCertificate - } - } - ``` - - The response contains a renewed client certificate signed by the Kyma Certificate Authority (CA), certificate chain, and the CA certificate. - -4. Decode the certificate chain. - - The returned certificates and the certificate chain are base64-encoded and need to be decoded before use. - To decode the certificate chain, run: - - ```bash - base64 -d {CERTIFICATE_CHAIN} - ``` - -> [!NOTE] -> See how to [revoke a client certificate](ra-03-revoke-client-certificate.md). diff --git a/docs/03-tutorials/00-application-connectivity/ra-03-revoke-client-certificate.md b/docs/03-tutorials/00-application-connectivity/ra-03-revoke-client-certificate.md deleted file mode 100644 index 99a94ce4c717..000000000000 --- a/docs/03-tutorials/00-application-connectivity/ra-03-revoke-client-certificate.md +++ /dev/null @@ -1,33 +0,0 @@ -# Revoke a Client Certificate (RA) - -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] -> A revoked client certificate remains valid until it expires, but it cannot be renewed. - -## Prerequisites - -- [OpenSSL toolkit](https://www.openssl.org/source/) to create a Certificate Signing Request (CSR), keys, and certificates which meet high security standards -- [Compass](https://github.com/kyma-incubator/compass) -- Registered Application -- Runtime connected to Compass -- [Established secure connection with Compass](ra-01-establish-secure-connection-with-compass.md) - -> [!NOTE] -> See how to [maintain a secure connection with Compass and renew a client certificate](ra-02-maintain-secure-connection-with-compass.md). - -## Revoke the Certificate - -To revoke a client certificate, make a call to the Certificate-Secured Connector URL using the client certificate. -The Certificate-Secured Connector URL is the `certificateSecuredConnectorURL` obtained when establishing a secure connection with Compass. -Send this mutation with the call: - -```graphql -mutation { result: revokeCertificate } -``` - -A successful call returns the following response: - -```json -{"data":{"result":true}} -``` diff --git a/docs/03-tutorials/00-application-connectivity/ra-04-configure-runtime-agent-with-compass.md b/docs/03-tutorials/00-application-connectivity/ra-04-configure-runtime-agent-with-compass.md deleted file mode 100644 index 332c10f9f18c..000000000000 --- a/docs/03-tutorials/00-application-connectivity/ra-04-configure-runtime-agent-with-compass.md +++ /dev/null @@ -1,33 +0,0 @@ -# Configure Runtime Agent with Compass - -This tutorial shows how to configure Runtime Agent with Compass. - -## Prerequisites - -- [Compass](https://github.com/kyma-incubator/compass) -- Runtime connected to Compass and the Runtime ID -- [Connector URL](ra-01-establish-secure-connection-with-compass.md) -- One-time token from the Connector -- Tenant ID - -> [!NOTE] -> Learn also about the [parameters required](../../05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md) to initialize the connection between Runtime Agent and Compass. - -## Steps - -To configure Runtime Agent with Compass, you need to create a Secret in the Runtime Agent namespace and specify it in the Runtime Agent Deployment. The default Secret is `compass-agent-configuration`. To create the Secret, run: - -```bash -cat < [!WARNING] -> Runtime Agent is used in the [Compass mode](../../01-overview/application-connectivity/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. - -This document presents the workflow of Runtime Agent. - -![Runtime Agent architecture](assets/ra-runtime-agent-workflow.svg) - -1. Runtime Agent fetches the certificate from the [Connector](https://github.com/kyma-incubator/compass/blob/master/docs/connector/02-01-connector-service.md) to initialize connection with Compass. - -2. Runtime Agent stores the certificate and key for the Connector and the Director in the Secret. - -3. Runtime Agent synchronizes the Runtime with the Director. It does so by: - - fetching new Applications from the Director and creating them in the Runtime - - removing from the Runtime the Applications that no longer exist in the Director. - -4. Runtime Agent labels the Runtime data in the Director with the Event Gateway URL and the Console URL of the Kyma cluster. These URLs are displayed in the Compass UI. - -5. Runtime Agent renews the certificate for the Connector and the Director to maintain connection with Compass. This only happens if the remaining validity period for the certificate passes a certain threshold. diff --git a/docs/05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md b/docs/05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md deleted file mode 100644 index d2ae61ef8a70..000000000000 --- a/docs/05-technical-reference/00-configuration-parameters/ra-01-connection-with-compass.md +++ /dev/null @@ -1,26 +0,0 @@ -# Runtime Agent Connection with Compass - -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. - -The initial connection requires the following parameters: - -| **Parameter** | **Description** | **Example value** | -|---------------|-----------------|-------------------| -| **CONNECTOR_URL** | Connector URL | `https://compass-gateway.kyma.local/connector/graphql` | -| **RUNTIME_ID** | ID of the Runtime registered in the Director | `1ae04041-17e5-478f-91f8-3a2ddc7700de` | -| **TENANT** | Tenant ID | `3e64ebae-38b5-46a0-b1ed-9ccee153a0ae` | -| **TOKEN** | One-time token generated for the Runtime | `2I7VVX5CqxHioEBQGPxWSp3k90uw51tmx5dbo0IZd5VNFzGoPfppYrMIuoCNwFOKp05wsioJNLJYxdI-LKlUYA==` | - -Runtime Agent reads this configuration from the Secret specified in the Runtime Agent Deployment (`compass-agent-configuration` by default). - -To see how to create the Secret, see the [tutorial](../../03-tutorials/00-application-connectivity/ra-04-configure-runtime-agent-with-compass.md). - -## Connection status - -The connection status is preserved in the [CompassConnection](../00-custom-resources/ra-01-compassconnection.md) custom resource (CR). This CR also stores the Connector URL and the Director URL. - -## Reconnecting Runtime Agent - -If the connection with Compass fails, Runtime Agent keeps trying to connect with the token from the Secret. If the connection is established successfully, Runtime Agent ignores the Secret until the connection is lost. - -To see how to reconnect Runtime Agent with Compass, see the [tutorial](../../03-tutorials/00-application-connectivity/ra-05-reconnect-runtime-agent-with-compass.md). diff --git a/docs/05-technical-reference/00-custom-resources/README.md b/docs/05-technical-reference/00-custom-resources/README.md index fb9c18556ea2..ce353af21523 100644 --- a/docs/05-technical-reference/00-custom-resources/README.md +++ b/docs/05-technical-reference/00-custom-resources/README.md @@ -1,10 +1,6 @@ # Custom Resources -A custom resource (CR) is an extension to the Kubernetes API which allows you to cover use cases that are not directly covered by core Kubernetes. Here's the list of the CRs developed by Kyma to support its functionality: - -| Area | Custom resource | -| ---- | -------------- | -| Application Connectivity | [CompassConnection](ra-01-compassconnection.md) | +A custom resource (CR) is an extension to the Kubernetes API which allows you to cover use cases that are not directly covered by core Kubernetes. > [!NOTE] > For information about third-party custom resources that come together with Kyma, visit the documentation of the respective project. diff --git a/docs/05-technical-reference/00-custom-resources/ra-01-compassconnection.md b/docs/05-technical-reference/00-custom-resources/ra-01-compassconnection.md deleted file mode 100644 index a38566bd7abc..000000000000 --- a/docs/05-technical-reference/00-custom-resources/ra-01-compassconnection.md +++ /dev/null @@ -1,94 +0,0 @@ -# CompassConnection CR - -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. -The `CompassConnection` custom resource (CR) contains the connection statuses and Compass URLs. -To get the up-to-date CRD and show the output in the `yaml` format, run this command: - -```bash -kubectl get crd compassconnections.compass.kyma-project.io -o yaml -``` - -## Sample Custom Resource - -This is a sample resource that registers the `compass-agent-connection` CompassConnection -which preserves the status of the connection between Runtime Agent and Compass. -It also stores the URLs for the Connector and the Director. - -```yaml -apiVersion: compass.kyma-project.io/v1alpha1 -kind: CompassConnection -metadata: - name: compass-connection -spec: - managementInfo: - connectorUrl: https://compass-gateway-mtls.kyma.example.com/connector/graphql - directorUrl: https://compass-gateway-mtls.kyma.example.com/director/graphql -status: - connectionState: ConnectionMaintenanceFailed - connectionStatus: - certificateStatus: - acquired: "2020-02-11T10:35:22Z" - notAfter: "2020-05-11T10:35:22Z" - notBefore: "2020-02-11T10:35:22Z" - established: "2020-02-11T10:35:22Z" - lastSuccess: "2020-02-12T10:45:10Z" - lastSync: "2020-02-12T12:37:48Z" - renewed: null - synchronizationStatus: - lastAttempt: "2020-02-12T10:45:10Z" - lastSuccessfulApplication: "2020-02-12T10:45:10Z" - lastSuccessfulFetch: "2020-02-12T10:45:10Z" -``` - -## Custom Resource Parameters - -This table lists all the possible parameters of the CompassConnection custom resource together with their descriptions. For more details, see the [CompassConnection specification file](../../../installation/resources/crds/compass-runtime-agent/compass-connection.crd.yaml). - - - - - - -### CompassConnection.compass.kyma-project.io/v1alpha1 - -**Spec:** - -| Parameter | Type | Description | -| ---- | ----------- | ---- | -| **managementInfo** (required) | object | | -| **managementInfo.​connectorUrl** (required) | string | URL used for maintaining the secure connection. | -| **managementInfo.​directorUrl** (required) | string | URL used for fetching Applications. | -| **refreshCredentialsNow** | boolean | If set to `true`, ignores certificate expiration date and refreshes in the next round. | -| **resyncNow** | boolean | If set to `true`, ignores `APP_MINIMAL_COMPASS_SYNC_TIME` and syncs in the next round. | - -**Status:** - -| Parameter | Type | Description | -| ---- | ----------- | ---- | -| **connectionState** (required) | string | | -| **connectionStatus** (required) | object | Represents the status of the connection to Compass. | -| **connectionStatus.​certificateStatus** (required) | object | Specifies the certificate issue and expiration dates. | -| **connectionStatus.​certificateStatus.​acquired** | string | Specifies when the certificate was acquired. | -| **connectionStatus.​certificateStatus.​notAfter** | string | Specifies when the certificate stops being valid. | -| **connectionStatus.​certificateStatus.​notBefore** | string | Specifies when the certificate becomes valid. | -| **connectionStatus.​error** | string | | -| **connectionStatus.​established** | string | Specifies when the connection was established. | -| **connectionStatus.​lastSuccess** | string | Specifies the date of the last successful synchronization with the Connector. | -| **connectionStatus.​lastSync** | string | Specifies the date of the last synchronization attempt. | -| **connectionStatus.​renewed** | string | Specifies the date of the last certificate renewal. | -| **synchronizationStatus** | object | Provides the status of the synchronization with the Director. | -| **synchronizationStatus.​error** | string | | -| **synchronizationStatus.​lastAttempt** | string | Specifies the date of the last synchronization attempt with the Director. | -| **synchronizationStatus.​lastSuccessfulApplication** | string | Specifies the date of the last successful application of resources fetched from Compass. | -| **synchronizationStatus.​lastSuccessfulFetch** | string | Specifies the date of the last successful fetch of resources from the Director. | - - - -## Dependents - -| **Component** | **Description** | -|---------------|------------------------------------------------------------------------------------------------------------| -| Runtime Agent | Stores the Connector and Director URLs and preserves the status of the connection with Compass in this CR. | - diff --git a/docs/05-technical-reference/ra-01-configuring-runtime.md b/docs/05-technical-reference/ra-01-configuring-runtime.md deleted file mode 100644 index b6d75c5002e1..000000000000 --- a/docs/05-technical-reference/ra-01-configuring-runtime.md +++ /dev/null @@ -1,23 +0,0 @@ -# Configuring the Runtime - -> [!NOTE] -> To represent API and Event Definitions of the Applications connected to a Runtime, we recommend that you use the Open Service Broker API. - -Runtime Agent periodically requests for the configuration of its Runtime from Compass. -Changes in the configuration for the Runtime are applied by Runtime Agent on the Runtime. - -To fetch the Runtime configuration, Runtime Agent calls the [`applicationsForRuntime`](https://github.com/kyma-incubator/compass/blob/master/components/director/pkg/graphql/schema.graphql) query offered by the Compass component called Director. -The response for the query contains Applications assigned for the Runtime. -Each Application contains only credentials that are valid for the Runtime that called the query. Runtime Agent uses the credentials to create Secrets used by Application Gateway. -Each Runtime Agent can fetch the configurations for Runtimes that belong to its tenant. - -Runtime Agent reports back to the Director the Runtime-specific [LabelDefinitions](https://github.com/kyma-incubator/compass/blob/master/docs/compass/03-04-labels.md#labeldefinitions), which represent Runtime configuration, together with their values. -Runtime-specific LabelDefinitions are Event Gateway URL and Runtime Console URL. - -The data mapping between Director and Kyma looks as follows: - -| **Director (Compass)** | **Kyma** | -|---------------------------|-------------------------------| -| Application | Application CR | -| API Bundle | Service in the Application CR | -| API Definition | Entry under the service | \ No newline at end of file diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 14f0344c3354..c39517323159 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -12,21 +12,12 @@ * [Eventing](/eventing-manager/user/README.md) * [API Gateway](/api-gateway/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) - * [Maintain a Secure Connection with Compass](ra-02-maintain-secure-connection-with-compass.md) - * [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) * [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 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 the Runtime](/05-technical-reference/ra-01-configuring-runtime.md) * [Glossary](/glossary.md)