docs/developer_info/Working_with_SO_Docker.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 Huawei Technologies Co., Ltd.
   4
   5 Working with SO Docker
   6 ======================
   7
   8 Verify that docker images are built
   9 ------------------------------------
  10
  11 .. code-block:: bash
  12
  13   docker images
  14
  15   *Example Output:*
  16
  17   REPOSITORY                      TAG                            IMAGE ID            CREATED              SIZE
  18   onap/so/so-monitoring           1.3.0-SNAPSHOT                 bb8f368a3ddb        7 seconds ago        206MB
  19   onap/so/so-monitoring           1.3.0-SNAPSHOT-20190213T0846   bb8f368a3ddb        7 seconds ago        206MB
  20   onap/so/so-monitoring           1.3.0-SNAPSHOT-latest          bb8f368a3ddb        7 seconds ago        206MB
  21   onap/so/so-monitoring           latest                         bb8f368a3ddb        7 seconds ago        206MB
  22   onap/so/api-handler-infra       1.3.0-SNAPSHOT                 2573165483e9        21 seconds ago       246MB
  23   onap/so/api-handler-infra       1.3.0-SNAPSHOT-20190213T0846   2573165483e9        21 seconds ago       246MB
  24   onap/so/api-handler-infra       1.3.0-SNAPSHOT-latest          2573165483e9        21 seconds ago       246MB
  25   onap/so/api-handler-infra       latest                         2573165483e9        21 seconds ago       246MB
  26   onap/so/bpmn-infra              1.3.0-SNAPSHOT                 8b1487665f2e        38 seconds ago       324MB
  27   onap/so/bpmn-infra              1.3.0-SNAPSHOT-20190213T0846   8b1487665f2e        38 seconds ago       324MB
  28   onap/so/bpmn-infra              1.3.0-SNAPSHOT-latest          8b1487665f2e        38 seconds ago       324MB
  29   onap/so/bpmn-infra              latest                         8b1487665f2e        38 seconds ago       324MB
  30   onap/so/sdc-controller          1.3.0-SNAPSHOT                 c663bb7d7c0d        About a minute ago   241MB
  31   onap/so/sdc-controller          1.3.0-SNAPSHOT-20190213T0846   c663bb7d7c0d        About a minute ago   241MB
  32   onap/so/sdc-controller          1.3.0-SNAPSHOT-latest          c663bb7d7c0d        About a minute ago   241MB
  33   onap/so/sdc-controller          latest                         c663bb7d7c0d        About a minute ago   241MB
  34   onap/so/vfc-adapter             1.3.0-SNAPSHOT                 dee0005ef18b        About a minute ago   212MB
  35   onap/so/vfc-adapter             1.3.0-SNAPSHOT-20190213T0846   dee0005ef18b        About a minute ago   212MB
  36   onap/so/vfc-adapter             1.3.0-SNAPSHOT-latest          dee0005ef18b        About a minute ago   212MB
  37   onap/so/vfc-adapter             latest                         dee0005ef18b        About a minute ago   212MB
  38   onap/so/openstack-adapter       1.3.0-SNAPSHOT                 fe9103aa9f36        About a minute ago   235MB
  39   onap/so/openstack-adapter       1.3.0-SNAPSHOT-20190213T0846   fe9103aa9f36        About a minute ago   235MB
  40   onap/so/openstack-adapter       1.3.0-SNAPSHOT-latest          fe9103aa9f36        About a minute ago   235MB
  41   onap/so/openstack-adapter       latest                         fe9103aa9f36        About a minute ago   235MB
  42   onap/so/sdnc-adapter            1.3.0-SNAPSHOT                 d02d42d92b06        2 minutes ago        231MB
  43   onap/so/sdnc-adapter            1.3.0-SNAPSHOT-20190213T0846   d02d42d92b06        2 minutes ago        231MB
  44   onap/so/sdnc-adapter            1.3.0-SNAPSHOT-latest          d02d42d92b06        2 minutes ago        231MB
  45   onap/so/sdnc-adapter            latest                         d02d42d92b06        2 minutes ago        231MB
  46   onap/so/request-db-adapter      1.3.0-SNAPSHOT                 5e0136f2201b        2 minutes ago        215MB
  47   onap/so/request-db-adapter      1.3.0-SNAPSHOT-20190213T0846   5e0136f2201b        2 minutes ago        215MB
  48   onap/so/request-db-adapter      1.3.0-SNAPSHOT-latest          5e0136f2201b        2 minutes ago        215MB
  49   onap/so/request-db-adapter      latest                         5e0136f2201b        2 minutes ago        215MB
  50   onap/so/catalog-db-adapter      1.3.0-SNAPSHOT                 bf1c2fe49acb        2 minutes ago        218MB
  51   onap/so/catalog-db-adapter      1.3.0-SNAPSHOT-20190213T0846   bf1c2fe49acb        2 minutes ago        218MB
  52   onap/so/catalog-db-adapter      1.3.0-SNAPSHOT-latest          bf1c2fe49acb        2 minutes ago        218MB
  53   onap/so/catalog-db-adapter      latest                         bf1c2fe49acb        2 minutes ago        218MB
  54   onap/so/base-image              1.0                            1685bba9831d        3 minutes ago        108MB
  55   openjdk                         8-jdk-alpine                   792ff45a2a17        7 days ago           105MB
  56   nexus3.onap.org:10001/openjdk   8-jdk-alpine                   792ff45a2a17        7 days ago           105MB
  57
  58 Start the containers
  59 ---------------------
  60
  61 .. code-block:: bash
  62
  63   cd $HOME/onap/workspace/SO/docker-config
  64
  65   ./deploy.sh
  66
  67   This should also download & start the mariaDB docker.
  68
  69 *Example Output:*
  70
  71 .. code-block:: bash
  72
  73   Deploying with local images, not pulling them from Nexus.
  74   docker command: local docker using unix socket
  75   Removing network dockerconfig_default
  76   Creating network "dockerconfig_default" with driver "bridge"
  77   Pulling mariadb (mariadb:10.1.11)...
  78   10.1.11: Pulling from library/mariadb
  79   7268d8f794c4: Pull complete
  80   a3ed95caeb02: Pull complete
  81   e5a99361f38c: Pull complete
  82   20b20853e29d: Pull complete
  83   9dbc63cf121f: Pull complete
  84   fdebb5c64c6c: Pull complete
  85   3154860d3699: Pull complete
  86   3cfa7ffec11c: Pull complete
  87   943211713cac: Pull complete
  88   d65a44f4573e: Pull complete
  89   Digest: sha256:3821f92155bf4311a59b7ec6219b79cbf9a42c75805000a7c8fe5d9f3ad28276
  90   Status: Downloaded newer image for mariadb:10.1.11
  91   Creating dockerconfig_mariadb_1
  92   Waiting for 'dockerconfig_mariadb_1' deployment to finish ...
  93   Waiting for 'dockerconfig_mariadb_1' deployment to finish ...
  94   Waiting for 'dockerconfig_mariadb_1' deployment to finish ...
  95   Waiting for 'dockerconfig_mariadb_1' deployment to finish ...
  96   Waiting for 'dockerconfig_mariadb_1' deployment to finish ...
  97   Waiting for 'dockerconfig_mariadb_1' deployment to finish ...
  98   dockerconfig_mariadb_1 is up-to-date
  99   Creating dockerconfig_catalog-db-adapter_1
 100   Creating dockerconfig_request-db-adapter_1
 101   Creating dockerconfig_sdc-controller_1
 102   Creating dockerconfig_vfc-adapter_1
 103   Creating dockerconfig_openstack-adapter_1
 104   Creating dockerconfig_sdnc-adapter_1
 105   Creating dockerconfig_api-handler-infra_1
 106   Creating dockerconfig_so-monitoring_1
 107   Creating dockerconfig_bpmn-infra_1
 108
 109 Check containers are now up
 110 ----------------------------
 111
 112 .. code-block:: bash
 113
 114   docker ps
 115
 116   *Example Output:*
 117
 118   CONTAINER ID        IMAGE                        COMMAND                  CREATED             STATUS              PORTS                     NAMES
 119   324ce4636285        onap/so/bpmn-infra           "/app/wait-for.sh ..."   5 minutes ago       Up 5 minutes        0.0.0.0:8081->8081/tcp    dockerconfig_bpmn-infra_1
 120   60986a742f6f        onap/so/so-monitoring        "/app/wait-for.sh ..."   5 minutes ago       Up 5 minutes        0.0.0.0:8088->8088/tcp    dockerconfig_so-monitoring_1
 121   ea6e3e396166        onap/so/api-handler-infra    "/app/wait-for.sh ..."   5 minutes ago       Up 5 minutes        0.0.0.0:8080->8080/tcp    dockerconfig_api-handler-infra_1
 122   473ca2dc852c        onap/so/sdnc-adapter         "/app/wait-for.sh ..."   5 minutes ago       Up 5 minutes        0.0.0.0:8086->8086/tcp    dockerconfig_sdnc-adapter_1
 123   7ae53b222a39        onap/so/vfc-adapter          "/app/wait-for.sh ..."   5 minutes ago       Up 5 minutes        0.0.0.0:8084->8084/tcp    dockerconfig_vfc-adapter_1
 124   8844999c9fc8        onap/so/openstack-adapter    "/app/wait-for.sh ..."   5 minutes ago       Up 5 minutes        0.0.0.0:8087->8087/tcp    dockerconfig_openstack-adapter_1
 125   d500c33665b6        onap/so/sdc-controller       "/app/wait-for.sh ..."   5 minutes ago       Up 5 minutes        0.0.0.0:8085->8085/tcp    dockerconfig_sdc-controller_1
 126   852483370df3        onap/so/request-db-adapter   "/app/wait-for.sh ..."   5 minutes ago       Up 5 minutes        0.0.0.0:8083->8083/tcp    dockerconfig_request-db-adapter_1
 127   cdfa29ee96cc        onap/so/catalog-db-adapter   "/app/wait-for.sh ..."   5 minutes ago       Up 5 minutes        0.0.0.0:8082->8082/tcp    dockerconfig_catalog-db-adapter_1
 128   7c7116026c07        mariadb:10.1.11              "/docker-entrypoin..."   5 minutes ago       Up 5 minutes        0.0.0.0:32770->3306/tcp   dockerconfig_mariadb_1
 129
 130 Check SO health
 131 ---------------
 132 .. code-block:: bash
 133
 134   curl http://localhost:8080/manage/health
 135
 136   *Example Output:*
 137
 138   {"status":"UP"}
 139
 140 Log into the mso container
 141 --------------------------
 142
 143 .. code-block:: bash
 144
 145   docker exec -it dockerconfig_api-handler-infra_1 sh
 146
 147 Inspect a docker image
 148 ----------------------
 149
 150 This command shows interesting information about the structure of the mso image.  Note that an image is NOT a running container.
 151 It is the template that a container is created from.
 152
 153 .. code-block:: bash
 154
 155   docker inspect onap/so/api-handler-infra
 156   Example Output:
 157
 158   [
 159     {
 160         "Id": "sha256:2573165483e9ac87826da9c08984a9d0e1d93a90c681b22d9b4f90ed579350dc",
 161         "RepoTags": [
 162             "onap/so/api-handler-infra:1.3.0-SNAPSHOT",
 163             "onap/so/api-handler-infra:1.3.0-SNAPSHOT-20190213T0846",
 164             "onap/so/api-handler-infra:1.3.0-SNAPSHOT-latest",
 165             "onap/so/api-handler-infra:latest"
 166         ],
 167         "RepoDigests": [],
 168         "Parent": "sha256:66b508441811ab4ed9968f8702a0d0a697f517bbc10d8d9076e5b98ae4437344",
 169         "Comment": "",
 170         "Created": "2019-02-13T09:37:33.770342225Z",
 171         "Container": "8be46c735d21935631130f9017c3747779aab26eab54a9149b1edde122f7576d",
 172         "ContainerConfig": {
 173             "Hostname": "ac4a12e21390",
 174             "Domainname": "",
 175             "User": "",
 176             "AttachStdin": false,
 177             "AttachStdout": false,
 178             "AttachStderr": false,
 179             "Tty": false,
 180             "OpenStdin": false,
 181             "StdinOnce": false,
 182             "Env": [
 183                 "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/lib/jvm/java-1.8-openjdk/jre/bin:/usr/lib/jvm/java-1.8-openjdk/bin",
 184                 "LANG=C.UTF-8",
 185                 "JAVA_HOME=/usr/lib/jvm/java-1.8-openjdk",
 186                 "JAVA_VERSION=8u191",
 187                 "JAVA_ALPINE_VERSION=8.191.12-r0",
 188                 "HTTP_PROXY=",
 189                 "HTTPS_PROXY=",
 190                 "http_proxy=",
 191                 "https_proxy="
 192             ],
 193             "Cmd": [
 194                 "/bin/sh",
 195                 "-c",
 196                 "#(nop) ",
 197                 "CMD [\"/app/start-app.sh\"]"
 198             ],
 199             "ArgsEscaped": true,
 200             "Image": "sha256:66b508441811ab4ed9968f8702a0d0a697f517bbc10d8d9076e5b98ae4437344",
 201             "Volumes": {
 202                 "/app/ca-certificates": {},
 203                 "/app/config": {}
 204             },
 205             "WorkingDir": "/app",
 206             "Entrypoint": null,
 207             "OnBuild": [],
 208             "Labels": {}
 209         },
 210         "DockerVersion": "17.05.0-ce",
 211         "Author": "",
 212         "Config": {
 213             "Hostname": "ac4a12e21390",
 214             "Domainname": "",
 215             "User": "",
 216             "AttachStdin": false,
 217             "AttachStdout": false,
 218             "AttachStderr": false,
 219             "Tty": false,
 220             "OpenStdin": false,
 221             "StdinOnce": false,
 222             "Env": [
 223                 "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/lib/jvm/java-1.8-openjdk/jre/bin:/usr/lib/jvm/java-1.8-openjdk/bin",
 224                 "LANG=C.UTF-8",
 225                 "JAVA_HOME=/usr/lib/jvm/java-1.8-openjdk",
 226                 "JAVA_VERSION=8u191",
 227                 "JAVA_ALPINE_VERSION=8.191.12-r0",
 228                 "HTTP_PROXY=",
 229                 "HTTPS_PROXY=",
 230                 "http_proxy=",
 231                 "https_proxy="
 232             ],
 233             "Cmd": [
 234                 "/app/start-app.sh"
 235             ],
 236             "ArgsEscaped": true,
 237             "Image": "sha256:66b508441811ab4ed9968f8702a0d0a697f517bbc10d8d9076e5b98ae4437344",
 238             "Volumes": {
 239                 "/app/ca-certificates": {},
 240                 "/app/config": {}
 241             },
 242             "WorkingDir": "/app",
 243             "Entrypoint": null,
 244             "OnBuild": [],
 245             "Labels": {}
 246         },
 247         "Architecture": "amd64",
 248         "Os": "linux",
 249         "Size": 245926705,
 250         "VirtualSize": 245926705,
 251         "GraphDriver": {
 252             "Data": null,
 253             "Name": "aufs"
 254         },
 255         "RootFS": {
 256             "Type": "layers",
 257             "Layers": [
 258                 "sha256:503e53e365f34399c4d58d8f4e23c161106cfbce4400e3d0a0357967bad69390",
 259                 "sha256:744b4cd8cf79c70508aace3697b6c3b46bee2c14f1c14b6ff09fd0ba5735c6d4",
 260                 "sha256:4c6899b75fdbea2f44efe5a2f8d9f5319c1cf7e87151de0de1014aba6ce71244",
 261                 "sha256:2e076d24f6d1277456e33e58fc8adcfd69dfd9c025f61aa7b98d500e7195beb2",
 262                 "sha256:bb67f2d5f8196c22137a9e98dd4190339a65c839822d16954070eeb0b2a17aa2",
 263                 "sha256:afbbd0cc43999d5c5b0ff54dfd82365a3feb826e5c857d9b4a7cf378001cd4b3",
 264                 "sha256:1920a7ca0f8ae38a79a1339ce742aaf3d7a095922d96e37074df67cf031d5035",
 265                 "sha256:1261fbaef67c5be677dae1c0f50394587832ea9d8c7dc105df2f3db6dfb92a3a",
 266                 "sha256:a33d8ee5c18908807458ffe643184228c21d3c5d5c5df1251f0f7dfce512f7e8",
 267                 "sha256:80704fca12eddb4cc638cee105637266e04ab5706b4e285d4fc6cac990e96d63",
 268                 "sha256:55abe39073a47f29aedba790a92c351501f21b3628414fa49a073c010ee747d1",
 269                 "sha256:cc4136c2c52ad522bd492545d4dd18265676ca690aa755994adf64943b119b28",
 270                 "sha256:2163a1f989859fdb3af6e253b74094e92a0fc1ee59f5eb959971f94eb1f98094"
 271             ]
 272         }
 273     }
 274   ]