brooklyn.location.docker.strategy.DockerAwarePlacementStrategy 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

Clocker Brooklyn entities and locations for Docker integration.

There is a newer version: 1.2.0

Show newest version

/*
 * 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.location.docker.strategy;

import java.util.List;

import brooklyn.config.ConfigKey;
import brooklyn.entity.Entity;
import brooklyn.entity.container.docker.DockerInfrastructure;
import brooklyn.location.docker.DockerHostLocation;
import brooklyn.location.docker.DockerVirtualLocation;
import brooklyn.util.flags.SetFromFlag;

/**
 * Placement strategy for Docker containers in host clusters.
 */
public interface DockerAwarePlacementStrategy {

    @SetFromFlag("infrastructure")
    ConfigKey DOCKER_INFRASTRUCTURE = DockerVirtualLocation.INFRASTRUCTURE;

    DockerInfrastructure getDockerInfrastructure();

    /**
     * Filters a list of {@link DockerHostLocation locations} to determine if the given {@link Entity} can be
     * deployed into a new container there.
     */
    List filterLocations(List locations, Entity context);

}