ContainerImage.Pinniped/README.md

# Pinniped

<img src="https://cdn.pixabay.com/photo/2015/12/07/21/52/harbor-1081482_1280.png" alt="Image of pinniped" width="250px"/>

<!--
    Image source: https://pixabay.com/illustrations/harbor-seal-sitting-maine-marine-1081482/
    Free for commercial use without attribution. https://pixabay.com/service/license/
-->

## About Pinniped

Pinniped provides authentication for Kubernetes clusters.

## Developing

### Running Lint

```cmd
./hack/module.sh lint
```

### Running Tests

```cmd
./hack/module.sh unittest
```

### Pre-commit hooks

This project uses the [pre-commit] to agree on some conventions about whitespace/file encoding.

```cmd
$ brew install pre-commit
[...]
$ pre-commit install
pre-commit installed at .git/hooks/pre-commit
```

[pre-commit]: https://pre-commit.com/

## Licence

Pinniped is open source and licenced under Apache License Version 2.0. See [LICENSE](LICENSE) file.

Copyright 2020 VMware, Inc.
Rename project 2020-08-20 17:54:15 +00:00			`# Pinniped`
First draft of moving API server TLS cert generation to controllers - Refactors the existing cert generation code into controllers which read and write a Secret containing the certs - Does not add any new functionality yet, e.g. no new handling for cert expiration, and no leader election to allow for multiple servers running simultaneously - This commit also doesn't add new tests for the cert generation code, but it should be more unit testable now as controllers 2020-08-09 17:04:05 +00:00
Rename project 2020-08-20 17:54:15 +00:00			`<img src="https://cdn.pixabay.com/photo/2015/12/07/21/52/harbor-1081482_1280.png" alt="Image of pinniped" width="250px"/>`

			`<!--`
			`Image source: https://pixabay.com/illustrations/harbor-seal-sitting-maine-marine-1081482/`
			`Free for commercial use without attribution. https://pixabay.com/service/license/`
			`-->`

			`## About Pinniped`

			`Pinniped provides authentication for Kubernetes clusters.`
Add some development notes to the README for now. Signed-off-by: Matt Moyer <moyerm@vmware.com> 2020-08-14 19:47:39 +00:00
			`## Developing`

			`### Running Lint`

			```cmd
			`./hack/module.sh lint`
			```

			`### Running Tests`

			```cmd
			`./hack/module.sh unittest`
			```

			`### Pre-commit hooks`

			`This project uses the [pre-commit] to agree on some conventions about whitespace/file encoding.`

			```cmd
			`$ brew install pre-commit`
			`[...]`
			`$ pre-commit install`
			`pre-commit installed at .git/hooks/pre-commit`
			```

			`[pre-commit]: https://pre-commit.com/`
Rename project 2020-08-20 17:54:15 +00:00
			`## Licence`

			`Pinniped is open source and licenced under Apache License Version 2.0. See [LICENSE](LICENSE) file.`

			`Copyright 2020 VMware, Inc.`