Skip to content

Commit

Permalink
add docs for trust-manager v0.6.0
Browse files Browse the repository at this point in the history
Signed-off-by: Ashley Davis <ashley.davis@venafi.com>
  • Loading branch information
SgtCoDFish committed Aug 24, 2023
1 parent cb4d48d commit a91777d
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 5 deletions.
2 changes: 2 additions & 0 deletions .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,8 @@ ssl
cert.pem
Rollout
rollout
JKS-formatted
changeit

# TEMPORARY
# these are temporarily ignored because the spellchecker
Expand Down
14 changes: 14 additions & 0 deletions content/docs/projects/trust-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,20 @@ helm upgrade -i -n cert-manager cert-manager jetstack/cert-manager --set install
helm upgrade -i -n cert-manager trust-manager jetstack/trust-manager --wait
```

### approver-policy Integration

If you're running [approver-policy](../approver-policy/README.md) then cert-manager's default approver will be disabled which will mean that
trust-manager's webhook certificate will - by default - block when you install the Helm chart until it's manually approved.

As of trust-manager v0.6.0 you can choose to automatically add an approver-policy `CertificateRequestPolicy` which
will approve the trust-manager webhook certificate:

```bash
helm upgrade -i -n cert-manager trust-manager jetstack/trust-manager --set app.webhook.tls.approverPolicy.enabled=true --set app.webhook.tls.approverPolicy.certManagerNamespace=cert-manager --wait
```

Note that if you've installed cert-manager to a different namespace, you'll need to pass that namespace in `app.webhook.tls.approverPolicy.certManagerNamespace`!

### Manual Installation

We strongly recommend that you install trust-manager using Helm and we don't currently support manually installed
Expand Down
8 changes: 4 additions & 4 deletions content/docs/projects/trust-manager/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ AdditionalFormats specifies any additional formats to write to the target
<td><b><a href="#bundlespectargetadditionalformatsjks">jks</a></b></td>
<td>object</td>
<td>
KeySelector is a reference to a key for some map data object.<br/>
JKS requests a JKS-formatted binary trust bundle to be written to the target. The bundle is created with the hardcoded password "changeit".<br/>
</td>
<td>false</td>
</tr></tbody>
Expand All @@ -278,7 +278,7 @@ AdditionalFormats specifies any additional formats to write to the target
### `Bundle.spec.target.additionalFormats.jks`


KeySelector is a reference to a key for some map data object.
JKS requests a JKS-formatted binary trust bundle to be written to the target. The bundle is created with the hardcoded password "changeit".

<table>
<thead>
Expand Down Expand Up @@ -510,7 +510,7 @@ AdditionalFormats specifies any additional formats to write to the target
<td><b><a href="#bundlestatustargetadditionalformatsjks">jks</a></b></td>
<td>object</td>
<td>
KeySelector is a reference to a key for some map data object.<br/>
JKS requests a JKS-formatted binary trust bundle to be written to the target. The bundle is created with the hardcoded password "changeit".<br/>
</td>
<td>false</td>
</tr></tbody>
Expand All @@ -520,7 +520,7 @@ AdditionalFormats specifies any additional formats to write to the target
### `Bundle.status.target.additionalFormats.jks`


KeySelector is a reference to a key for some map data object.
JKS requests a JKS-formatted binary trust bundle to be written to the target. The bundle is created with the hardcoded password "changeit".

<table>
<thead>
Expand Down
2 changes: 1 addition & 1 deletion scripts/gendocs/generate-trust-manager
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ gendocs() {
echo "+++ Cloning trust-manager repository..."
git clone "https://github.com/cert-manager/trust-manager.git" "$tmpdir"

checkout "v0.5.0"
checkout "v0.6.0"

gendocs "$REPO_ROOT/content/docs/projects/trust-manager/api-reference.md"

0 comments on commit a91777d

Please sign in to comment.