From 576e9ee80189f2ec5c47c14c4ef1c55359966d40 Mon Sep 17 00:00:00 2001 From: Ian MacDougall Date: Tue, 5 Jun 2018 11:23:11 +0100 Subject: [PATCH] docs: Add in documentation --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 75b5077..0f1d30b 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,14 @@ The following environment variables can be set: Name | description | default --- | --- | --- +DOCKER_CERTIFICATE_SECRET | You **must** provide a certificate to enable TLS between the docker daemon and the registry and create a secret from it, this variable is the name of the secret | None NAMESPACE | The namespace in which the resources should be created. This should be the same namespace as where the container is running | default SECONDS_BETWEEN_STREAMS | Time to sleep between calls to the API. The operator will occasionally lose connection or else fail to run if the Custom Resource Definition does not exist. | 30 HOSTESS_DOCKER_REGISTRY | The docker registry where mirror-hostess is to be pulled from. | docker.io HOSTESS_DOCKER_IMAGE | The name of the docker image for mirror-hostess. | ocadotechnology/mirror-hostess HOSTESS_DOCKER_TAG | The tag for the mirror-hostess docker image. | 1.1.0 +IMAGE_PULL_SECRETS | (Optional) Secret to pull images from the upstream registry | None +CA_CERTIFICATE_BUNDLE | (Optional) Certificate bundle for the registry host | None ## Usage In order to have the operator deploy a new mirror, the cluster needs to have the custom resource defined: