|
| 1 | +[](https://circleci.com/gh/giantswarm/cert-manager-app) |
| 2 | + |
| 3 | +# cert-manager-app |
| 4 | + |
| 5 | +Helm chart for the [cert-manager](https://cert-manager.io/) app running in Giant Swarm clusters. |
| 6 | + |
| 7 | +This repository contains the source of the helm chart for the Giant Swarm cert-manager app. This fork tracks the upstream chart closely but contains some changes to make it run smoothly on Giant Swarm clusters. |
| 8 | + |
| 9 | +cert-manager adds certificates and certificate issuers (e.g. [Let's Encrypt](https://letsencrypt.org/docs/) (ACME)) as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates. |
| 10 | + |
| 11 | +## Index |
| 12 | +- [Installing](#installing) |
| 13 | +- [Configuration](#configuration) |
| 14 | +- [Upgrading](#upgrading) |
| 15 | +- [Contributing & Reporting Bugs](#contributing--reporting-bugs) |
| 16 | +- [Release Process](#release-process) |
| 17 | + |
| 18 | +## Installing |
| 19 | + |
| 20 | +There are 2 ways to install this app onto a workload cluster. If your clusters are running on AWS, cert-manager is already installed as a default app. |
| 21 | + |
| 22 | +1. [Using our web interface](https://docs.giantswarm.io/ui-api/web/app-platform/#installing-an-app) |
| 23 | +3. Directly creating the [App custom resource](https://docs.giantswarm.io/getting-started/app-platform/deploy-app/#creating-an-app-cr) on the management cluster. |
| 24 | + |
| 25 | +### Issuing Certificates |
| 26 | + |
| 27 | +First, an [Issuer](https://cert-manager.io/docs/configuration/) should be configured. There are several ways to [issue certificates](https://cert-manager.io/docs/usage/) through cert-manager. Check upstream documentation for your use case. |
| 28 | + |
| 29 | +## Configuration |
| 30 | + |
| 31 | +Configuration options are documented in [Configuration.md](https://github.com/giantswarm/cert-manager-app/blob/main/helm/cert-manager-app/Configuration.md) document. |
| 32 | + |
| 33 | +## Upgrading |
| 34 | + |
| 35 | +Before upgrading, please check [Upgrading.md](https://github.com/giantswarm/cert-manager-app/blob/main/docs/upgrading.md). |
| 36 | + |
| 37 | +## Contributing & Reporting Bugs |
| 38 | + |
| 39 | +If you have suggestions for how `cert-manager` could be improved, or want to report a bug, open an issue! We'd love all and any contributions. |
| 40 | + |
| 41 | +Check out the [Contributing Guide](https://github.com/giantswarm/cert-manager-app/blob/main/CONTRIBUTING.md) for details on the contribution workflow, submitting patches, and reporting bugs. |
| 42 | + |
| 43 | +## Release Process |
| 44 | + |
| 45 | +* Ensure CHANGELOG.md is up to date. |
| 46 | +* Create a new branch to trigger the release workflow as either a patch, minor, or major. E.g. to release a patch, create a branch from main called `release#patch` and push it. Automation will create a release PR. |
| 47 | +* Merging the release PR will push a new git tag and trigger a new tarball to be pushed to the |
| 48 | + [giantswarm-catalog]. |
| 49 | +* Test and verify the cert-manager release across supported environments in a new or existing WIP platform release. |
| 50 | + |
| 51 | + |
| 52 | +--- |
| 53 | + |
| 54 | +[app-operator]: https://github.com/giantswarm/app-operator |
| 55 | +[cluster-operator]: https://github.com/giantswarm/cluster-operator |
| 56 | +[cert-manager]: https://github.com/cert-manager/cert-manager |
| 57 | +[default-catalog]: https://github.com/giantswarm/default-catalog |
| 58 | +[default-test-catalog]: https://github.com/giantswarm/default-test-catalog |
| 59 | +[giantswarm-catalog]: https://github.com/giantswarm/giantswarm-catalog |
0 commit comments