Skip to content

Commit 09ff154

Browse files
m8rmclarenm8rmclaren
authored
Merge pull request #8 from Keyfactor/helmdocs
chore: Update docs with Helm chart installation
2 parents af07af6 + c1f8683 commit 09ff154

File tree

2 files changed

+63
-21
lines changed

2 files changed

+63
-21
lines changed

‎README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ Additionally, verify that at least one Kubernetes node is running by running the
4343
kubectl get nodes
4444
```
4545

46+
### Installation from Manifests
47+
4648
Once Kubernetes is running, a static installation of cert-manager can be installed with the following command:
4749
```shell
4850
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.11.0/cert-manager.yaml
@@ -60,6 +62,26 @@ Finally, deploy the controller to the cluster:
6062
make deploy
6163
```
6264

65+
### Installation from Helm Chart
66+
67+
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/).
68+
69+
First, add the Helm repository:
70+
```bash
71+
helm repo add command-issuer https://keyfactor.github.io/command-cert-manager-issuer
72+
helm repo update
73+
```
74+
75+
Then, install the chart:
76+
```bash
77+
helm install command-cert-manager-issuer command-issuer/command-cert-manager-issuer
78+
```
79+
80+
Modifications can be made by overriding the default values in the `values.yaml` file with the `--set` flag. For example, to override the `replicaCount` value, run the following command:
81+
```bash
82+
helm install command-cert-manager-issuer command-issuer/command-cert-manager-issuer --set replicaCount=2
83+
```
84+
6385
## Usage
6486
The cert-manager external issuer for Keyfactor Command can be used to issue certificates from Keyfactor Command using cert-manager.
6587

‎deploy/charts/command-cert-manager-issuer/README.md‎

Lines changed: 41 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,55 @@
66

77
[![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)
88
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://img.shields.io/badge/License-Apache%202.0-blue.svg)
9-
![Version: v0.1.0](https://img.shields.io/badge/Version-v0.1.0-informational?style=flat-square)
9+
![Version: v1.0.3](https://img.shields.io/badge/Version-v1.0.3-informational?style=flat-square)
1010
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
1111
![AppVersion: v1.0.3](https://img.shields.io/badge/AppVersion-v1.0.3-informational?style=flat-square)
1212

1313
A Helm chart for the Keyfactor Command External Issuer for cert-manager.
1414

1515
The Command external issuer for cert-manager allows users to enroll certificates from Keyfactor Command using cert-manager.
1616

17+
## Installation
18+
19+
### Add Helm Repository
20+
21+
```bash
22+
helm repo add command-issuer https://keyfactor.github.io/command-cert-manager-issuer
23+
helm repo update
24+
```
25+
26+
### Install Chart
27+
28+
```bash
29+
helm install command-cert-manager-issuer command-issuer/command-cert-manager-issuer
30+
```
31+
32+
Modifications can be made by overriding the default values in the `values.yaml` file with the `--set` flag. For example, to override the `replicaCount` value, run the following command:
33+
```bash
34+
helm install command-cert-manager-issuer command-issuer/command-cert-manager-issuer --set replicaCount=2
35+
```
36+
1737
## Configuration
1838

1939
The following table lists the configurable parameters of the `command-cert-manager-issuer` chart and their default values.
2040

21-
| Parameter | Description | Default |
22-
|-----------------------------------|-----------------------------------------------------|--------------------------------------------------------------|
23-
| `replicaCount` | Number of replica command-cert-manager-issuers to run | `1` |
24-
| `image.repository` | Image repository | `m8rmclarenkf/command-cert-manager-external-issuer-controller` |
25-
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
26-
| `image.tag` | Image tag | `v1.3.1` |
27-
| `imagePullSecrets` | Image pull secrets | `[]` |
28-
| `nameOverride` | Name override | `""` |
29-
| `fullnameOverride` | Full name override | `""` |
30-
| `crd.create` | Specifies if CRDs will be created | `true` |
31-
| `crd.annotations` | Annotations to add to the CRD | `{}` |
32-
| `serviceAccount.create` | Specifies if a service account should be created | `true` |
33-
| `serviceAccount.annotations` | Annotations to add to the service account | `{}` |
34-
| `serviceAccount.name` | Name of the service account to use | `""` (uses the fullname template if `create` is true) |
35-
| `podAnnotations` | Annotations for the pod | `{}` |
36-
| `podSecurityContext.runAsNonRoot` | Run pod as non-root | `true` |
37-
| `securityContext` | Security context for the pod | `{}` (with commented out options) |
38-
| `resources` | CPU/Memory resource requests/limits | `{}` (with commented out options) |
39-
| `nodeSelector` | Node labels for pod assignment | `{}` |
40-
| `tolerations` | Tolerations for pod assignment | `[]` |
41+
| Parameter | Description | Default |
42+
|-----------------------------------|-------------------------------------------------------|----------------------------------------------------------------|
43+
| `replicaCount` | Number of replica command-cert-manager-issuers to run | `1` |
44+
| `image.repository` | Image repository | `m8rmclarenkf/command-cert-manager-external-issuer-controller` |
45+
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
46+
| `image.tag` | Image tag | `1.0.3` |
47+
| `imagePullSecrets` | Image pull secrets | `[]` |
48+
| `nameOverride` | Name override | `""` |
49+
| `fullnameOverride` | Full name override | `""` |
50+
| `crd.create` | Specifies if CRDs will be created | `true` |
51+
| `crd.annotations` | Annotations to add to the CRD | `{}` |
52+
| `serviceAccount.create` | Specifies if a service account should be created | `true` |
53+
| `serviceAccount.annotations` | Annotations to add to the service account | `{}` |
54+
| `serviceAccount.name` | Name of the service account to use | `""` (uses the fullname template if `create` is true) |
55+
| `podAnnotations` | Annotations for the pod | `{}` |
56+
| `podSecurityContext.runAsNonRoot` | Run pod as non-root | `true` |
57+
| `securityContext` | Security context for the pod | `{}` (with commented out options) |
58+
| `resources` | CPU/Memory resource requests/limits | `{}` (with commented out options) |
59+
| `nodeSelector` | Node labels for pod assignment | `{}` |
60+
| `tolerations` | Tolerations for pod assignment | `[]` |

0 commit comments

Comments
 (0)