Skip to content

Commit

Permalink
Add config info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Troy Astle committed May 23, 2023
1 parent d58414b commit 7a99996
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# Intro

This repo contains 'cmd-admission-webhook-k8s' an application thar registers the Network Service Mesh
`Mutatingwebhookconfigurations` and responds to mutation requests.

# Usage

## Environment config

`cmd-admission-webhook-k8s` accept following environment variables:

| Variable | Type | Default | Description |
| -------- | ---- | ------- | ----------- |
| NSM_NAME | string | `admission-webhook-k8s` | Name of current admission webhook instance |
| NSM_SERVICE_NAME | string | `default` | Name of service that related to this admission webhook instance |
| NSM_NAMESPACE | string | `default` | Namespace where admission webhook is deployed |
| NSM_ANNOTATION | string | `networkservicemesh.io` | Name of annotation that means that the resource can be handled by admission-webhook |
| NSM_LABELS | map[string]string | | Map of labels and their values to be appended for each deployment that has `NSM_ANNOTATION` |
| NSM_NSURL_ENV_NAME | string | `NSM_NETWORK_SERVICES` | Name of environment variable that contains NSURL in initContainers/Containers |
| NSM_INIT_CONTAINER_IMAGES | []string | | List of init containers to be appended for each deployment that has `NSM_ANNOTATION` |
| NSM_CONTAINER_IMAGES | []string | | List of containers to be appended for each deployment that has `NSM_ANNOTATION` |
| NSM_ENVS | []string | | Additional environment variables to be appended to each appeded container and init container |
| NSM_CERT_FILE_PATH | string | | Path to certificate |
| NSM_KEY_FILE_PATH | string | | Path to RSA/Ed25519 related to `NSM_CERT_FILE_PATH` |
| NSM_CA_BUNDLE_FILE_PATH | string | | Path to cabundle file related to `NSM_CERT_FILE_PATH` |
| NSM_OPEN_TELEMETRY_ENDPOINT | string | `otel-collector.observability.svc.cluster.local:4317` | OpenTelemetry Collector Endpoint |

# Build

## Build cmd binary locally
Expand Down

0 comments on commit 7a99996

Please sign in to comment.