Update FAQ from repo switch (#15)

* Update FAQ from repo switch Signed-off-by: Faisal Memon <[email protected]> * Add note about repo name Signed-off-by: Faisal Memon <[email protected]> * Clarify old and new forks Signed-off-by: Faisal Memon <[email protected]> --------- Signed-off-by: Faisal Memon <[email protected]>
spiffe · Oct 4, 2023 · ebfa518 · ebfa518
1 parent c23e6cb
commit ebfa518
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/FAQ.md b/FAQ.md
@@ -1,9 +1,36 @@
 # Frequently Asked Questions
 
+- [How does this repo relate to the helm-charts repo?](#how-does-this-repo-relate-to-the-helm-charts-repo)
+- [How do I migrate my changeset from the old helm-charts repo to this one?](#how-do-i-migrate-my-changeset-from-the-old-helm-charts-repo-to-this-one)
+- [How do I update my helm registry to point to this one?](#how-do-i-update-my-helm-registry-to-point-to-this-one)
 - [Pods are stuck terminating after uninstall. How do I fix it?](#pods-are-stuck-terminating-after-uninstall-how-do-i-fix-it)
 - [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)
 
+## How does this repo relate to the helm-charts repo?
+
+The helm-charts repo has been archived. This repo has all the commit history and releases copied over from that repo and is continuing development to provide a SPIRE helm chart for the community to use and contribute to.
+
+## How do I migrate my changeset from the old helm-charts repo to this one?
+
+Run one of these commands to switch to the new repo:
+
+- If working off a branch (maintainers with write access): `git remote set-url origin [email protected]:spiffe/helm-charts-hardened.git`
+- If working off a fork:
+    1. Create a new fork of helm-charts-hardened
+    1. In your local clone of your old fork of helm-charts: `git remote set-url origin https://github.com/<your new fork>/helm-charts-hardened.git`
+
+Then just `git push` your branches. Git history has been migrated over so you can just push your existing branches without issues.
+
+## How do I update my helm registry to point to this one?
+
+Assuming you named the repo `spiffe`:
+
+``` bash
+helm repo remove spiffe
+helm repo add spiffe https://spiffe.github.io/helm-charts-hardened
+```
+
 ## Pods are stuck terminating after uninstall. How do I fix it?
 
 If you uninstall the SPIRE chart before all users of the CSI driver are removed, Pods will get stuck in a terminating state waiting for the driver, that no longer is installed, to unmount the volumes for the Pod. In order to fix this, reinstall the chart and remove all affected workloads that are not part of the SPIRE helm chart itself, before attempting to remove SPIRE again.