-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-..
-.. Copyright (C) 2019 AT&T Intellectual Property
-
-
-Developer-Guide
-===============
-
-.. contents::
- :depth: 3
- :local:
-
-.. note:
-.. * This section is used to describe what a contributor needs to know in order to work on the componenta
-
-.. * this should be very technical, aimed at people who want to help develop the components
-
-.. * this should be how the component does what it does, not a requirements document of what the component should do
-
-.. * this should contain what language(s) and frameworks are used, with versions
-
-.. * this should contain how to obtain the code, where to look at work items (Jira tickets), how to get started developing
-
-.. * This note must be removed after content has been added.
-
-
-Processes
----------
-
-
-
-Actions
--------
-
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+..\r
+.. Copyright (C) 2019 AT&T Intellectual Property\r
+\r
+\r
+Developer-Guide\r
+===============\r
+\r
+.. contents::\r
+ :depth: 3\r
+ :local:\r
+\r
+.. note:\r
+.. * This section is used to describe what a contributor needs to know in order to work on the componenta\r
+\r
+.. * this should be very technical, aimed at people who want to help develop the components\r
+\r
+.. * this should be how the component does what it does, not a requirements document of what the component should do\r
+\r
+.. * this should contain what language(s) and frameworks are used, with versions\r
+\r
+.. * this should contain how to obtain the code, where to look at work items (Jira tickets), how to get started developing\r
+\r
+.. * This note must be removed after content has been added.\r
+\r
+Deployment\r
+----------\r
+\r
+OTF Frontend\r
+^^^^^^^^^^^^\r
+1) docker build -t otf-frontend:0.0.1-SNAPSHOT .\r
+2) docker run -d --network="host" otf-frontend:0.0.1-SNAPSHOT\r
+\r
+OTF SERVICE API\r
+^^^^^^^^^^^^^^^^\r
+1) Modify src/main/resources/application.properties according to needs (disable aaf/ssl, set ports)\r
+2) navigate to otf-service-api folder and run "docker build -t otf-service-api:0.0.1-SNAPSHOT -f docker/Dockerfile ." (maven will run from inside the container, command is inside the Dockerfile)\r
+3) docker run -d --network="host" otf-service-api:0.0.1-SNAPSHOT\r
+\r
+OTF CAMUNDA\r
+^^^^^^^^^^^^\r
+1) Modify src/main/resources/application.yaml according to needs, and validate the yaml is correct format (disable aaf/ssl, set ports)\r
+2) navigate to otf-camunda folder and run "docker build -t otf-camunda:0.0.1-SNAPSHOT -f docker/Dockerfile ." (maven will run from inside the container, command is inside the Dockerfile)\r
+3) docker run -d --network="host" otf-camunda:0.0.1-SNAPSHOT\r
+\r
+Virtual Test Head (VTH)\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+VTH can be deployed in many ways. The following is a simple example of running vths via docker and using it on OTF UI.\r
+\r
+ - Sample vth deployment example\r
+ 1) docker build -t [VTH_NAME] .\r
+ 2) docker run --rm --network [NETWORK-NAME] --name [VTH-NAME] -dit [DOCKER_IMAGE_NAME]\r
+ 3) use url and port to onboard it via OTF UI (instructions can be found in user guide)\r
+\r
+To update vth port, you will have to update its python file (App.py). Most of them will default to port 5000.\r
+\r
+OTF-DATABASE\r
+-------------\r
+\r
+1) run sudo installdbs.sh and export PATH=/usr/local/mysql/bin:$PATH to add mysql commands to path\r
+2) run sudo createMongoUser.sh\r
+3) edit mongo to create a replica set by modifying replication and net fields on file /etc/mongod.conf\r
+ - add security: authorization: 'enabled'\r
+4) after script is ran mysql should be able to be used, connect to mysql using the password set by script and mysql command and\r
+ - alter the root password\r
+ - alter user 'root'@'localhost' identified by 'new_password'\r
+ - grant root ability to connect remotely\r
+ - grant all on *.* to 'root'@'%' identified by 'password'\r
+ - create db and exit mysql shell\r
+ - create database 'new_db'\r
+ - create tables using mysql scripts\r
+ - mysql -u root -p db < engine.sql\r
+\r
+Common issues\r
+--------------\r
+Unable to log in to OTF UI as the first user on the platform\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+When registering as a new user, you will eventually need an admin to "enable" you. If you are the first User,\r
+there will be no admin and you will be unable to log in even after you register. In order to fix this, you will have to\r
+manually go into the mongo database and alter certain attributes for this new user.\r
+\r
+.. image:: images/mongo-user.PNG\r
+\r
+- make sure enabled is set to true\r
+- on the permission section, change role from user to admin\r
+\r
+\r
+Processes\r
+---------\r
+\r
+\r
+\r
+Actions\r
+-------\r
+\r
Code Review / it / otf.git / blobdiff