Merge pull request #90 from packagist/kubernetes-maintenance

Self-Hosted: start maintenance and troubleshoot guide for Kubernetes

Author: glaubinix

docs/self-hosted/kubernetes-embedded.md

@@ -1,4 +1,4 @@
-# Installing Private Packagist Self-Hosted with an embeded Kubernetes cluster
+# Installing Private Packagist Self-Hosted in a Kubernetes cluster installed with kURL
 ##
 
 Private Packagist Self-Hosted leverages the [kots](https://docs.replicated.com/reference/kots-cli-getting-started)

docs/self-hosted/kubernetes-maintenance.md

@@ -0,0 +1,33 @@
+# Maintenance
+## Private Packagist Self-Hosted (Kubernetes)
+
+### Updates
+
+By default Replicated checks for updates every 4 hours and you can install updates from the dashboard in the Replicated
+Management Console on port 8800 once they are available.
+You can configure this behavior under “Configure automatic updates” on the dashboard.
+
+The [Private Packagist Self-Hosted Changelog](https://packagist.com/docs/self-hosted/changelog) details all new features,
+behavior changes and major bugfixes each release introduces.
+
+New versions that ask you to upgrade KOTS (Kubernetes Off-The-Shelf), the Replicated tool used to distribute Private Packagist,
+require that you download and rerun the install script via the command below.
+
+#### Update KOTS for Private Packagist Self-Hosted Kubernetes in a Kubernetes cluster installed with kURL
+
+Please note that running the command will take a while as it will also update Kubernetes and other dependencies of Private Packagist Self-Hosted.
+Private Packagist and the Replicated Management Console will become temporarily unavailable.
+
+```
+curl -sSL https://k8s.kurl.sh/privatepackagistkots | bash -s
+```
+
+#### Update KOTS for Private Packagist Self-Hosted Kubernetes in an existing cluster
+
+```
+curl https://kots.io/install | bash
+kubectl kots admin-console upgrade -n NAMESPACE
+```
+
+Replace `NAMESPACE` with the namespace in your cluster where KOTS is installed.
+

docs/self-hosted/kubernetes-troubleshooting.md

@@ -0,0 +1,38 @@
+# Troubleshooting
+## Private Packagist Self-Hosted (Kubernetes)
+
+#### Private Packagist Self-Hosted update requires KOTS upgrade
+If the dashboard shows: 
+
+'This version of Private Packagist Self-Hosted requires a version of KOTS that is different than what you currently have installed.'
+
+Please refer to the "[Updates](./kubernetes-maintenance.md#updates)" section in our maintenance guide.
+
+#### Generating a support bundle
+
+You can generate a support bundle from the Replicated Management Console on port
+8800 by navigating to the Troubleshoot tab, clicking "Generate a support bundle",
+and selecting "Analyze".
+Once the analysis is done, either download the bundle and manually send it to us
+or click on the send icon which will send us the bundle. Please always notify us
+if you send us a support bundle!
+
+#### Issues with Multi-factor Authentication
+
+If you are having problems setting up MFA, or are unable to log in via MFA, with
+your generated codes, there may be a time-drift issue with either the
+Self-hosted Private Packagist server or the device you are using to generate the
+codes.
+
+To make sure that the Self-hosted Private Packagist server is synchronized to
+the correct time, you should check that both the current server time and
+timezone are set to the correct values. If you can enable Network Time Protocol
+(NTP) for the server, we also recommend doing that.
+
+The methods for doing so will vary depending on the underlying server Operating
+System.
+
+> Please be aware that offline-based TOTP hardware can drift up to a few minutes
+> a year. As Private Packagist only allows a time-drift of up to one (1) minute, we
+> recommend using TOTP devices that have the ability to stay synchronized with
+> the correct time (such as a phone, or re-programmable TOTP hardware devices).

docs/self-hosted/kubernetes.md

@@ -17,7 +17,7 @@ an embedded Kubernetes cluster on a linux machine.
 
 If you already have an existing Kubernetes cluster running, follow [this guide](./kubernetes-existing.md).
 
-#### Installing Private Packagist Self-Hosted Kubernetes without an existing cluster
+#### Installing Private Packagist Self-Hosted Kubernetes in a Kubernetes cluster installed with kURL
 
 Don't use Kubernetes? Use the installer that takes care of installing Private Packagist Self-Hosted on a linux
 machine following [this guide](./kubernetes-embedded.md).