Merge pull request #2567 from marcschaeferger/fix-kubernetes-install

feat(kubernetes): enable newtInstances by default and update installation instructions

docker-compose.example.yml

@@ -4,6 +4,12 @@ services:
     image: fosrl/pangolin:latest
     container_name: pangolin
     restart: unless-stopped
+    deploy:
+      resources:
+        limits:
+          memory: 1g
+        reservations:
+          memory: 256m
     volumes:
       - ./config:/app/config
     healthcheck:

install/config/docker-compose.yml

@@ -4,6 +4,12 @@ services:
     image: docker.io/fosrl/pangolin:{{if .IsEnterprise}}ee-{{end}}{{.PangolinVersion}}
     container_name: pangolin
     restart: unless-stopped
+    deploy:
+      resources:
+        limits:
+          memory: 1g
+        reservations:
+          memory: 256m
     volumes:
       - ./config:/app/config
     healthcheck:

messages/en-US.json

@@ -1670,10 +1670,10 @@
     "sshSudoModeCommandsDescription": "User can run only the specified commands with sudo.",
     "sshSudo": "Allow sudo",
     "sshSudoCommands": "Sudo Commands",
-    "sshSudoCommandsDescription": "List of commands the user is allowed to run with sudo.",
+    "sshSudoCommandsDescription": "Comma separated list of commands the user is allowed to run with sudo.",
     "sshCreateHomeDir": "Create Home Directory",
     "sshUnixGroups": "Unix Groups",
-    "sshUnixGroupsDescription": "Unix groups to add the user to on the target host.",
+    "sshUnixGroupsDescription": "Comma separated Unix groups to add the user to on the target host.",
     "retryAttempts": "Retry Attempts",
     "expectedResponseCodes": "Expected Response Codes",
     "expectedResponseCodesDescription": "HTTP status code that indicates healthy status. If left blank, 200-300 is considered healthy.",

server/routers/client/listClients.ts

@@ -370,7 +370,7 @@ export async function listClients(
                     ? order === "asc"
                         ? asc(clients[sort_by])
                         : desc(clients[sort_by])
-                    : asc(clients.clientId)
+                    : asc(clients.name)
             );
 
         const [clientsList, totalCount] = await Promise.all([

server/routers/resource/listResources.ts

@@ -429,7 +429,7 @@ export async function listResources(
                         ? order === "asc"
                             ? asc(resources[sort_by])
                             : desc(resources[sort_by])
-                        : asc(resources.resourceId)
+                        : asc(resources.name)
                 ),
             countQuery
         ]);

server/routers/site/listSites.ts

@@ -289,7 +289,7 @@ export async function listSites(
                     ? order === "asc"
                         ? asc(sites[sort_by])
                         : desc(sites[sort_by])
-                    : asc(sites.siteId)
+                    : asc(sites.name)
             );
 
         const [totalCount, rows] = await Promise.all([

server/routers/siteResource/listAllSiteResourcesByOrg.ts

@@ -205,7 +205,7 @@ export async function listAllSiteResourcesByOrg(
                         ? order === "asc"
                             ? asc(siteResources[sort_by])
                             : desc(siteResources[sort_by])
-                        : asc(siteResources.siteResourceId)
+                        : asc(siteResources.name)
                 ),
             countQuery
         ]);

server/routers/siteResource/listSiteResources.ts

@@ -31,12 +31,23 @@ const listSiteResourcesQuerySchema = z.object({
     sort_by: z
         .enum(["name"])
         .optional()
-        .catch(undefined),
+        .catch(undefined)
+        .openapi({
+            type: "string",
+            enum: ["name"],
+            description: "Field to sort by"
+        }),
     order: z
         .enum(["asc", "desc"])
         .optional()
         .default("asc")
         .catch("asc")
+        .openapi({
+            type: "string",
+            enum: ["asc", "desc"],
+            default: "asc",
+            description: "Sort order"
+        })
 });
 
 export type ListSiteResourcesResponse = {
@@ -112,7 +123,7 @@ export async function listSiteResources(
                     ? order === "asc"
                         ? asc(siteResources[sort_by])
                         : desc(siteResources[sort_by])
-                    : asc(siteResources.siteResourceId)
+                    : asc(siteResources.name)
             )
             .limit(limit)
             .offset(offset);

src/app/[orgId]/settings/resources/proxy/[niceId]/proxy/page.tsx

@@ -89,7 +89,14 @@ import {
 } from "lucide-react";
 import { useTranslations } from "next-intl";
 import { useRouter } from "next/navigation";
-import { use, useActionState, useCallback, useEffect, useMemo, useState } from "react";
+import {
+    use,
+    useActionState,
+    useCallback,
+    useEffect,
+    useMemo,
+    useState
+} from "react";
 import { useForm } from "react-hook-form";
 import { z } from "zod";
 
@@ -184,7 +191,8 @@ function ProxyResourceTargetsForm({
         setDockerStates((prev) => new Map(prev.set(siteId, dockerState)));
     };
 
-    const refreshContainersForSite = useCallback(async (siteId: number) => {
+    const refreshContainersForSite = useCallback(
+        async (siteId: number) => {
             const dockerManager = new DockerManager(api, siteId);
             const containers = await dockerManager.fetchContainers();
 
@@ -196,9 +204,12 @@ function ProxyResourceTargetsForm({
                 }
                 return newMap;
             });
-    }, [api]);
+        },
+        [api]
+    );
 
-    const getDockerStateForSite = useCallback((siteId: number): DockerState => {
+    const getDockerStateForSite = useCallback(
+        (siteId: number): DockerState => {
             return (
                 dockerStates.get(siteId) || {
                     isEnabled: false,
@@ -206,7 +217,9 @@ function ProxyResourceTargetsForm({
                     containers: []
                 }
             );
-    }, [dockerStates]);
+        },
+        [dockerStates]
+    );
 
     const [isAdvancedMode, setIsAdvancedMode] = useState(() => {
         if (typeof window !== "undefined") {
@@ -220,7 +233,9 @@ function ProxyResourceTargetsForm({
 
     const removeTarget = useCallback((targetId: number) => {
         setTargets((prevTargets) => {
-            const targetToRemove = prevTargets.find((target) => target.targetId === targetId);
+            const targetToRemove = prevTargets.find(
+                (target) => target.targetId === targetId
+            );
             if (targetToRemove && !targetToRemove.new) {
                 setTargetsToRemove((prev) => [...prev, targetId]);
             }
@@ -228,7 +243,8 @@ function ProxyResourceTargetsForm({
         });
     }, []);
 
-    const updateTarget = useCallback((targetId: number, data: Partial<LocalTarget>) => {
+    const updateTarget = useCallback(
+        (targetId: number, data: Partial<LocalTarget>) => {
             setTargets((prevTargets) => {
                 const site = sites.find((site) => site.siteId === data.siteId);
                 return prevTargets.map((target) =>
@@ -242,7 +258,9 @@ function ProxyResourceTargetsForm({
                         : target
                 );
             });
-    }, [sites]);
+        },
+        [sites]
+    );
 
     const openHealthCheckDialog = useCallback((target: LocalTarget) => {
         setSelectedTargetForHealthCheck(target);
@@ -250,7 +268,6 @@ function ProxyResourceTargetsForm({
     }, []);
 
     const columns = useMemo((): ColumnDef<LocalTarget>[] => {
-
         const priorityColumn: ColumnDef<LocalTarget> = {
             id: "priority",
             header: () => (
@@ -581,7 +598,17 @@ function ProxyResourceTargetsForm({
                 actionsColumn
             ];
         }
-    }, [isAdvancedMode, isHttp, sites, updateTarget, getDockerStateForSite, refreshContainersForSite, openHealthCheckDialog, removeTarget, t]);
+    }, [
+        isAdvancedMode,
+        isHttp,
+        sites,
+        updateTarget,
+        getDockerStateForSite,
+        refreshContainersForSite,
+        openHealthCheckDialog,
+        removeTarget,
+        t
+    ]);
 
     function addNewTarget() {
         const isHttp = resource.http;

src/components/ContainersSelector.tsx

@@ -171,8 +171,7 @@ const DockerContainersTable: FC<{
                 ...Object.values(container.networks)
                     .map((n) => n.ipAddress)
                     .filter(Boolean),
-                ...getExposedPorts(container).map((p) => p.toString()),
+                ...getExposedPorts(container).map((p) => p.toString())
-                ...Object.entries(container.labels).flat()
             ];
 
             return searchableFields.some((field) =>

src/components/CreateShareLinkForm.tsx

@@ -20,7 +20,7 @@ import {
 import { toast } from "@app/hooks/useToast";
 import { zodResolver } from "@hookform/resolvers/zod";
 import { AxiosResponse } from "axios";
-import { useEffect, useState } from "react";
+import { useState, useMemo } from "react";
 import { useForm } from "react-hook-form";
 import { z } from "zod";
 import CopyTextBox from "@app/components/CopyTextBox";
@@ -39,7 +39,8 @@ import { formatAxiosError } from "@app/lib/api";
 import { cn } from "@app/lib/cn";
 import { createApiClient } from "@app/lib/api";
 import { useEnvContext } from "@app/hooks/useEnvContext";
-import { ListResourcesResponse } from "@server/routers/resource";
+import { useQuery } from "@tanstack/react-query";
+import { orgQueries } from "@app/lib/queries";
 import {
     Popover,
     PopoverContent,
@@ -94,14 +95,22 @@ export default function CreateShareLinkForm({
     const [isOpen, setIsOpen] = useState(false);
     const t = useTranslations();
 
-    const [resources, setResources] = useState<
+    const { data: allResources = [] } = useQuery(
-        {
+        orgQueries.resources({ orgId: org?.org.orgId ?? "" })
-            resourceId: number;
+    );
-            name: string;
+
-            niceId: string;
+    const resources = useMemo(
-            resourceUrl: string;
+        () =>
-        }[]
+            allResources
-    >([]);
+                .filter((r) => r.http)
+                .map((r) => ({
+                    resourceId: r.resourceId,
+                    name: r.name,
+                    niceId: r.niceId,
+                    resourceUrl: `${r.ssl ? "https://" : "http://"}${toUnicode(r.fullDomain || "")}/`
+                })),
+        [allResources]
+    );
 
     const formSchema = z.object({
         resourceId: z.number({ message: t("shareErrorSelectResource") }),
@@ -130,47 +139,6 @@ export default function CreateShareLinkForm({
         }
     });
 
-    useEffect(() => {
-        if (!open) {
-            return;
-        }
-
-        async function fetchResources() {
-            const res = await api
-                .get<
-                    AxiosResponse<ListResourcesResponse>
-                >(`/org/${org?.org.orgId}/resources`)
-                .catch((e) => {
-                    console.error(e);
-                    toast({
-                        variant: "destructive",
-                        title: t("shareErrorFetchResource"),
-                        description: formatAxiosError(
-                            e,
-                            t("shareErrorFetchResourceDescription")
-                        )
-                    });
-                });
-
-            if (res?.status === 200) {
-                setResources(
-                    res.data.data.resources
-                        .filter((r) => {
-                            return r.http;
-                        })
-                        .map((r) => ({
-                            resourceId: r.resourceId,
-                            name: r.name,
-                            niceId: r.niceId,
-                            resourceUrl: `${r.ssl ? "https://" : "http://"}${toUnicode(r.fullDomain || "")}/`
-                        }))
-                );
-            }
-        }
-
-        fetchResources();
-    }, [open]);
-
     async function onSubmit(values: z.infer<typeof formSchema>) {
         setLoading(true);
 

src/components/InternalResourceForm.tsx

@@ -1230,8 +1230,12 @@ export function InternalResourceForm({
                                                 )}
                                             </FormLabel>
                                             <FormControl>
-                                            <StrategySelect<"site" | "remote">
+                                                <StrategySelect<
-                                                value={field.value ?? undefined}
+                                                    "site" | "remote"
+                                                >
+                                                    value={
+                                                        field.value ?? undefined
+                                                    }
                                                     options={[
                                                         {
                                                             id: "site",
@@ -1241,7 +1245,8 @@ export function InternalResourceForm({
                                                             description: t(
                                                                 "internalResourceAuthDaemonSiteDescription"
                                                             ),
-                                                        disabled: sshSectionDisabled
+                                                            disabled:
+                                                                sshSectionDisabled
                                                         },
                                                         {
                                                             id: "remote",
@@ -1251,11 +1256,13 @@ export function InternalResourceForm({
                                                             description: t(
                                                                 "internalResourceAuthDaemonRemoteDescription"
                                                             ),
-                                                        disabled: sshSectionDisabled
+                                                            disabled:
+                                                                sshSectionDisabled
                                                         }
                                                     ]}
                                                     onChange={(v) => {
-                                                    if (sshSectionDisabled) return;
+                                                        if (sshSectionDisabled)
+                                                            return;
                                                         field.onChange(v);
                                                         if (v === "site") {
                                                             form.setValue(
@@ -1289,10 +1296,17 @@ export function InternalResourceForm({
                                                         max={65535}
                                                         placeholder="22123"
                                                         {...field}
-                                                    disabled={sshSectionDisabled}
+                                                        disabled={
-                                                    value={field.value ?? ""}
+                                                            sshSectionDisabled
+                                                        }
+                                                        value={
+                                                            field.value ?? ""
+                                                        }
                                                         onChange={(e) => {
-                                                        if (sshSectionDisabled) return;
+                                                            if (
+                                                                sshSectionDisabled
+                                                            )
+                                                                return;
                                                             const v =
                                                                 e.target.value;
                                                             if (v === "") {
@@ -1301,12 +1315,12 @@ export function InternalResourceForm({
                                                                 );
                                                                 return;
                                                             }
-                                                        const num = parseInt(
+                                                            const num =
-                                                            v,
+                                                                parseInt(v, 10);
-                                                            10
-                                                        );
                                                             field.onChange(
-                                                            Number.isNaN(num)
+                                                                Number.isNaN(
+                                                                    num
+                                                                )
                                                                     ? null
                                                                     : num
                                                             );

src/components/newt-install-commands.tsx

@@ -101,6 +101,7 @@ export function NewtSiteInstallCommands({
                 `helm install newt fossorial/newt \\
     --create-namespace \\
     --set newtInstances[0].name="main-tunnel" \\
+    --set newtInstances[0].enabled=true \\
     --set-string newtInstances[0].auth.keys.endpointKey="${endpoint}" \\
     --set-string newtInstances[0].auth.keys.idKey="${id}" \\
     --set-string newtInstances[0].auth.keys.secretKey="${secret}"`
@@ -186,9 +187,7 @@ WantedBy=default.target`
                 />
 
                 <div className="pt-4">
-                        <p className="font-bold mb-3">
+                    <p className="font-bold mb-3">{t("siteConfiguration")}</p>
-                            {t("siteConfiguration")}
-                        </p>
                     <div className="flex items-center space-x-2 mb-2">
                         <CheckboxWithLabel
                             id="acceptClients"
@@ -211,19 +210,34 @@ WantedBy=default.target`
 
                 <div className="pt-4">
                     <p className="font-bold mb-3">{t("commands")}</p>
+                    {platform === "kubernetes" && (
+                        <p className="text-sm text-muted-foreground mb-3">
+                            For more and up to date Kubernetes installation
+                            information, see{" "}
+                            <a
+                                href="https://docs.pangolin.net/manage/sites/install-kubernetes"
+                                target="_blank"
+                                rel="noreferrer"
+                                className="underline"
+                            >
+                                docs.pangolin.net/manage/sites/install-kubernetes
+                            </a>
+                            .
+                        </p>
+                    )}
                     <div className="mt-2 space-y-3">
                         {commands.map((item, index) => {
                             const commandText =
-                                    typeof item === "string"
+                                typeof item === "string" ? item : item.command;
-                                        ? item
-                                        : item.command;
                             const title =
                                 typeof item === "string"
                                     ? undefined
                                     : item.title;
 
+                            const key = `${title ?? ""}::${commandText}`;
+
                             return (
-                                    <div key={index}>
+                                <div key={key}>
                                     {title && (
                                         <p className="text-sm font-medium mb-1.5">
                                             {title}

src/lib/queries.ts

@@ -4,7 +4,8 @@ import type { ListClientsResponse } from "@server/routers/client";
 import type { ListDomainsResponse } from "@server/routers/domain";
 import type {
     GetResourceWhitelistResponse,
-    ListResourceNamesResponse
+    ListResourceNamesResponse,
+    ListResourcesResponse
 } from "@server/routers/resource";
 import type { ListRolesResponse } from "@server/routers/role";
 import type { ListSitesResponse } from "@server/routers/site";
@@ -90,23 +91,13 @@ export const productUpdatesQueries = {
         })
 };
 
-export const clientFilterSchema = z.object({
-    pageSize: z.int().prefault(1000).optional()
-});
-
 export const orgQueries = {
-    clients: ({
+    clients: ({ orgId }: { orgId: string }) =>
-        orgId,
-        filters
-    }: {
-        orgId: string;
-        filters?: z.infer<typeof clientFilterSchema>;
-    }) =>
         queryOptions({
-            queryKey: ["ORG", orgId, "CLIENTS", filters] as const,
+            queryKey: ["ORG", orgId, "CLIENTS"] as const,
             queryFn: async ({ signal, meta }) => {
                 const sp = new URLSearchParams({
-                    pageSize: (filters?.pageSize ?? 1000).toString()
+                    pageSize: "10000"
                 });
 
                 const res = await meta!.api.get<
@@ -143,9 +134,13 @@ export const orgQueries = {
         queryOptions({
             queryKey: ["ORG", orgId, "SITES"] as const,
             queryFn: async ({ signal, meta }) => {
+                const sp = new URLSearchParams({
+                    pageSize: "10000"
+                });
+
                 const res = await meta!.api.get<
                     AxiosResponse<ListSitesResponse>
-                >(`/org/${orgId}/sites`, { signal });
+                >(`/org/${orgId}/sites?${sp.toString()}`, { signal });
                 return res.data.data.sites;
             }
         }),
@@ -182,6 +177,22 @@ export const orgQueries = {
                 );
                 return res.data.data.idps;
             }
+        }),
+
+    resources: ({ orgId }: { orgId: string }) =>
+        queryOptions({
+            queryKey: ["ORG", orgId, "RESOURCES"] as const,
+            queryFn: async ({ signal, meta }) => {
+                const sp = new URLSearchParams({
+                    pageSize: "10000"
+                });
+
+                const res = await meta!.api.get<
+                    AxiosResponse<ListResourcesResponse>
+                >(`/org/${orgId}/resources?${sp.toString()}`, { signal });
+
+                return res.data.data.resources;
+            }
         })
 };