org.apache.brooklyn.container.entity.docker.DockerContainer Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.brooklyn.container.entity.docker;
import org.apache.brooklyn.api.entity.ImplementedBy;
import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.config.BasicConfigInheritance;
import org.apache.brooklyn.core.config.ConfigKeys;
import org.apache.brooklyn.core.config.MapConfigKey;
import org.apache.brooklyn.entity.software.base.SoftwareProcess;
import com.google.common.collect.ImmutableMap;
import com.google.common.reflect.TypeToken;
/**
* The DockerContainer type is for easily deploying any docker image from the
* image repository set on the target swarm or docker-engine based location
*
* Example YAML is shown below. Note the different types of the {@code env}
* key in the location config and the {@code docker.container.environment}
* key on the entity. The entity environment variables will override any
* environment configured on the location. To specify environment variables
* that will be set when executing SSH commands against the container you
* should use the {@link SoftwareProcess#SHELL_ENVIRONMENT shell.env} key.
*
*
{@code location:
* docker:
* endpoint: "https://52.29.59.193:3376"
* identity: "~/.certs/cert.pem"
* credential: "~/.certs/key.pem"
* templateOptions:
* networkMode: "brooklyn"
* env:
* - "HTTP_CONFIG_ROOT=/var/httpd"
* - "USE_DEFAULTS=true"
* services:
* - type: org.apache.brooklyn.container.entity.docker.DockerContainer
* brooklyn.config:
* docker.container.imageName: "apache/httpd:latest"
* docker.container.disableSsh: true
* docker.container.inboundPorts:
* - "8080-8081"
* docker.container.environment:
* ENABLE_JMX: false
* ENABLE_SHUTDOWN: false
* }
*/
@ImplementedBy(DockerContainerImpl.class)
public interface DockerContainer extends SoftwareProcess {
ConfigKey DISABLE_SSH =
ConfigKeys.newBooleanConfigKey(
"docker.container.disableSsh",
"Skip checks such as ssh for when docker image doesn't allow ssh",
Boolean.TRUE);
ConfigKey IMAGE_NAME =
ConfigKeys.newStringConfigKey(
"docker.container.imageName",
"Image name to pull from docker hub");
@SuppressWarnings("serial")
ConfigKey> INBOUND_TCP_PORTS =
ConfigKeys.newConfigKey(
new TypeToken>() {
},
"docker.container.inboundPorts",
"List of ports, that the docker image opens, to be made public");
MapConfigKey