You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-java/features/connectivity/008-transparent-proxy.mdx
+67-36Lines changed: 67 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
---
2
2
id: transparent-proxy
3
-
title: Transparent Proxy Destinations
3
+
title: Transparent Proxy
4
4
hide_title: false
5
5
hide_table_of_contents: false
6
6
sidebar_label: Transparent Proxy
7
-
description: This article explains how to use Transparent Proxy Destinations to connect to systems through the SAP BTP Transparent Proxy.
7
+
description: This article explains how to use Transparent Proxy to connect to systems through defined as SAP Destinations.
8
8
keywords:
9
9
- sap
10
10
- cloud
@@ -22,103 +22,131 @@ keywords:
22
22
importTabsfrom'@theme/Tabs';
23
23
importTabItemfrom'@theme/TabItem';
24
24
25
-
The SAP Cloud SDK supports connecting to systems through the [**Transparent Proxy**](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/transparent-proxy-for-kubernetes), which provides enhanced connectivity features and simplified on-premise access in Kubernetes-based environments like Kyma.
25
+
The SAP Cloud SDK supports connecting to systems through the [**Transparent Proxy**](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/transparent-proxy-for-kubernetes), which provides enhanced connectivity features and simplified on-premise access in Kubernetes-based environments.
26
26
The `TransparentProxyDestination` class enables applications to leverage these capabilities seamlessly.
27
27
28
28
## Prerequisites
29
29
30
30
:::info Kubernetes Only
31
31
32
-
The Transparent Proxy is currently **only available for Kubernetes-based environments** such as Kyma and Gardener.
32
+
The Transparent Proxy is currently **only available for Kubernetes-based environments**.
33
33
34
34
:::
35
35
36
36
:::caution Installation Required
37
37
38
38
Before using `TransparentProxyDestination`, ensure that the **Transparent Proxy is installed and configured** in your Kubernetes cluster.
39
39
Refer to the [official installation guide](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/installation-47b8844e90be440881838a5d5d9f8a68) for setup instructions.
40
+
The Transparent Proxy is available in Kyma environment as a dedicated module.
41
+
Refer to [Transparent Proxy in Kyma environment](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/transparent-proxy-in-kyma-environment) for instructions how to add the module.
40
42
41
43
:::
42
44
43
45
## Background Information
44
46
45
-
The **Transparent Proxy** is a connectivity component provided by SAP BTP that acts as an intermediary between your application and target systems.
46
-
When using the Transparent Proxy your app performs requests against the Transparent Proxy without explicit authentication.
47
-
This relies on the secure network communication provided by Kyma via Istio.
48
-
The Transparent Proxy will obtain the relevant destination from the destination service.
49
-
It will then use this destination to forward the request to the target system or to the Connectivity Proxy for On-Premise destinations.
50
-
Consequently, your app itself does not interact with destination or connectivity service at all.
51
-
This means your application pods do not require bindings to these two services.
47
+
The **Transparent Proxy** is a SAP BTP Connectivity component that acts as an intermediary between your application and target systems.
48
+
The Transparent Proxy simplifies and unifies how your Kubernetes workloads connect to remote systems using SAP BTP destinations.
49
+
It provides authentication, principal propagation, SOCKS5 handshake, and easy access to the destination target systems by exposing them as [Kubernetes Services](https://kubernetes.io/docs/concepts/services-networking/service).
50
+
51
+
The Transparent Proxy obtains relevant destination configuration from the SAP Destination service.
52
+
It uses this destination to forward the request to the target system or to the Connectivity Proxy for On-Premise destinations.
53
+
Consequently, your app does not interact with SAP Destination service or Connectivity service.
54
+
This means your application do not require bindings to these two services, everything is handled by the Transparent Proxy.
52
55
53
56
## Creating Transparent Proxy Destinations
54
57
55
58
The `TransparentProxyDestination` class provides two types of builders for different use cases:
56
59
57
-
### 1. Static Destinations
60
+
### 1. Destination
58
61
59
-
Static destinations connect directly to a specified URL.
60
-
They allow setting generic headers but do not support dynamic properties like destination name or fragments.
62
+
Allows you to connect to a concrete SAP destination.
63
+
Setting generic headers is allowed but dynamic properties like destination name or fragments is not.
64
+
As a prerequisite, you have to create a Destination Custom Resource inside the Kubernetes cluster.
65
+
For more information how to use the Transparent Proxy, refer to [Using the Transparent Proxy](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/using-transparent-proxy).
`<destination-custom-resource-namespace>` can be omitted if the destination custom resource is created in the same namespace as the application workload.
77
+
:::
78
+
79
+
### 2. Gateway
71
80
72
-
Dynamic destinations require both URL and destination name.
73
-
They support dynamic properties like fragments.
81
+
Allows you to connect to arbitrary SAP destinations you have access to.
82
+
As a prerequisite, you have to create a Gateway Destination Custom Resource inside the Kubernetes cluster.
83
+
For more information how to use the Transparent Proxy for this concrete scenario, refer to [Destination Gateway](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/dynamic-lookup-of-destinations).
1.**Missing destination name for dynamic destinations**: Ensure the destination name is provided as the first parameter to `.dynamicDestination("destination-name", "gateway-url")`
180
+
1.**Missing destination name for gateway**: Ensure the destination name is provided as the first parameter to `.gateway(<destination-name>, <destination-custom-resource-name>.<destination-custom-resource-namespace>)`
153
181
2.**Tenant context not available**: Verify tenant information is properly set in the request context
154
182
3.**Authentication failures**: Check that authentication headers and parameters are correctly configured
155
183
4.**Network connectivity**: Verify that the Transparent Proxy is accessible from your environment
@@ -177,9 +205,12 @@ try {
177
205
-`X-Error-Origin` - the source of the error
178
206
-`X-Proxy-Server` - the proxy server (Transparent Proxy)
179
207
-`X-Error-Message` - thorough error message
180
-
-`X-Error-Internal-Code` - set only when the source of the error is the XSUAA or Destination service. The value is the HTTP code returned from one of these services.
208
+
-`X-Error-Internal-Code` - set only when the source of the error is the XSUAA or Destination service.
209
+
The value is the HTTP code returned from one of these services.
181
210
-`X-Request-Id` is sent with the response in all requests, both successful and failed
182
211
212
+
For more information, see [Troubleshooting](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/transparent-proxy-troubleshooting)
213
+
183
214
## Related Documentation
184
215
185
216
-[HTTP Client](http-client) - For using destinations with HTTP clients
0 commit comments