...
CONTAINER_NAME, name of the container, default value is akraino-validation-mysql
MYSQL_ROOT_PASSWORD, the desired mysql root user password, this variable is required
MYSQL_USER, the mysql user, the default value is 'akraino'
MYSQL_PASSWORD, the desired mysql user password, this variable is required
REGISTRY, registry of the mysql image, default value is akraino
NAME, name of the mysql image, default value is validation
TAG_PRE, first part of the image version, default value is mysql
TAG_VER, last part of the image version, default value is latestMYSQL_HOST_PORT, port on which mysql is exposed on host, default value is 3307
In order to build and deploy the image using only the required parameters, the below instructions should be followed:
The mysql root password , and the mysql akraino user password (currently the UI connects to the database using the akraino user) , the UI admin password and the UI akraino password should be configured using the appropriate variables and the following commands should be executed (the user should override default variables based on requirements):
~$ cd validation/ui
~$ mvn docker:build -Ddocker.filter=akraino/validation:dev-mysql-latest
~$ cd ../docker/mysql
~$ ./deploy.sh --TAG_PRE dev-mysql --MYSQL_ROOT_PASSWORD <mysql root user password> --MYSQL_PASSWORD <mysql akraino user password>
~$ mysql -p<MYSQL_AKRAINO_PASSWORD> -uakraino -h <IP of the mysql container> < ../../ui/db-scripts/examples/initialize_db_example.sql
...
CONTAINER_NAME, the name of the container, default value is akraino-validation-mysql
REGISTRY, the registry of the mysql image, default value is akraino
NAME, the name of the mysql image, default value is validation
TAG_PRE, the first part of the image version, default value is mysql
TAG_VER, the last part of the image version, default value is latest
MYSQL_HOST_PORT, the port on which mysql is exposed on host, default value is 3307
In order to deploy the image using only the required parameters and the existing persistent storage, the below instructions should be followed:
The mysql root user password (currently the UI connects to the database using root privileges) should be configured using the appropriate variable should be configured using the appropriate variable and the following commands should be executed (the user should override the default variables based on the requirements):
~$ cd validation/docker/mysql~$ ./deploy_with_existing_persistent_storage.sh TAG_PRE=dev-mysql
...
To this end, after the image build process, the following commands should be executed (the user should override the default variables based on the requirements):
~$ docker volume rm akraino-validation-mysql
~$ cd validation/docker/mysql
~$ ./deploy.sh --TAG_PRE dev-mysql --MYSQL_ROOT_PASSWORD <root user password> --MYSQL_PASSWORD <mysql akraino user password>
~$ mysql -p<MYSQL_AKRAINO_PASSWORD> -uakraino -h <IP of the mysql container> < ../../ui/db-scripts/examples/initialize_db_example.sql
In the context of the full control loop mode, the following tables must be initialized with appropriate data:
- lab (here, every lab owner should store the name of the lab and the silo used for storing results in Nexus)
- timeslot (here, every lab owner should register the available timeslots that can be used for blueprint validation test execution)
- blueprint_layer (here, all the blueprint layers should be registered. These layers will be referenced by the blueprint instances)
- blueprint (here, every blueprint owner should register the name of the blueprint)
- blueprint_instance_for_validation (here, every blueprint owner should register the blueprint instances for validation, i.e. version and layer)
- blueprint_instance_blueprint_layer (here, the many-to-many relationship between blueprint instances and layers is formulated)
- blueprint_instance_timeslot (here, the many-to-many relationship between blueprint instances and timeslots is formulated)
...
CONTAINER_NAME, the name of the container, default value is akraino-validation-ui
DB_IP_PORT, the IP and port of the mysql instance, this variable is required
MYSQL_USER, the mysql user, the default value is 'akraino'
MYSQL_PASSWORD, the mysql user password, this variable is required
REGISTRY, the registry of the ui image, default value is akraino
NAME, the name of the ui image, default value is validation
TAG_PRE, the first part of the image version, default value is ui
TAG_VER, the last part of the image version, default value is latest
JENKINS_URL, the URL of the Jenkins instance (http or https must be defined), the default value is 'https://jenkins.akraino.org/'
JENKINS_USERNAME, the Jenkins user name, the default value is 'demo' (in the context of UI full control loop mode, this parameter must be changed to include a real Jenkins user)
JENKINS_USER_PASSWORD, the Jenkins user password, the default value is 'demo' (in the context of UI full control loop mode, this parameter must be changed to include a real Jenkins user password)
JENKINS_JOB_NAME, the name of Jenkins job capable of executing the blueprint validation tests, the default value is 'validation' (in the context of UI full control loop mode, this parameter must be changed to include a real Jenkins job name)
NEXUS_PROXY, the needed proxy in order for the Nexus server to be reachable, default value is none
JENKINS_PROXY, the needed proxy in order for the Jenkins server to be reachable, default value is none
CERTDIR, the directory where the SSL certificates can be found, default value is the working directory where self signed certificates exist only for demo purposes
ENCRYPTION_KEY, the key that should be used by the AES algorithm for encrypting passwords stored in database, this variable is required
UI_ADMIN_PASSWORD, the desired Blueprint Validation UI password for the admin user, this variable is required
TRUST_ALL, the variable that defines whether the UI should trust all certificates or not, default value is false
USE_NETWORK_HOST, the variable that defines whether the UI container should run in 'network host' mode or not, default value is "false"
So, for a functional UI, the following prerequisites are needed:
...
More users can be created using the 'Create User' tab of the UI. This tab is available only for the admin user.
The If the content of the 'USE_NETWORK_HOST' is equal to true (in this case, the ports 8443 and 443 must be available on the host), the UI should be available in the following url:
https://<IP of
...
the host>
Else, the UI should be available in the following url:
https://<IP of the UI container>
...
As far as the SSL certificates are concerned, self-signed built-in certificates exist in the 'validation/docker/ui' directory which are used by default. It should be noted that these
certificates should be used only for demo purposes. If a user wants to use different ones which are more appropriate for a production environment, the directory that contains these new
certificates must be defined using the 'CERTDIR' parameter of the 'validation/docker/ui/deploy.sh' script. It should be noted that the certificates must have specific names, that are 'bluval.crt'
and 'bluval.key' for the certificate and the key respectively.
...