From 048d5fac811e1886b25d65275b7348d99427fd6e Mon Sep 17 00:00:00 2001 From: Keyfactor Date: Fri, 29 Mar 2024 16:37:21 +0000 Subject: [PATCH] Update generated README --- README.md | 52 +++++++++++++++++++++++++++++++++------------------- 1 file changed, 33 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 748ddff..31d4e35 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,13 @@ ejbca-cert-manager-issuer is open source and supported on best effort level for - - Terraform logo + + + EJBCA logo + + + + EJBCA logo # Keyfactor EJBCA Issuer for cert-manager @@ -33,27 +38,36 @@ ejbca-cert-manager-issuer is open source and supported on best effort level for The EJBCA external issuer for cert-manager allows users to enroll certificates from Keyfactor EJBCA using cert-manager. -Cert-manager is a native Kubernetes certificate management controller which allows applications to get their certificates from a variety of CAs (Certification Authorities). It ensures certificates are valid and up to date, it also attempts to renew certificates at a configured time before expiration. +Cert-manager is a native Kubernetes certificate management controller that allows applications to get their certificates from a variety of CAs (Certification Authorities). It ensures certificates are valid and up to date, it also attempts to renew certificates at a configured time before expiration. -## Community supported -We welcome contributions. +## Get started -The cert-manager external issuer for Keyfactor EJBCA is open source and community supported, meaning that there is **no SLA** applicable for these tools. +* To install the tool, see [Installation](docs/install.md). +* To configure and use the tool, see: + * [Usage](docs/config_usage.md) + * [Customization](docs/annotations.md) + * [End Entity Name Selection](docs/endentitynamecustomization.md) +* To test the tool, see [Testing the Source](docs/testing.md). -###### To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, see the [contribution guidelines](https://github.com/Keyfactor/ejbca-k8s-csr-signer/blob/main/CONTRIBUTING.md) and use the **[Pull requests](../../pulls)** tab. +### System Requirements -## EJBCA API Usage -The EJBCA Issuer for cert-manager requires the following API endpoints: -* `/ejbca-rest-api/v1/certificate/pkcs10enroll` -* `/ejbca/ejbca-rest-api/v1/certificate/status` +For more information, see [Prerequisites](https://github.com/KarolinHem/ejbca-cert-manager-issuer/blob/main/docs/install.md#prerequisites). -## Docs +## Community Support +In the [Keyfactor Community](https://www.keyfactor.com/community/), we welcome contributions. -* [Installation](docs/install.md) -* Usage - * [Usage](docs/config_usage.md) - * [Customization](docs/annotations.md) - * [End Entity Name Selection](docs/endentitynamecustomization.md) -* [Testing the Source](docs/testing.md) -* [License](LICENSE) +The Community software is open-source and community-supported, meaning that **no SLA** is applicable. + +* To report a problem or suggest a new feature, go to [Issues](../../issues). +* If you want to contribute actual bug fixes or proposed enhancements, see the [Contributing Guidelines](CONTRIBUTING.md) and go to [Pull requests](../../pulls). + +## Commercial Support + +Commercial support is available for [EJBCA Enterprise](https://www.keyfactor.com/products/ejbca-enterprise/). + +## License +For license information, see **[LICENSE](LICENSE)**. + +## Related Projects +See all [Keyfactor EJBCA GitHub projects](https://github.com/orgs/Keyfactor/repositories?q=ejbca).