Skip to content

Commit

Permalink
Fleshed out main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Joe Elliott committed Jul 7, 2019
1 parent d531671 commit 9074c77
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 8 deletions.
3 changes: 0 additions & 3 deletions docs/dashboards.md

This file was deleted.

20 changes: 19 additions & 1 deletion docs/deploy.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
# deploy

wip
wip

#### flags
The following 5 flags are the most commonly used to control cert-exporter behavior. They allow you to use file globs to include and exclude certs and kubeconfig files.

```
-exclude-cert-glob value
File globs to exclude when looking for certs.
-exclude-kubeconfig-glob value
File globs to exclude when looking for kubeconfigs.
-include-cert-glob value
File globs to include when looking for certs.
-include-kubeconfig-glob value
File globs to include when looking for kubeconfigs.
-polling-period duration
Periodic interval in which to check certs. (default 1h0m0s)
```

For a full flag listing run the application with the `--help` parameter.
17 changes: 13 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,18 @@ Kubernetes uses PKI certificates for authentication between all major components

### Usage

wip
cert-exporter supports x509 certificates on disk encoded in the [PEM format](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) as well as certs embedded or referenced from kubeconfig files. Certificates are often stored both ways when building clusters.

See [deployment](./docs/deploy.md) for detailed information on running cert-exporter and examples of running it in a [kops](https://github.com/kubernetes/kops) cluster.

### Dashboard

After running cert-exporter in your cluster it's easy to build a [custom dashboard](./docs/sample-dashboard.yaml) to expose information about the certs in your cluster.

![cert-exporter dashboard](./docs/dashboard.png)

### Docs
- [testing](./docs/testing.md)
- [deploy](./docs/deploy.md)
- [dashboards](./docs/dashboards.md)
- [Testing](./docs/testing.md)
- An overview of the testing scripts and how to run them.
- [Deploy](./docs/deploy.md)
- Information on how to deploy cert-exporter as well as examples for a kops cluster.

0 comments on commit 9074c77

Please sign in to comment.