blob: e6b8023704bd869ac8921bf3731d16f90b113552 [file] [log] [blame]
ajayd19711c2021-12-07 12:07:04 -08001..
2 SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
3 SPDX-License-Identifier: Apache-2.0
4
ajay07514982021-12-07 22:24:32 -08005.. _deployment_5G_guide:
ajayd19711c2021-12-07 12:07:04 -08006
ajay07514982021-12-07 22:24:32 -080075G Deployment Guide
8===================
ajayd19711c2021-12-07 12:07:04 -08009
10Deployment Overview
11-------------------
12SD-Core is released with Helm chart and container images.
13We recommend using **Kubernetes** and **Helm** to deploy SD-Core.
Ajay Lotan Thakurd0573072022-05-04 19:16:52 -070014SD-Core images are hosted on docker hub.
ajayd19711c2021-12-07 12:07:04 -080015
16Hardware resource requirement
17-----------------------------
18
ajayce0380c2021-12-14 21:51:00 -080019.. list-table:: CPU & Memory Requirements for 5G components
20 :widths: 5 5 5
21 :header-rows: 1
ajayd19711c2021-12-07 12:07:04 -080022
ajayce0380c2021-12-14 21:51:00 -080023 * - SD-Core Component
24 - Required CPU
25 - Required Memory in Gi
26 * - AMF
27 - 2 CPU Cores
28 - 4Gi
29 * - SMF
30 - 2 CPU Cores
31 - 4Gi
32 * - NRF
33 - 2 CPU Cores
34 - 1Gi
35 * - NSSF
36 - 2 CPU Cores
37 - 1Gi
38 * - AUSF
39 - 1 CPU Cores
40 - 1Gi
41 * - PCF
42 - 1 CPU Cores
43 - 1Gi
44 * - UDR
45 - 2 CPU Cores
46 - 1Gi
47 * - UDM
48 - 2 CPU Cores
49 - 1Gi
50 * - Config5G(webconsole)
51 - 1 CPU Cores
52 - 1Gi
53 * - SimApp
54 - 1 CPU Cores
55 - 1Gi
56 * - MongoDB
57 - 2 CPU Cores
58 - 4Gi
59
ajayd19711c2021-12-07 12:07:04 -080060
Ajay Lotan Thakur05ce5ce2022-09-25 20:36:16 -070061.. note::
62 SD-Core deployment is tested on Intel/AMD hardware. There is WIP to run SD-Core
63 on ARM architecture.
64
ajayd19711c2021-12-07 12:07:04 -080065Deployment Options
66------------------
67
68Development Environments
69""""""""""""""""""""""""
70
ajayce0380c2021-12-14 21:51:00 -080071Please refer (see :ref:`aiab-guide`) to setup 5G development environment.
ajayd19711c2021-12-07 12:07:04 -080072
ajayd19711c2021-12-07 12:07:04 -080073Production Environments - 5G
74""""""""""""""""""""""""""""
75
76To install SD-Core into your Kubernetes cluster, follow instructions
77
78Step1 - Clone SD-Core 5G Helm chart
79'''''''''''''''''''''''''''''''''''
80.. code-block::
81
ajaycbd17062022-03-06 11:12:58 -080082 git clone "https://gerrit.opencord.org/sdcore-helm-charts"
ajayd19711c2021-12-07 12:07:04 -080083 cd sdcore-helm-charts/sdcore-helm-charts/
84 helm dep update #Update Helm dependencies
85
86Step2 - Prepare your Helm value for 5G
87''''''''''''''''''''''''''''''''''''''
88
89You can modify existing values.yaml directly, but we recommend composing another value
90file myvalues.yaml using values.yaml as an example. We are highlighting a few things we
91need to modify here. More explanation of the supported Helm values can be found in the
92Configuration section below.
93
94Step3 - Install 5G using SD-Core umbrella helm chart
95''''''''''''''''''''''''''''''''''''''''''''''''''''
96
ajaycbd17062022-03-06 11:12:58 -080097The following command will deploy the SD-Core helm chart with release name sdcore-5g in the sdcore-5g namespace.
ajayd19711c2021-12-07 12:07:04 -080098
99.. code-block::
100
ajaycbd17062022-03-06 11:12:58 -0800101 helm install -n sdcore-5g --create-namespace -f myvalues.yaml sdcore-5g ~/cord/sdcore-helm-charts/sdcore-helm-charts
ajayd19711c2021-12-07 12:07:04 -0800102
103To verify the installation:
104
105.. code-block::
106
107 helm -n sdcore-5g ls
ajaycbd17062022-03-06 11:12:58 -0800108 ajayonf@node:~$ helm -n sdcore-5g ls
109 NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
110 sdcore-5g sdcore-5g 1 2022-03-05 16:25:32.338495035 -0700 MST deployed sd-core-0.10.9
111 ajayonf@node:~$
112
113 ajayonf@node:~$ kubectl get pods -n sdcore-5g
114 NAME READY STATUS RESTARTS AGE
115 amf-66bf99c879-5x4ms 1/1 Running 0 3m23s
116 ausf-65dc454b79-jp2cb 1/1 Running 0 3m23s
117 mongodb-6df94d8dd9-h8p4w 1/1 Running 0 3m23s
118 nrf-65bcfbb496-xvt6t 1/1 Running 0 3m23s
119 nssf-6f58859d67-552l2 1/1 Running 0 3m23s
120 pcf-5b4c75f57d-sl5rh 1/1 Running 0 3m23s
121 simapp-d8994999d-98k6v 1/1 Running 0 3m23s
122 smf-77c89ccc6d-4d8g2 1/1 Running 0 3m23s
123 udm-6dcdc457c6-gwmfk 1/1 Running 0 3m23s
124 udr-84678ff6dc-zkj52 1/1 Running 0 3m23s
125 upf-0 0/5 Pending 0 3m23s
126 webui-66b4df44b-9clwf 1/1 Running 0 3m23s
127 ajayonf@node:~$
ajayd19711c2021-12-07 12:07:04 -0800128
129To uninstall:
130
131.. code-block::
132
133 helm -n sdcore-5g uninstall sdcore-5g
134 kubectl delete namespace sdcore-5g # also remove the sdcore-5g if needed
135
136