|
9 | 9 |
|
10 | 10 | Deployment Overview |
11 | 11 | ------------------- |
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. |
15 | 12 |
|
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 | +------------------------------ |
18 | 19 |
|
19 | 20 | .. list-table:: CPU & Memory Requirements for 4G components |
20 | 21 | :widths: 5 5 5 |
@@ -54,47 +55,63 @@ Deployment Options |
54 | 55 |
|
55 | 56 | Development Environments |
56 | 57 | """""""""""""""""""""""" |
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). |
58 | 61 |
|
59 | 62 | Production Environments - 4G |
60 | 63 | """""""""""""""""""""""""""" |
61 | 64 |
|
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 |
63 | 73 |
|
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 |
67 | 77 |
|
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 | +'''''''''''''''''''''''''''''''''''''''' |
71 | 80 |
|
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. |
74 | 84 |
|
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. |
79 | 87 |
|
80 | | -Step3 - Install 4G using SD-Core umbrella helm chart |
81 | | -'''''''''''''''''''''''''''''''''''''''''''''''''''' |
| 88 | +Step 3: Install 4G Using SD-Core Umbrella Helm Chart |
| 89 | +''''''''''''''''''''''''''''''''''''''''''''''''''''' |
82 | 90 |
|
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. |
84 | 101 |
|
85 | | -.. code-block:: |
| 102 | +**Verify the Installation** |
86 | 103 |
|
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: |
88 | 105 |
|
89 | | -To verify the installation: |
| 106 | +.. code-block:: bash |
90 | 107 |
|
91 | | -.. code-block:: |
| 108 | + helm -n sdcore-4g ls |
92 | 109 |
|
93 | | - helm -n sdcore-4g ls |
| 110 | +**Uninstall SD-Core** |
94 | 111 |
|
95 | | -To uninstall: |
| 112 | +To uninstall the SD-Core deployment: |
96 | 113 |
|
97 | | -.. code-block:: |
| 114 | +.. code-block:: bash |
98 | 115 |
|
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