diff --git a/docs/dashboards.md b/docs/dashboards.md deleted file mode 100644 index b4a5c46..0000000 --- a/docs/dashboards.md +++ /dev/null @@ -1,3 +0,0 @@ -# dashboards - -wip \ No newline at end of file diff --git a/docs/deploy.md b/docs/deploy.md index 7b95a56..5a12484 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -1,3 +1,21 @@ # deploy -wip \ No newline at end of file +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. diff --git a/readme.md b/readme.md index 0cb851c..6be2a59 100644 --- a/readme.md +++ b/readme.md @@ -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) \ No newline at end of file +- [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. \ No newline at end of file