Init

Description

Install Codefresh Runner solution’s components on Kubernetes cluster.

Command

codefresh runner init

Options

Option Alias Default Description
--help Print help information
--name Agent’s name to be created if token is not provided
--token Registration’s token
--url Codefresh system custom url
--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)
--build-node-selector The Kubernetes node selector “key=value” to be used by the Codefresh build resources (default is no node selector)
--yes -y Use installation defaults (don’t ask any questions)
--skip-cluster-test Do not test given kubeconfig context to have all the required permission
--set-default-runtime Set this as the default runtime environment for your Codefresh account
--exec-demo-pipeline Run a demo pipeline after the installation completes
--install-monitor true Install a monitoring component that will help provide valueable data about your cluster to Codefresh
--kube-namespace Name of the namespace on which runner should be installed [$CF_ARG_KUBE_NAMESPACE]
--tolerations The Kubernetes tolerations as path to a JSON file prefixed with @ to be used by runner resources (default is no tolerations) (string)
--storage-class-name Set a name of your custom storage class
--docker-registry The prefix for the container registry that will be used for pulling the required components images. Example: --docker-registry=“docker.io”
--kube-config-path Path to kubeconfig file (default is $HOME/.kube/config)
--values specify values in a YAML file
--set-value Set values for templates, example: --set-value LocalVolumesDir=/mnt/disks/ssd0/codefresh-volumes
--set-file Set values for templates from file, example: --set-file Storage.GoogleServiceAccount=/path/to/service-account.json
--http-proxy http proxy to be used in the runner
--https-proxy https proxy to be used in the runner
--verbose Print logs
--env-vars Addiontal env vars to be used in agent’s pod
--app-proxy install app proxy component (default false)
--app-proxy-host the hostname that will be used by the app-proxy ingress
--app-proxy-ingress-class the ingress class that will be used by the app-proxy ingress
--docker-daemon-access true docker daemon access (default true)