Installer to install the UI stack in native mode on podman.

Signed-off-by: Anil Vishnoi <[email protected]>

Author: vishnoianil

api-server/Makefile

@@ -28,9 +28,6 @@ ifeq ($(APISERVER_RACE_DETECTOR),1)
     CGO_ENABLED=1
     APISERVER_BUILD_FLAGS+=-race
 endif
-ifneq ($(APISERVER_BUILD_TAGS),)
-	APISERVER_BUILD_FLAGS+=-tags $(APISERVER_BUILD_TAGS)
-endif
 ifeq ($(CGO_ENABLED),0)
     APISERVER_LDFLAGS+=-extldflags=-static
 endif
@@ -75,7 +72,6 @@ dist/packages: \
 
 dist/packages/%: apiserver
 	$(CMD_PREFIX) mkdir -p $(basename $(basename $@))
-	$(CMD_PREFIX) cp README.md $(basename $(basename $@))
 	$(CMD_PREFIX) cp dist/apiserver-$(subst apiserver-,,$(basename $(basename $(@F))))$(if $(findstring windows,$@),.exe) $(basename $(basename $@))/ilab-apiserver$(if $(findstring windows,$@),.exe)
 	$(CMD_PREFIX) if test "$(word 2,$(subst -, ,$(shell basename $@)))" = "windows" ; then \
 		printf "  %-12s dist/packages/$(@F)\n" "[ZIP]" ;\

api-server/main.go

@@ -214,7 +214,7 @@ func (srv *ILabServer) runServer(cmd *cobra.Command, args []string) {
 		srv.ilabCmd = ilabPath
 	} else {
 		// Use ilab from virtual environment
-		srv.ilabCmd = filepath.Join(srv.baseDir, "venv", "bin", "ilab")
+		srv.ilabCmd = filepath.Join(srv.baseDir, "bin", "ilab")
 		if _, err := os.Stat(srv.ilabCmd); os.IsNotExist(err) {
 			srv.log.Fatalf("ilab binary not found at %s. Please ensure the virtual environment is set up correctly.", srv.ilabCmd)
 		}

deploy/podman/native/README.md

@@ -3,11 +3,62 @@
 
 Please follow the below instructions to deploy UI stack with Native mode enabled in Podman.
 
-## Generate Secret
+## Deploy using the installer (Recommended)
+
+Make a temporary directory and download the installer
+
+```shell
+mkdir instructlab-ui
+cd instructlab-ui
+
+curl -fsSL https://raw.githubusercontent.com/instructlab/ui/refs/heads/main/installers/podman/ilab-ui-native-installer.sh
+```
+
+Give execution permission to the install
+
+```shell
+chmod a+x ilab-ui-native-installer.sh
+```
+
+Execute the installer and follow the instructions prompted on the terminal.
+
+If your deployment machine has InstructLab (ilab CLI) setup, either on the host or in python virtual environment, use the following command
+
+```shell
+./ilab-ui-native-installer.sh --username <USERNAME> --password <PASSWORD>
+
+e.g ./ilab-ui-native-installer.sh --username admin --password passw0rd
+```
+
+If your deployment machine don't have InstructLab CLI setup, please clone the taxonomy repo and fire the following command.
+
+```shell
+./ilab-ui-native-installer.sh --username <USERNAME> --password <PASSWORD> --taxonomy-dir <TAXONOMY_DIR>
+
+e.g ./ilab-ui-native-installer.sh --username admin --password passw0rd --taxonomy-dir /Users/johndoe/instructlab/taxonomy
+```
+
+>[!NOTE]
+> In the absence of InstructLab CLI, UI won't be able to support the synthetic data generation and fine tuning, but skill and knowledge contribution should work as expected.
+
+If you are deploying the UI stack on a remote machine, please provide the auth url in the input
+
+```shell
+./ilab-ui-native-installer.sh --username <USERNAME> --password <PASSWORD> --taxonomy-dir <TAXONOMY_DIR> --auth-url http://<REMOTE-IP>:3000
+```
+
+Please use `--help` to see more options supported by the installer.
+
+## Deploy manually
+
+If you would like to install the UI stack manually, it's a two step process
+
+- Generate the secret file with the required input
+- Deploy the UI stack manifest file using podman.
 
 A secret is required to provide required input to the UI stack in a secure way.
 
-Two options exist to generate the secret, either using `kubectl` or filling in values in the `secret.yaml` provided.
+There are two options to generate the secret's file, either using `kubectl` or filling in values in the `secret.yaml` provided.
 
 ### Generate secrets using kubectl
 
@@ -46,17 +97,17 @@ echo "password" | base64
 
 Using the above to fill in all the required input fields.
 
-## Deploy the secret
+### Deploy the secret
 
 Now that the `secret.yaml` has been generated, use `podman kube play` to load the secret.
 
 ```bash
 podman kube play secret.yaml
 ```
 
-## Deploying the InstructLab UI Stack
+### Deploy the InstructLab UI Stack
 
-One last step before you launch the InstructLab UI. A file named [instructlab-ui.yaml](instructlab-ui.yaml) present in the [native](../native/) directory. Search for <TAXONOMY_REPO_ROOT_DIR> in the yaml file and replace it with the same value that is used while creating the secret.yaml file. Now with the secret in place and deployment yaml updated, use `podman kube play` to launch the containers. UI will look for the taxonomy repo in this directory to submit the skill and knowledge contributions.
+One last step before you launch the InstructLab UI. A file named [instructlab-ui.yaml](instructlab-ui.yaml) present in the [native](../native/) directory. Search for <TAXONOMY_ROOT_DIR> in the yaml file and replace it with the same value that is used while creating the secret.yaml file. Now with the secret in place and deployment yaml updated, use `podman kube play` to launch the containers. UI will look for the taxonomy repo in this directory to submit the skill and knowledge contributions.
 
 ```bash
 podman kube play instructlab-ui.yaml

deploy/podman/native/instructlab-ui.yaml

@@ -127,5 +127,5 @@ spec:
       volumes:
       - name: taxonomy-repo
         hostPath:
-          path: <TAXONOMY_REPO_ROOT_DIR>
+          path: <TAXONOMY_ROOT_DIR>
           type: Directory

deploy/podman/native/secret.yaml.example

@@ -1,13 +1,13 @@
 apiVersion: v1
 data:
-  IL_ENABLE_DEV_MODE: ZmFsc2U=
-  IL_UI_ADMIN_PASSWORD:
-  IL_UI_ADMIN_USERNAME:
-  IL_UI_DEPLOYMENT: bmF0aXZl
-  NEXT_PUBLIC_EXPERIMENTAL_FEATURES: dHJ1ZQ==
-  NEXT_PUBLIC_TAXONOMY_ROOT_DIR:
-  NEXTAUTH_SECRET: 
-  NEXTAUTH_URL: aHR0cDovL2xvY2FsaG9zdDozMDAw
+  IL_UI_ADMIN_PASSWORD: <PASSWORD>
+  IL_UI_ADMIN_USERNAME: <USERNAME>
+  IL_UI_DEPLOYMENT: <UI_DEPLOYMENT>
+  IL_ENABLE_DEV_MODE: <DEV_MODE>
+  NEXT_PUBLIC_EXPERIMENTAL_FEATURES: <EXPERIMENTAL_FEATURES>
+  NEXT_PUBLIC_TAXONOMY_ROOT_DIR: <TAXONOMY_ROOT_DIR>
+  NEXTAUTH_URL: <AUTH_URL>
+  NEXTAUTH_SECRET: <AUTH_SECRET>
 kind: Secret
 metadata:
   creationTimestamp: null