README.md

Clocker

The current release is 2.0.0, available in Maven Central. For more information, see the official Clocker site, including documentation and tutorials.

The development version is 2.1.0-SNAPSHOT, available in the Sonatype Open-Source repository. To install this, follow the instructions below.

Overview

Clocker for Apache Brooklyn is a set of open source, Apache Licensed tools designed to make working with Docker containers as simple as a few clicks. Clocker contains Brooklyn blueprints to enable deployment and management of Docker Swarm and Kubernetes clusters.

You will find the source code for the blueprints in this repository.

• Docker
• Swarm
• Kubernetes

Getting Started

Add Clocker to Brooklyn (Karaf Edition)

Add catalog entries using the YAML below:

brooklyn.catalog:
  brooklyn.libraries:
    - "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=io.brooklyn.etcd&a=brooklyn-etcd&v=2.7.0-SNAPSHOT"
    - "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=io.brooklyn.clocker&a=clocker-common&v=2.1.0-SNAPSHOT"
    - "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=io.brooklyn.clocker&a=clocker-swarm&v=2.1.0-SNAPSHOT"
    - "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=io.brooklyn.clocker&a=clocker-kubernetes&v=2.1.0-SNAPSHOT"
  items:
    - classpath://io.brooklyn.clocker.swarm:swarm/catalog.bom
    - classpath://io.brooklyn.clocker.kubernetes:kubernetes/catalog.bom

Add Clocker to Brooklyn (Classic Edition)

You must add the following JARs to ./lib/dropins:

• brooklyn-etcd
• common
• swarm
• kubernetes

Then add the catalog entries using the following YAML:

brooklyn.catalog:
  items:
    - classpath://swarm/catalog.bom
    - classpath://kubernetes/catalog.bom

Copyright

The following icon images have been used, and their use here is believed to be acceptable under their licensing terms or fair use doctrine. The source URLs and other links given contain more details:

• common/resources/icons/centos.png Remixed version of freely available logo
• common/resources/icons/docker.png Icon taken from media kit
• common/resources/icons/haproxy.png Fair use of logo from Twitter account for open source project
• common/resources/icons/openssl.png Public domain image
• swarm/resources/icons/swarm.png Fair use of image from https://www.docker.com/products/docker-swarm and also found in Docker media kit
• kubernetes/resources/icons/calico.png APACHE 2.0 https://github.com/projectcalico/calico/blob/master/LICENSE image
• kubernetes/resources/icons/flannel.png APACHE 2.0 https://github.com/coreos/flannel/blob/master/LICENSE image
• kubernetes/resources/icons/kubernetes.png APACHE 2.0 https://github.com/kubernetes/kubernetes/blob/master/LICENSE image
• kubernetes/resources/icons/prometheus.png APACHE 2.0 https://github.com/prometheus/docs/blob/master/LICENSE image
• kubernetes/resources/icons/openshift.png APACHE 2.0 https://github.com/openshift/origin-web-console/blob/master/LICENSE image