Skip to content

Commit

Permalink
docs: Add in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
blerko committed Jun 5, 2018
1 parent fa1abbe commit 576e9ee
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 576e9ee

Please sign in to comment.