k8s/README.md

   1 # ONAP DCAE Kubernetes Plugin for Cloudify
   2
   3 This directory contains a Cloudify plugin  used to orchestrate the deployment of containerized DCAE platform and service components  into a Kubernetes ("k8s")
   4 environment. This work is based on the [ONAP DCAE Docker plugin] (../docker).
   5
   6 This plugin is *not* a generic Kubernetes plugin that exposes the full set of Kubernetes features.
   7 In fact, the plugin largely hides the fact that we're using Kubernetes from both component developers and blueprint authors.
   8 The Cloudify node type definitions are very similar to the Cloudify type definitions used in the ONAP DCAE Docker plugin.
   9
  10 For the node types `ContainerizedPlatformComponent`, `ContainerizedServiceComponent`, and `ContainerizedServiceComponentUsingDmaap`, this plugin
  11 creates the following Kubernetes entities:
  12
  13 - A Kubernetes `Deployment` containing information about what containers to run and what volume to mount.
  14   - The `Deployment` always includes a container that runs the component's Docker image
  15   - The `Deployment` includes any volumes specified in the blueprint
  16   - If the blueprint specifies a logging directory via the `log_info` property, the `Deployment` includes a second container,
  17   running the `filebeat` logging sidecar that ships logging information to the ONAP ELK stack.  The `Deployment` will include
  18   some additional volumes needed by filebeat.
  19 - If the blueprint indicates that the component exposes any ports, the plugin will create a Kubernetes `Service` that allocates an address
  20   in the Kubernetes network address space that will route traffic to a container that's running the component.  This `Service` provides a
  21   fixed "virtual IP" for the component.
  22 - If the blueprint indicates that the component exposes a port externally, the plugin will create an additional Kubernetes `Service` that opens up a
  23   port on the external interface of each node in the Kubernetes cluster.
  24
  25 Through the `replicas` property, a blueprint can request deployment of multiple instances of the component.  The plugin will still create a single `Deployment` (and,
  26 if needed one or two `Services`), but the `Deployment` will cause multiple instances of the container to run.   (Specifically, the `Deployment` will create
  27 a Kubernetes `Pod` for each requested instance.)  Other entities connect to a component via the IP address of a `Service`, and Kubernetes takes care of routing
  28 traffic to an appropriate container instance.
  29
  30 ## Pre-requisites
  31 ### Configuration
  32 #### Configuration file
  33 The plugin expects a configuration file in the Python "ini" format to be stored at `/opt/onap/config.txt`.  This file contains the address of the Consul cluster.
  34 Here is an example:
  35 ```
  36 [consul]
  37 address=10.12.5.115:30270
  38 ```
  39 #### Configuration entry in Consul
  40 Additional configuration information is stored in the Consul KV store under the key `k8s-plugin`.
  41 The configuration is provided as JSON object with the following properties:
  42
  43     - namespace:  k8s namespace to use for DCAE
  44     - consul_dns_name: k8s internal DNS name for Consul (passed to containers)
  45     - image_pull_secrets: list of names of k8s secrets for accessing Docker registries, with the following properties:
  46     - filebeat:  object containing onfiguration for setting up filebeat container
  47             - log_path: mount point for log volume in filebeat container
  48             - data_path: mount point for data volume in filebeat container
  49             - config_path: mount point for config volume in filebeat container
  50             - config_subpath: subpath for config data in filebeat container
  51             - config_map: name of a ConfigMap holding the filebeat configuration file
  52             - image: Docker image to use for filebeat
  53
  54 #### Kubernetes access information
  55 The plugin accesses a Kubernetes cluster.  The information and credentials for accessing a cluster are stored in a "kubeconfig"
  56 file.  The plugin expects to find such a file at `/etc/cloudify/.kube/config`.
  57
  58 #### Additional Kubernetes configuration elements
  59 The plugin expects certain elements to be provided in the DCAE/ONAP environment, namely:
  60    - Kubernetes secret(s) containing the credentials needed to pull images from Docker registries, if needed
  61    - A Kubernetes ConfigMap containing the filebeat.yml file used by the filebeat logging container
  62    - An ExternalName service
  63
  64 ## Input parameters
  65
  66 ### `start` operation parameters
  67
  68 These input parameters are for the `start` `cloudify.interfaces.lifecycle` and are inputs into the variant task operations `create_and_start_container*`.
  69
  70 #### `envs`
  71
  72 A map of environment variables that is intended to be forwarded to the container as environment variables.  Example:
  73
  74 ```yaml
  75 envs:
  76   EXTERNAL_IP: '10.100.1.99'
  77 ```
  78
  79 These environment variables will be forwarded in addition to the *platform-related* environment variables like `CONSUL_HOST`.
  80
  81 #### `volumes`
  82
  83 List of maps used for setting up Kubernetes volume mounts.  Example:
  84
  85 ```yaml
  86 volumes:
  87   - host:
  88       path: '/var/run/docker.sock'
  89     container:
  90       bind: '/tmp/docker.sock'
  91       mode: 'ro'
  92 ```
  93
  94 The table below describes the fields.
  95
  96 key | description
  97 --- | -----------
  98 path | Full path to the file or directory on the host machine to be mounted
  99 bind | Full path to the file or directory in the container where the volume should be mounted to
 100 mode | Readable, writeable: `ro`, `rw`
 101
 102 #### `ports`
 103
 104 List of strings - Used to bind container ports to host ports. Each item is of the format: `<container port>:<host port>`.
 105
 106 Note that `ContainerizedPlatformComponent` has the property pair `host_port` and `container_port`. This pair will be merged with the input parameters ports.
 107
 108 ```yaml
 109 ports:
 110   - '8000:31000'
 111 ```
 112
 113 Default is `None`.
 114
 115 In the Kubernetes environment, most components will communicate over the Kubernetes network using private addresses. For those cases,
 116 setting the `<host port>` to 0 will expose the `<container port>` to other components on the Kubernetes network, but not will not expose any
 117 ports on the Kubernetes host's external interface.    Setting `<host port>` to a non-zero value will expose that port on the external interfaces
 118 of every Kubernetes host in the cluster.  (This uses the Kubernetes `NodePort` service type.)
 119
 120 #### `max_wait`
 121
 122 Integer - seconds to wait for component to become ready before throwing a `NonRecoverableError`. For example:
 123
 124 ```yaml
 125 max_wait:
 126     60
 127 ```
 128
 129 Default is 300 seconds.
 130
 131 ## Using DMaaP
 132
 133 The node type `dcae.nodes.ContainerizedServiceComponentUsingDmaap` is intended to be used by components that use DMaaP and expects to be connected with the DMaaP node types found in the DMaaP plugin.
 134
 135 ### Node properties
 136
 137 The properties `streams_publishes` and `streams_subscribes` both are lists of objects that are intended to be passed into the DMaaP plugin and used to create additional parameters that will be passed into the DMaaP plugin.
 138
 139 #### Message router
 140
 141 For message router publishers and subscribers, the objects look like:
 142
 143 ```yaml
 144 name: topic00
 145 location: mtc5
 146 client_role: XXXX
 147 type: message_router
 148 ```
 149
 150 Where `name` is the node name of `dcae.nodes.Topic` or `dcae.nodes.ExistingTopic` that the Docker node is connecting with via the relationships `dcae.relationships.publish_events` for publishing and `dcae.relationships.subscribe_to_events` for subscribing.
 151
 152 #### Data router
 153
 154 For data router publishers, the object looks like:
 155
 156 ```yaml
 157 name: feed00
 158 location: mtc5
 159 type: data_router
 160 ```
 161
 162 Where `name` is the node name of `dcae.nodes.Feed` or `dcae.nodes.ExistingFeed` that the Docker node is connecting with via the relationships `dcae.relationships.publish_files`.
 163
 164 For data router subscribers, the object looks like:
 165
 166 ```yaml
 167 name: feed00
 168 location: mtc5
 169 type: data_router
 170 username: king
 171 password: "123456"
 172 route: some-path
 173 scheme: https
 174 ```
 175
 176 Where the relationship to use is `dcae.relationships.subscribe_to_files`.
 177
 178 If `username` and `password` are not provided, then the plugin will generate username and password pair.
 179
 180 `route` and `scheme` are parameter used in the dynamic construction of the delivery url which will be passed to the DMaaP plugin to be used in the setting up of the subscriber to the feed.
 181
 182 `route` is the http path endpoint of the subscriber that will handle files from the associated feed.
 183
 184 `scheme` is either `http` or `https`.  If not specified, then the plugin will default to `http`.
 185
 186 ### Component configuration
 187
 188 The DMaaP plugin is responsible to provision the feed/topic and store into Consul the resulting DMaaP connection details.  Here is an example:
 189
 190 ```json
 191 {
 192     "topic00": {
 193         "client_role": "XXXX",
 194         "client_id": "XXXX",
 195         "location": "XXXX",
 196         "topic_url": "https://some-topic-url.com/events/abc"
 197     }
 198 }
 199 ```
 200
 201 This is to be merged with the templatized application configuration:
 202
 203 ```json
 204 {
 205     "some-param": "Lorem ipsum dolor sit amet",
 206     "streams_subscribes": {
 207         "topic-alpha": {
 208             "type": "message_router",
 209             "aaf_username": "user-foo",
 210             "aaf_password": "password-bar",
 211             "dmaap_info": "<< topic00 >>"
 212         },
 213     },
 214     "streams_publishes": {},
 215     "services_calls": {}
 216 }
 217 ```
 218
 219 To form the application configuration:
 220
 221 ```json
 222 {
 223     "some-param": "Lorem ipsum dolor sit amet",
 224     "streams_subscribes": {
 225         "topic-alpha": {
 226             "type": "message_router",
 227             "aaf_username": "user-foo",
 228             "aaf_password": "password-bar",
 229             "dmaap_info": {
 230                 "client_role": "XXXX",
 231                 "client_id": "XXXX",
 232                 "location": "XXXX",
 233                 "topic_url": "https://some-topic-url.com/events/abc"
 234             }
 235         },
 236     },
 237     "streams_publishes": {},
 238     "services_calls": {}
 239 }
 240 ```
 241
 242 This also applies to data router feeds.
 243
 244 ## Additional Operations Supported by the Plugin
 245 In addition to supporting the Cloudify `install` and `uninstall` workflows, the plugin provides two standalone operations that can be invoked using the Cloudify [`execute_operation` workflow](https://docs.cloudify.co/4.3.0/working_with/workflows/built-in-workflows/).  The `dcae.nodes.ContainerizedApplication`, `dcae.nodes.ContainerizedPlatformComponent`, `dcae.nodes.ContainerizedServiceComponent`, and `dcae.nodes.ContainerizedServiceComponentUsingDmaap` node types support these operations.
 246
 247 Currently, there's no convenient high-level interface to trigger these operations, but they could potentially be exposed through some kind of dashboard.
 248
 249 ### Scaling Operation (`scale`)
 250 The `scale` operation provides a way to change the number of replicas running for a node instance.  The operation is implemented by modifying the number of replicas in the Kubernetes Deployment specification associated with a node instance and submitting the updated specification to the Kubernetes API.  The scale operation works for increasing the number of replicas as well as decreasing the number of replications.  The minimum number of replicas is 1.
 251
 252 The `scale` operation takes two parameters:
 253 - `replicas`: Number of desired replicas. Integer, required.
 254 - `max_wait`: Number of seconds to wait for successful completion of the operation.  Integer, optional, defaults to 300 seconds.
 255
 256 One way to trigger a `scale` operation is by using the Cloudify command line.  For example:
 257 ```
 258 cfy executions start -d my_deployment -p scale_params.yaml execute_operation
 259 ```
 260 where `my_deployment` is the name of an existing Cloudify deployment and
 261 `scale_params.yaml` is a a file containing the operation parameters:
 262 ```
 263 operation: scale
 264 operation_kwargs:
 265     replicas: 3
 266 node_ids:
 267     - "web_server"
 268 ```
 269 Note that the `node_ids` list is required by the `execute_operation` workflow.  The list contains all of the nodes that are being targeted by the workflow.  If a blueprint contains more than one node, it's possible to scale all of them--or some subset--with a single workflow execution.
 270
 271 ### Image Update Operation (`image_update`)
 272 The `update_image` operation provides a way to change the Docker image running for a node instance, using the Kubernetes _rolling update_ strategy.  (See this [tutorial](https://kubernetes.io/docs/tutorials/kubernetes-basics/update/update-intro/) and this [discussion of the concept](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#updating-a-deployment) in the Kubernetes documentation.) The operation is implemented by modifying the image property in the Kubernetes Deployment specification associated with a node instance and submitting the updated specification to the Kubernetes API.
 273
 274 The `update_image` operation takes two parameters:
 275 - `image`: Full name (including registry, if not the default Docker registry, and tag) of the new image to use for the component.  String, required.
 276 - `max_wait`: Number of seconds to wait for successful completion of the operation.  Integer, optional, defaults to 300 seconds.
 277
 278 The `update_image` operation can be triggered using the Cloudify command line.  For example:
 279 ```
 280 cfy executions start -d my_deployment -p update_params.yaml execute_operation
 281 ```
 282 where `my_deployment` is the name of an existing Cloudify deployment and
 283 `update_params.yaml` is a a file containing the operation parameters:
 284 ```
 285 operation: update_image
 286 operation_kwargs:
 287     image: myrepository.example.com/server/web:1.15
 288 node_ids:
 289     - "web_server"
 290 ```
 291 Note that the `node_ids` list is required by the `execute_operation` workflow.  The list contains all of the nodes that are being targeted by the workflow.  For an `update_image` operation, the list typically has only one element.
 292
 293 Note also that the `update_image` operation targets the container running the application code (i.e., the container running the image specified in the `image` node property).  This plugin may deploy "sidecar" containers running supporting code--for example, the "filebeat" container that relays logs to the central log server.  The `update_image` operation does not touch any "sidecar" containers.