Code Review / validation.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Fix Sonobuoy systemd-image for k8 1.18
[validation.git] / docker / README.rst
diff --git a/docker/README.rst b/docker/README.rst
index 1708db1..74cd787 100644 (file)
--- a/docker/README.rst
+++ b/docker/README.rst
@@ -106,7 +106,6 @@ 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
 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
-MYSQL_HOST_PORT, port on which mysql is exposed on host, default value is 3307
 
 In order to deploy the container, this script can be executed with the appropriate parameters.
 
 
 In order to deploy the container, this script can be executed with the appropriate parameters.
 
@@ -126,7 +125,6 @@ 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
 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 container, this script can be executed with the appropriate parameters.
 
 
 In order to deploy the container, this script can be executed with the appropriate parameters.
 
@@ -179,6 +177,7 @@ CERTDIR, the directory where the SSL certificates can be found, default value is
 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
 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:
 
 
 Note that, for a functional UI, the following prerequisites are needed:
 
@@ -200,84 +199,19 @@ Example (assuming the default variables have been utilized for building the imag
 The kube-conformance container
 ==============================
 
 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.16
-
-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
 ==========================================
 
 
 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
 =======================
 
 The openstack container
 =======================