org.apache.brooklyn.container.location.kubernetes

Class KubernetesLocation

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.location.AbstractLocation

org.apache.brooklyn.container.location.kubernetes.KubernetesLocation

All Implemented Interfaces:

Location, MachineProvisioningLocation<KubernetesMachineLocation>, ProvisioningLocation<KubernetesMachineLocation>, Rebindable, BrooklynObject, Configurable, Identifiable, KubernetesLocationConfig, CloudLocationConfig, HasHostGeoInfo, LocationInternal, BrooklynObjectInternal

Direct Known Subclasses:

OpenShiftLocation

public class KubernetesLocation
extends AbstractLocation
implements MachineProvisioningLocation<KubernetesMachineLocation>, KubernetesLocationConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KubernetesLocation.ExitCondition

Nested classes/interfaces inherited from class org.apache.brooklyn.core.location.AbstractLocation

AbstractLocation.BasicSubscriptionSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BROOKLYN_APPLICATION_ID
static java.lang.String	BROOKLYN_ENTITY_ID
static java.lang.String	BROOKLYN_ROOT_PASSWORD The environment variable for injecting login credentials.
static java.util.List<java.lang.String>	IMAGE_DESCRIPTION_REGEXES_REQUIRING_INJECTED_LOGIN_CREDS The regex for the image descriptions that support us injecting login credentials.
static java.lang.String	IMMUTABLE_CONTAINER_KEY
static java.lang.String	KUBERNETES_DOCKERCFG
static java.lang.String	NODE_PORT
static java.lang.String	PHASE_ACTIVE
static java.lang.String	PHASE_AVAILABLE
static java.lang.String	PHASE_TERMINATING
static java.lang.String	SSHABLE_CONTAINER

Fields inherited from class org.apache.brooklyn.core.location.AbstractLocation

PARENT_LOCATION, TEMPORARY_LOCATION

Fields inherited from interface org.apache.brooklyn.container.location.kubernetes.KubernetesLocationConfig

ACTION_TIMEOUT, CA_CERT_DATA, CA_CERT_FILE, CLIENT_CERT_DATA, CLIENT_CERT_FILE, CLIENT_KEY_ALGO, CLIENT_KEY_DATA, CLIENT_KEY_FILE, CLIENT_KEY_PASSPHRASE, CLIENT_TIMEOUT, CREATE_NAMESPACE, DELETE_EMPTY_NAMESPACE, ENV, IMAGE, INJECT_LOGIN_CREDENTIAL, KUBECONFIG, KUBECONFIG_CONTEXT, KUBERNETES_CLIENT_REGISTRY, LOGIN_USER, LOGIN_USER_PASSWORD, MASTER_URL, NAMESPACE, OAUTH_TOKEN, OS_FAMILY, OS_VERSION_REGEX, PRIVILEGED, TRUST_CERTS

Fields inherited from interface org.apache.brooklyn.core.location.cloud.CloudLocationConfig

ACCESS_CREDENTIAL, ACCESS_IDENTITY, ADDITIONAL_INBOUND_PORTS, CALLER_CONTEXT, CLOUD_AVAILABILITY_ZONE_ID, CLOUD_ENDPOINT, CLOUD_REGION_ID, DESTROY_ON_FAILURE, DOMAIN_NAME, EXTENSION, INBOUND_PORTS, LEGACY_PRIVATE_KEY_DATA, LEGACY_PRIVATE_KEY_FILE, LEGACY_PRIVATE_KEY_PASSPHRASE, LEGACY_PUBLIC_KEY_DATA, LEGACY_PUBLIC_KEY_FILE, LOG_CREDENTIALS, MACHINE_LOCATION_CUSTOMIZERS, MIN_CORES, MIN_DISK, MIN_RAM, OAUTH_ENDPOINT, OS_64_BIT, PASSWORD, POLL_FOR_FIRST_REACHABLE_ADDRESS, POLL_FOR_FIRST_REACHABLE_ADDRESS_PREDICATE, POLL_FOR_FIRST_REACHABLE_ADDRESS_PREDICATE_TYPE, PRIVATE_KEY_DATA, PRIVATE_KEY_FILE, PRIVATE_KEY_PASSPHRASE, PUBLIC_KEY_DATA, PUBLIC_KEY_FILE, USER, VM_NAME_ALLOWED_CHARACTERS, VM_NAME_MAX_LENGTH, VM_NAME_SALT_LENGTH, WAIT_FOR_SSHABLE, WAIT_FOR_WINRM_AVAILABLE

Fields inherited from interface org.apache.brooklyn.core.location.internal.LocationInternal

FINAL_SPEC, NAMED_SPEC_NAME, ORIGINAL_SPEC

Constructor Summary

Constructors

Constructor and Description
KubernetesLocation()
KubernetesLocation(java.util.Map<?,?> properties)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getProvisioningFlags(java.util.Collection<java.lang.String> tags) Gets flags, suitable as an argument to MachineProvisioningLocation.obtain(Map).
boolean	implementsInterface(Entity entity, java.lang.Class<?> type)
void	init() Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
<T> T	lookup(ConfigKey<T> config, Entity entity, ConfigBag setup)
<T> T	lookup(ConfigKey<T> config, Entity entity, ConfigBag setup, T defaultValue) Looks up configuration with the entity value taking precedence over the location, and returning a default value (normally null) if neither is present.
MachineProvisioningLocation<KubernetesMachineLocation>	newSubLocation(java.util.Map<?,?> newFlags) Creates a new location of the same type, but with additional creation instructions in the form of flags, e.g.
KubernetesMachineLocation	obtain(java.util.Map<?,?> flags) Obtain a machine in this location.
void	release(KubernetesMachineLocation machine) Release a previously-obtained machine.
void	waitForExitCondition(KubernetesLocation.ExitCondition exitCondition)
void	waitForExitCondition(KubernetesLocation.ExitCondition exitCondition, Duration initial, Duration duration)

Methods inherited from class org.apache.brooklyn.core.location.AbstractLocation

addChild, addExtension, config, configure, containsLocation, equals, getChildren, getConfig, getConfig, getDisplayName, getExtension, getHostGeoInfo, getLocationTypeInternal, getParent, getRebindSupport, hasExtension, hashCode, isManaged, onManagementStarted, onManagementStopped, rebind, relations, removeChild, setDisplayName, setHostGeoInfo, setManagementContext, setParent, setParent, subscriptions, toMetadataRecord, toString, toVerboseString

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, getManagementContext, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId, tags

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.api.location.Location

containsLocation, getChildren, getConfig, getDisplayName, getExtension, getId, getParent, hasExtension, relations, setParent, toVerboseString

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.location.internal.LocationInternal

getManagementContext

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Field Detail

NODE_PORT

public static final java.lang.String NODE_PORT

See Also:

Constant Field Values

IMMUTABLE_CONTAINER_KEY

public static final java.lang.String IMMUTABLE_CONTAINER_KEY

See Also:

Constant Field Values

SSHABLE_CONTAINER

public static final java.lang.String SSHABLE_CONTAINER

See Also:

Constant Field Values

BROOKLYN_ENTITY_ID

public static final java.lang.String BROOKLYN_ENTITY_ID

See Also:

Constant Field Values

BROOKLYN_APPLICATION_ID

public static final java.lang.String BROOKLYN_APPLICATION_ID

See Also:

Constant Field Values

KUBERNETES_DOCKERCFG

public static final java.lang.String KUBERNETES_DOCKERCFG

See Also:

Constant Field Values

PHASE_AVAILABLE

public static final java.lang.String PHASE_AVAILABLE

See Also:

Constant Field Values

PHASE_TERMINATING

public static final java.lang.String PHASE_TERMINATING

See Also:

Constant Field Values

PHASE_ACTIVE

public static final java.lang.String PHASE_ACTIVE

See Also:

Constant Field Values

IMAGE_DESCRIPTION_REGEXES_REQUIRING_INJECTED_LOGIN_CREDS

public static final java.util.List<java.lang.String> IMAGE_DESCRIPTION_REGEXES_REQUIRING_INJECTED_LOGIN_CREDS

The regex for the image descriptions that support us injecting login credentials.

BROOKLYN_ROOT_PASSWORD

public static final java.lang.String BROOKLYN_ROOT_PASSWORD

The environment variable for injecting login credentials.

See Also:

Constant Field Values

Constructor Detail

KubernetesLocation

public KubernetesLocation()

KubernetesLocation

public KubernetesLocation(java.util.Map<?,?> properties)

Method Detail

init

public void init()

Description copied from class: AbstractBrooklynObject

Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.

To preserve backwards compatibility for if the instance is constructed directly, one can call the code below, but that means it will be called after references to this policy have been shared with other entities.

 
 if (isLegacyConstruction()) {
     init();
 }
 
 

Overrides:

init in class AbstractLocation

obtain

public KubernetesMachineLocation obtain(java.util.Map<?,?> flags)
                                 throws NoMachinesAvailableException

Description copied from interface: MachineProvisioningLocation

Obtain a machine in this location.

Specified by:

obtain in interface MachineProvisioningLocation<KubernetesMachineLocation>

Specified by:

obtain in interface ProvisioningLocation<KubernetesMachineLocation>

Parameters:

flags - Details of the desired machine (e.g. image, size, open ports, etc; some flag support is limited to selected providers). "callerContext" can be specified to have custom logging and error messages (useful if starting machines in parallel)

Returns:

a machine that is a child of this location.

Throws:

NoMachinesAvailableException - if there are no machines available in this location (or impls may return null, but that is discouraged)

release

public void release(KubernetesMachineLocation machine)

Description copied from interface: MachineProvisioningLocation

Release a previously-obtained machine.

Specified by:

release in interface MachineProvisioningLocation<KubernetesMachineLocation>

Specified by:

release in interface ProvisioningLocation<KubernetesMachineLocation>

Parameters:

machine - a MachineLocation previously obtained from a call to #obtain()

getProvisioningFlags

public java.util.Map<java.lang.String,java.lang.Object> getProvisioningFlags(java.util.Collection<java.lang.String> tags)

Description copied from interface: MachineProvisioningLocation

Gets flags, suitable as an argument to MachineProvisioningLocation.obtain(Map). The tags provided give hints about the machine required. The provisioning-location could be configured to understand those tags. For example, an AWS-location could be configured to understand that a particular entity type (e.g. "TomcatServer") requires a particular AMI in that region, so would return the required image id.

Specified by:

getProvisioningFlags in interface MachineProvisioningLocation<KubernetesMachineLocation>

Returns:

implementsInterface

public boolean implementsInterface(Entity entity,
                                   java.lang.Class<?> type)

newSubLocation

public MachineProvisioningLocation<KubernetesMachineLocation> newSubLocation(java.util.Map<?,?> newFlags)

Description copied from interface: MachineProvisioningLocation

Creates a new location of the same type, but with additional creation instructions in the form of flags, e.g. for specifying subnets, security groups, etc

Implementers who wish to subclass this provisioning location for additional functionality in a specific cloud can use the relevant implementation of this method as a guide.

Specified by:

newSubLocation in interface MachineProvisioningLocation<KubernetesMachineLocation>

lookup

public <T> T lookup(ConfigKey<T> config,
                    Entity entity,
                    ConfigBag setup)

See Also:

#lookup(ConfigKey, Entity, ConfigBag, Object)}

lookup

public <T> T lookup(ConfigKey<T> config,
                    Entity entity,
                    ConfigBag setup,
                    T defaultValue)

Looks up configuration with the entity value taking precedence over the location, and returning a default value (normally null) if neither is present.

waitForExitCondition

public void waitForExitCondition(KubernetesLocation.ExitCondition exitCondition)

waitForExitCondition

public void waitForExitCondition(KubernetesLocation.ExitCondition exitCondition,
                                 Duration initial,
                                 Duration duration)