Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Kevin Fox <[email protected]>
  • Loading branch information
kfox1111 committed Nov 25, 2023
1 parent d67e60c commit 59791b1
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 91 deletions.
46 changes: 37 additions & 9 deletions charts/spire/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,57 @@ A Helm chart for deploying the complete Spire stack including: spire-server, spi

**Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>

## Install notes
## Install Instructions

### Non Production
To do a quick non production install suitable for quick testing in something like minikube:

```shell
helm install -n spire-server spire-crds --repo https://spiffe.github.io/helm-charts-hardened/ --create-namespace
helm install -n spire-server spire --repo https://spiffe.github.io/helm-charts-hardened/
helm upgrade --install -n spire-server spire-crds spire-crds --repo https://spiffe.github.io/helm-charts-hardened/ --create-namespace
helm upgrade --install -n spire-server spire spire --repo https://spiffe.github.io/helm-charts-hardened/
```

To customize, start with a base values file and edit as needed:
### Production

Preparing a production deployment requires a few steps.

Step 1: Save the following to your-values.yaml, ideally your git repo.
```yaml
global:
openshift: false # If running on openshift, set to true
spire:
useRecommended:
enabled: true
namespaces:
create: true
ingressControllerType: "" # If not openshift, and want to expose services, set to a supported option [ingress-nginx]
# Update these
clusterName: example-cluster
trustDomain: example.org
spire-server:
ca_subject:
# Update these
country: ARPA
organization: Example
common_name: example.org
```
Step 2: If your Kubernetes cluster is OpenShift based, use the output of the following command for your trustDomain:
```shell
curl -o your-values.yaml https://raw.githubusercontent.com/spiffe/helm-charts-hardened/main/examples/production/example-your-values.yaml
oc get cm -n openshift-config-managed console-public -o go-template="{{ .data.consoleURL }}" | sed 's@https://@@; s/^[^.]*\.//'
```
Step 3: Find any additional values you might want to set based on the documentation below or the examples at:
https://github.com/spiffe/helm-charts-hardened/tree/main/examples

Step 4: Edit your-values.yaml with the appropriate values.

Then:
Step 5: Deployment

```shell
helm install -n spire-server spire --repo https://spiffe.github.io/helm-charts-hardened/ -f your-values.yaml
helm upgrade --install -n spire-mgmt spire-crds spire-crds --repo https://spiffe.github.io/helm-charts-hardened/ --create-namespace
helm upgrade --install -n spire-mgmt spire spire --repo https://spiffe.github.io/helm-charts-hardened/ -f your-values.yaml
```

For production installs, please see [the production example](https://github.com/spiffe/helm-charts-hardened/tree/main/examples/production).

## Upgrade notes

### 0.15.X
Expand Down
5 changes: 5 additions & 0 deletions examples/openshift-on-ibm-cloud/values.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
spiffe-csi-driver:
kubeletPath: /var/data/kubelet
restrictedScc:
enabled: true

80 changes: 0 additions & 80 deletions examples/openshift/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions examples/openshift/openshift-values.yaml

This file was deleted.

0 comments on commit 59791b1

Please sign in to comment.