STEP

Run kubectl command

This Kubectl step container allows general kubectl use and can take kubectl commands.

Specification

cluster

Required

object
A map of configuration and credentials for accessing a Kubernetes cluster.
cluster.name

Required

string
A name for the Kubernetes cluster. Used for referencing it via kubectl contexts.
cluster.connection

Required

A Relay Kubernetes connection to useConnection docs
!Connection {type: kubernetes, name: my-kubernetes-connection}
command

Required

string
The command to pass to kubectl. For example, `apply`.
args
Optional
string
A string of arguments for commands other than `apply`.
file
Optional
string
A resource file to use when command is `apply`.
namespace
Optional
string
The namespace to run the command under.
git
Optional
object
A map of git configuration. If you're using HTTPS, only name and repository are required.
git.ssh_key

Required

string
The SSH key to use when cloning the git repository. You can pass the key to Relay as a secret. See the example below.
git.known_hosts
Optional
string
SSH known hosts file. Use a Relay secret to pass the contents of the file into the workflow as a base64-encoded string. See the example below.
git.name

Required

string
A directory name for the git clone.
git.branch
Optional
string
The Git branch to clone.
git.repository

Required

string
The git repository URL.

Integrations in this step

Install the Relay CLI

Relay CLI is an essential companion for authoring and managing workflows. You can install it with a package manager or download it.
brew install puppetlabs/puppet/relay
Learn more about setting up Relay.

How to contribute

We’re excited to see and share in our community’s creation. Take a look at our community overview to learn how to begin contributing to Relay.