Skip to content
This repository has been archived by the owner on Mar 22, 2024. It is now read-only.

Commit

Permalink
Add a FAQ and switch rare issue from README to it
Browse files Browse the repository at this point in the history
Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
  • Loading branch information
kfox1111 committed Aug 8, 2023
1 parent 1e3039c commit f02fead
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 48 deletions.
40 changes: 40 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Frequently Asked Questions

- [Uninstall is stuck. How do I fix it?](#uninstall-is-stuck-how-do-i-fix-it)
- [The PSAT plugin is not working](#the-psat-plugin-is-not-working)

## Uninstall is stuck. How do I fix it?

If you uninstall the spiffe csi driver manually before removing the chart, pods can still be using the driver an are unable to mount the csi volume.

To resolve, reinstall the chart before trying to remove it again.

## The PSAT plugin is not working

The chart requires `Projected Service Account Tokens` which has to be enabled on your k8s api server. In most cases this is already done for you.

> **Note** This is enabled by default with newer versions as shown by the existence of:
>
> - --service-account-issuer
> - --service-account-key-file
> - --service-account-signing-key-file
See [Service Account Token Volume Projection](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#serviceaccount-token-volume-projection) in the Kubernetes docs for more details.

To enable Projected Service Account Tokens on Docker for Mac/Windows run the following
command to SSH into the Docker Desktop K8s VM.

```bash
docker run -it --privileged --pid=host debian nsenter -t 1 -m -u -n -i sh
```
Then add the following to `/etc/kubernetes/manifests/kube-apiserver.yaml`
```yaml
spec:
containers:
- command:
- kube-apiserver
- --api-audiences=api,spire-server
- --service-account-issuer=api,spire-agent
- --service-account-key-file=/run/config/pki/sa.pub
- --service-account-signing-key-file=/run/config/pki/sa.key
```
24 changes: 0 additions & 24 deletions charts/spire/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,30 +23,6 @@ A Helm chart for deploying the complete Spire stack including: spire-server, spi

> **Note**: For Kubernetes, we will officially support the last 3 versions as described in [k8s versioning](https://kubernetes.io/releases/version-skew-policy/#supported-versions). Any version before the last 3 we will try to support as long it doesn't bring security issues or any big maintenance burden.
## Prerequisites

Please note this chart requires `Projected Service Account Tokens` which has to be enabled on your k8s api server.

To enable Projected Service Account Tokens on Docker for Mac/Windows run the following
command to SSH into the Docker Desktop K8s VM.

```bash
docker run -it --privileged --pid=host debian nsenter -t 1 -m -u -n -i sh
```

Then add the following to `/etc/kubernetes/manifests/kube-apiserver.yaml`

```yaml
spec:
containers:
- command:
- kube-apiserver
- --api-audiences=api,spire-server
- --service-account-issuer=api,spire-agent
- --service-account-key-file=/run/config/pki/sa.pub
- --service-account-signing-key-file=/run/config/pki/sa.key
```
## Usage

To utilize Spire in your own workloads you should add the following to your workload:
Expand Down
24 changes: 0 additions & 24 deletions charts/spire/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -25,30 +25,6 @@

> **Note**: For Kubernetes, we will officially support the last 3 versions as described in [k8s versioning](https://kubernetes.io/releases/version-skew-policy/#supported-versions). Any version before the last 3 we will try to support as long it doesn't bring security issues or any big maintenance burden.

## Prerequisites

Please note this chart requires `Projected Service Account Tokens` which has to be enabled on your k8s api server.

To enable Projected Service Account Tokens on Docker for Mac/Windows run the following
command to SSH into the Docker Desktop K8s VM.

```bash
docker run -it --privileged --pid=host debian nsenter -t 1 -m -u -n -i sh
```

Then add the following to `/etc/kubernetes/manifests/kube-apiserver.yaml`

```yaml
spec:
containers:
- command:
- kube-apiserver
- --api-audiences=api,spire-server
- --service-account-issuer=api,spire-agent
- --service-account-key-file=/run/config/pki/sa.pub
- --service-account-signing-key-file=/run/config/pki/sa.key
```

## Usage

To utilize Spire in your own workloads you should add the following to your workload:
Expand Down

0 comments on commit f02fead

Please sign in to comment.