AETHER-2011 (part1)
Add basic 1.5 release documentation framework
Update edge deployment docs
- Describe different topologies and add deployment diagrams
- Split out Pronto BOM and diagrams
- Make BESS diagram a SVG
Updates to Sphinx and modules, fixed linkcheck to have a timeout/retry
for faulty webservers.
Fix spelling and formatting issue across entire site, remove "Smart
quotes" that cause the spellchecker to throw errors. Add many more
dictionary entries. Make spelling fail the build. Fix all spelling and
grammar errors that triggered failures.
Add autosectionlabel, and manage duplicate section names where they
existed.
Updated readme on image/diagram embedding
Added docs on PoE power cycle with Aruba switches (Pronto)
Change-Id: I7f9f7afae13788f9fe29bfe2683a295ba7b8914e
diff --git a/edge_deployment/runtime_deployment.rst b/edge_deployment/runtime_deployment.rst
index 231b0a7..19935d9 100644
--- a/edge_deployment/runtime_deployment.rst
+++ b/edge_deployment/runtime_deployment.rst
@@ -8,14 +8,14 @@
This section describes how to install and configure Aether Edge Runtime including Kubernetes
and system level applications listed below.
-* sealed-secrets
-* rancher-monitoring
-* fluent-bit
-* opendistro-es
-* hostpath-provisioner
-* edge-maintenance-agent
-* sriov-device-plugin
-* uedns
+* ``sealed-secrets``
+* ``rancher-monitoring``
+* ``fluent-bit``
+* ``opendistro-es``
+* ``hostpath-provisioner``
+* ``edge-maintenance-agent``
+* ``sriov-device-plugin``
+* ``uedns``
For this, we will be using GitOps based CI/CD systems and what you will need to do is
create patches in Aether GitOps repositories, **aether-pod-configs** and **aether-app-configs**,
@@ -23,7 +23,7 @@
.. attention::
- If you skipped VPN bootstap step and didn't add the deployment jobs for the new edge,
+ If you skipped VPN bootstrap step and didn't add the deployment jobs for the new edge,
go to :ref:`Add deployment jobs <add_deployment_jobs>` step and finish it first
before proceeding.
@@ -40,7 +40,7 @@
.. attention::
- If you skipped VPN bootstap step and didn't update global resource maps for the new edge,
+ If you skipped VPN bootstrap step and didn't update global resource maps for the new edge,
go to :ref:`Update global resource maps <update_global_resource>` step and
finish ``cluster_map.tfvars`` and ``user_map.tfvars`` update first before proceeding.
@@ -118,7 +118,7 @@
$ git clone "ssh://[username]@gerrit.opencord.org:29418/aether-app-configs"
Configure rancher-monitoring
-############################
+""""""""""""""""""""""""""""
Open ``fleet.yaml`` under ``infrastructure/rancher-monitoring``, add a custom target
with the new cluster name as a selector, and provide cluster specific Helm values and
@@ -148,11 +148,11 @@
Above step will not be required in Rancher v2.6 as it supports using cluster labels as helm values in a list.
-Configure ue-dns
-################
+Configure ``ue-dns``
+""""""""""""""""""""
For UE-DNS, it is required to create a Helm values file for the new cluster.
-You'll need cluster domain and kube-dns ClusterIP. Both can be found in
+You'll need cluster domain and ``kube-dns`` ClusterIP. Both can be found in
``aether-pod-configs/production/cluster_map.tfvars``.
Be sure to replace ``[ ]`` in the example configuration below to the actual cluster values.
@@ -231,15 +231,16 @@
Assign Fleet workspace
-######################
+""""""""""""""""""""""
-By default, all new clusters are assgiend to a default Fleet workspace called **fleet-default**.
+By default, all new clusters are assigned to a default Fleet workspace called **fleet-default**.
To make a cluster part of Aether and have the applications defined in aether-app-configs deployed,
you must assign the cluster to either **aether-stable** or **aether-alpha** workspace.
For clusters expecting minimal downtime, assign to **aether-stable**.
For clusters for development or previewing upcoming release, assign to **aether-alpha**.
Workspace assignment can be done from Fleet dashboard.
+
To access Fleet dashboard, log in to `Rancher <https://rancher.aetherproject.org>`_ as
``admin`` or ``onfadmin`` user, go to the **Cluster Explorer**,
and click **Cluster Explorer > Continuous Delivery** in the top left dropdown menu.