Adding install guide

config.toml

@@ -85,6 +85,27 @@ archived_version = false
 
 version = "latest"
 
+# The version of the latest code build
+latestTag = "1.5.4"
+
+# The version of docker the latest code build in automated jobs
+version_docker = "v28.1.1"
+
+# The version of golang the latest code build in automated jobs
+version_go = "v1.25.3"
+
+# The version of git the latest code build in automated jobs
+version_git = "v2.51.2"
+
+# The version of kind the latest code build in automated jobs
+version_kind = "v0.30.0"
+
+# The version of kubectl the latest code build in automated jobs
+version_kube = "v1.34.2"
+
+# The version of kpt the latest code build in automated jobs
+version_kpt = "v1.0.0-beta.59"
+
 # A link to latest version of the docs. Used in the "version-banner" partial to
 # point people to the main doc site.
 

content/en/docs/neo-porch/3_getting_started/_index.md

@@ -2,9 +2,5 @@
 title: "Getting Started"
 type: docs
 weight: 3
-description: Getting Started with Porch
+description: "This section serves to act as an introduction to setting up Porch as for a first time user. It lists the prerequisites required before installation, then deployment of the porchctl cli binary along with a deployment of porch on an existing kubernetes cluster." 
 ---
-
-## Lorem Ipsum
-
-Lorem Ipsum

content/en/docs/neo-porch/3_getting_started/installing-porch.md

@@ -2,13 +2,188 @@
 title: "Installing Porch"
 type: docs
 weight: 1
-description: Installing Porch
+description: Installing prerequisites, the porchctl CLI and an instance of Porch on a K8s cluster.
 ---
 
 ## Prerequisites
 
-list of prerequisites for script to run and porch to be deployed. e.g. kubectl, kind cluster etc
+{{% alert color="primary" %}}
+Note that Porch and this guide assumes a K8s cluster is set up and a Unix Operating system is used as the basis for operation. These include Linux OS's such as Ubuntu 24.04 LTS or MacOS.
 
-## install script
+If you are using a Windows OS please install and follow this guide using the [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) layer and ensure the prerequisites are installed on that subsystem.
+{{% /alert %}}
 
-we should have a simple installing porch script which deploys porch similar to the (./scripts/setup-dev-env.sh + make run-in-kind + setting up an example-repository) with a small description for exactly what this script does for those who want more information but does not impede those who simply want to deploy porch
+Before porch and its CLI can be installed a few prerequisites are required to be present on the system.
+These are as follows:
+
+1. [git](https://git-scm.com/) ({{< version_git >}})
+2. [Docker](https://www.docker.com/get-started/) - either Docker Desktop or Docker Engine ({{< version_docker >}})
+3. [kubectl](https://kubernetes.io/docs/reference/kubectl/) - make sure that [kubectl context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) configured with your cluster ({{< version_kube >}})
+4. [kpt](https://kpt.dev/installation/kpt-cli/) ({{< version_kpt >}})
+5. [The go programming language](https://go.dev/) ({{< version_go >}})
+
+## Installing the porchctl CLI
+
+The porchctl CLI can be obtained through the following means:
+
+### Download the latest porchctl binary
+
+<!-- linkchecker-disable -->
+{{< tabpane lang="bash" >}}
+{{< tab header="Linux AMD64" >}}
+curl -LO "https://github.com/nephio-project/porch/releases/download/v{{% latestTag %}}/porchctl_{{% latestTag %}}_linux_amd64.tar.gz"
+{{< /tab >}}
+{{< tab header="Linux ARM64" >}}
+curl -LO "https://github.com/nephio-project/porch/releases/download/v{{% latestTag %}}/porchctl_{{% latestTag %}}_linux_arm64.tar.gz"
+{{< /tab >}}
+{{< tab header="macOS AMD64" >}}
+curl -LO "https://github.com/nephio-project/porch/releases/download/v{{% latestTag %}}/porchctl_{{% latestTag %}}_darwin_amd64.tar.gz"
+{{< /tab >}}
+{{< tab header="macOS ARM64" >}}
+curl -LO "https://github.com/nephio-project/porch/releases/download/v{{% latestTag %}}/porchctl_{{% latestTag %}}_darwin_arm64.tar.gz"
+{{< /tab >}}
+{{< /tabpane >}}
+<!-- linkchecker-enable -->
+
+{{% alert color="primary" title="Note:" %}}
+To download a specific version of porch and its porchctl binary you can do so by replacing the version number and machine type its for in the curl link above.
+
+For example, to download the **[1.5.0](https://github.com/nephio-project/porch/releases/tag/v1.5.0)** release version of porch on **macOS AMD64** the URL would be:
+
+```bash
+curl -LO "https://github.com/nephio-project/porch/releases/download/v1.5.0/porchctl_1.5.0_darwin_amd64.tar.gz"
+```
+
+{{% /alert %}}
+
+### Install the porchctl binary
+
+This extracts the tar file containting the binary executable and installs it into the root binary directory of the machine.
+
+{{% alert color="primary" title="Note:" %}}
+That this requires **root** permissions on the host machine.
+{{% /alert %}}
+
+```bash
+tar -xzf porchctl_{{% latestTag %}}_linux_amd64.tar.gz | sudo install -o root -g root -m 0755 porchctl /usr/local/bin/
+```
+
+{{% alert color="primary" title="Note:" %}}
+If you do not have root access on the target system, you can still install porchctl to the `~/.local/bin` directory:
+{{% /alert %}}
+
+```bash
+tar -xzf porchctl_{{% latestTag %}}_linux_amd64.tar.gz
+chmod +x ./porchctl
+mkdir -p ~/.local/bin
+mv ./porchctl ~/.local/bin/porchctl
+# and then append (or prepend) ~/.local/bin to $PATH
+```
+
+You can test that the CLI has been installed correctly by doing `porchctl version` in your terminal and you should be prompted with a printout that looks similar to this.
+
+```bash
+Version: {{% latestTag %}}
+Git commit: cddc13bdcd569141142e2b632f09eb7a3e4988c9 (dirty)
+```
+
+### Enable porchctl autocompletion (optional)
+
+Create the completions directory (if it doesn’t already exist):
+
+```bash
+mkdir -p ~/.local/share/bash-completion/completions
+```
+
+{{% alert color="primary" title="Note:" %}}
+This is the auto-completion directory for Ubuntu 24.04 LTS and a few other distributions.
+Please do your due diligence and use/create the directory for your appropriate OS/distribution.
+{{% /alert %}}
+
+Generate and install the completion script:
+
+```bash
+porchctl completion bash > ~/.local/share/bash-completion/completions/porchctl
+```
+
+Reload your shell:
+
+```bash
+exec bash
+```
+
+{{% alert color="primary" title="Note:" %}}
+You can just reload/refresh your terminal manually without the command by just closing the terminal and starting a new one. Either works as intended.
+{{% /alert %}}
+
+Test that the auto-completion works with the following command and pressing the auto-complete key usually `<TAB>` twice.
+
+```bash
+porchctl
+```
+
+If auto-completion is working as correctly this should return a similar output to the one below
+
+```bash
+completion  (Generate the autocompletion script for the specified shell)
+help        (Help about any command)
+repo        (Manage package repositories.)
+rpkg        (Manage packages.)
+version     (Print the version number of porchctl)
+```
+
+## Deploying Porch on a cluster
+
+Create a new directory for the kpt package and path inside of it
+
+```bash
+mkdir porch-{{% latestTag %}} && cd porch-{{% latestTag %}}
+```
+
+Download the latest Porch kpt package blueprint
+
+```bash
+curl -LO "https://github.com/nephio-project/porch/releases/download/v{{% latestTag %}}/porch_blueprint.tar.gz"
+```
+
+Extract the Porch kpt package contents
+
+```bash
+tar -xzf porch_blueprint.tar.gz
+```
+
+Initialize and apply the Porch kpt package
+
+```bash
+kpt live init && kpt live apply
+```
+
+You can check that porch is up and running by doing
+
+```bash
+kubectl get all -n porch-system
+```
+
+A healthy porch install should look as such
+
+```bash
+NAME                                   READY   STATUS    RESTARTS   AGE
+pod/function-runner-567ddc76d-7k8sj    1/1     Running   0          4m3s
+pod/function-runner-567ddc76d-x75lv    1/1     Running   0          4m3s
+pod/porch-controllers-d8dfccb4-8lc6j   1/1     Running   0          4m3s
+pod/porch-server-7dc5d7cd4f-smhf5      1/1     Running   0          4m3s
+
+NAME                      TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)            AGE
+service/api               ClusterIP   10.96.108.221   <none>        443/TCP,8443/TCP   4m3s
+service/function-runner   ClusterIP   10.96.237.108   <none>        9445/TCP           4m3s
+
+NAME                                READY   UP-TO-DATE   AVAILABLE   AGE
+deployment.apps/function-runner     2/2     2            2           4m3s
+deployment.apps/porch-controllers   1/1     1            1           4m3s
+deployment.apps/porch-server        1/1     1            1           4m3s
+
+NAME                                         DESIRED   CURRENT   READY   AGE
+replicaset.apps/function-runner-567ddc76d    2         2         2       4m3s
+replicaset.apps/porch-controllers-d8dfccb4   1         1         1       4m3s
+replicaset.apps/porch-server-7dc5d7cd4f      1         1         1       4m3s
+```

layouts/shortcodes/latestTag.html

@@ -0,0 +1 @@
+{{ site.Params.latestTag }}

layouts/shortcodes/version_docker.html

@@ -0,0 +1 @@
+{{ site.Params.version_docker }}

layouts/shortcodes/version_git.html

@@ -0,0 +1 @@
+{{ site.Params.version_git }}

layouts/shortcodes/version_go.html

@@ -0,0 +1 @@
+{{ site.Params.version_go }}

layouts/shortcodes/version_kind.html

@@ -0,0 +1 @@
+{{ site.Params.version_kind }}

layouts/shortcodes/version_kpt.html

@@ -0,0 +1 @@
+{{ site.Params.version_kpt }}

layouts/shortcodes/version_kube.html

@@ -0,0 +1 @@
+{{ site.Params.version_kube }}