README.md

Docker containers service chain example

Overview

Purpose of this example is to show how TOSCA-based orchestration may be used to provisioning of virtualized network services chain in non-specialized environment.

In this example Cloudify orchestration will be used. Repository consists of Cloudify services descriptors (blueprints).

As result of execution of this example you will have fully-functional service chain with 3 services.

All services and infrastructure elements are run as docker containers. During example execution 5 docker containers will be created:

• host - container to which you can attach terminal session and check connectivity with server through service chain
• server - container running 2 python SimpleHTTPServers on 8080 and 8181 ports
• vRouter - 1st service - container acts as virtual router
• vFirewall - 2nd service - container using iptables to drop HTTP traffic on 8181 port
• vURLFilter - 3rd service - container running squid3. Should restrict access to HTTP server on 8080 port

Also connections between containers are made using standard docker networks (bridge) API. Orchestrator uses docker REST API to provision all elements and configuration.

To steer traffic between services one container running Open vSwitch is used. This container is connected by docker networks with each of containers.

In OvS container one main OpenFlow bridge has been defined - it is br0. Its role is to steer traffic between input (host container), output (server container) and endpoints (additional OpenFlow bridges dedicated to plug services in).

Endpoint bridge can be considered and connector to which you can plug your own service. Each of endpoint OpenFlow bridges: br1, br2 and br3 has initially 2 patch interfaces with peers connected to main bridge. In initial mode it forwards traffic between patch interfaces - this behaviour enables chain traffic to be forwarded between host and server without any service plugged. During service blueprint installation new service is plugged in to endpoint bridge. Two new interfaces connected to endpoint bridge and appropriate docker networks are created. Installation of service blueprint reconfigures also OpenFlow flows defined in endpoint bridge to forward traffic between patch interfaces connected to br0 and external interfaces connected to service networks. During service blueprint uninstallation external interfaces are removed and flows are "reverted" to forward traffic again between patch interfaces. Purpose of introducing this kind of architecture was to provide additional abstraction layer - you can simply plug and unplug service without need of main bridge flows reconfiguration.

Each service container has interfaces to 2 networks: "input" chain network and "output" chain network.

Implementation

Solution has been implemented as set o 3 blueprints:

• main infrastructure blueprint - responsible for provisioning of:

  • host, server and ovs containers
  • docker newtorks between containers
  • main OpenFlow bridge (br0) on ovs container
  • proper openflow interfaces connected to br0
  • flows on br0

  It also uses endpoint infrastructure blueprint to install 3 deployments of endpoint blueprint

• endpoint infrastructure blueprint - responsible for provisioning of:

  • endpoint OpenFlow bridge on ovs container
  • proper openflow interfaces connected to endpoint bridge
  • flows on endpoint bridge

• service blueprint - responsible for provisioning of:

  • service container
  • simple service configuration
  • "input" and "output" docker newtorks dedicated for each service
  • proper openflow interfaces connected to endpoint bridge
  • flows reconfiguration on endpoint bridge

endpoint infrastructure blueprint must be uploaded first on Cloudify Manager. It is used (read and executed) by main infrastructure blueprint during its installation.

Prerequisites

• Docker

  You need to install docker to run this example. Blueprints have been tested on docker v.1.13.1.

• Docker REST API expose

  Docker REST API should be reachable for Cloudify Manager, so you need to expose it on localhost. Exposing process is described here:

  https://success.docker.com/article/how-do-i-enable-the-remote-api-for-dockerd

  Blueprints have been tested using docker REST API v.1.26 and v.1.38.

• Docker images

  5 custom images are used in this example. There are:

  • cfy_lab_docker_sfc/server
  • cfy_lab_docker_sfc/firewall_vnf
  • cfy_lab_docker_sfc/filter_vnf
  • cfy_lab_docker_sfc/client
  • cfy_lab_docker_sfc/router_vnf

  Before start you need to build them:

  ./docker/build_all.sh

  Also one image needs to be pulled:

  • socketplane/openvswitch

  It is good idea to pull it once before start:

  docker pull socketplane/openvswitch

• Container with Cloudify Manager

  To run this example you need to have an instance of Cloudify Manger.

  It may be simply run on docker usign this command:

  sudo docker run --name cfy_manager_local -d --restart unless-stopped -v /sys/fs/cgroup:/sys/fs/cgroup:ro --tmpfs /run --tmpfs /run/lock --security-opt seccomp:unconfined --cap-add SYS_ADMIN -p 80:80 -p 8000:8000 cloudifyplatform/premium

  Blueprints have been tested using Cloudify Manager v.4.5.

• cloudify-utilities-plugin v.1.12.0

  Last required preparation step is to upload cloudify-utilities-plugin into Cloudify Manager:

  cfy plugins upload https://github.com/cloudify-incubator/cloudify-utilities-plugin/releases/download/1.12.0/cloudify_utilities_plugin-1.12.0-py27-none-linux_x86_64-centos-Core.wgn -y https://github.com/cloudify-incubator/cloudify-utilities-plugin/releases/download/1.12.0/plugin.yaml

Demo execution

Before start - check if there are no existing Docker resources. Execute:

docker ps -a

You should observe the only one container with Cloudify Manager is running:

3252d0d3b35b        cloudifyplatform/premium    "/bin/bash -c 'exe..."   5 weeks ago         Up 9 minutes                22/tcp, 443/tcp, 0.0.0.0:80->80/tcp, 0.0.0.0:8000->8000/tcp, 5671-5672/tcp, 0.0.0.0:53333->53333/tcp   cfy_manager_local

Then check existing Docker networks:

docker network list

No networks with prefix cfy_lab should be present:

NETWORK ID          NAME                     DRIVER              SCOPE
f6459a81cb93        bridge                   bridge              local
07c9ed0b8bd5        host                     host                local
80089a4cbcba        none                     null                local

Stage 1 - chain infrastructure installation

Result of execution of this stage will be creation of SFC infrastructure - all things required to start services insertion into chain, like:

• containers with host, OpenvSwitch and server
• networks connecting host with OvS and OvS with server
• proper network interfaces
• OvS bridges
• OvS flows

When blueprints installation will be completed successfully, you should have ready SFC setup to which 3 services may be plugged. You should be able to access / ping server from the host, but traffic will be forwarded only through OvS bridges (no services containers plugged).

1. Upload infrastructure-endpoint blueprint. It will be used in step 2 by infrastructure-main blueprint. Execute:

   cfy blueprints upload infrastructure_endpoint-blueprint.yaml -b cfy_lab_infrastructure_endpoint

2. Install infrastructure-main blueprint:

   cfy install infrastructure_main-blueprint.yaml -i inputs/infrastructure_main-inputs.yaml -b cfy_lab_infrastructure
   

3. Gather outputs of install workflow execution:

   cfy deployments outputs cfy_lab_infrastructure

   You should find in outputs:

   • server_ip - IP of server container interface placed in chain network. It will be uses to test connectivity to the server from host container.
   • service_1_install_commad - CFY CLI command which will be used later to install service 1 (vRouter)
   • service_2_install_commad - CFY CLI command which will be used later to install service 2 (vFirewall)
   • service_3_install_commad - CFY CLI command which will be used later to install service 3 (vURLFilter)

   Please copy outputs and keep them for further steps.

4. Verify containers and networks creation:

   docker ps

   You should find 3 new containers: cfy_lab_host, cfy_lab_ovs, cfy_lab_server.

   docker network list

   You should find 2 new networks: cfy_lab_host_ovs_net, cfy_lab_ovs_server_net.

5. Observe OpenFlow bridges configuration and flows. Execute:

   docker exec cfy_lab_ovs ovs-ofctl show br0
   docker exec cfy_lab_ovs ovs-ofctl show br1
   docker exec cfy_lab_ovs ovs-ofctl show br2
   docker exec cfy_lab_ovs ovs-ofctl show br3

   You should observe bridges and interfaces configuration depicted on the image above.

   docker exec cfy_lab_ovs ovs-ofctl dump-flows br0

   You should observe flows responsible for forwarding traffic between host, server and endpoint bridges.

   docker exec cfy_lab_ovs ovs-ofctl dump-flows br1
   docker exec cfy_lab_ovs ovs-ofctl dump-flows br2
   docker exec cfy_lab_ovs ovs-ofctl dump-flows br3

   For each endpoint bridge you should observe flows responsible for traffic forwarding between patch interfaces.

   You can also execute these commands again with step 6. to observe packet counters.

6. Open new terminal. Attach to the host container terminal:

    docker exec -it cfy_lab_host /bin/bash

   Keep this session open ! Commands which should be executed in this host terminal will be marked with [HT].

   Try to ping server - use server IP obtained from deployment outputs:

   [HT] ping <server_ip>

   You should receive response from the server. Then try to open HTTP content hosted by server:

   [HT] curl <server_ip>:8080
   [HT] curl <server_ip>:8181

   For both ports you should see directory list returned by pythons SimpleHTTPServer

Stage 2 - vRouter service insertion

Now you will plug first service into chain:

1. Paste content of service_1_install_command output gathered before into console and execute it.

2. Verify containers and networks creation:

   docker ps

   You should find 1 new container: cfy_lab_service_1

   docker network list

   You should find 2 new networks: cfy_lab_ovs_service_1_net, cfy_lab_ovs_service_1_net.

3. Observe OpenFlow bridge br1 reconfiguration:

   docker exec cfy_lab_ovs ovs-ofctl show br1

   2 new interfaces should be added.

   docker exec cfy_lab_ovs ovs-ofctl dump-flows br1

   Flows should be reconfigured to pass traffic to / from service networks.

4. Verify connectivity with server

   Try to ping server - use server IP obtained from deployment outputs:

   [HT] ping <server_ip>

   You should receive response from the server. Then try to open HTTP content hosted by server:

   [HT] curl <server_ip>:8080
   [HT] curl <server_ip>:8181

   For both ports you should see directory list returned by pythons SimpleHTTPServer

Stage 3 - vFirewall service insertion

Second service will be plugged into chain:

1. Paste content of service_2_install_command output gathered before into console and execute it.

2. (optional) Using commands mentioned in previous step you may observe that new container, networks have been created and flows reconfigured.

3. Verify connectivity with server

   Try to ping server - use server IP obtained from deployment outputs:

   [HT] ping <server_ip>

   You should receive response from the server. Then try to open HTTP content hosted by server:

   [HT] curl <server_ip>:8080
   [HT] curl <server_ip>:8181

   For 8080 you should see directory list returned by pythons SimpleHTTPServer

   For 8181 traffic should be dropped by firewall

Stage 4 - vURLFilter service insertion

You will have chain with all (3) services:

1. Paste content of service_3_install_command output gathered before into console and execute it.

2. (optional) Using commands mentioned in previous steps you may observe that new container, networks have been created and flows reconfigured.

3. Verify connectivity with server

   Try to ping server - use server IP obtained from deployment outputs:

   [HT] ping <server_ip>

   You should receive response from the server. Then try to open HTTP content hosted by server:

   [HT] curl <server_ip>:8080
   [HT] curl <server_ip>:8181

   For 8080 you should see receive notification page with ACCESS DENIED information (traffic filtered by URL filter)

   For 8181 traffic should be dropped by firewall

Stage 5 - single service removal (vFirewall)

Now you will remove second service from the chain to observe that removal of randomly choosen service won't break traffic forwarding in chain:

1. Run uninstallation of service 2 (vFirewall):

   cfy uninstall cfy_lab_service_2

2. (optional) Using commands mentioned in previous steps you may observe that one container and 2 networks have been deleted.

3. Observe OpenFlow bridge br2 reconfiguration:

   docker exec cfy_lab_ovs ovs-ofctl show br2

   2 "external" interfaces should be removed.

   docker exec cfy_lab_ovs ovs-ofctl dump-flows br2

   Previously installed flows should be removed.

4. Verify connectivity with server

   Try to ping server - use server IP obtained from deployment outputs:

   [HT] ping <server_ip>

   You should receive response from the server. Then try to open HTTP content hosted by server:

   [HT] curl <server_ip>:8080
   [HT] curl <server_ip>:8181

   For 8080 you should see receive notification page with ACCESS DENIED information (traffic filtered by URL filter)

   For 8181 you should see directory list returned by pythons SimpleHTTPServer

Stage 6 - service cleanup

You will remove rest of existing services:

1. Run uninstallation:

   cfy uninstall cfy_lab_service_3

   and then

   cfy uninstall cfy_lab_service_1

2. You may execute some of mentioned before checks. You should have clean chain without services. You should observe the same behaviour like after execution of stage 1 commands.

Stage 7 - chain infrastructure uninstallation

Perform full cleanup - uninstall main infrastructure blueprint deployment:

1. Execute:

   cfy uninstall cfy_lab_infrastructure
   cfy blueprints delete cfy_lab_infrastructure_endpoint
   

2. Using mentioned before commands you should observe that all docker resources created before by Cloudify have been deleted.