-
Notifications
You must be signed in to change notification settings - Fork 405
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
111 additions
and
64 deletions.
There are no files selected for viewing
4 changes: 2 additions & 2 deletions
4
components/remote-environment-controller/charts/remote-environments/Chart.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
apiVersion: v1 | ||
description: Gateway helm chart for Kubernetes | ||
description: Remote Environment helm chart for Kubernetes | ||
name: gateway | ||
version: 0.0.1 | ||
version: 0.0.1 |
63 changes: 14 additions & 49 deletions
63
components/remote-environment-controller/charts/remote-environments/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,70 +1,35 @@ | ||
``` | ||
_ _ _ _ _____ _ | ||
/\ | (_) | | (_) / ____| | | | ||
/ \ _ __ _ __ | |_ ___ __ _| |_ _ ___ _ __ | | ___ _ __ _ __ ___ ___| |_ ___ _ __ | ||
/ /\ \ | '_ \| '_ \| | |/ __/ _` | __| |/ _ \| '_ \ | | / _ \| '_ \| '_ \ / _ \/ __| __/ _ \| '__| | ||
/ ____ \| |_) | |_) | | | (_| (_| | |_| | (_) | | | | | |___| (_) | | | | | | | __/ (__| || (_) | | | ||
/_/ \_\ .__/| .__/|_|_|\___\__,_|\__|_|\___/|_| |_| \_____\___/|_| |_|_| |_|\___|\___|\__\___/|_| | ||
| | | | | ||
|_| |_| | ||
_____ _ ______ _ _ | ||
| __ \ | | | ____| (_) | | | ||
| |__) |___ _ __ ___ ___ | |_ ___ | |__ _ ____ ___ _ __ ___ _ __ _ __ ___ ___ _ __ | |_ ___ | ||
| _ // _ \ '_ ` _ \ / _ \| __/ _ \ | __| | '_ \ \ / / | '__/ _ \| '_ \| '_ ` _ \ / _ \ '_ \| __/ __| | ||
| | \ \ __/ | | | | | (_) | || __/ | |____| | | \ V /| | | | (_) | | | | | | | | | __/ | | | |_\__ \ | ||
|_| \_\___|_| |_| |_|\___/ \__\___| |______|_| |_|\_/ |_|_| \___/|_| |_|_| |_| |_|\___|_| |_|\__|___/ | ||
``` | ||
|
||
## Overview | ||
|
||
An Application Connector connects an external solution to Kyma. | ||
A Remote Environment (RE) is a representation of an external solution connected to Kyma. The Application Connector manages the traffic, connection, security, and Events of REs. It is a proprietary implementation that consists of four services. | ||
Read the [Application Connector documentation](../../docs/application-connector/docs/001-overview-application-connector.md) for more details regarding the implementation. | ||
|
||
## Details | ||
|
||
An Application Connector contains a Remote Environment Custom Resource Definition (CRD) and the Gateway service, exposed over the Ingress-Nginx controller, which handles the connection between Kyma and the external solution. | ||
This directory contains the Remote Environment Helm chart that creates a new RE. Additionally, the chart installs the Gateway Service and all of the Ingresses required to access Application Connector services in the context of the created RE. A single RE allows to connect a single external solution to Kyma. | ||
|
||
### Remote Environment CRD | ||
### Customize the Gateway Service installation | ||
|
||
The CRD contains the information about a given Remote Environment, as well as the connected external solution and the Event Bus configuration. For more information, see the [Remote Environment definition](https://github.com/kyma-project/kyma/blob/master/docs/application-connector/docs/014-details-remote-environment.md) document. | ||
|
||
### Gateway | ||
|
||
Gateway is a Kyma core component that proxies events and HTTP requests to and from Kyma. | ||
To define ports, adjust the `values.yaml` file. | ||
|
||
The Gateway has the following parameters: | ||
Edit the [`values`](./values.yaml) file to customize the installation of the Gateway Service. | ||
You can adjust these parameters: | ||
|
||
- **proxyPort** - This port proxies calls from services and lambdas to an external solution. The default port is `8080`. | ||
- **externalAPIPort** - This port exposes the Gateway API to an external solution. The default port is `8081`. | ||
- **eventsTargetURL** - The URL to proxy incoming events. The default URL is `http://localhost:9000`. | ||
- **remoteEnvironment** - The Remote Environment to read and write information about the services. The default Remote Environment is `default-ec`. | ||
- **remoteEnvironment** - The RE to read and write information about the services. The default RE is `default-ec`. | ||
- **namespace** - The Namespace to which you deploy the Gateway. The default Namespace is `kyma-system`. | ||
- **requestTimeout** - A time-out for requests sent through the Gateway. Provide it in seconds. The default time-out is `1`. | ||
- **skipVerify** - The flag to skip the verification of certificates for the proxy targets. The default value is `false`. | ||
|
||
The Gateway has the parameters for the Event API which correspond to the fields in the [Remote Environment](https://github.com/kyma-project/kyma/blob/master/docs/application-connector/docs/014-details-remote-environment.md): | ||
|
||
Additionally, you can adjust the parameters used in the communication with the Event Service: | ||
- **sourceEnvironment** - The Event source environment name. | ||
- **sourceType** - The Event source type. | ||
- **sourceNamespace** - The organization that publishes the Event. | ||
|
||
### Installation | ||
|
||
By default, Kyma comes with these Application Connector installed in the `kyma-integration` Namespace: | ||
|
||
- ec-default | ||
- hmc-default | ||
|
||
#### Install an Application Connector manually | ||
|
||
Use the Helm chart to install an additional Application Connector. | ||
|
||
``` bash | ||
helm install --name remote-environment-name --set deployment.args.sourceType=commerce --set global.isLocalEnv=false --namespace kyma-integration ./resources/remote-environments | ||
``` | ||
|
||
For installations on Minikube, provide the NodePort as shown in this example: | ||
|
||
``` bash | ||
helm install --name remote-environment-name --set deployment.args.sourceType=commerce --set global.isLocalEnv=true --set service.externalapi.nodePort=32001 --namespace kyma-integration ./resources/remote-environments | ||
``` | ||
|
||
The user can override the following parameters: | ||
|
||
- **sourceEnvironment** | ||
- **sourceType** | ||
- **sourceNamespace** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters