Reorganized install (#52)

ixodie · pogossian · web-flow · commit 301b7fd01ba6 · 2021-10-27T16:14:13.000-04:00
* Quick fixes

* Adding alt tags and cleaning up formatting

* More cleanup and tags

* installation updates

* More installation updates

* Added slack info

Co-authored-by: Josh Saul &lt;ixodie@gmail.com&gt;
Co-authored-by: Gor Poghosyan &lt;gor@netris.ai&gt;
diff --git a/README.md b/README.md
@@ -8,4 +8,6 @@ hello@netris.ai
 
 https://netris.ai
 
+Slack Support Channel: https://www.netris.ai/slack/
+
 Current docs are available at: https://netris.ai/docs
diff --git a/SoftGate-agent-installation.rst b/SoftGate-agent-installation.rst
@@ -1,9 +1,10 @@
 .. meta::
   :description: Netris SoftGate Agent Installation
 
-***********************************
-Netris SoftGate Agent Installation
-***********************************
+***************************
+SoftGate Agent Installation
+***************************
+
 Minimum Hardware Requirements
 =============================
 * 2 x Intel Silver CPU
diff --git a/accounts.rst b/accounts.rst
@@ -26,6 +26,8 @@ Example: Creating a user with full access to all sections of Netris Controller,
 
 .. image:: images/users.png
     :align: center
+    :class: with-shadow
+    :alt: User Management
     
 **Password**: To set a password or email the user for a password form, go to the listing of usernames and click the menu on the right side. 
 
@@ -34,6 +36,8 @@ Example: Listing of user accounts.
 
 .. image:: images/password.png
     :align: center
+    :class: with-shadow
+    :alt:  List User Accounts
     
 Tenants
 =======
@@ -45,6 +49,8 @@ Example: Adding a tenant.
 
 .. image:: images/tenants.png
     :align: center
+    :class: with-shadow
+    :alt: Adding Tenants
     
 Permission Groups
 =================
@@ -54,11 +60,15 @@ Example: Permission Group.
 
 .. image:: images/permission_group.png
     :align: center
+    :class: with-shadow
+    :alt: Managing Permissions 
     
 User Roles
 ==========
 Permission Groups and Tenants can be either linked directly to an individual username or can be linked to a User Role object which then can be linked to an individual username.  
 
 .. image:: images/user_role.png
     :align: center
+    :class: with-shadow
+    :alt: User Roles
     
diff --git a/controller-k8s-installation.rst b/controller-k8s-installation.rst
@@ -1,16 +1,15 @@
 
 .. meta::
-  :description: Netris Controller Installation on Kubernetes
-
-Netris Controller Helm Chart
-============================
+  :description: Controller Helm Chart Installation
 
+=======================
+Helm Chart Installation
+=======================
 
 * Installs the automatic NetOps platform `Netris Controller <https://www.netris.ai/overview/>`_
 
-Prerequisites
--------------
-
+Requirements
+------------
 
 * Kubernetes 1.12+
 * Helm 3.1+
@@ -61,11 +60,13 @@ To uninstall/delete the ``netris-controller`` helm release:
 
    helm uninstall netris-controller
 
-Configuration
--------------
+Chart Default Configuration
+---------------------------
 
 The following table lists the configurable parameters of the netris-controller chart and their default values.
 
+.. note:: These settings are already enabled, you do not need to do anything.
+
 Common Parameters
 ^^^^^^^^^^^^^^^^^
 
diff --git a/controller-vm-installation.rst b/controller-vm-installation.rst
@@ -1,35 +1,37 @@
 .. meta::
-  :description: Netris Controller Virtual Machine Installation
+  :description: Controller Virtual Machine Installation
 
-**************************************
-On-Prem Netris Controller Installation
-**************************************
-Netris Controller can be hosted in Netris Cloud, installed locally as a VM, or deployed as a Kubernetes application. All three options provide the same functionality. Cloud-hosted Controller can be moved into on-prem anytime. 
+****************************
+Virtual Machine Installation
+****************************
+
+Requirements
+============
 
-KVM virtual machine
-===================
 Minimal system requirements for the VM:
+
 * CPU - 4 Core
 * RAM - 4 Gb
 * Disk - 100Gb
 * Network - 1 virtual NIC
 
 Recommended system requirements for the VM:
+
 * CPU - 8 Core
 * RAM - 16 Gb
 * Disk - 100Gb
 * Network - 1 virtual NIC
 
-Installation steps for KVM hypervisor
-=====================================
+KVM Hypervisor Installation
+===========================
 If KVM is not already installed, install Qemu/KVM on the host machine (example provided for Ubuntu Linux 18.04)
 
 .. code-block:: shell-session
 
   sudo apt-get install virt-manager
 
-Netris Controller Installation
-==============================
+VM Controller Installation
+==========================
 
 1. Download the Netris Controller image. (contact Netris support for repository access permissions).
 
@@ -161,12 +163,14 @@ Reload the network config.
 After reboot, the Netris Controller GUI should be accessible using a browser. Use ``netris/newNet0ps`` credentials. 
 
 .. image:: images/credentials.png
-    :align: center
+   :align: center
+   :class: with-shadow
+   :alt: Netris Credentials
 
 .. note::Don’t forget to change the default password by clicking your login name in the top right corner and then clicking “Change Password”.
 
 Replacing the SSL certificate
-------------------------------
+=============================
 
 1. Replace the below file with your SSL certificate file.
 
diff --git a/definitions.rst b/definitions.rst
@@ -5,13 +5,22 @@
 Definitions
 ===========
 
+When configuring and operating a Netris system, the following nomenclature is important to understand:
+
 * **User** - A user account for accessing Netris Controller through GUI, RestAPI, and Kubernetes. The default username is ``netris``, with password ``newNet0ps``. 
+
 * **Tenant** - IP addresses and Switch Ports are network resources assigned to different Tenants to have under their management. Admin is the default tenant, and by default, it owns all the resources. You can use different Tenants for sharing and delegation of control over the network resources. Network teams typically use Tenants to grant access to other groups to request and manage network services using the Netris Controller as a self-service portal or programmatically (with Kubernetes CRDs) via a DevOps/NetOps pipeline.  
+
 * **Permission Group** - List of permissions on a per section basis can be attached individually to a User or a User Role  
+
 * **User Role** - Group of user permissions and tenants for role-based access control (RBAC)
 
 * **Site** - Each separate deployment (each data center) should be defined as a *Site*. All network units and resources are attached to a site. Netris Controller comes with a "default" site preconfigured. Site entry defines global attributes such as; AS numbers, default ACL policy, and Site Mesh (site to site VPN) type.
+
 * **Subnet** - IPv4/IPv6 address resources linked to *Sites* and *Tenants* 
+
 * **Switch Port** - Physical ports of all switches attached to the system
+
 * **Inventory** - Inventory of all network units that are operated using Netris Agent
+
 * **E-BGP** - Defines all External BGP peers (iBGP and eBGP)
diff --git a/index.rst b/index.rst
@@ -15,14 +15,12 @@ Netris is the Automatic NetOps platform that runs the physical network and provi
    introduction
    netris-architecture
    supported-networks
-   reference-designs
 
 .. toctree::
    :maxdepth: 2
    :caption: Installation
 
-   controller-installation
-   controller-k8s-installation
+   installation
    switch-agent-installation
    SoftGate-agent-installation
 
diff --git a/installation.rst b/installation.rst
@@ -0,0 +1,20 @@
+.. meta::
+    :description: Controller Installation
+
+=======================
+Controller Installation
+=======================
+
+Netris Controller can be installed locally as a VM, deployed as a Kubernetes application, or hosted in the Netris Cloud. All three options provide the same functionality. Cloud-hosted Controller can be moved into on-prem anytime. 
+
+.. note::
+  
+  Select ONE installation option below.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Controller Installation
+
+   controller-vm-installation
+   controller-k8s-installation
diff --git a/introduction.rst b/introduction.rst
@@ -3,7 +3,9 @@
 
 Introduction to Netris
 ======================
-.. image:: images/netris-architecture.png
-    :align: center
 
 Netris is an automatic netops software for operating physical networks like it is a cloud. Netris automatically configures switching, routing, load-balancing, and network security based on user-defined services and policies. Netris continuously monitors the network's health and either applies software remediation or informs you of necessary actions if human intervention is required. Netris abstracts away the complexities of detailed network configuration, letting you perform efficiently by operating your physical network in a top down approach like a cloud – instead of the legacy box by box operation.
+
+.. image:: images/netris-architecture.png
+    :align: center
+    
diff --git a/inventory-profiles.rst b/inventory-profiles.rst
@@ -21,5 +21,6 @@ As soon as the inventory profile is attached to a device it denies all traffic d
 **Example:** In this example Netris Controller is used to provide NTP and DNS services to the switches (common setup).
 
 .. image:: images/inventory-profile.png
-    :align: center
-    :class: with-shadow
+   :align: center
+   :class: with-shadow
+   :alt: Adding an inventory profile
diff --git a/ipam.rst b/ipam.rst
@@ -22,7 +22,6 @@ There are 2 main types of IP prefixes - allocation and subnet. Allocations are I
    :alt: IPAM Tree View
    :class: with-shadow
 
-.. centered::
    IPAM Tree View
 
 --------------------------
@@ -53,7 +52,6 @@ Add an Allocation
    :class: with-shadow
    :alt: Add a New IP Allocation
 
-.. centered::
    Add Allocation Window
 
 --------------------------
@@ -93,5 +91,4 @@ Add a Subnet
    :alt: Add a New Subnet
    :class: with-shadow
 
-.. centered::
    Add Subnet Window
diff --git a/kubernetes-integration.rst b/kubernetes-integration.rst
@@ -99,7 +99,10 @@ Now we can see that the service type changed to LoadBalancer, and "EXTERNAL-IP"
 Going into the Netris Controller web interface, navigate to **Services / L4 Load Balancer**, and you may see L4LBs provisioning in real-time. If you do not see the provisioning process it is likely because it already completed. Look for the service with the name **"podinfo-xxxxxxxx"**
 
 .. image:: /images/sandbox-podinfo-prov.png
-    :align: center
+   :align: center
+   :class: with-shadow
+   :alt: Sandbox pod provisioning
+
 
 After provisioning has finished, inspect the service in k8s:
 
@@ -203,10 +206,12 @@ You will see the servers’ hostname in curl output:
 You can also inspect the L4LB in the Netris Controller web interface:
 
 .. image:: /images/sandbox-l4lbs.png
-    :align: center
+   :align: center
+   :class: with-shadow
+   :alt: View L4 LB instances
 
 V-Net Custom Resource
---------------------
+---------------------
 
 You can also create Netris V-Nets (L2 segments) via Kubernetes with a simple manifest:
 
diff --git a/l3-load-balancer.rst b/l3-load-balancer.rst
@@ -21,22 +21,22 @@ To configure L3 (Anycast) load balancing:
 #. This will create a service under Services→Load Balancer and permit using the Anycast IP address in multiple ROH instances. 
 
 .. image:: images/add-l3-lb.png
-    :align: center
-    :class: with-shadow
-
-.. centered::
+   :align: center
+   :class: with-shadow
+   :alt: Add a L3 LB
+   
    Example: Adding an Anycast IPv4 address 
 
 .. image:: images/list-l3-lb.png
-    :align: center
-    :class: with-shadow
-
-.. centered::
+   :align: center
+   :class: with-shadow
+   :alt: List L3 LBs
+   
    Example: Under Services→Load Balancer, you can find the listing of L3 (Anycast) Load Balancers, service statuses, and you can add/remove more ROH instances and/or health checks.
 
 .. image:: images/list-l3-lb-detail.png
-    :align: center
-    :class: with-shadow
-
-.. centered::
-   Screenshot: L3 (Anycast) Load Balancer Detail
+   :align: center
+   :class: with-shadow
+   :alt: List L3 LB Details
+   
+   Screenshot: L3 (Anycast) Load Balancer Detail
diff --git a/l4-load-balancer.rst b/l4-load-balancer.rst
@@ -16,15 +16,17 @@ The IP address pool for L4LB can be defined in the Net→IPAM section by adding
 Example: Adding a load-balancer IP pool assignment.
 
 .. image:: images/add-allocation.png
-    :align: center
-    :class: with-shadow
+   :align: center
+   :class: with-shadow
+   :alt: Add an IP Allocation
     
     
 Screenshot: Listing of Net→IPAM after adding a load-balancer assignment
 
 .. image:: images/list-subnets.png
-    :align: center
-    :class: with-shadow
+   :align: center
+   :class: with-shadow
+   :alt: List IP Subnets 
     
     
 Consuming L4LB service
@@ -66,15 +68,16 @@ Add new L4 Load Balancer fields are described below:
 * **Port** - Service port on the backend host.
 * **Enabled** - Administrative state of particular backend. 
 
-
-Example: Requesting an L4 Load Balancer service.
-
 .. image:: images/request-L4.png
-    :align: center
-    :class: with-shadow
+   :align: center
+   :class: with-shadow
+   :alt: Request an L4 Load Balancer
     
-Example: Listing of L4 Load Balancer services
+   Example: Requesting an L4 Load Balancer service.
 
 .. image:: images/list-l4-load-balancers.png
-    :align: center
-    :class: with-shadow
+   :align: center
+   :class: with-shadow
+   :alt: List L4 Load Balancers
+
+   Example: Listing of L4 Load Balancer services
diff --git a/roh.rst b/roh.rst
diff --git a/supported-networks.rst b/supported-networks.rst
diff --git a/switch-agent-installation.rst b/switch-agent-installation.rst
diff --git a/switch-ports.rst b/switch-ports.rst
diff --git a/topology-management.rst b/topology-management.rst
