1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2020 CommScope Inc
5 TR-069 Adapter Deployment and Configuration
6 ===========================================
8 This section lists the required steps to deploy and install the TR-069Adapter in Kubernetes environment.
10 Note: Before deploying and installing the TR-069Adapter, ensure the required third-party software such as Kubernetes, Docker, and Helm softwares are installed.
12 1. Push all TR-069Adapter Docker image files to the central repository.
14 2. Edit the values.yaml file to update the following parameters.
16 +------------------+----------------------+------------------------------------------------------------+
17 |**Parameter** |**Default Value** |**Description** |
19 +==================+======================+============================================================+
20 |mountPath |/dockerdata-nfs |Persisted Volume Mount point on the worker |
22 +------------------+----------------------+------------------------------------------------------------+
23 |macID |0005B9AAAAA3 |Mac ID of the Device |
25 +------------------+----------------------+------------------------------------------------------------+
26 |dbRootPassword |root |MariaDB root user password that needs to be |
28 +------------------+----------------------+------------------------------------------------------------+
29 |preConfigOnPNP |false |Set it to True if TR-069Adapter has to provision initial |
30 | | |set of parameters as part of BootStrap.If this parameter |
31 | | |is set to true, then TR-069Adapter shall provision the |
32 | | |configurations as part of BootStrap and sets Admin |
33 | | |Status to true. In case of boot, TR-069Adapter shall set |
34 | | |Admin Status to true.Allowed values: true/false |
36 +------------------+----------------------+------------------------------------------------------------+
37 |repository |repo.com:5100 |Domain name and port to access the central repository where |
38 | | |TR-069Adapter docker images are uploaded. |
39 +------------------+----------------------+------------------------------------------------------------+
40 |pullSecret |dockerhub.com |Secret key or password to login to central repository. |
42 +------------------+----------------------+------------------------------------------------------------+
43 |onapFaultVes |10.211.5.27 |VES collector IP Address for sending device fault events. |
45 +------------------+----------------------+------------------------------------------------------------+
46 |onapFaultVesCo |30235 |VES collector IP Port for sending device fault events. |
47 |llectorPort | |must be configured. |
49 +------------------+----------------------+------------------------------------------------------------+
50 |onapPnfRegVes |10.211.5.27 |VES collector IP Address for sending pnfRegistration events.|
52 +------------------+----------------------+------------------------------------------------------------+
53 |onapPnfRegVes |30235 |VES collector IP Address for sending pnfRegistration events.|
55 +------------------+----------------------+------------------------------------------------------------+
56 |type | |Cluster IP or node port details to register |
58 +------------------+----------------------+------------------------------------------------------------+
59 |portName |srv-netconf |Service name required to open the ports |
61 +------------------+----------------------+------------------------------------------------------------+
62 |internalPort |17830 |Starting internal port number |
64 +------------------+----------------------+------------------------------------------------------------+
65 |externalPort |105 |Last 3 digits of the starting external port |
67 +------------------+----------------------+------------------------------------------------------------+
68 |portRange |10 |Number of ports to open. Each TR-069 Device that the adapter|
69 | | |manages it needs dedicated port for NetConf Server. In this |
70 | | |release maximum 200 devices could be connected to a single |
71 | | |Adapter hence Maximum 200 ports are supported. |
73 +------------------+----------------------+------------------------------------------------------------+
76 3. Execute the following command to install the TR-069Adapter
78 ``# helm install tr069adapter --name=<Deployment_Name>``
80 For example: # helm install tr069adapter --name=AdapterDevices1To200
82 4. Execute the following command to check if the TR-069Adapter is successfully installed:
84 ``# helm history <Deployment_Name>``
86 For example: # helm history AdapterDevices1To200
88 5. Execute the following command to check if all the clusters are running