Skip to content

Commit 6584d72

Browse files
authored
Improve deployment documentation (#101)
* Improve deployment documentation Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com> * Address Copilot's comments Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com> --------- Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>
1 parent 0e06e45 commit 6584d72

File tree

3 files changed

+308
-275
lines changed

3 files changed

+308
-275
lines changed

deployment/deployment4G.rst

Lines changed: 48 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@
99

1010
Deployment Overview
1111
-------------------
12-
SD-Core is released with Helm chart and container images.
13-
We recommend using **Kubernetes** and **Helm** to deploy SD-Core.
14-
SD-Core images are hosted on docker hub.
1512

16-
Hardware resource requirement
17-
-----------------------------
13+
SD-Core is released with Helm charts and container images. We recommend using
14+
**Kubernetes** and **Helm** to deploy SD-Core. All SD-Core container images are
15+
hosted on Docker Hub.
16+
17+
Hardware Resource Requirements
18+
------------------------------
1819

1920
.. list-table:: CPU & Memory Requirements for 4G components
2021
:widths: 5 5 5
@@ -54,47 +55,63 @@ Deployment Options
5455

5556
Development Environments
5657
""""""""""""""""""""""""
57-
Please refer (see :ref:`aiab-guide`) to setup 4G development environment.
58+
59+
For setting up a 4G development environment, please refer to the
60+
:ref:`aiab-guide` (Aether-in-a-Box guide).
5861

5962
Production Environments - 4G
6063
""""""""""""""""""""""""""""
6164

62-
To install SD-Core into your Kubernetes cluster, follow instructions
65+
To install SD-Core into your Kubernetes cluster, follow these steps:
66+
67+
Step 1: Clone SD-Core 4G Helm Chart
68+
''''''''''''''''''''''''''''''''''''
69+
70+
Clone the repository and update dependencies:
71+
72+
.. code-block:: bash
6373
64-
Step1 - Clone SD-Core 4G Helm chart
65-
'''''''''''''''''''''''''''''''''''
66-
.. code-block::
74+
git clone https://github.com/omec-project/sdcore-helm-charts.git
75+
cd sdcore-helm-charts/sdcore-helm-charts/
76+
helm dep update # Update Helm dependencies
6777
68-
git clone https://github.com/omec-project/sdcore-helm-charts.git
69-
cd sdcore-helm-charts/sdcore-helm-charts/
70-
helm dep update #Update Helm dependencies
78+
Step 2: Prepare Your Helm Values for 4G
79+
''''''''''''''''''''''''''''''''''''''''
7180

72-
Step2 - Prepare your Helm values for 4G
73-
'''''''''''''''''''''''''''''''''''''''
81+
While you can modify the existing ``values.yaml`` directly, we recommend creating a
82+
separate values file (e.g., ``myvalues.yaml``) using ``values.yaml`` as a template.
83+
This approach makes it easier to track your customizations and upgrade in the future.
7484

75-
You can modify existing values.yaml directly, but we recommend composing another value
76-
file myvalues.yaml using values.yaml as an example. We are highlighting a few things we
77-
need to modify here. More explanation of the supported Helm values can be found in the
78-
Configuration section below.
85+
For detailed explanations of the supported Helm values, refer to the Configuration
86+
section below.
7987

80-
Step3 - Install 4G using SD-Core umbrella helm chart
81-
''''''''''''''''''''''''''''''''''''''''''''''''''''
88+
Step 3: Install 4G Using SD-Core Umbrella Helm Chart
89+
'''''''''''''''''''''''''''''''''''''''''''''''''''''
8290

83-
The following command will deploy the SD-Core helm chart with release name sdcore-4g in the sdcore-4g namespace.
91+
The following command deploys the SD-Core Helm chart with release name ``sdcore-4g``
92+
in the ``sdcore-4g`` namespace:
93+
94+
.. code-block:: bash
95+
96+
helm install -n sdcore-4g --create-namespace -f myvalues.yaml sdcore-4g \
97+
./sdcore-helm-charts
98+
99+
.. note::
100+
Adjust the chart path (``./sdcore-helm-charts``) to match your local directory structure where you cloned the sdcore-helm-charts repository.
84101

85-
.. code-block::
102+
**Verify the Installation**
86103

87-
helm install -n sdcore-4g --create-namespace -f myvalues.yaml sdcore-4g ~/cord/sdcore-helm-charts/sdcore-helm-charts
104+
Check the Helm release status:
88105

89-
To verify the installation:
106+
.. code-block:: bash
90107
91-
.. code-block::
108+
helm -n sdcore-4g ls
92109
93-
helm -n sdcore-4g ls
110+
**Uninstall SD-Core**
94111

95-
To uninstall:
112+
To uninstall the SD-Core deployment:
96113

97-
.. code-block::
114+
.. code-block:: bash
98115
99-
helm -n sdcore-4g uninstall sdcore-4g
100-
kubectl delete namespace sdcore-4g # also remove the sdcore-4g if needed
116+
helm -n sdcore-4g uninstall sdcore-4g
117+
kubectl delete namespace sdcore-4g # Optional: remove the namespace

0 commit comments

Comments
 (0)