brooklyn.entity.container.DockerUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of brooklyn-clocker-docker Show documentation
Show all versions of brooklyn-clocker-docker Show documentation
Clocker Brooklyn entities and locations for Docker integration.
/*
* Copyright 2014-2015 by Cloudsoft Corporation Limited
*
* Licensed 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 brooklyn.entity.container;
import java.util.List;
import java.util.Locale;
import java.util.Set;
import javax.annotation.Nullable;
import brooklyn.entity.Entity;
import brooklyn.entity.basic.SoftwareProcess;
import brooklyn.entity.container.docker.DockerHost;
import brooklyn.entity.container.docker.DockerInfrastructure;
import brooklyn.entity.database.DatastoreMixins;
import brooklyn.entity.messaging.MessageBroker;
import brooklyn.entity.nosql.couchbase.CouchbaseCluster;
import brooklyn.entity.nosql.couchbase.CouchbaseNode;
import brooklyn.entity.webapp.WebAppServiceConstants;
import brooklyn.event.AttributeSensor;
import brooklyn.event.basic.PortAttributeSensorAndConfigKey;
import brooklyn.event.basic.Sensors;
import brooklyn.location.Location;
import brooklyn.location.LocationDefinition;
import brooklyn.location.docker.DockerContainerLocation;
import brooklyn.management.ManagementContext;
import brooklyn.networking.sdn.SdnAttributes;
import brooklyn.util.text.Identifiers;
import brooklyn.util.text.Strings;
import com.google.common.base.CharMatcher;
import com.google.common.base.Charsets;
import com.google.common.base.Function;
import com.google.common.base.Joiner;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.hash.Hashing;
public class DockerUtils {
/** Do not instantiate. */
private DockerUtils() { }
/*
* Configuration and constants.
*/
public static final String DOCKERFILE = "Dockerfile";
public static final String MAPPED = "mapped";
public static final String ENDPOINT = "endpoint";
public static final String PORT = "port";
public static final Set URL_SENSOR_NAMES = ImmutableSet.of(
WebAppServiceConstants.ROOT_URL.getName(),
DatastoreMixins.DATASTORE_URL.getName(),
CouchbaseNode.COUCHBASE_WEB_ADMIN_URL.getName(),
MessageBroker.BROKER_URL.getName());
public static final Set BLACKLIST_URL_SENSOR_NAMES = ImmutableSet.of(
SoftwareProcess.DOWNLOAD_URL.getName(),
CouchbaseCluster.COUCHBASE_CLUSTER_CONNECTION_URL.getName());
public static final String DEFAULT_DOCKER_CONTAINER_NAME_FORMAT = "docker-container-brooklyn-%1$s";
public static final String DEFAULT_DOCKER_HOST_NAME_FORMAT = "docker-host-brooklyn-%1$s";
public static final String UBUNTU_DOCKERFILE = "classpath://brooklyn/entity/container/docker/ubuntu/Dockerfile";
public static final String UBUNTU_NETWORKING_DOCKERFILE = "classpath://brooklyn/entity/container/docker/ubuntu/NetworkingDockerfile";
public static final String UBUNTU_USES_JAVA_DOCKERFILE = "classpath://brooklyn/entity/container/docker/ubuntu/UsesJavaDockerfile";
public static final String CENTOS_DOCKERFILE = "classpath://brooklyn/entity/container/docker/centos/Dockerfile";
public static final String COREOS_DOCKERFILE = "classpath://brooklyn/entity/container/docker/coreos/Dockerfile";
public static final String SSHD_DOCKERFILE = "classpath://brooklyn/entity/container/docker/SshdDockerfile";
/** Valid characters for the Dockerfile location. */
public static final CharMatcher DOCKERFILE_CHARACTERS = CharMatcher.anyOf("_")
.or(CharMatcher.inRange('a', 'z'))
.or(CharMatcher.inRange('0', '9'));
/** Invalid characters for the Dockerfile location. */
public static final CharMatcher DOCKERFILE_INVALID_CHARACTERS = DOCKERFILE_CHARACTERS.negate();
public static AttributeSensor mappedSensor(AttributeSensor source) {
return (AttributeSensor) Sensors.newSensorWithPrefix(MAPPED + ".", source);
}
public static AttributeSensor mappedPortSensor(PortAttributeSensorAndConfigKey source) {
return Sensors.newStringSensor(MAPPED + "." + source.getName(), source.getDescription() + " (Docker mapping)");
}
public static AttributeSensor endpointSensor(PortAttributeSensorAndConfigKey source) {
List name = Lists.transform(source.getNameParts(), new Function() {
@Override
public String apply(@Nullable String input) {
String target = PORT;
if (input.equals(target)) return ENDPOINT;
if (input.endsWith(target)) {
return input.replace(target, ENDPOINT);
}
target = Strings.toInitialCapOnly(PORT);
if (input.endsWith(target)) {
return input.replace(target, Strings.toInitialCapOnly(ENDPOINT));
}
return input;
}
});
if (!name.contains(ENDPOINT)) name.add(ENDPOINT);
return Sensors.newStringSensor(Joiner.on(".").join(name), source.getDescription() + " (Docker mapping)");
}
/**
* Transforms the input to contain only valid characters.
*
* @see #ALLOWED
* @see #DOCKERFILE_CHARACTERS
*/
public static String allowed(String input) {
return ALLOWED.apply(input);
}
public static final Function ALLOWED = new Function() {
@Override
public String apply(@Nullable String input) {
if (input == null) return null;
return DOCKERFILE_INVALID_CHARACTERS.collapseFrom(input.toLowerCase(Locale.ENGLISH), '_');
}
};
/** Parse and return the ID returned from a Docker command. */
public static String checkId(String input) {
String imageId = Strings.trim(input).toLowerCase(Locale.ENGLISH);
if (imageId.length() == 64 && DOCKERFILE_CHARACTERS.matchesAllOf(imageId)) {
return imageId;
} else {
throw new IllegalStateException("Invalid image ID returned: " + imageId);
}
}
public static String imageName(Entity entity, String dockerfile) {
String simpleName = entity.getEntityType().getSimpleName();
String version = entity.config().get(SoftwareProcess.SUGGESTED_VERSION);
String label = Joiner.on(":").skipNulls().join(simpleName, version, dockerfile);
return Identifiers.makeIdFromHash(Hashing.md5().hashString(label, Charsets.UTF_8).asLong()).toLowerCase(Locale.ENGLISH);
}
public static boolean isSdnProvider(Entity dockerHost, String providerName) {
if (dockerHost.config().get(SdnAttributes.SDN_ENABLE)) {
Entity sdn = dockerHost.getAttribute(DockerHost.DOCKER_INFRASTRUCTURE).getAttribute(DockerInfrastructure.SDN_PROVIDER);
if (sdn == null) return false;
return sdn.getEntityType().getSimpleName().equalsIgnoreCase(providerName);
} else return false;
}
public static final Predicate sameInfrastructure(Entity entity) {
Preconditions.checkNotNull(entity, "entity");
return new SameInfrastructurePredicate(entity.getId());
}
public static class SameInfrastructurePredicate implements Predicate {
private final String id;
public SameInfrastructurePredicate(String id) {
this.id = Preconditions.checkNotNull(id, "id");
}
@Override
public boolean apply(@Nullable Entity input) {
// Check if entity is deployed to a DockerContainerLocation
Optional lookup = Iterables.tryFind(input.getLocations(), Predicates.instanceOf(DockerContainerLocation.class));
if (lookup.isPresent()) {
DockerContainerLocation container = (DockerContainerLocation) lookup.get();
// Only containers that are part of this infrastructure
return id.equals(container.getOwner().getDockerHost().getInfrastructure().getId());
} else {
return false;
}
}
};
public static final ManagementContext.PropertiesReloadListener reloadLocationListener(ManagementContext context, LocationDefinition definition) {
return new ReloadDockerLocation(context, definition);
}
public static class ReloadDockerLocation implements ManagementContext.PropertiesReloadListener {
private final ManagementContext context;
private final LocationDefinition definition;
public ReloadDockerLocation(ManagementContext context, LocationDefinition definition) {
this.context = Preconditions.checkNotNull(context, "context");
this.definition = Preconditions.checkNotNull(definition, "definition");
}
@Override
public void reloaded() {
Location resolved = context.getLocationRegistry().resolve(definition);
context.getLocationRegistry().updateDefinedLocation(definition);
context.getLocationManager().manage(resolved);
}
};
}