docker-class: docker Class uses the

In johndharrison/dockerAPI: R Client for the docker Remote API

Description

docker is a generator object.

Fields

dockerUrl

a string of the docker host url or a httr object of class url

dockerConf

Persistent configuration settings for curl

Methods

buildREST(dUrl = dockerUrl, urlComp, httpMethod, renderDF = data.frame(), pass = c(200L), errors = c(), ...)

Utility function to build RESTful requests.

checkAuth(...)

Get the default username and email:

...:

Additional arguments to pass to httr functions GET, POST etc.

createContainer(contOpt, ...)

Create a container

contOpt:

A object of class "containerOpt". See containerOpt

...:

Additional arguments to pass to httr functions GET, POST etc.

createImage(fromImage, fromSrc = NULL, repo = NULL, tag = NULL, registry = NULL, XRegistryAuth = NULL, ...)

Create an image, either by pulling it from the registry or by importing it.

fromImage:

Name of the image to pull.

fromSrc:

source to import, means stdin

repo:

Repository

tag:

Tag

registry:

Registry

XRegistryAuth:

Base64-encoded AuthConfig object.

...:

Additional arguments to pass to httr functions GET, POST etc.

getContainers(all = TRUE, limit = NULL, since = NULL, before = NULL, size = NULL, ...)

List containers:

all:

1/True/true or 0/False/false, Show all containers. Only running containers are shown by default (i.e., this defaults to false)

limit:

Show limit last created containers, include non-running ones.

since:

Show only containers created since Id, include non-running ones.

before:

Show only containers created before Id, include non-running ones.

size:

1/True/true or 0/False/false, Show the containers sizes

...:

Additional arguments to pass to httr functions GET, POST etc.

getImages(all = FALSE, filters = NULL, ...)

List images:

all:

1/True/true or 0/False/false, Show all images. Only running images are shown by default (i.e., this defaults to false)

filters:

a json encoded value of the filters (a map[string][]string) to process on the images list.

...:

Additional arguments to pass to httr functions GET, POST etc.

info(...)

Display system-wide information:

...:

Additional arguments to pass to httr functions GET, POST etc.

ping(...)

Ping the docker server:

...:

Additional arguments to pass to httr functions GET, POST etc.

searchImages(term, ...)

List images:

term:

Term to search.

...:

Additional arguments to pass to httr functions GET, POST etc.

version(...)

Show the docker version information:

...:

Additional arguments to pass to httr functions GET, POST etc.

Examples

## Not run: 
docker <- docker("http://192.168.59.103:2375") # windows example
docker$getContainers()

# TLS example:
dckr <- docker("https://192.168.59.103:2376")
# Note the location of your certs.
myConfig = httr::config(sslcert = "../../certs/cert.pem"
                   , sslkey = "../../certs/key.pem"
                   , sslversion=1L, ssl.verifypeer = FALSE)
dckr$getContainers(config = myConfig)
dckr$searchImages("rstudio", config = myConfig)

## End(Not run)

johndharrison/dockerAPI documentation built on May 19, 2019, 5:13 p.m.