| Scott Baker | fab7c9e | 2021-07-29 17:12:16 -0700 | [diff] [blame] | 1 | .. vim: syntax=rst |
| 2 | |
| 3 | Aether SD-Core Developer Guide |
| 4 | ============================== |
| 5 | |
| 6 | Clone Repositories |
| 7 | ------------------ |
| 8 | |
| 9 | Clone the following repositories, using your gerrit ids as necessary:: |
| 10 | |
| 11 | mkdir -p ~/cord #need to clone below 2 repos in this directory |
| 12 | git clone "ssh://<username>@gerrit.opencord.org:29418/helm-charts" |
| 13 | git clone "ssh://<username>@gerrit.opencord.org:29418/aether-helm-charts" |
| 14 | |
| 15 | cd ~ #go back to home directory |
| 16 | git clone "ssh://<username>@gerrit.opencord.org:29418/aether-in-a-box" |
| 17 | |
| 18 | Start the 4G Core |
| 19 | ----------------- |
| 20 | |
| 21 | Deploy Aether-in-a-Box and start the 4G core:: |
| 22 | |
| 23 | cd aether-in-a-box |
| 24 | |
| 25 | #create K8s cluster for you and also start 4G network functions and carry out 1 ping test |
| 26 | make test |
| 27 | |
| 28 | Apply the necessary pull secrets |
| 29 | -------------------------------- |
| 30 | |
| 31 | The deployment may fail and leave pods in ImagePullBackoff status if the |
| 32 | necessary secrets are not applied. |
| 33 | Obtain the secret from ONF, and then execute the following:: |
| 34 | |
| 35 | cat > ~/registry-secret.json |
| 36 | ... paste the secret here ... |
| 37 | kubectl apply -f ~/registry-secret.json |
| 38 | |
| 39 | |
| 40 | |
| 41 | Transition from 4G Core to 5G Core |
| 42 | ---------------------------------- |
| 43 | |
| 44 | Before starting the 5G core, the 4G Core must be stopped:: |
| 45 | |
| 46 | make reset-test #this does not destroy K8s cluster. |
| 47 | |
| 48 | Now, start the 5G Core:: |
| 49 | |
| 50 | make 5gc #this will start all 5G network functions with default images. |
| 51 | |
| 52 | kubectl get pods -n omec #verify that all 5g pods are started. |
| 53 | |
| 54 | Sample output:: |
| 55 | |
| 56 | NAME READY STATUS RESTARTS AGE |
| 57 | amf-7d6f649b4f-jzd9r 1/1 Running 0 41s |
| 58 | ausf-8dd5d7465-xrjdl 1/1 Running 0 41s |
| 59 | gnbsim-0 1/1 Running 0 25s |
| 60 | mongodb-55555bc884-wqcrh 1/1 Running 0 41s |
| 61 | nrf-ddd7d8d5b-vjv84 1/1 Running 0 41s |
| 62 | nssf-7978bb74cc-zct9v 1/1 Running 0 41s |
| 63 | pcf-5bbbff96d6-l54f6 1/1 Running 0 41s |
| 64 | smf-86b6fd5674-tq8h9 1/1 Running 0 41s |
| 65 | udm-5fdf9cf56d-76hlt 1/1 Running 0 41s |
| 66 | udr-d8f855c6b-jj8lw 1/1 Running 0 41s |
| 67 | ue-setup-if-mftrm 0/1 Completed 0 23d |
| 68 | ue-teardown-if-whbvm 0/1 Completed 0 23d |
| 69 | upf-0 4/4 Running 0 55s |
| 70 | webui-79c8b7dfc7-wn6st 1/1 Running 0 41s |
| 71 | |
| 72 | Developer Loop |
| 73 | -------------- |
| 74 | |
| 75 | Deploy custom images by editing `~/aether-in-a-box/aether-in-a-box-values.yaml`:: |
| 76 | |
| 77 | images: |
| 78 | tags: |
| 79 | webui: registry.aetherproject.org/omecproject/5gc-webui:onf-release3.0.5-roc-935305f |
| 80 | pullPolicy: IfNotPresent |
| 81 | pullSecrets: |
| 82 | - name: "aether.registry" |
| 83 | |
| 84 | Stop the 5G Core and start it again:: |
| 85 | |
| 86 | make reset-5g-test |
| 87 | make 5gc |