X-Git-Url: https://gerrit.akraino.org/r/gitweb?p=validation.git;a=blobdiff_plain;f=docker%2FREADME.rst;h=4694cdef87bb750aeee30b4c7b8de71d365bc8db;hp=97d1e39c4c6a013a111c1ff007e1e0f7b0966323;hb=dda7dca2c875008b67a5af805912ffc8966ad343;hpb=ee71f948a177b2f57518f2b209c2d1ca62c4fc48 diff --git a/docker/README.rst b/docker/README.rst index 97d1e39..4694cde 100644 --- a/docker/README.rst +++ b/docker/README.rst @@ -76,9 +76,8 @@ stored on the local server. By default, the container will run the k8s conformance test. If you want to enter the container, add */bin/sh* at the end of the command above - -The postgresql container -======================== +The mariadb container +===================== Building and pushing the container ---------------------------------- @@ -87,25 +86,59 @@ To build just the postgresql container, use the command: .. code-block:: console - make postgresql-build [ REGISTRY= NAME=] + make mariadb-build [ REGISTRY= NAME=] To both build and push the container, use the command: .. code-block:: console - make postgresql [ REGISTRY= NAME=] + make mariadb [ REGISTRY= NAME=] 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: -If you want to deploy the container, you can run the corresponding deploy.sh script with the appropriate parameters. +CONTAINER_NAME, name of the container, default value is akraino-validation-mariadb +MARIADB_ROOT_PASSWORD, the desired mariadb root user password, this variable is required +UI_ADMIN_PASSWORD, the desired Blueprint Validation UI password for the admin user, this variable is required +UI_AKRAINO_PASSWORD, the desired Blueprint Validation UI password for the akraino user, 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 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 -Example: +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.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 - ./deploy.sh POSTGRES_PASSWORD=password + 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 ================ @@ -113,8 +146,7 @@ The ui container Building and pushing the container ---------------------------------- -To build just the ui container, you must first compile the ui project. -Then use the command: +To build just the UI container, use the command: .. code-block:: console @@ -128,15 +160,38 @@ To both build and push the container, use the command: 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: -If you want to deploy the container, you can run the corresponding deploy.sh script with the appropriate parameters. -Note, that you must also build and run the postgresql container for a functional 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, 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 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 -Example: +Note that, for a functional UI, the following prerequisites are needed: + +- The mariadb container in up and running state +- A Jenkins instance capable of running the blueprint validation test +- A Nexus repo in which all the test results are stored. + +More info can be found at the UI README file. + +In order to deploy the container, the aforementioned 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 - ./deploy.sh postgres_db_user_pwd=password jenkins_url=http://192.168.2.2:8080 jenkins_user_name=name jenkins_user_pwd=jenkins_pwd jenkins_job_name=job1 nexus_results_url=https://nexus.akraino.org/content/sites/logs proxy_ip=172.28.40.9 proxy_port=3128 + 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 ============================== @@ -173,7 +228,7 @@ Example: .. code-block:: console - docker run -ti akraino/validation:kube-conformance-v1.11 + docker run -ti akraino/validation:kube-conformance-v1.15 By default, the container will run the `run_e2e.sh` script. If you want to enter the container, add */bin/sh* at the end of the command above