Local repo (#268)

* init localrepo * Add files via upload * Update controller-k3s-installation.rst * Update controller-k3s-installation.rst * Update controller-k3s-installation.rst * Update controller-k3s-installation.rst Moving local repo setup one level upper * Create Controller-local-repository.rst * Update installation.rst new page for local repo setup * Update controller-k3s-installation.rst * Update Controller-local-repository.rst * Add files via upload * Update Controller-local-repository.rst * Update Controller-local-repository.rst * Update Controller-local-repository.rst * update local repo url output * update local repo url output * Update Controller-local-repository.rst --------- Co-authored-by: Arsen Arakelyan <[email protected]>
netrisai · Oct 17, 2024 · 2a1f424 · 2a1f424
1 parent 60164d1
commit 2a1f424
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 0 deletions.
diff --git a/Controller-local-repository.rst b/Controller-local-repository.rst
@@ -0,0 +1,69 @@
+Netris Local Repository Setup
+=============================
+
+
+When & Why to Use the Local Repository?
+---------------------------------------
+
+The Netris Local Repository is essential for environments where switches, softgates, or other infrastructure devices do not have direct access to the internet. By setting up a local repository, you ensure that these devices can still download necessary packages and updates through a local APT repository. This setup is particularly useful in air-gapped or restricted network environments, where relying on external repositories is not an option.
+In addition to serving as an APT repository, the local repository can also host custom ISO files. This feature allows you to store and manage ISOs for specific use cases, such as deploying operating systems or firmware to your servers, softgates, or switches. While ISO hosting is an optional feature, it provides flexibility and control over the resources you use in your infrastructure, especially when working in isolated networks.
+By utilizing the Netris Local Repository, you ensure that your infrastructure can always access necessary files and packages, even when internet connectivity is limited or unavailable.
+
+How to Enable the Local Repository on the Netris Controller?
+------------------------------------------------------------
+
+To install the Netris Local Repository on the controller host, run the following command:  
+*Note: The controller must be set up using the `--ctl-hostname` argument; otherwise, the Netris Local Repository setup script will exit with an error.*
+
+.. code-block:: shell-session
+
+  curl -sS https://get.netris.io/local-repo.sh | sh -
+
+The script may take a while, depending on the controller's connectivity and available resources.
+
+The output of the script will look similar to this:
+
+.. code-block:: shell-session
+
+  ubuntu@netris:~$ curl -sS https://get.netris.io/local-repo.sh | sh -
+  Checking if the controller is installed
+  Checking controller's FQDN
+  Creating local repo service under URL: http://netris.example.com/repo/
+  Waiting for netris-local-repo pod to be ready...
+  No pods found. Waiting for pod creation...
+  Current pod status: Pending. Waiting...
+  Current pod status: Pending. Waiting...
+  Current pod status: Pending. Waiting...
+  Current pod status: Pending. Waiting...
+  Current pod status: Pending. Waiting...
+  Pod is running.
+
+  Netris local repository pod is now running.
+
+  Path to upload custom ISOs: /var/lib/rancher/k3s/storage/pvc-ea0dd3ef-ded1-49d3-bbd8-b797c91d76b5_netris-controller_netris-local-repo-pvc/repo/isos
+  Local repository URL: http://netris.example.com/repo/
+  URL to ISOs directory: http://netris.example.com/repo/isos/
+
+The script will output the local repository URL and URL to ISOs directory. Copy and paste this URL of the Local repository into the Netris Controller Web UI under **Settings** section (as shown in the screenshots below).
+
+Additionally, it provides the host system path, which you may want to use to host your custom ISOs for your servers, softgates, or switches.
+
+.. image:: images/Global-settings-edit.png
+    :align: center
+
+.. image:: images/Global-settings-save.png
+    :align: center
+
+
+How to consume local repository
+-------------------------------
+
+Once the local repository function is enabled in the Netris Controller Settings, the Netris agent installation oneliner will automatically point to the local repository (as shown in the screenshots below).
+
+.. note::
+
+  The local repository includes all the necessary scripts and dependency packages for the Netris NVUE (Cumulus 5.9 and higher) and Netris SoftGate HS (Ubuntu 24.04) agents.
+
+
+.. image:: images/oneliner-from-local-repo.png
+    :align: center
diff --git a/images/Global-settings-edit.png b/images/Global-settings-edit.png
diff --git a/images/Global-settings-save.png b/images/Global-settings-save.png
diff --git a/images/oneliner-from-local-repo.png b/images/oneliner-from-local-repo.png
diff --git a/installation.rst b/installation.rst
@@ -18,3 +18,4 @@ Netris Controller can be installed locally as a VM, deployed as a Kubernetes app
 
    controller-k3s-installation
    controller-k8s-installation
+   Controller-local-repository
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,3 +18,4 @@ Netris Controller can be installed locally as a VM, deployed as a Kubernetes app

		controller-k3s-installation
		controller-k8s-installation
		Controller-local-repository