Fix README documentation and typos in BOM file
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-server/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-server/commit/458866ae Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-server/tree/458866ae Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-server/diff/458866ae Branch: refs/heads/master Commit: 458866aeb1d614b1a3fee06c337af3b8dd62936c Parents: 36560bf Author: Andrew Donald Kennedy <[email protected]> Authored: Thu May 25 11:04:29 2017 -0400 Committer: Andrew Donald Kennedy <[email protected]> Committed: Thu May 25 11:04:29 2017 -0400 ---------------------------------------------------------------------- README.md | 95 ++++-------------------------------------------------- container.bom | 4 +-- 2 files changed, 8 insertions(+), 91 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/458866ae/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index fd117b7..3198138 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,8 @@ -# Cloudsoft Container Service +# Brooklyn Container Service -This project contains entities and other items for using Cloudsoft AMP in a -container ecosystem. +This project contains entities and locations that allow Apache Brooklyn to +deploy applications to a container ecosystem. -## Docker Engine - -* `docker-engine` for provisioning a VM with Docker Engine. Normal - `SoftwareProcess` configuration keys apply - -* `docker-engine-container` for provisioning a container on a `docker-engine` - as a child of that node, using the key `container` for the image name at - Docker Hub and optionally using `postLaunchCommand` key for any additional - commands e.g. port-forwards - -Here's an example: - -```YAML -services: - - type: docker-engine - name: "hello-world" - brooklyn.children: - - type: docker-engine-container - container: hello-world -``` - -The implementation is as simple as possible, as you can see in the -[docker.bom](docker.bom) definition of these entities. - -## Docker Swarm - -* `docker-swarm` for provisioning a cluster of VMs with Docker Swarm managed - Docker Engines. - -* `ca-server` provides a simple certificate authority to generate the - required TLS keys. - -Here's an example, creating a Swarm cluster with a single manager node, an -etcd server for discovery, an OpenSSL certificate server, and three Docker -Engine nodes in the cluster. The cluster can be scaled to a maximum of five -nodes, using the default auto-scaling policy. It uses the `docker-swarm` -catalog entry. - -```YAML -services: - - type: docker-swarm - name: "swarm" - brooklyn.config: - swarm.initial.size: 3 - swarm.max.size: 5 - etcd.initial.size: 1 -``` - -This requires the [ca.bom](ca.bom) and [swarm.bom](swarm.bom) definitions to -be loaded in addition to the Docker Engine definitions in [docker.bom](docker.bom). - -To extend the Swarm for high-availability and resilience, simply increase the -size of the manager and etcd clusters and optionally configure the recovery -timeout settings, as shown in the [swarm.yaml](examples/swarm.yaml) snippet -below. - -```YAML -services: - - type: docker-swarm - name: "swarm" - brooklyn.config: - swarm.initial.size: 8 - swarm.max.size: 16 - swarm.manager.size: 3 - etcd.initial.size: 3 - swarm.port: 4000 - swarm.defaultnetwork: "swarm" - swarm.scaling.cpu.limit: 0.80 - swarm.strategy: "binpack" - swarm.overcommit: 0.50 - swarm.recovery.stabilizationDelay: 10s - swarm.recovery.failOnRecurringFailuresInThisDuration: 5m - provisioning.properties: - minRam: 4g - minCores: 2 -``` - -This is configured for a more typical production Swarm cluster, with 8-16 -Docker Engine members, three managers and three etcd servers. An HAProxy load -balancer will also be created, and the `swarm.url` sensor on the root -application entity points to this, which will round-robin across the -available, healthy Swarm managers. - -There are many other configuration options available for the Swarm service, -some of which are also shown in the above blueprint. Further details -can be found in the [swarm.bom](swarm.bom) file or the AMP documentation. +The [container.bom](container.bom) file contains catalog entries that can +be used to define Docker Containers and Kubernetes Pods in application +blueprints. http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/458866ae/container.bom ---------------------------------------------------------------------- diff --git a/container.bom b/container.bom index 58de910..912d6be 100644 --- a/container.bom +++ b/container.bom @@ -131,7 +131,7 @@ brooklyn.catalog: defaultValue: 1 - id: openshift-resource-entity - name: "Kubernetes resource" + name: "OpenShift resource" description: | An easy way to launch an OpenShift resource defined by a YAML file itemType: entity @@ -142,5 +142,5 @@ brooklyn.catalog: - name: resource label: "Resource" description: | - Kubernetes resource YAML file URI + OpenShift resource YAML file URI type: string
