libcloud.container package

Subpackages

• libcloud.container.drivers package
  • Submodules
  • libcloud.container.drivers.docker module
    • DockerConnection
      • DockerConnection.add_default_headers()
      • DockerConnection.responseCls
      • DockerConnection.timeout
    • DockerContainerDriver
      • DockerContainerDriver.connectionCls
      • DockerContainerDriver.deploy_container()
      • DockerContainerDriver.destroy_container()
      • DockerContainerDriver.ex_delete_image()
      • DockerContainerDriver.ex_get_logs()
      • DockerContainerDriver.ex_list_processes()
      • DockerContainerDriver.ex_rename_container()
      • DockerContainerDriver.ex_search_images()
      • DockerContainerDriver.get_container()
      • DockerContainerDriver.install_image()
      • DockerContainerDriver.list_containers()
      • DockerContainerDriver.list_images()
      • DockerContainerDriver.name
      • DockerContainerDriver.restart_container()
      • DockerContainerDriver.start_container()
      • DockerContainerDriver.stop_container()
      • DockerContainerDriver.supports_clusters
      • DockerContainerDriver.type
      • DockerContainerDriver.version
      • DockerContainerDriver.website
    • DockerException
    • DockerResponse
      • DockerResponse.parse_body()
      • DockerResponse.parse_error()
      • DockerResponse.success()
      • DockerResponse.valid_response_codes
    • DockertlsConnection
      • DockertlsConnection.add_default_headers()
      • DockertlsConnection.responseCls
    • ts_to_str()
  • libcloud.container.drivers.dummy module
    • DummyContainerDriver
      • DummyContainerDriver.name
      • DummyContainerDriver.supports_clusters
      • DummyContainerDriver.website
  • libcloud.container.drivers.ecs module
    • ElasticContainerDriver
      • ElasticContainerDriver.connectionCls
      • ElasticContainerDriver.create_cluster()
      • ElasticContainerDriver.deploy_container()
      • ElasticContainerDriver.destroy_cluster()
      • ElasticContainerDriver.destroy_container()
      • ElasticContainerDriver.ecrConnectionClass
      • ElasticContainerDriver.ecr_repository_host
      • ElasticContainerDriver.ex_create_service()
      • ElasticContainerDriver.ex_describe_service()
      • ElasticContainerDriver.ex_destroy_service()
      • ElasticContainerDriver.ex_get_registry_client()
      • ElasticContainerDriver.ex_get_repository_id()
      • ElasticContainerDriver.ex_get_repository_token()
      • ElasticContainerDriver.ex_list_containers_for_task()
      • ElasticContainerDriver.ex_list_service_arns()
      • ElasticContainerDriver.ex_start_task()
      • ElasticContainerDriver.get_container()
      • ElasticContainerDriver.list_clusters()
      • ElasticContainerDriver.list_containers()
      • ElasticContainerDriver.list_images()
      • ElasticContainerDriver.name
      • ElasticContainerDriver.restart_container()
      • ElasticContainerDriver.start_container()
      • ElasticContainerDriver.status_map
      • ElasticContainerDriver.stop_container()
      • ElasticContainerDriver.supports_clusters
      • ElasticContainerDriver.website
  • libcloud.container.drivers.gke module
    • GKEConnection
      • GKEConnection.host
      • GKEConnection.pre_connect_hook()
      • GKEConnection.request()
      • GKEConnection.responseCls
    • GKEContainerDriver
      • GKEContainerDriver.AUTH_URL
      • GKEContainerDriver.api_name
      • GKEContainerDriver.connectionCls
      • GKEContainerDriver.get_server_config()
      • GKEContainerDriver.list_clusters()
      • GKEContainerDriver.name
      • GKEContainerDriver.supports_clusters
      • GKEContainerDriver.type
      • GKEContainerDriver.website
    • GKEResponse
  • libcloud.container.drivers.kubernetes module
    • KubernetesContainerDriver
      • KubernetesContainerDriver.connectionCls
      • KubernetesContainerDriver.create_namespace()
      • KubernetesContainerDriver.delete_namespace()
      • KubernetesContainerDriver.deploy_container()
      • KubernetesContainerDriver.destroy_container()
      • KubernetesContainerDriver.ex_destroy_node()
      • KubernetesContainerDriver.ex_destroy_pod()
      • KubernetesContainerDriver.ex_get_version()
      • KubernetesContainerDriver.ex_list_deployments()
      • KubernetesContainerDriver.ex_list_nodes()
      • KubernetesContainerDriver.ex_list_nodes_metrics()
      • KubernetesContainerDriver.ex_list_pods()
      • KubernetesContainerDriver.ex_list_pods_metrics()
      • KubernetesContainerDriver.ex_list_services()
      • KubernetesContainerDriver.get_container()
      • KubernetesContainerDriver.get_namespace()
      • KubernetesContainerDriver.list_containers()
      • KubernetesContainerDriver.list_namespaces()
      • KubernetesContainerDriver.name
      • KubernetesContainerDriver.supports_clusters
      • KubernetesContainerDriver.type
      • KubernetesContainerDriver.website
    • to_cpu_str()
    • to_memory_str()
    • to_n_bytes()
    • to_n_cpus()
  • libcloud.container.drivers.lxd module
    • LXDAPIException
    • LXDConnection
      • LXDConnection.add_default_headers()
      • LXDConnection.responseCls
      • LXDConnection.timeout
    • LXDContainerDriver
      • LXDContainerDriver.attach_volume()
      • LXDContainerDriver.build_operation_websocket_url()
      • LXDContainerDriver.connectionCls
      • LXDContainerDriver.create_volume()
      • LXDContainerDriver.default_architecture
      • LXDContainerDriver.default_ephemeral
      • LXDContainerDriver.default_profiles
      • LXDContainerDriver.default_time_out
      • LXDContainerDriver.deploy_container()
      • LXDContainerDriver.destroy_container()
      • LXDContainerDriver.ex_create_network()
      • LXDContainerDriver.ex_create_storage_pool()
      • LXDContainerDriver.ex_delete_network()
      • LXDContainerDriver.ex_delete_storage_pool()
      • LXDContainerDriver.ex_delete_storage_pool_volume()
      • LXDContainerDriver.ex_execute_cmd_on_container()
      • LXDContainerDriver.ex_freeze_container()
      • LXDContainerDriver.ex_get_api_endpoints()
      • LXDContainerDriver.ex_get_image()
      • LXDContainerDriver.ex_get_network()
      • LXDContainerDriver.ex_get_server_configuration()
      • LXDContainerDriver.ex_get_storage_pool()
      • LXDContainerDriver.ex_get_storage_pool_volume()
      • LXDContainerDriver.ex_get_volume_by_name()
      • LXDContainerDriver.ex_has_image()
      • LXDContainerDriver.ex_list_networks()
      • LXDContainerDriver.ex_list_storage_pool_volumes()
      • LXDContainerDriver.ex_list_storage_pools()
      • LXDContainerDriver.ex_replace_storage_volume_config()
      • LXDContainerDriver.ex_unfreeze_container()
      • LXDContainerDriver.get_container()
      • LXDContainerDriver.install_image()
      • LXDContainerDriver.list_containers()
      • LXDContainerDriver.list_images()
      • LXDContainerDriver.name
      • LXDContainerDriver.restart_container()
      • LXDContainerDriver.start_container()
      • LXDContainerDriver.stop_container()
      • LXDContainerDriver.supports_clusters
      • LXDContainerDriver.type
      • LXDContainerDriver.version
      • LXDContainerDriver.website
    • LXDContainerExecuteResult
      • LXDContainerExecuteResult.control
      • LXDContainerExecuteResult.output
      • LXDContainerExecuteResult.result
      • LXDContainerExecuteResult.secret_0
      • LXDContainerExecuteResult.secret_1
      • LXDContainerExecuteResult.secret_2
      • LXDContainerExecuteResult.uuid
    • LXDNetwork
      • LXDNetwork.build_from_response()
    • LXDResponse
      • LXDResponse.parse_body()
      • LXDResponse.parse_error()
      • LXDResponse.success()
      • LXDResponse.valid_response_codes
    • LXDServerInfo
      • LXDServerInfo.build_from_response()
    • LXDStoragePool
    • LXDtlsConnection
      • LXDtlsConnection.add_default_headers()
      • LXDtlsConnection.responseCls
    • assert_response()
    • check_certificates()
    • strip_http_prefix()
  • libcloud.container.drivers.rancher module
    • RancherConnection
      • RancherConnection.add_default_headers()
      • RancherConnection.responseCls
      • RancherConnection.timeout
    • RancherContainerDriver
      • RancherContainerDriver.connectionCls
      • RancherContainerDriver.deploy_container()
      • RancherContainerDriver.destroy_container()
      • RancherContainerDriver.ex_activate_service()
      • RancherContainerDriver.ex_activate_stack()
      • RancherContainerDriver.ex_deactivate_service()
      • RancherContainerDriver.ex_deactivate_stack()
      • RancherContainerDriver.ex_deploy_service()
      • RancherContainerDriver.ex_deploy_stack()
      • RancherContainerDriver.ex_destroy_service()
      • RancherContainerDriver.ex_destroy_stack()
      • RancherContainerDriver.ex_get_service()
      • RancherContainerDriver.ex_get_stack()
      • RancherContainerDriver.ex_list_services()
      • RancherContainerDriver.ex_list_stacks()
      • RancherContainerDriver.ex_search_containers()
      • RancherContainerDriver.ex_search_services()
      • RancherContainerDriver.ex_search_stacks()
      • RancherContainerDriver.get_container()
      • RancherContainerDriver.list_containers()
      • RancherContainerDriver.name
      • RancherContainerDriver.start_container()
      • RancherContainerDriver.stop_container()
      • RancherContainerDriver.supports_clusters
      • RancherContainerDriver.type
      • RancherContainerDriver.version
      • RancherContainerDriver.website
    • RancherException
    • RancherResponse
      • RancherResponse.parse_error()
      • RancherResponse.success()
  • Module contents
• libcloud.container.utils package
  • Submodules
  • libcloud.container.utils.docker module
    • HubClient
      • HubClient.host
    • RegistryClient
      • RegistryClient.connectionCls
      • RegistryClient.get_image()
      • RegistryClient.get_repository()
      • RegistryClient.list_images()
  • Module contents

Submodules

libcloud.container.base module

class libcloud.container.base.ClusterLocation(id, name, country, driver)

Bases: object

A physical location where clusters can be.

>>> from libcloud.container.drivers.dummy import DummyContainerDriver
>>> driver = DummyContainerDriver(0)
>>> location = driver.list_locations()[0]
>>> location.country
'US'

Parameters:

• id (str) – Location ID.

• name (str) – Location name.

• country (str) – Location country.

• driver (ContainerDriver) – Driver this location belongs to.

class libcloud.container.base.Container(id, name, image, state, ip_addresses, driver, extra=None, created_at=None)

Bases: object

Container.

Parameters:

• id (str) – Container id.

• name (str) – The name of the container.

• image (ContainerImage) – The image this container was deployed using.

• state (libcloud.container.types.ContainerState) – The state of the container, e.g. running

• ip_addresses (list of str) – A list of IP addresses for this container

• driver (ContainerDriver) – ContainerDriver instance.

• extra (dict) – (optional) Extra attributes (driver specific).

destroy() → bool

restart() → Container

start() → Container

stop() → Container

class libcloud.container.base.ContainerCluster(id, name, driver, extra=None)

Bases: object

A cluster group for containers

Parameters:

• id (str) – Container Image id.

• name (str) – The name of the image.

• driver (ContainerDriver) – ContainerDriver instance.

• extra (dict) – (optional) Extra attributes (driver specific).

destroy() → bool

list_containers() → List[Container]

class libcloud.container.base.ContainerDriver(key, secret=None, secure=True, host=None, port=None, **kwargs)

Bases: BaseDriver

A base ContainerDriver class to derive from

This class is always subclassed by a specific driver.

Parameters:

• key (str) – API key or username to used (required)

• secret (str) – Secret password to be used (required)

• secure (bool) – Whether to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default.

• host (str) – Override hostname used for connections.

• port (int) – Override port used for connections.

Returns:

None

connectionCls

alias of ConnectionUserAndKey

create_cluster(name: str, location: ClusterLocation | None = None) → ContainerCluster

Create a container cluster

Parameters:

• name (str) – The name of the cluster

• location (ClusterLocation) – The location to create the cluster in

Return type:

ContainerCluster

deploy_container(name: str, image: ContainerImage, cluster: ContainerCluster | None = None, parameters: str | None = None, start: bool = True) → Container

Deploy an installed container image

Parameters:

• name (str) – The name of the new container

• image (ContainerImage) – The container image to deploy

• cluster (ContainerCluster) – The cluster to deploy to, None is default

• parameters (str) – Container Image parameters

• start (bool) – Start the container on deployment

Return type:

Container

destroy_cluster(cluster: ContainerCluster) → bool

Delete a cluster

Returns:

True if the destroy was successful, otherwise False.

Return type:

bool

destroy_container(container: Container) → bool

Destroy a deployed container

Parameters:

container (Container) – The container to destroy

Return type:

bool

get_cluster(id: str) → ContainerCluster

Get a cluster by ID

Parameters:

id (str) – The ID of the cluster to get

Return type:

ContainerCluster

get_container(id: str) → Container

Get a container by ID

Parameters:

id (str) – The ID of the container to get

Return type:

Container

install_image(path: str) → ContainerImage

Install a container image from a remote path.

Parameters:

path (str) – Path to the container image

Return type:

ContainerImage

list_clusters(location: ClusterLocation | None = None) → List[ContainerCluster]

Get a list of potential locations to deploy clusters into

Parameters:

location (ClusterLocation) – The location to search in

Return type:

list of ContainerCluster

list_containers(image: ContainerImage | None = None, cluster: ContainerCluster | None = None) → List[Container]

List the deployed container images

Parameters:

• image (ContainerImage) – Filter to containers with a certain image

• cluster (ContainerCluster) – Filter to containers in a cluster

Return type:

list of Container

list_images() → List[ContainerImage]

List the installed container images

Return type:

list of ContainerImage

list_locations() → List[ClusterLocation]

Get a list of potential locations to deploy clusters into

Return type:

list of ClusterLocation

name = None

restart_container(container: Container) → Container

Restart a deployed container

Parameters:

container (Container) – The container to restart

Return type:

Container

start_container(container: Container) → Container

Start a deployed container

Parameters:

container (Container) – The container to start

Return type:

Container

stop_container(container: Container) → Container

Stop a deployed container

Parameters:

container (Container) – The container to stop

Return type:

Container

supports_clusters = False

Whether the driver supports containers being deployed into clusters

website = None

class libcloud.container.base.ContainerImage(id, name, path, version, driver, extra=None)

Bases: object

Container Image.

Parameters:

• id (str) – Container Image id.

• name (str) – The name of the image.

• path (str) – The path to the image

• version (str) – The version of the image

• driver (ContainerDriver) – ContainerDriver instance.

• extra (dict) – (optional) Extra attributes (driver specific).

deploy(name: str, parameters: str, cluster: ContainerCluster | None = None, start: bool = True) → Container

libcloud.container.providers module

libcloud.container.providers.get_driver(provider: Provider | str) → Type[ContainerDriver]

libcloud.container.providers.set_driver(provider: Provider | str, module: ModuleType, klass: type) → Type[ContainerDriver]

libcloud.container.types module

class libcloud.container.types.ContainerState

Bases: Type

Standard states for a container

Variables:

• RUNNING – Container is running.

• REBOOTING – Container is rebooting.

• TERMINATED – Container is terminated. This container can’t be started later on.

• STOPPED – Container is stopped. This container can be started later on.

• PENDING – Container is pending.

• SUSPENDED – Container is suspended.

• ERROR – Container is an error state. Usually no operations can be performed on the container once it ends up in the error state.

• PAUSED – Container is paused.

• UNKNOWN – Container state is unknown.

ERROR = 'error'

PAUSED = 'paused'

PENDING = 'pending'

REBOOTING = 'rebooting'

RUNNING = 'running'

STOPPED = 'stopped'

SUSPENDED = 'suspended'

TERMINATED = 'terminated'

UNKNOWN = 'unknown'

class libcloud.container.types.Provider

Bases: object

Defines for each of the supported providers

Non-Dummy drivers are sorted in alphabetical order. Please preserve this ordering when adding new drivers.

DOCKER = 'docker'

DUMMY = 'dummy'

ECS = 'ecs'

GKE = 'GKE'

KUBERNETES = 'kubernetes'

LXD = 'lxd'

RANCHER = 'rancher'

Module contents