From b58b2f6652e963d48e616c942c381bf7a498decc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Sch=C3=A4fer?= Date: Mon, 15 Sep 2025 19:26:16 +0200 Subject: [PATCH 1/3] feat(self-host): add official Newt Kubernetes Helm install --- self-host/manual/kubernetes.mdx | 115 ++++++++++++++++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 self-host/manual/kubernetes.mdx diff --git a/self-host/manual/kubernetes.mdx b/self-host/manual/kubernetes.mdx new file mode 100644 index 0000000..3f5b1ee --- /dev/null +++ b/self-host/manual/kubernetes.mdx @@ -0,0 +1,115 @@ +--- +title: "Kubernetes Installation" +description: "How to deploy Newt on Kubernetes" +--- + +This guide walks you through setting up Newt on Kubernetes using Helm. + +This guide assumes you already are familiar with Kubernetes concepts and you fulfill the following Global prerequisites: + +## Global Prerequisites + + +- Kubernetes Cluster (v1.28.15+) +- Access to the Kubernetes Cluster +- Helm (v3.0+) installed, see Helm install docs + + + +**Recommended**: Helm Chart Installation. + + +--- + + + + + # Helm Installation + + + All Fossorial Helm charts are available on Artifact Hub. See Fossorial Charts. + + + ## Install Newt + + + + ```bash + helm repo add fossorial https://charts.fossorial.io + helm repo update fossorial + helm search repo fossorial + ``` + + + + Prepare your Newt credentials: + ```env title="newt-cred.env" + PANGOLIN_ENDPOINT= + NEWT_ID= + NEWT_SECRET= + ``` + + Prepare a values file with your desired configuration. + + See Newt chart values configuration options. + + ```yaml title="values-newt.yaml" + newtInstances: + - name: main + enabled: true + auth: + existingSecretName: newt-cred + keys: + endpointKey: PANGOLIN_ENDPOINT + idKey: NEWT_ID + secretKey: NEWT_SECRET + ``` + + + + Create a Kubernetes Secret from the env file created earlier: + ```bash + kubectl create secret generic newt-cred -n newt --from-env-file=newt-cred.env + ``` + + Install Newt with Helm: + ```bash + helm install my-newt fossorial/newt \ + -n newt --create-namespace \ + -f values-newt.yaml + ``` + + Change the release name (`my-newt`), namespace (`newt`), and values filename as needed. + + + ```bash + # Update repo to get latest charts + helm repo update fossorial + # Upgrade Newt (after editing values) + helm upgrade my-newt fossorial/newt -n newt -f values-newt.yaml + ``` + ```bash + # Roll back to a previous revision + helm rollback my-newt 1 -n newt + ``` + + + + + +--- + +## Customizing Your Values + +All configuration options are documented in the respective repositories: + +- Newt Helm chart values + +--- + +## References + + - All Fossorial Helm Charts repo + - All Fossorial Kubernetes resources + - Pangolin Kubernetes Controller + - Helm documentation From 29ecff80e9712ab4c6b79dd4f621b37616af42f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Sch=C3=A4fer?= Date: Mon, 15 Sep 2025 19:33:49 +0200 Subject: [PATCH 2/3] fix(self-host): fixed indentation for official Newt Kubernetes Helm install --- self-host/manual/kubernetes.mdx | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/self-host/manual/kubernetes.mdx b/self-host/manual/kubernetes.mdx index 3f5b1ee..1c40752 100644 --- a/self-host/manual/kubernetes.mdx +++ b/self-host/manual/kubernetes.mdx @@ -54,22 +54,22 @@ This guide assumes you already are familiar with Kubernetes concepts and you ful See Newt chart values configuration options. ```yaml title="values-newt.yaml" - newtInstances: - - name: main - enabled: true - auth: - existingSecretName: newt-cred - keys: - endpointKey: PANGOLIN_ENDPOINT - idKey: NEWT_ID - secretKey: NEWT_SECRET - ``` + newtInstances: + - name: main + enabled: true + auth: + existingSecretName: newt-cred + keys: + endpointKey: PANGOLIN_ENDPOINT + idKey: NEWT_ID + secretKey: NEWT_SECRET + ``` - Create a Kubernetes Secret from the env file created earlier: + Create a Kubernetes Secret from the env file created earlier: ```bash - kubectl create secret generic newt-cred -n newt --from-env-file=newt-cred.env + kubectl create secret generic newt-cred -n newt --from-env-file=newt-cred.env ``` Install Newt with Helm: From 6ccbcdfe2ac6b804aca5e5ff788aa80fc513c7f8 Mon Sep 17 00:00:00 2001 From: Owen Schwartz Date: Mon, 15 Sep 2025 10:37:14 -0700 Subject: [PATCH 3/3] Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- self-host/manual/kubernetes.mdx | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/self-host/manual/kubernetes.mdx b/self-host/manual/kubernetes.mdx index 1c40752..f8697e6 100644 --- a/self-host/manual/kubernetes.mdx +++ b/self-host/manual/kubernetes.mdx @@ -54,16 +54,16 @@ This guide assumes you already are familiar with Kubernetes concepts and you ful See Newt chart values configuration options. ```yaml title="values-newt.yaml" - newtInstances: - - name: main - enabled: true - auth: - existingSecretName: newt-cred - keys: - endpointKey: PANGOLIN_ENDPOINT - idKey: NEWT_ID - secretKey: NEWT_SECRET - ``` + newtInstances: + - name: main + enabled: true + auth: + existingSecretName: newt-cred + keys: + endpointKey: PANGOLIN_ENDPOINT + idKey: NEWT_ID + secretKey: NEWT_SECRET + ```