Skip to content

Commit

Permalink
chore(docs): Update docs for instructions on using pre-built containe…
Browse files Browse the repository at this point in the history
…r image
  • Loading branch information
m8rmclaren committed Dec 21, 2023
1 parent 2cf282b commit 61bf0f9
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 42 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# v1.0.6

## Features
* feat(helm): Rename `secureMetrics` to `metrics` and add `metrics.secure` and `metrics.metricsAddress` as configuration values. This way, Prometheus can scrape the controller manager metrics without the secure metrics proxy.
* feat(helm): Add configuration element in Helm chart default values file to configure container ports on the controller manager container.

## Fixes
Expand Down
18 changes: 18 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<a href="https://kubernetes.io">
<img src="https://raw.githubusercontent.com/cert-manager/cert-manager/d53c0b9270f8cd90d908460d69502694e1838f5f/logo/logo-small.png" alt="Terraform logo" title="K8s" align="left" height="50" />
</a>

# Keyfactor Command Issuer for cert-manager

[![Go Report Card](https://goreportcard.com/badge/github.com/Keyfactor/command-cert-manager-issuer)](https://goreportcard.com/report/github.com/Keyfactor/command-cert-manager-issuer)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://img.shields.io/badge/License-Apache%202.0-blue.svg)

The Command external issuer for cert-manager allows users to enroll certificates with a CA managed by Keyfactor Command using cert-manager. This allows security administrators to manage the lifecycle of certificates for Kubernetes applications.

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.

* [Installation](install.markdown)
* [Usage](config_usage.markdown)
* [Example Usage](example.markdown)
* [Customization](annotations.markdown)
* [Testing the Source](testing.markdown)
60 changes: 18 additions & 42 deletions docs/install.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,38 +38,7 @@ kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/

###### :pushpin: Running the static cert-manager configuration is not recommended for production use. For more information, see [Installing cert-manager](https://cert-manager.io/docs/installation/).

### Building the Container Image

The cert-manager external issuer for Keyfactor Command is distributed as source code, and the container must be built manually. The container image can be built using the following command:
```shell
make docker-build DOCKER_REGISTRY=<your container registry> DOCKER_IMAGE_NAME=keyfactor/command-cert-manager-issuer VERSION=<tag>
```

###### :pushpin: The container image can be built using Docker Buildx by running `make docker-buildx`. This will build the image for all supported platforms.

To push the container image to a container registry, run the following command:
```shell
docker login <your container registry>
make docker-push DOCKER_REGISTRY=<your container registry> DOCKER_IMAGE_NAME=keyfactor/command-cert-manager-issuer VERSION=<tag>
```

### Installation from Manifests

The cert-manager external issuer for Keyfactor Command can be installed using the manifests in the `config/` directory.

1. Install the custom resource definitions (CRDs) for the cert-manager external issuer for Keyfactor Command:

```shell
make install
```

2. Finally, deploy the controller to the cluster:

```shell
make deploy DOCKER_REGISTRY=<your container registry> DOCKER_IMAGE_NAME=keyfactor/command-cert-manager-issuer VERSION=<tag>
```

### Installation from Helm Chart
### Installation from Helm Chart [recommended]

The cert-manager external issuer for Keyfactor Command can also be installed using a Helm chart. The chart is available in the [Command cert-manager Helm repository](https://keyfactor.github.io/command-cert-manager-issuer/).

Expand All @@ -86,10 +55,7 @@ The cert-manager external issuer for Keyfactor Command can also be installed usi
helm install command-cert-manager-issuer command-issuer/command-cert-manager-issuer \
--namespace command-issuer-system \
--create-namespace \
--set image.repository=<your container registry>/keyfactor/command-cert-manager-issuer \
--set image.tag=<tag> \
--set crd.create=true \
# --set image.pullPolicy=Never # Only required if using a local image
--set crd.create=true
```

1. Modifications can be made by overriding the default values in the `values.yaml` file with the `--set` flag. For example, to override the `secretConfig.useClusterRoleForSecretAccess` to configure the chart to use a cluster role for secret access, run the following command:
Expand All @@ -98,8 +64,6 @@ The cert-manager external issuer for Keyfactor Command can also be installed usi
helm install command-cert-manager-issuer command-issuer/command-cert-manager-issuer \
--namespace command-issuer-system \
--create-namespace \
--set image.repository=<your container registry>/keyfactor/command-cert-manager-issuer \
--set image.tag=<tag> \
--set crd.create=true \
--set secretConfig.useClusterRoleForSecretAccess=true
```
Expand All @@ -108,10 +72,6 @@ The cert-manager external issuer for Keyfactor Command can also be installed usi

```yaml
cat <<EOF > override.yaml
image:
repository: <your container registry>/keyfactor/command-cert-manager-issuer
pullPolicy: Never
tag: "<tag>"
secretConfig:
useClusterRoleForSecretAccess: true
EOF
Expand All @@ -125,4 +85,20 @@ The cert-manager external issuer for Keyfactor Command can also be installed usi
-f override.yaml
```
### Installation from Manifests
The cert-manager external issuer for Keyfactor Command can be installed using the manifests in the `config/` directory.
1. Install the custom resource definitions (CRDs) for the cert-manager external issuer for Keyfactor Command:
```shell
make install
```
2. Finally, deploy the controller to the cluster:
```shell
make deploy DOCKER_REGISTRY=<your container registry> DOCKER_IMAGE_NAME=keyfactor/command-cert-manager-issuer VERSION=<tag>
```
Next, complete the [Usage](config_usage.markdown) steps to configure the cert-manager external issuer for Keyfactor Command.

0 comments on commit 61bf0f9

Please sign in to comment.