From 95697929d8c97a0621c5ba4ade9f5e285142e38b Mon Sep 17 00:00:00 2001 From: Larry Peterson Date: Fri, 1 Mar 2024 15:12:20 -0700 Subject: [PATCH 1/6] draft devel section --- index.rst | 1 + onramp/devel.rst | 69 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) create mode 100644 onramp/devel.rst diff --git a/index.rst b/index.rst index 73d889f..2688095 100644 --- a/index.rst +++ b/index.rst @@ -22,6 +22,7 @@ onramp/gnbsim onramp/gnb onramp/roc + onramp/devel onramp/blueprints .. toctree:: diff --git a/onramp/devel.rst b/onramp/devel.rst new file mode 100644 index 0000000..aaa5388 --- /dev/null +++ b/onramp/devel.rst @@ -0,0 +1,69 @@ +Development Support +----------------------- + +OnRamp's primary goal is to support users that want to deploy +officially released versions of Aether on local hardware, but it also +provides a way for users that want to develop new features to deploy +and test those changes. To this end, this section describes how to +configure OnRamp to include locally modified components. + +At a low level, development is a component-specific task, and users +are referred to documentation for the respective subsystems: + +* To develop SD-Core, see the :doc:`SD-Core Guide `. + +* To develop SD-RAN, see the :doc:`SD-RAN Guide `. + +* To develop ROC-based APIs, see :doc:`ROC Development `. + +* To develop Monitoring Dashboards, see :doc:`Monitoring & Alert Development `. + +At a high level, OnRamp provides a means to deploy developmental +versions of Aether than include local modifications to the standard +components. These modifications range from coarse-grain (i.e., +replacing the Helm Chart for an entire subsystem), to fine-grain +(i.e., replacing the container image for an individual microservice). +The following uses SD-Core as a specific example to illustrate how +this is done. The same approach can be applied to other subsystems. + +To substitute a local Helm Chart—for example, one located in directory +``/home/ubuntu/aether/sdcore-helm-charts/sdcore-helm-charts`` on the +server where you run the OnRamp ``make`` targets—edit the ``helm`` +block of the ``core`` section of ``vars/main.yml`` to replace: + +.. code-block:: + + helm: + local_charts: false + chart_ref: aether/sd-core + chart_version: 0.12.8 + +with + +.. code-block:: + + helm: + local_charts: true + chart_ref: "/home/ubuntu/aether/sdcore-helm-charts/sdcore-helm-charts" + chart_version: 0.13.2 + +Note that variable ``core.helm.local_charts`` is a boolean, not the +string ``"true"``. And in this example, we have declared our new chart +to be version ``0.13.2`` instead of ``0.12.8``. + +To substitute a locally built container image, edit the corresponding +block in the values override file that you have configured in +``vars/main.yml``; e.g., +``deps/5gc/roles/core/templates/sdcore-5g-values.yaml``. For example, +if you have published an alternative version of the AMF microservice +in your account on Docker Hub with tag ``myversion:foo``, then set the +``images`` block of 5G control plane section accordingly: + +.. code-block:: + + 5g-control-plane: + enable5G: true + images: + repository: "hub.docker.com/myregistry/" + tags: + amf: myversion:foo From 6c16b0f285f62c11616dad2912ec1c63035c53ae Mon Sep 17 00:00:00 2001 From: Larry Peterson Date: Fri, 1 Mar 2024 15:12:20 -0700 Subject: [PATCH 2/6] draft devel section --- conf.py | 1 + index.rst | 1 + onramp/devel.rst | 69 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 71 insertions(+) create mode 100644 onramp/devel.rst diff --git a/conf.py b/conf.py index 6633c98..533cda7 100644 --- a/conf.py +++ b/conf.py @@ -269,6 +269,7 @@ def get_version(): r'https://ark.intel.com/.*', r'https://wiki.onosproject.org/.*', r'https://wiki.opennetworking.org/.*', + r'https://docs.sd-core.opennetworking.org/.*', ] linkcheck_timeout = 3 diff --git a/index.rst b/index.rst index 73d889f..2688095 100644 --- a/index.rst +++ b/index.rst @@ -22,6 +22,7 @@ onramp/gnbsim onramp/gnb onramp/roc + onramp/devel onramp/blueprints .. toctree:: diff --git a/onramp/devel.rst b/onramp/devel.rst new file mode 100644 index 0000000..aaa5388 --- /dev/null +++ b/onramp/devel.rst @@ -0,0 +1,69 @@ +Development Support +----------------------- + +OnRamp's primary goal is to support users that want to deploy +officially released versions of Aether on local hardware, but it also +provides a way for users that want to develop new features to deploy +and test those changes. To this end, this section describes how to +configure OnRamp to include locally modified components. + +At a low level, development is a component-specific task, and users +are referred to documentation for the respective subsystems: + +* To develop SD-Core, see the :doc:`SD-Core Guide `. + +* To develop SD-RAN, see the :doc:`SD-RAN Guide `. + +* To develop ROC-based APIs, see :doc:`ROC Development `. + +* To develop Monitoring Dashboards, see :doc:`Monitoring & Alert Development `. + +At a high level, OnRamp provides a means to deploy developmental +versions of Aether than include local modifications to the standard +components. These modifications range from coarse-grain (i.e., +replacing the Helm Chart for an entire subsystem), to fine-grain +(i.e., replacing the container image for an individual microservice). +The following uses SD-Core as a specific example to illustrate how +this is done. The same approach can be applied to other subsystems. + +To substitute a local Helm Chart—for example, one located in directory +``/home/ubuntu/aether/sdcore-helm-charts/sdcore-helm-charts`` on the +server where you run the OnRamp ``make`` targets—edit the ``helm`` +block of the ``core`` section of ``vars/main.yml`` to replace: + +.. code-block:: + + helm: + local_charts: false + chart_ref: aether/sd-core + chart_version: 0.12.8 + +with + +.. code-block:: + + helm: + local_charts: true + chart_ref: "/home/ubuntu/aether/sdcore-helm-charts/sdcore-helm-charts" + chart_version: 0.13.2 + +Note that variable ``core.helm.local_charts`` is a boolean, not the +string ``"true"``. And in this example, we have declared our new chart +to be version ``0.13.2`` instead of ``0.12.8``. + +To substitute a locally built container image, edit the corresponding +block in the values override file that you have configured in +``vars/main.yml``; e.g., +``deps/5gc/roles/core/templates/sdcore-5g-values.yaml``. For example, +if you have published an alternative version of the AMF microservice +in your account on Docker Hub with tag ``myversion:foo``, then set the +``images`` block of 5G control plane section accordingly: + +.. code-block:: + + 5g-control-plane: + enable5G: true + images: + repository: "hub.docker.com/myregistry/" + tags: + amf: myversion:foo From 3fbf102759b5bb2072a92410933a739741d697c9 Mon Sep 17 00:00:00 2001 From: Larry Peterson Date: Sat, 2 Mar 2024 14:12:46 -0700 Subject: [PATCH 3/6] Update onramp/devel.rst Co-authored-by: gab-arrobo --- onramp/devel.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/onramp/devel.rst b/onramp/devel.rst index aaa5388..bd519f3 100644 --- a/onramp/devel.rst +++ b/onramp/devel.rst @@ -4,7 +4,7 @@ Development Support OnRamp's primary goal is to support users that want to deploy officially released versions of Aether on local hardware, but it also provides a way for users that want to develop new features to deploy -and test those changes. To this end, this section describes how to +and test them. To this end, this section describes how to configure OnRamp to include locally modified components. At a low level, development is a component-specific task, and users From 5d332183a89d04020895f61a46ad485ff281c39e Mon Sep 17 00:00:00 2001 From: Larry Peterson Date: Sat, 2 Mar 2024 14:12:59 -0700 Subject: [PATCH 4/6] Update onramp/devel.rst Co-authored-by: gab-arrobo --- onramp/devel.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/onramp/devel.rst b/onramp/devel.rst index bd519f3..f87beac 100644 --- a/onramp/devel.rst +++ b/onramp/devel.rst @@ -5,7 +5,8 @@ OnRamp's primary goal is to support users that want to deploy officially released versions of Aether on local hardware, but it also provides a way for users that want to develop new features to deploy and test them. To this end, this section describes how to -configure OnRamp to include locally modified components. +configure OnRamp to use locally modified components, such as +Helm Charts, Docker images, 5GC's source code. At a low level, development is a component-specific task, and users are referred to documentation for the respective subsystems: From 4434630ee7f120118879bd73146dacc513f9f552 Mon Sep 17 00:00:00 2001 From: Larry Peterson Date: Sat, 2 Mar 2024 14:13:11 -0700 Subject: [PATCH 5/6] Update onramp/devel.rst Co-authored-by: gab-arrobo --- onramp/devel.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/onramp/devel.rst b/onramp/devel.rst index f87beac..5d99919 100644 --- a/onramp/devel.rst +++ b/onramp/devel.rst @@ -20,7 +20,7 @@ are referred to documentation for the respective subsystems: * To develop Monitoring Dashboards, see :doc:`Monitoring & Alert Development `. At a high level, OnRamp provides a means to deploy developmental -versions of Aether than include local modifications to the standard +versions of Aether that include local modifications to the standard components. These modifications range from coarse-grain (i.e., replacing the Helm Chart for an entire subsystem), to fine-grain (i.e., replacing the container image for an individual microservice). From fff26876c8a66a1e93e13e279f7edd520f01e355 Mon Sep 17 00:00:00 2001 From: Larry Peterson Date: Sat, 2 Mar 2024 14:13:25 -0700 Subject: [PATCH 6/6] Update onramp/devel.rst Co-authored-by: gab-arrobo --- onramp/devel.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/onramp/devel.rst b/onramp/devel.rst index 5d99919..83480f9 100644 --- a/onramp/devel.rst +++ b/onramp/devel.rst @@ -23,7 +23,7 @@ At a high level, OnRamp provides a means to deploy developmental versions of Aether that include local modifications to the standard components. These modifications range from coarse-grain (i.e., replacing the Helm Chart for an entire subsystem), to fine-grain -(i.e., replacing the container image for an individual microservice). +(i.e., replacing the container image (source code) for an individual microservice). The following uses SD-Core as a specific example to illustrate how this is done. The same approach can be applied to other subsystems.