Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Commit

Permalink
section on service accounts in readme (#90)
Browse files Browse the repository at this point in the history
add a section on service accounts to the readme


Co-authored-by: airlockgithubci <[email protected]>
  • Loading branch information
libuweber and airlockgithubci authored Feb 19, 2021
1 parent 239f58f commit 4dd261e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
14 changes: 12 additions & 2 deletions charts/microgateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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: <existing service account>
```

## Deployment Smoketest
The following example shows how to run a smoke test against a microgateway deployment.
```
Expand Down
14 changes: 12 additions & 2 deletions charts/microgateway/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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: <existing service account>
```

## Deployment Smoketest
The following example shows how to run a smoke test against a microgateway deployment.
```
Expand Down

0 comments on commit 4dd261e

Please sign in to comment.