1 ## RANPM project in docker
3 A docker compose project showing pm file flow from simulated network elements to filtered pm data.
5 ## Run in docker-desktop - docker only
7 ### Clone the ranpm repo:
9 `git clone https://gerrit.nordix.org/local/oransc/ranpm`
11 ### Build Https server
13 `cd ranpm/https-server`
20 WARNING: The setup scripts below will prune all unused docker volumes!
22 INFO: Temporary files for some containers will be stored in subdirs under `/tmp`
24 `cd ranpm/docker-proj`
26 There are several ways to start and run the demo, with file or minio file storage, single or multi instances of data-file collector and kafka as well as a choice of sftp, ftpes or https.
27 Additional configuration can be made in the setup script.
29 It could be a good idea to clean any other running containers in docker to avoid port and container name clashes.
31 Command usage: `docker-setup.sh`
37 Let the script finish.
39 If the script fails, make sure to clean the setup before attempting a new setup.
41 `./docker-tear-down.sh`
43 In addition, a `docker system prune` might be needed now and then.
45 ### Tools for monitoring
47 Open browser to redpanda (kafka gui) - watch topics, messages etc\
48 browser: `localhost:8780`
50 Open brower to minio - available only if minio is given on the cmd line when starting the demo\
51 user: admin pwd: adminadmin\
52 browser: `localhost:9001`
57 File ready events can be pushed to the ves collector or pushed directly to the topic for file ready events (bypassing the ves collector).
59 Push to ves collector:
61 Usage: `push-to-ves-collector.sh <node-count> <num-of-events> <node-name-base> <file-extension> <num-servers>`
64 node-count - number of unique NEs\
65 num-of-events - number of events per NE\
66 node-name-base - NE name prefix\
67 file-extension - xml or xml.gz
68 num-servers - number of sftp/ftpes/https servers to simulate NEs (10 is default)
70 Usage: `push-to-file-ready-topic.sh <node-count> <num-of-events> <node-name-base> <file-extension> <num-servers>`
73 Same as `push-to-ves-collector.sh`
75 Once the events has been pushed the progress can be viewed in the monitoring tools described above.
77 If several sets of data shall be pushed, just change the parameter `<node-name-base>` to make the new files unique.
82 Run the script to remove all docker containers.
84 `./docker-tear-down.sh`
86 To also cleanup files.
88 `cd pm-file-flow-demo/scripts`
90 `./clean-shared-volume.sh`