call_kubectl {AzureContainers}R Documentation

Call the Kubernetes commandline tool, kubectl


Call the Kubernetes commandline tool, kubectl


call_kubectl(cmd = "", config = NULL, ...,
  echo = getOption("azure_containers_tool_echo", TRUE))



The kubectl command line to execute. This should be a vector of individual kubectl arguments, but can also be a single commandline string. See below.


The pathname of the cluster config file, if required.


Other arguments to pass to processx::run.


Whether to echo the output of the command to the console.


This function calls the kubectl binary, which must be located in your search path. AzureContainers will search for the binary at package startup, and print a warning if it is not found.

The kubectl command should be specified as a vector of the individual arguments, which is what processx::run expects. If a single string is passed, for convenience and back-compatibility reasons call_docker_compose will split it into arguments for you. This is prone to error, for example if you are working with pathnames that contain spaces, so it's strongly recommended to pass a vector of arguments as a general practice.


A list with the following components:

The first four components are from processx::run; AzureContainers adds the last to make it easier to construct scripts that can be run outside R.

See Also

processx::run, call_docker, call_helm


Kubectl command line reference


## Not run: 

# without any args, prints the kubectl help screen

# append "--help" to get help for a command
call_kubectl(c("create", "--help"))

# deploy a service from a yaml file
call_kubectl(c("create", "-f", "deployment.yaml"))

# get deployment and service status
call_kubectl(c("get", "deployment"))
call_kubectl(c("get", "service"))

## End(Not run)

[Package AzureContainers version 1.3.2 Index]