| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 1 | .. |
| 2 | SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org> |
| 3 | SPDX-License-Identifier: Apache-2.0 |
| 4 | |
| ajay | 0751498 | 2021-12-07 22:24:32 -0800 | [diff] [blame] | 5 | .. _deployment_4G_guide: |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 6 | |
| ajay | 0751498 | 2021-12-07 22:24:32 -0800 | [diff] [blame] | 7 | 4G Deployment Guide |
| 8 | ==================== |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 9 | |
| 10 | Deployment Overview |
| 11 | ------------------- |
| 12 | SD-Core is released with Helm chart and container images. |
| 13 | We recommend using **Kubernetes** and **Helm** to deploy SD-Core. |
| Ajay Lotan Thakur | d057307 | 2022-05-04 19:16:52 -0700 | [diff] [blame] | 14 | SD-Core images are hosted on docker hub. |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 15 | |
| 16 | Hardware resource requirement |
| 17 | ----------------------------- |
| 18 | |
| ajay | ce0380c | 2021-12-14 21:51:00 -0800 | [diff] [blame] | 19 | .. list-table:: CPU & Memory Requirements for 4G components |
| 20 | :widths: 5 5 5 |
| 21 | :header-rows: 1 |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 22 | |
| ajay | ce0380c | 2021-12-14 21:51:00 -0800 | [diff] [blame] | 23 | * - SD-Core Component |
| 24 | - Required CPU |
| 25 | - Required Memory in Gi |
| 26 | * - MME |
| 27 | - 2 CPU Cores |
| 28 | - 2Gi |
| 29 | * - SPGW |
| 30 | - 2 CPU Cores |
| 31 | - 5Gi |
| 32 | * - PCRF |
| 33 | - 2 CPU Cores |
| 34 | - 1Gi |
| 35 | * - HSS |
| 36 | - 2 CPU Cores |
| 37 | - 1Gi |
| 38 | * - Config4G |
| 39 | - 1 CPU Cores |
| 40 | - 1Gi |
| 41 | * - SimApp |
| 42 | - 1 CPU Cores |
| 43 | - 1Gi |
| 44 | * - Cassandra |
| 45 | - 2 CPU Cores |
| 46 | - 4Gi |
| 47 | |
| Ajay Lotan Thakur | 05ce5ce | 2022-09-25 20:36:16 -0700 | [diff] [blame] | 48 | .. note:: |
| 49 | SD-Core deployment is tested on Intel/AMD hardware. There is WIP to run SD-Core |
| 50 | on ARM architecture. |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 51 | |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 52 | Deployment Options |
| 53 | ------------------ |
| 54 | |
| 55 | Development Environments |
| 56 | """""""""""""""""""""""" |
| ajay | ce0380c | 2021-12-14 21:51:00 -0800 | [diff] [blame] | 57 | Please refer (see :ref:`aiab-guide`) to setup 4G development environment. |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 58 | |
| 59 | Production Environments - 4G |
| 60 | """""""""""""""""""""""""""" |
| 61 | |
| 62 | To install SD-Core into your Kubernetes cluster, follow instructions |
| 63 | |
| 64 | Step1 - Clone SD-Core 4G Helm chart |
| 65 | ''''''''''''''''''''''''''''''''''' |
| 66 | .. code-block:: |
| 67 | |
| ajay | cbd1706 | 2022-03-06 11:12:58 -0800 | [diff] [blame] | 68 | git clone "https://gerrit.opencord.org/sdcore-helm-charts" |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 69 | cd sdcore-helm-charts/sdcore-helm-charts/ |
| 70 | helm dep update #Update Helm dependencies |
| 71 | |
| 72 | Step2 - Prepare your Helm values for 4G |
| 73 | ''''''''''''''''''''''''''''''''''''''' |
| 74 | |
| 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. |
| 79 | |
| 80 | Step3 - Install 4G using SD-Core umbrella helm chart |
| 81 | '''''''''''''''''''''''''''''''''''''''''''''''''''' |
| 82 | |
| 83 | The following command will deploy the SD-Core helm chart with release name sdcore-4g in the sdcore-4g namespace. |
| 84 | |
| 85 | .. code-block:: |
| 86 | |
| ajay | cbd1706 | 2022-03-06 11:12:58 -0800 | [diff] [blame] | 87 | helm install -n sdcore-4g --create-namespace -f myvalues.yaml sdcore-4g ~/cord/sdcore-helm-charts/sdcore-helm-charts |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 88 | |
| 89 | To verify the installation: |
| 90 | |
| 91 | .. code-block:: |
| 92 | |
| 93 | helm -n sdcore-4g ls |
| 94 | |
| 95 | To uninstall: |
| 96 | |
| 97 | .. code-block:: |
| 98 | |
| 99 | helm -n sdcore-4g uninstall sdcore-4g |
| 100 | kubectl delete namespace sdcore-4g # also remove the sdcore-4g if needed |