Install

Description

Install and create an agent on kubernetes cluster.

Command

codefresh install agent

Options

Option Alias Default Description
--help Print help information
--name Agent’s name to be created if token is not provided
--token Agent’s token
--kube-context-name Name of the kubernetes context on which runner should be installed [$CF_ARG_KUBE_CONTEXT_NAME]
--kube-node-selector The kubernetes node selector “key=value” to be used by runner build resources (default is no node selector) (string)
--dry-run Set to true to simulate installation
--in-cluster Set flag if runner is been installed from inside a cluster
--kube-namespace Name of the namespace on which runner should be installed [$CF_ARG_KUBE_NAMESPACE]
--kubernetes-runner-type Set the runner type to kubernetes (alpha feature)
--tolerations The kubernetes tolerations as path to a JSON file to be used by runner resources (default is no tolerations) (string)
--kube-config-path Path to kubeconfig file (default is $HOME/.kube/config)
--skip-version-check Do not compare current runner’s version with latest
--install-runtime Install and attach runtime on the same namespace as the agent (default is false)
--make-default-runtime should all pipelines run on the hybrid runtime (default is false)
--storage-class-name Set a name of your custom storage class, note: this will not install volume provisioning components
--agent-kube-context-name Agent kubernetes context (on attach)
--agent-kube-namespace Agent’s namespace (on attach)
--docker-registry The prefix for the container registry that will be used for pulling the required components images. Example: --docker-registry=“docker.io”
--verbose Print logs