Public Member Functions | Public Attributes | List of all members
dockeros.image.DockeROSImage Class Reference

Public Member Functions

def __init__ (self, roscommand, config, dockerfile=None)
 
def build (self)
 
def check_rosdep (self)
 
def logIt (self, logging_fun, it)
 
def make_client (self, ip=None, port=None)
 
def push (self)
 
def replaceDockerfile (self, in_fname, dockerfile_fname)
 
def run (self)
 
def stop (self)
 

Public Attributes

 deb_package
 
 docker_client
 
 dockerfile
 
 dockeros_path
 
 image
 
 name
 
 path
 
 registry_string
 
 roscommand
 
 rospackage
 
 tag
 
 user_package
 

Detailed Description

    Remotely deploys a docker container with a user specified image of a
    rospackage

    Example:
        >>> import image
        >>> obj = image.DockeROSImage(roscommand, config)
        >>> obj.make_client()
        >>> obj.build()
        >>> obj.run()

Definition at line 22 of file image.py.

Constructor & Destructor Documentation

def dockeros.image.DockeROSImage.__init__ (   self,
  roscommand,
  config,
  dockerfile = None 
)
    Initilizes the commands with the rospkg configuration and roscommands allowed in this context
    Args:
roscommand: any of suppoorted roscommands (rosrun/roslaunch)
config: configuraion for rospkg and connection to docker host

Definition at line 35 of file image.py.

Member Function Documentation

def dockeros.image.DockeROSImage.build (   self)
Compiles a baseDocker image with specific image of a rospackage

Definition at line 164 of file image.py.

def dockeros.image.DockeROSImage.check_rosdep (   self)
Checking system dependencies required by ROS packages

Definition at line 121 of file image.py.

def dockeros.image.DockeROSImage.logIt (   self,
  logging_fun,
  it 
)

Definition at line 159 of file image.py.

def dockeros.image.DockeROSImage.make_client (   self,
  ip = None,
  port = None 
)
Initialize a docker client either using local or remote docker deamon.
When you give no parameters, the local enviornment is used.
So either your local deamon or the one defined in the DOCKER_HOST environment variable.(see https://dockr.ly/2zMPc17 for details)
(see https://dockr.ly/2zMPc17 for details)
Args:
    ip: ip or host of the remote deamon (give None to use local environment)
    port: port of the remote deamon

Definition at line 240 of file image.py.

def dockeros.image.DockeROSImage.push (   self)
Push the image to a registry defined in the config

Definition at line 228 of file image.py.

def dockeros.image.DockeROSImage.replaceDockerfile (   self,
  in_fname,
  dockerfile_fname 
)

Definition at line 132 of file image.py.

def dockeros.image.DockeROSImage.run (   self)
Run the Image on Host

Definition at line 199 of file image.py.

def dockeros.image.DockeROSImage.stop (   self)
Stop the container

Definition at line 211 of file image.py.

Member Data Documentation

dockeros.image.DockeROSImage.deb_package

Definition at line 130 of file image.py.

dockeros.image.DockeROSImage.docker_client

Definition at line 251 of file image.py.

dockeros.image.DockeROSImage.dockerfile

Definition at line 84 of file image.py.

dockeros.image.DockeROSImage.dockeros_path

Definition at line 61 of file image.py.

dockeros.image.DockeROSImage.image

Definition at line 119 of file image.py.

dockeros.image.DockeROSImage.name

Definition at line 113 of file image.py.

dockeros.image.DockeROSImage.path

Definition at line 63 of file image.py.

dockeros.image.DockeROSImage.registry_string

Definition at line 108 of file image.py.

dockeros.image.DockeROSImage.roscommand

Definition at line 49 of file image.py.

dockeros.image.DockeROSImage.rospackage

Definition at line 52 of file image.py.

dockeros.image.DockeROSImage.tag

Definition at line 114 of file image.py.

dockeros.image.DockeROSImage.user_package

Definition at line 72 of file image.py.


The documentation for this class was generated from the following file:


dockeros
Author(s):
autogenerated on Mon Dec 9 2019 21:17:31