.. code-block:: console
docker run -ti -v /home/jenkins/k8s_access:/root/.kube/ \
- -v /home/jenkins/k8s_results:/opt/akraino/validation/results/ \
+ -v /home/jenkins/k8s_results:/opt/akraino/results/ \
akraino/validation:k8s-latest
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 postgresql 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
-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
+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
-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 the default variables have been utilized for building the image using the make command):
+
+.. code-block:: console
+
+ 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 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-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
-Example (assuming you have used the default variables for building the image using the make command):
+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 MARIADB_ROOT_PASSWORD=password UI_ADMIN_PASSWORD=admin UI_AKRAINO_PASSWORD=akraino
+ cd validation/docker/mysql
+ ./deploy_with_existing_persistent_storage.sh
+
+More info can be found at the UI README file.
The ui 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
-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
-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
+CONTAINER_NAME, the name of the contaner, 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 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/'
+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"
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
+- 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.
-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
- ./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
+ cd validation/docker/ui
+ ./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
==============================
+The current kube-conformance image used is being pulled from k8s.gcr.io
+based on the kubernetes version the cluster is running on.
+
+For more information refer to https://sonobuoy.io/docs/v0.50.0/
+
+The sonobuoy-plugin-systemd-logs container
+==========================================
+
+The current sonobuoy-plugin-systemd-logs image used is being pulled from
+gcr.io/heptio-images repo with latest tag.
+
+For more information refer to https://sonobuoy.io/docs/v0.50.0/
+
+
+The openstack container
+=======================
+
Building and pushing the container
----------------------------------
-To build just the kube-conformance container, use the command:
+To build just the openstack container, use the command:
.. code-block:: console
- make kube-conformance-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
+ make openstack-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>]
+ make openstack [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
Using the container
-------------------
-This is a standalone container able to launch Kubernetes end-to-end tests,
-for the purposes of conformance testing.
+The openstack image is meant to be ran from a server that has access to the
+openstack deployment (jenkins slave, jumpserver, etc).
-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.
+Before running the image, copy openstack deployment environment variables
+(openrc) to a local folder (e.g. /root/openrc).
-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).
+Container needs to be started with the openrc file mounted. Optionally, test
+cases can be excluded from execution via a mounted blacklist file.
-Example:
+The results folder can be mounted as well; this way the logs are
+stored on the local server.
.. code-block:: console
- docker run -ti akraino/validation:kube-conformance-v1.11
-
-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
+ docker run -ti -v /home/jenkins/openrc:/root/openrc \
+ -v /home/jenkins/blacklist.txt:/opt/akraino/validation/tests/openstack/tempest/blacklist.txt \
+ -v /home/jenkins/openstack_results:/opt/akraino/results/ \
+ akraino/validation:openstack-latest
-Normally, this conainer is not used directly, but instead leveraged via
-sonobuoy.
-
-The sonobuoy-plugin-systemd-logs container
-==========================================
+The helm container
+==================
Building and pushing the container
----------------------------------
-To build just the sonobuoy-plugin-systemd-logs container, use the command:
+To build just the helm container, use the command:
.. code-block:: console
- make sonobuoy-plugin-systemd-logs-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
+ make helm-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>]
+ make helm [ 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.
+Container needs to be started with the SSH key file mounted. Users
+credentials can be provided via a mounted variables.yaml file.
-Example:
+The results folder can be mounted as well; this way the logs are
+stored on the local server.
.. code-block:: console
- docker run -ti akraino/validation:sonobuoy-plugin-systemd-logs-latest
-
-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.
-
-Normally, this conainer is not used directly, but instead leveraged via
-sonobuoy.
+ docker run -ti -v /home/jenkins/openrc:/root/openrc \
+ -v /home/foobar/.ssh/id_rsa:/root/.ssh/id_rsa \
+ -v /home/foobar/variables.yaml:/opt/akraino/validation/tests/variables.yaml \
+ -v /home/foobar/helm_results:/opt/akraino/results/ \
+ akraino/validation:helm-latest
Code Review / validation.git / blobdiff