Fix Sonobuoy systemd-image for k8 1.18
[validation.git] / docker / README.rst
index 17e84ba..74cd787 100644 (file)
@@ -76,36 +76,36 @@ 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 mariadb container
+The mysql container
 =====================
 
 Building and pushing the container
 ----------------------------------
 
-To build just the mariadb container, use the command:
+To build just the mysql container, use the command:
 
 .. code-block:: console
 
-   make mariadb-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
+   make mysql-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 
 To both build and push the container, use the command:
 
 .. code-block:: console
 
-   make mariadb [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
+   make mysql [ REGISTRY=<dockerhub_registry> NAME=<image_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:
 
-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
-MARIADB_AKRAINO_PASSWORD, the desired mariadb akraino 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 mariadb
+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 desired 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 latest
-MARIADB_HOST_PORT, 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.
 
@@ -113,19 +113,18 @@ Example (assuming the default variables have been utilized for building the imag
 
 .. code-block:: console
 
-    cd validation/docker/mariadb
-    ./deploy.sh MARIADB_ROOT_PASSWORD=root_password MARIADB_AKRAINO_PASSWORD=akraino_password
+    cd validation/docker/mysql
+    ./deploy.sh --MYSQL_ROOT_PASSWORD root_password --MYSQL_PASSWORD akraino_password
 
-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.
+Also, in order to re-deploy the database (it is assumed that the corresponding mysql container has been stopped and deleted) while the persistent storage already exists (currently, the 'akraino-validation-mysql' docker volume is used), a different approach should be used after the image building 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
-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
+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
-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.
 
@@ -133,7 +132,7 @@ Example (assuming the default variables have been utilized for building the imag
 
 .. code-block:: console
 
-    cd validation/docker/mariadb
+    cd validation/docker/mysql
     ./deploy_with_existing_persistent_storage.sh
 
 More info can be found at the UI README file.
@@ -161,10 +160,11 @@ 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, the name of the contaner, default value is akraino-validation-ui
-DB_IP_PORT, the IP and port of the maridb instance, this variable is required
-MARIADB_AKRAINO_PASSWORD, the mariadb akraino 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
+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 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 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/'
@@ -176,11 +176,12 @@ JENKINS_PROXY, the needed proxy in order for the Jenkins server to be reachable,
 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
-UI_AKRAINO_PASSWORD, the desired Blueprint Validation UI password for the akraino 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"
 
 Note that, for a functional UI, the following prerequisites are needed:
 
-- The mariadb container in up and running state
+- The mysql container in up and running state
 - A Jenkins instance capable of running the blueprint validation test (this is optional and is needed only for UI full control loop mode)
 - A Nexus repo in which all the test results are stored.
 
@@ -193,89 +194,24 @@ Example (assuming the default variables have been utilized for building the imag
 .. code-block:: console
 
     cd validation/docker/ui
-    ./deploy.sh DB_IP_PORT=172.17.0.3:3306 MARIADB_AKRAINO_PASSWORD=akraino_password ENCRYPTION_KEY=AGADdG4D04BKm2IxIWEr8o== UI_ADMIN_PASSWORD=admin UI_AKRAINO_PASSWORD=akraino
+    ./deploy.sh --DB_IP_PORT 172.17.0.3:3306 --MYSQL_PASSWORD akraino_password --ENCRYPTION_KEY AGADdG4D04BKm2IxIWEr8o== --UI_ADMIN_PASSWORD admin
 
 The kube-conformance container
 ==============================
 
-Building and pushing the container
-----------------------------------
-
-To build just the kube-conformance container, use the command:
-
-.. code-block:: console
-
-    make kube-conformance-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
-
-To both build and push the container, use the command:
-
-.. code-block:: console
-
-    make kube-conformance [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
+The current kube-conformance image used is being pulled from k8s.gcr.io
+based on the kubernetes version the cluster is running on.
 
-Using the container
--------------------
-
-This is a standalone container able to launch Kubernetes end-to-end tests,
-for the purposes of conformance testing.
-
-It is a thin wrapper around the `e2e.test` binary in the upstream Kubernetes
-distribution, which drops results in a predetermined location for use as a
-[Heptio Sonobuoy](https://github.com/heptio/sonobuoy) plugin.
-
-To learn more about conformance testing and its Sonobuoy integration, read the
-[conformance guide](https://github.com/heptio/sonobuoy/blob/master/docs/conformance-testing.md).
-
-Example:
-
-.. code-block:: console
-
-    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
-
-Normally, this conainer is not used directly, but instead leveraged via
-sonobuoy.
+For more information refer to https://sonobuoy.io/docs/v0.50.0/
 
 The sonobuoy-plugin-systemd-logs container
 ==========================================
 
-Building and pushing the container
-----------------------------------
-
-To build just the sonobuoy-plugin-systemd-logs container, use the command:
-
-.. code-block:: console
-
-    make sonobuoy-plugin-systemd-logs-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
-
-To both build and push the container, use the command:
-
-.. code-block:: console
-
-    make sonobuoy-plugin-systemd-logs [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
-
-Using the container
--------------------
-
-This is a simple standalone container that gathers log information from
-systemd, by chrooting into the node's filesystem and running `journalctl`.
-
-This container is used by [Heptio Sonobuoy](https://github.com/heptio/sonobuoy)
-for gathering host logs in a Kubernetes cluster.
-
-Example:
-
-.. code-block:: console
-
-    docker run -ti akraino/validation:sonobuoy-plugin-systemd-logs-latest
+The current sonobuoy-plugin-systemd-logs image used is being pulled from
+gcr.io/heptio-images repo with latest tag.
 
-By default, the container will run the `get_systemd_logs.sh` script. If you
-want to enter the container, add */bin/sh* at the end of the command above.
+For more information refer to https://sonobuoy.io/docs/v0.50.0/
 
-Normally, this conainer is not used directly, but instead leveraged via
-sonobuoy.
 
 The openstack container
 =======================