Skip to content

Commit

Permalink
Add documentation on how to use the types.
Browse files Browse the repository at this point in the history
  • Loading branch information
jelmersnoeck committed Jan 3, 2018
1 parent f9f2952 commit 0d4dc22
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased

### Added

- Added the posibility to specify the secret type that needs to be generated for a resource.

### Changed

- Put the default controller deployment in it's own namespace.
Expand Down
24 changes: 24 additions & 0 deletions README.md
Expand Up @@ -78,6 +78,30 @@ the new value.
By using exsiting Kubernetes secrets, we allow you to use the Manifold
credentials as secrets. We've [provided an example manifest file](_examples/secrets-usage/manifest.yml).

### Defining secret types

Kubernetes allows you to set up different types of secrets, such as Opaque,
Docker Registry, TLS, ….

The Manifold CRD allows you to create Opaque and Docker Registry types. The
Opaque type is the default and is transparant, meaning that all credentials
that are available through your custom resource will be loaded as a secret.

#### Docker Registry

Using the Docker Registry type it's possible to create a secret which will make
it possible to pull images from a private registry. This secret type requires
you to have the following credentials available:

- `DOCKER_USERNAME`
- `DOCKER_EMAIL`
- `DOCKER_PASSWORD`

There is the optional `DOCKER_SERVER` if your registry is anything other than
Docker Hub.

We've provided [an example](_examples/docker-registry/manifest.yml) on how to use the `docker-registry` secret type.

## Installation

### Setting up the controller
Expand Down

0 comments on commit 0d4dc22

Please sign in to comment.