| 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. |
| 14 | SD-Core images are hosted on an ONF member-only Docker registry. |
| 15 | You need to obtain access token and supply that as part of the Helm value. |
| 16 | |
| 17 | Hardware resource requirement |
| 18 | ----------------------------- |
| 19 | |
| ajay | ce0380c | 2021-12-14 21:51:00 -0800 | [diff] [blame] | 20 | .. list-table:: CPU & Memory Requirements for 4G components |
| 21 | :widths: 5 5 5 |
| 22 | :header-rows: 1 |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 23 | |
| ajay | ce0380c | 2021-12-14 21:51:00 -0800 | [diff] [blame] | 24 | * - SD-Core Component |
| 25 | - Required CPU |
| 26 | - Required Memory in Gi |
| 27 | * - MME |
| 28 | - 2 CPU Cores |
| 29 | - 2Gi |
| 30 | * - SPGW |
| 31 | - 2 CPU Cores |
| 32 | - 5Gi |
| 33 | * - PCRF |
| 34 | - 2 CPU Cores |
| 35 | - 1Gi |
| 36 | * - HSS |
| 37 | - 2 CPU Cores |
| 38 | - 1Gi |
| 39 | * - Config4G |
| 40 | - 1 CPU Cores |
| 41 | - 1Gi |
| 42 | * - SimApp |
| 43 | - 1 CPU Cores |
| 44 | - 1Gi |
| 45 | * - Cassandra |
| 46 | - 2 CPU Cores |
| 47 | - 4Gi |
| 48 | |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 49 | |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 50 | Deployment Options |
| 51 | ------------------ |
| 52 | |
| 53 | Development Environments |
| 54 | """""""""""""""""""""""" |
| ajay | ce0380c | 2021-12-14 21:51:00 -0800 | [diff] [blame] | 55 | Please refer (see :ref:`aiab-guide`) to setup 4G development environment. |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 56 | |
| 57 | Production Environments - 4G |
| 58 | """""""""""""""""""""""""""" |
| 59 | |
| 60 | To install SD-Core into your Kubernetes cluster, follow instructions |
| 61 | |
| 62 | Step1 - Clone SD-Core 4G Helm chart |
| 63 | ''''''''''''''''''''''''''''''''''' |
| 64 | .. code-block:: |
| 65 | |
| ajay | cbd1706 | 2022-03-06 11:12:58 -0800 | [diff] [blame^] | 66 | git clone "https://gerrit.opencord.org/sdcore-helm-charts" |
| ajay | d19711c | 2021-12-07 12:07:04 -0800 | [diff] [blame] | 67 | cd sdcore-helm-charts/sdcore-helm-charts/ |
| 68 | helm dep update #Update Helm dependencies |
| 69 | |
| 70 | Step2 - Prepare your Helm values for 4G |
| 71 | ''''''''''''''''''''''''''''''''''''''' |
| 72 | |
| 73 | You can modify existing values.yaml directly, but we recommend composing another value |
| 74 | file myvalues.yaml using values.yaml as an example. We are highlighting a few things we |
| 75 | need to modify here. More explanation of the supported Helm values can be found in the |
| 76 | Configuration section below. |
| 77 | |
| 78 | Step3 - Install 4G using SD-Core umbrella helm chart |
| 79 | '''''''''''''''''''''''''''''''''''''''''''''''''''' |
| 80 | |
| 81 | The following command will deploy the SD-Core helm chart with release name sdcore-4g in the sdcore-4g namespace. |
| 82 | |
| 83 | .. code-block:: |
| 84 | |
| ajay | cbd1706 | 2022-03-06 11:12:58 -0800 | [diff] [blame^] | 85 | 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] | 86 | |
| 87 | To verify the installation: |
| 88 | |
| 89 | .. code-block:: |
| 90 | |
| 91 | helm -n sdcore-4g ls |
| 92 | |
| 93 | To uninstall: |
| 94 | |
| 95 | .. code-block:: |
| 96 | |
| 97 | helm -n sdcore-4g uninstall sdcore-4g |
| 98 | kubectl delete namespace sdcore-4g # also remove the sdcore-4g if needed |