call_helm {AzureContainers}

Call the Helm commandline tool

Description

Call the Helm commandline tool

Usage

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

Arguments

cmd

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

config

The pathname of the cluster config file, if required.

...

Other arguments to pass to processx::run.

echo

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

Details

This function calls the helm 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 helm 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.

Value

A list with the following components:

• status: The exit status of the helm tool. If this is NA, then the process was killed and had no exit status.

• stdout: The standard output of the command, in a character scalar.

• stderr: The standard error of the command, in a character scalar.

• timeout: Whether the process was killed because of a timeout.

• cmdline: The command line.

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_kubectl

kubernetes_cluster

Kubectl command line reference