From 38c02e8cd810f596ff47e641ac7c08b9a760a91e Mon Sep 17 00:00:00 2001 From: Stanislav Chlebec Date: Tue, 23 Oct 2018 14:03:07 +0200 Subject: Documentation corrected markups. Change-Id: I99ead3648f0175f188e280c76868da7c117d9a28 Signed-off-by: Stanislav Chlebec Issue-ID: AAF-582 --- sidecar/fproxy/README.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) (limited to 'sidecar/fproxy') diff --git a/sidecar/fproxy/README.md b/sidecar/fproxy/README.md index e1d3667..abd6558 100644 --- a/sidecar/fproxy/README.md +++ b/sidecar/fproxy/README.md @@ -1,24 +1,24 @@ -# Introduction +# Forward Proxy Introduction -The AAF Forward Proxy is a forward proxy service with credential caching capabilities for incoming REST requests. It is one of two applications (along with Reverse proxy) deployed as a -Kubernetes sidecar to the main Primary service +The **AAF Forward Proxy** (or **fProxy**) is a forward proxy service with credential caching capabilities for incoming REST requests. It is one of the two applications (alongside with [Reverse proxy][1]) deployed as a +Kubernetes sidecar to the main Primary service. ## Features -Forward Proxy: +**Forward Proxy**: -* The service will forward all incoming REST requests on to their original endpoints. +* The service will forward all incoming REST requests onto their original endpoints. * Add any cached security credentials to the forwarding request ### Credential Cache: The credential cache is a short-lived in-memory cache, keyed on a transaction ID. The following data is cached: -* Transaction ID - this is the key for retrieving cached values -* CredentialName - this is the name of the credential to be cached. +* `Transaction ID` - this is the key for retrieving cached values +* `CredentialName` - this is the name of the credential to be cached. This should correspond to the header name for a header credential, or the cookie name for a cookie credential. -* CredentialValue - this is the value associated with the credential. +* `CredentialValue` - this is the value associated with the credential. This should correspond to the header value of a header credential, or the cookie contents for a cookie credential. -* CredentialType - this is the type of the credential to be cached. Currently supported values are: HEADER, COOKIE. +* `CredentialType` - this is the type of the credential to be cached. Currently supported values are: HEADER, COOKIE. The cache has a configurable cache expiry period, so that any cache entries older than the expiry period will be automatically removed from the cache. ### Credential Cache REST API: @@ -26,16 +26,20 @@ Credentials can be added to the credential cache by performing a REST POST using (Note that the transaction ID is provided as a URL parameter) -https://:/credential-cache/ +`https://:/credential-cache/` The body of the request should contain the cached data (described above) in JSON format as follows: +``` { "credentialName":"foo", "credentialValue":"bar", "credentialType":"
" } - +``` ## Configuring the fProxy service -The fProxy service is configured through the fproxy.properties file that resides under the ${CONFIG_HOME} environment variable. +The **fProxy service** is configured through the `fproxy.properties` file that resides under the `${CONFIG_HOME}` environment variable. The file has the following configurable properties: -credential.cache.timeout.ms This is the time in milliseconds that a cache entry will expire after it is added. 180000 -transactionid.header.name This is the name of the header in incoming requests that will contain the transaction ID. X-TransactionId \ No newline at end of file +- `credential.cache.timeout.ms` This is the time in milliseconds that a cache entry will expire after it is added. e.g. 180000 +- `transactionid.header.name` This is the name of the header in incoming requests that will contain the transaction ID. e.g. X-TransactionId + + +[1]: ../rproxy/README.md -- cgit 1.2.3-korg