From 4dd261ea9ca562245162a347dcb90d3b22ff04ee Mon Sep 17 00:00:00 2001 From: Roland Weber Date: Fri, 19 Feb 2021 12:32:46 +0100 Subject: [PATCH] section on service accounts in readme (#90) add a section on service accounts to the readme Co-authored-by: airlockgithubci --- charts/microgateway/README.md | 14 ++++++++++++-- charts/microgateway/README.md.gotmpl | 14 ++++++++++++-- 2 files changed, 24 insertions(+), 4 deletions(-) diff --git a/charts/microgateway/README.md b/charts/microgateway/README.md index 32df0921..f4bf1a61 100644 --- a/charts/microgateway/README.md +++ b/charts/microgateway/README.md @@ -43,12 +43,13 @@ The current chart version is: 0.6.7 * [Route Edge configuration](#route-edge-configuration) * [Route Re-encrypt configuration](#route-re-encrypt-configuration) * [Route Passthrough configuration](#route-passthrough-configuration) - * [Automated Hostname Assignment](#automated-hostname-assignment) + * [Hostnames Generated by Openshift](#hostnames-generated-by-openshift) * [Security](#security) * [Store sensitive information in secrets](#store-sensitive-information-in-secrets) * [Secure handling of license and passphrase](#secure-handling-of-license-and-passphrase) * [Credentials to pull image from Docker registry](#credentials-to-pull-image-from-docker-registry) * [Certificates for Microgateway](#certificates-for-microgateway) + * [Service Account](#service-account) * [Deployment Smoketest](#deployment-smoketest) ## Introduction @@ -744,7 +745,7 @@ Therefore, no certificates need to be configured on the Route and termination ta destinationCACertificate: "" ``` -#### Automated Hostname Assignment +#### Hostnames Generated by Openshift Openshift assigns an automatically generated hostname to a route if you do not provide one. You can achieve this by specifying an empty string as hostname. @@ -842,6 +843,15 @@ Used for backend connection: generic: tlsSecretName: "microgateway-tls" ``` +### Service Account +The microgateway runs under a dedicated service account created with the deployment by default. +The following example shows how to use an existing service account instead of having one created in the deployment. +``` +serviceAccount: + create: false + name: +``` + ## Deployment Smoketest The following example shows how to run a smoke test against a microgateway deployment. ``` diff --git a/charts/microgateway/README.md.gotmpl b/charts/microgateway/README.md.gotmpl index 593b38da..7ad3353f 100644 --- a/charts/microgateway/README.md.gotmpl +++ b/charts/microgateway/README.md.gotmpl @@ -42,12 +42,13 @@ The current chart version is: {{ template "chart.version" . }} * [Route Edge configuration](#route-edge-configuration) * [Route Re-encrypt configuration](#route-re-encrypt-configuration) * [Route Passthrough configuration](#route-passthrough-configuration) - * [Automated Hostname Assignment](#automated-hostname-assignment) + * [Hostnames Generated by Openshift](#hostnames-generated-by-openshift) * [Security](#security) * [Store sensitive information in secrets](#store-sensitive-information-in-secrets) * [Secure handling of license and passphrase](#secure-handling-of-license-and-passphrase) * [Credentials to pull image from Docker registry](#credentials-to-pull-image-from-docker-registry) * [Certificates for Microgateway](#certificates-for-microgateway) + * [Service Account](#service-account) * [Deployment Smoketest](#deployment-smoketest) ## Introduction @@ -635,7 +636,7 @@ Therefore, no certificates need to be configured on the Route and termination ta destinationCACertificate: "" ``` -#### Automated Hostname Assignment +#### Hostnames Generated by Openshift Openshift assigns an automatically generated hostname to a route if you do not provide one. You can achieve this by specifying an empty string as hostname. @@ -734,6 +735,15 @@ Used for backend connection: generic: tlsSecretName: "microgateway-tls" ``` +### Service Account +The microgateway runs under a dedicated service account created with the deployment by default. +The following example shows how to use an existing service account instead of having one created in the deployment. +``` +serviceAccount: + create: false + name: +``` + ## Deployment Smoketest The following example shows how to run a smoke test against a microgateway deployment. ```