X-Git-Url: https://gerrit.akraino.org/r/gitweb?p=validation.git;a=blobdiff_plain;f=docker%2FREADME.rst;h=12c75becb58af9ff13ef576938f4d5c5ea4b921d;hp=5da728841e8d8ab117429206c08c1fd43fb18a68;hb=b39e27ede8238ef63440810a8327b927c4c43ac0;hpb=088e841f4b5e1aba5469720033072e36c9679419 diff --git a/docker/README.rst b/docker/README.rst index 5da7288..12c75be 100644 --- a/docker/README.rst +++ b/docker/README.rst @@ -108,14 +108,38 @@ TAG_PRE, first part of the image version, default value is mariadb TAG_VER, last part of the image version, default value is latest MARIADB_HOST_PORT, port on which mariadb is exposed on host, default value is 3307 -If you want to deploy the container, you can run this script with the appropriate parameters. +In order to deploy the container, this script can be executed with the appropriate parameters. -Example (assuming you have used the default variables for building the image using the make command): +Example (assuming the default variables have been utilized for building the image using the make command): .. code-block:: console + cd validation/docker/mariadb ./deploy.sh MARIADB_ROOT_PASSWORD=password UI_ADMIN_PASSWORD=admin UI_AKRAINO_PASSWORD=akraino +Also, in order to re-deploy the database (it is assumed that the corresponding mariadb container has been stopped and deleted) while the persistent storage already exists (currently, the directory /var/lib/mariadb of the host is used), a different approach should be used after the image build process. + +To this end, another script has been developed, namely deploy_with_existing_storage.sh which easily deploys the container. This script accepts the following items as input parameters: + +CONTAINER_NAME, the name of the container, default value is akraino-validation-mariadb +MARIADB_ROOT_PASSWORD, the desired mariadb root user password, this variable is required +REGISTRY, the registry of the mariadb image, default value is akraino +NAME, the name of the mariadb image, default value is validation +TAG_PRE, the first part of the image version, default value is mariadb +TAG_VER, the last part of the image version, default value is latest +MARIADB_HOST_PORT, the port on which mariadb is exposed on host, default value is 3307 + +In order to deploy the container, this script can be executed with the appropriate parameters. + +Example (assuming the default variables have been utilized for building the image using the make command): + +.. code-block:: console + + cd validation/docker/mariadb + ./deploy_with_existing_persistent_storage.sh MARIADB_ROOT_PASSWORD=password + +More info can be found at the UI README file. + The ui container ================ @@ -138,19 +162,19 @@ Using the container ------------------- In order for the container to be easily created, the deploy.sh script has been developed. This script accepts the following as input parameters: -CONTAINER_NAME, name of the contaner, default value is akraino-validation-ui +CONTAINER_NAME, the name of the contaner, default value is akraino-validation-ui DB_CONNECTION_URL, the URL connection with the akraino database of the maridb instance, this variable is required -MARIADB_ROOT_PASSWORD, mariadb root user password, this variable is required -REGISTRY, registry of the mariadb image, default value is akraino -NAME, name of the mariadb image, default value is validation -TAG_PRE, first part of the image version, default value is ui -TAG_VER, last part of the image version, default value is latest +MARIADB_ROOT_PASSWORD, the mariadb root user password, this variable is required +REGISTRY, the registry of the mariadb image, default value is akraino +NAME, the name of the mariadb 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, this variable is required JENKINS_USERNAME, the Jenkins user name, this variable is required JENKINS_USER_PASSWORD, the Jenkins user password, this variable is required JENKINS_JOB_NAME, the name of Jenkins job capable of executing the blueprint validation tests, this variable is required -NEXUS_PROXY, the proxy needed in order for the Nexus server to be reachable, default value is none -JENKINS_PROXY, the proxy needed in order for the Jenkins server to be reachable, default value is none +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 Note that, for a functional UI, the following prerequisites are needed: @@ -158,14 +182,15 @@ Note that, for a functional UI, the following prerequisites are needed: - A Jenkins instance capable of running the blueprint validation test - A Nexus repo in which all the test results are stored. -Look at the UI README file for more info. +More info can be found at the UI README file. -If you want to deploy the container, you can run the aforementioned script with the appropriate parameters. +In order to deploy the container, the aforementioned script can be executed with the appropriate parameters. -Example (assuming you have used the default variables for building the image using the make command): +Example (assuming the default variables have been utilized for building the image using the make command): .. code-block:: console + cd validation/docker/ui ./deploy.sh DB_CONNECTION_URL=172.17.0.3:3306/akraino MARIADB_ROOT_PASSWORD=password JENKINS_URL=http://192.168.2.2:8080 JENKINS_USERNAME=name JENKINS_USER_PASSWORD=jenkins_pwd JENKINS_JOB_NAME=job1 The kube-conformance container