docker/README.rst

   1 .. ############################################################################
   2 .. Copyright (c) 2019 AT&T, ENEA AB, Nokia and others                         #
   3 ..                                                                            #
   4 .. Licensed under the Apache License, Version 2.0 (the "License");            #
   5 .. you maynot use this file except in compliance with the License.            #
   6 ..                                                                            #
   7 .. You may obtain a copy of the License at                                    #
   8 ..       http://www.apache.org/licenses/LICENSE-2.0                           #
   9 ..                                                                            #
  10 .. Unless required by applicable law or agreed to in writing, software        #
  11 .. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT  #
  12 .. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.           #
  13 .. See the License for the specific language governing permissions and        #
  14 .. limitations under the License.                                             #
  15 .. ############################################################################
  16
  17
  18 Overview
  19 ========
  20
  21 The Makefile in this directory is used to build and push all
  22 the validation containers. The default registry is **akraino** on
  23 dockerhub, but only CI jenkins slaves are authorized to push
  24 images to that registry. If you want to push to your own test registry, set
  25 the REGISTRY variables as in the commands below.
  26
  27 To build and push the images:
  28
  29 .. code-block:: console
  30
  31     make all [ REGISTRY=<dockerhub_registry> ]
  32
  33 To just build the containers, use the command:
  34
  35 .. code-block:: console
  36
  37     make build-all [ REGISTRY=<dockerhub_registry> ]
  38
  39 The k8s container
  40 =================
  41
  42 Building and pushing the container
  43 ----------------------------------
  44
  45 To build just the k8s container, use the command:
  46
  47 .. code-block:: console
  48
  49     make k8s-build [ REGISTRY=<dockerhub_registry> ]
  50
  51 To both build and push the container, use the command:
  52
  53 .. code-block:: console
  54
  55     make k8s [ REGISTRY=<dockerhub_registry> ]
  56
  57 Using the container
  58 -------------------
  59
  60 The k8s image is meant to be ran from a server that has access to the
  61 kubernetes cluster (jenkins slave, jumpserver, etc).
  62
  63 Before running the image, copy the folder ~/.kube from your kubernetes
  64 master node to a local folder (e.g. /home/jenkins/k8s_access).
  65
  66 Container needs to be started with the kubernetes access folder mounted.
  67 Optionally, the results folder can be mounted as well; this way the logs are
  68 stored on the local server.
  69
  70 .. code-block:: console
  71
  72     docker run -ti -v /home/jenkins/k8s_access:/root/.kube/ \
  73     -v /home/jenkins/k8s_results:/opt/akraino/results/ \
  74     akraino/validation:k8s-latest
  75
  76 By default, the container will run the k8s conformance test. If you want to
  77 enter the container, add */bin/sh* at the end of the command above
  78
  79 The mysql container
  80 =====================
  81
  82 Building and pushing the container
  83 ----------------------------------
  84
  85 To build just the mysql container, use the command:
  86
  87 .. code-block:: console
  88
  89    make mysql-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
  90
  91 To both build and push the container, use the command:
  92
  93 .. code-block:: console
  94
  95    make mysql [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
  96
  97 Using the container
  98 -------------------
  99 In order for the container to be easily created, the deploy.sh script has been developed. This script accepts the following as input parameters:
 100
 101 CONTAINER_NAME, name of the container, default value is akraino-validation-mysql
 102 MYSQL_ROOT_PASSWORD, the desired mysql root user password, this variable is required
 103 MYSQL_AKRAINO_PASSWORD, the desired mysql akraino user password, this variable is required
 104 REGISTRY, registry of the mysql image, default value is akraino
 105 NAME, name of the mysql image, default value is validation
 106 TAG_PRE, first part of the image version, default value is mysql
 107 TAG_VER, last part of the image version, default value is latest
 108 MYSQL_HOST_PORT, port on which mysql is exposed on host, default value is 3307
 109
 110 In order to deploy the container, this script can be executed with the appropriate parameters.
 111
 112 Example (assuming the default variables have been utilized for building the image using the make command):
 113
 114 .. code-block:: console
 115
 116     cd validation/docker/mysql
 117     ./deploy.sh MYSQL_ROOT_PASSWORD=root_password MYSQL_AKRAINO_PASSWORD=akraino_password
 118
 119 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.
 120
 121 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:
 122
 123 CONTAINER_NAME, the name of the container, default value is akraino-validation-mysql
 124 REGISTRY, the registry of the mysql image, default value is akraino
 125 NAME, the name of the mysql image, default value is validation
 126 TAG_PRE, the first part of the image version, default value is mysql
 127 TAG_VER, the last part of the image version, default value is latest
 128 MYSQL_HOST_PORT, the port on which mysql is exposed on host, default value is 3307
 129
 130 In order to deploy the container, this script can be executed with the appropriate parameters.
 131
 132 Example (assuming the default variables have been utilized for building the image using the make command):
 133
 134 .. code-block:: console
 135
 136     cd validation/docker/mysql
 137     ./deploy_with_existing_persistent_storage.sh
 138
 139 More info can be found at the UI README file.
 140
 141 The ui container
 142 ================
 143
 144 Building and pushing the container
 145 ----------------------------------
 146
 147 To build just the UI container, use the command:
 148
 149 .. code-block:: console
 150
 151     make ui-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 152
 153 To both build and push the container, use the command:
 154
 155 .. code-block:: console
 156
 157     make ui [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 158
 159 Using the container
 160 -------------------
 161 In order for the container to be easily created, the deploy.sh script has been developed. This script accepts the following as input parameters:
 162
 163 CONTAINER_NAME, the name of the contaner, default value is akraino-validation-ui
 164 DB_IP_PORT, the IP and port of the mysql instance, this variable is required
 165 MYSQL_AKRAINO_PASSWORD, the mysql akraino user password, this variable is required
 166 REGISTRY, the registry of the mysql image, default value is akraino
 167 NAME, the name of the mysql image, default value is validation
 168 TAG_PRE, the first part of the image version, default value is ui
 169 TAG_VER, the last part of the image version, default value is latest
 170 JENKINS_URL, the URL of the Jenkins instance (http or https must be defined), the default value is 'https://jenkins.akraino.org/'
 171 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)
 172 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)
 173 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)
 174 NEXUS_PROXY, the needed proxy in order for the Nexus server to be reachable, default value is none
 175 JENKINS_PROXY, the needed proxy in order for the Jenkins server to be reachable, default value is none
 176 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
 177 ENCRYPTION_KEY, the key that should be used by the AES algorithm for encrypting passwords stored in database, this variable is required
 178 UI_ADMIN_PASSWORD, the desired Blueprint Validation UI password for the admin user, this variable is required
 179
 180 Note that, for a functional UI, the following prerequisites are needed:
 181
 182 - The mysql container in up and running state
 183 - A Jenkins instance capable of running the blueprint validation test (this is optional and is needed only for UI full control loop mode)
 184 - A Nexus repo in which all the test results are stored.
 185
 186 More info can be found at the UI README file.
 187
 188 In order to deploy the container, the aforementioned script can be executed with the appropriate parameters.
 189
 190 Example (assuming the default variables have been utilized for building the image using the make command):
 191
 192 .. code-block:: console
 193
 194     cd validation/docker/ui
 195     ./deploy.sh DB_IP_PORT=172.17.0.3:3306 MYSQL_AKRAINO_PASSWORD=akraino_password ENCRYPTION_KEY=AGADdG4D04BKm2IxIWEr8o== UI_ADMIN_PASSWORD=admin
 196
 197 The kube-conformance container
 198 ==============================
 199
 200 Building and pushing the container
 201 ----------------------------------
 202
 203 To build just the kube-conformance container, use the command:
 204
 205 .. code-block:: console
 206
 207     make kube-conformance-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 208
 209 To both build and push the container, use the command:
 210
 211 .. code-block:: console
 212
 213     make kube-conformance [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 214
 215 Using the container
 216 -------------------
 217
 218 This is a standalone container able to launch Kubernetes end-to-end tests,
 219 for the purposes of conformance testing.
 220
 221 It is a thin wrapper around the `e2e.test` binary in the upstream Kubernetes
 222 distribution, which drops results in a predetermined location for use as a
 223 [Heptio Sonobuoy](https://github.com/heptio/sonobuoy) plugin.
 224
 225 To learn more about conformance testing and its Sonobuoy integration, read the
 226 [conformance guide](https://github.com/heptio/sonobuoy/blob/master/docs/conformance-testing.md).
 227
 228 Example:
 229
 230 .. code-block:: console
 231
 232     docker run -ti akraino/validation:kube-conformance-v1.16
 233
 234 By default, the container will run the `run_e2e.sh` script. If you want to
 235 enter the container, add */bin/sh* at the end of the command above
 236
 237 Normally, this conainer is not used directly, but instead leveraged via
 238 sonobuoy.
 239
 240 The sonobuoy-plugin-systemd-logs container
 241 ==========================================
 242
 243 Building and pushing the container
 244 ----------------------------------
 245
 246 To build just the sonobuoy-plugin-systemd-logs container, use the command:
 247
 248 .. code-block:: console
 249
 250     make sonobuoy-plugin-systemd-logs-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 251
 252 To both build and push the container, use the command:
 253
 254 .. code-block:: console
 255
 256     make sonobuoy-plugin-systemd-logs [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 257
 258 Using the container
 259 -------------------
 260
 261 This is a simple standalone container that gathers log information from
 262 systemd, by chrooting into the node's filesystem and running `journalctl`.
 263
 264 This container is used by [Heptio Sonobuoy](https://github.com/heptio/sonobuoy)
 265 for gathering host logs in a Kubernetes cluster.
 266
 267 Example:
 268
 269 .. code-block:: console
 270
 271     docker run -ti akraino/validation:sonobuoy-plugin-systemd-logs-latest
 272
 273 By default, the container will run the `get_systemd_logs.sh` script. If you
 274 want to enter the container, add */bin/sh* at the end of the command above.
 275
 276 Normally, this conainer is not used directly, but instead leveraged via
 277 sonobuoy.
 278
 279 The openstack container
 280 =======================
 281
 282 Building and pushing the container
 283 ----------------------------------
 284
 285 To build just the openstack container, use the command:
 286
 287 .. code-block:: console
 288
 289     make openstack-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 290
 291 To both build and push the container, use the command:
 292
 293 .. code-block:: console
 294
 295     make openstack [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 296
 297 Using the container
 298 -------------------
 299
 300 The openstack image is meant to be ran from a server that has access to the
 301 openstack deployment (jenkins slave, jumpserver, etc).
 302
 303 Before running the image, copy openstack deployment environment variables
 304 (openrc) to a local folder (e.g. /root/openrc).
 305
 306 Container needs to be started with the openrc file mounted. Optionally, test
 307 cases can be excluded from execution via a mounted blacklist file.
 308
 309 The results folder can be mounted as well; this way the logs are
 310 stored on the local server.
 311
 312 .. code-block:: console
 313
 314     docker run -ti -v /home/jenkins/openrc:/root/openrc \
 315     -v /home/jenkins/blacklist.txt:/opt/akraino/validation/tests/openstack/tempest/blacklist.txt \
 316     -v /home/jenkins/openstack_results:/opt/akraino/results/ \
 317     akraino/validation:openstack-latest
 318
 319 The helm container
 320 ==================
 321
 322 Building and pushing the container
 323 ----------------------------------
 324
 325 To build just the helm container, use the command:
 326
 327 .. code-block:: console
 328
 329     make helm-build [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 330
 331 To both build and push the container, use the command:
 332
 333 .. code-block:: console
 334
 335     make helm [ REGISTRY=<dockerhub_registry> NAME=<image_name>]
 336
 337 Using the container
 338 -------------------
 339
 340 Container needs to be started with the SSH key file mounted. Users
 341 credentials can be provided via a mounted variables.yaml file.
 342
 343 The results folder can be mounted as well; this way the logs are
 344 stored on the local server.
 345
 346 .. code-block:: console
 347
 348     docker run -ti -v /home/jenkins/openrc:/root/openrc \
 349     -v /home/foobar/.ssh/id_rsa:/root/.ssh/id_rsa \
 350     -v /home/foobar/variables.yaml:/opt/akraino/validation/tests/variables.yaml \
 351     -v /home/foobar/helm_results:/opt/akraino/results/ \
 352     akraino/validation:helm-latest