| 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 | |
| 20 | SD-Core 4G has following K8s pods |
| 21 | |
| 22 | - MME: 2 CPU Cores, 4Gi RAM |
| 23 | - SPGW: 2 CPU Cores, 4Gi RAM |
| 24 | - PCRF: 2 CPU Cores, 1Gi RAM |
| 25 | - HSS : 2 CPU Cores, 1Gi RAM |
| 26 | - ConfigPod: 1 CPU Core, 1Gi RAM |
| 27 | - SimApp: 1 CPU Core, 1Gi RAM |
| 28 | - Cassandra: 2 CPU Core, 4Gi RAM |
| 29 | |
| 30 | Prepare access credential for SD-Core images |
| 31 | -------------------------------------------- |
| 32 | |
| 33 | Container images can be download from ONF self-hosted container registry but you have to gain the access token first. |
| 34 | |
| 35 | 1. Login to `Aether Harbor Registry <https://registry.aetherproject.org/harbor/sign-in?redirect_url=%2Fharbor%2Fprojects>`_ using your ONF Crowd credential, |
| 36 | 2. Select ``User Profile`` drop-down menu in the upper-right corner |
| 37 | 3. Generate the CLI secret and it's the secret token you have to access the container registry via CLI tool. |
| 38 | 4. Login to the container registry with your username and access token |
| 39 | by ``docker login command`` to ensure you can access it. |
| 40 | |
| 41 | .. code-block:: |
| 42 | |
| 43 | ╰─$ docker login registry.aetherproject.org --username hwchiu |
| 44 | Password: |
| 45 | Login Succeeded |
| 46 | |
| 47 | Deployment Options |
| 48 | ------------------ |
| 49 | |
| 50 | Development Environments |
| 51 | """""""""""""""""""""""" |
| 52 | |
| 53 | TODO - AIAB document link |
| 54 | |
| 55 | Production Environments - 4G |
| 56 | """""""""""""""""""""""""""" |
| 57 | |
| 58 | To install SD-Core into your Kubernetes cluster, follow instructions |
| 59 | |
| 60 | Step1 - Clone SD-Core 4G Helm chart |
| 61 | ''''''''''''''''''''''''''''''''''' |
| 62 | .. code-block:: |
| 63 | |
| 64 | git clone ssh://gerrit.opencord.org:29418/sdcore-helm-charts |
| 65 | cd sdcore-helm-charts/sdcore-helm-charts/ |
| 66 | helm dep update #Update Helm dependencies |
| 67 | |
| 68 | Step2 - Prepare your Helm values for 4G |
| 69 | ''''''''''''''''''''''''''''''''''''''' |
| 70 | |
| 71 | You can modify existing values.yaml directly, but we recommend composing another value |
| 72 | file myvalues.yaml using values.yaml as an example. We are highlighting a few things we |
| 73 | need to modify here. More explanation of the supported Helm values can be found in the |
| 74 | Configuration section below. |
| 75 | |
| 76 | Step3 - Install 4G using SD-Core umbrella helm chart |
| 77 | '''''''''''''''''''''''''''''''''''''''''''''''''''' |
| 78 | |
| 79 | The following command will deploy the SD-Core helm chart with release name sdcore-4g in the sdcore-4g namespace. |
| 80 | |
| 81 | .. code-block:: |
| 82 | |
| 83 | helm install -n sdcore-4g --create-namespace -f myvaules.yaml sdcore-4g . |
| 84 | |
| 85 | To verify the installation: |
| 86 | |
| 87 | .. code-block:: |
| 88 | |
| 89 | helm -n sdcore-4g ls |
| 90 | |
| 91 | To uninstall: |
| 92 | |
| 93 | .. code-block:: |
| 94 | |
| 95 | helm -n sdcore-4g uninstall sdcore-4g |
| 96 | kubectl delete namespace sdcore-4g # also remove the sdcore-4g if needed |