Install Runtime-Environment


Install and create a runtime on kubernetes cluster.


codefresh install runtime


Option Alias Type Default Description
--help Print help information
--runtime-name The name of the runtime to install
--token Agent’s token
--agent-name Agent’s name
--storage-class-name Set a name of your custom storage class, note: this will not install volume provisioning components
--docker-registry string The prefix for the container registry that will be used for pulling the required components images. Example: --docker-registry=“”
--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
--dry-run Set to true to simulate installation
--in-cluster Set flag if runner is been installed from inside a cluster
--kube-node-selector The kubernetes node selector “key=value” to be used by runner build resources (default is no node selector) (string)
--runtime-kube-config-path Path to kubeconfig file (default is $HOME/.kube/config)
--runtime-kube-context-name Name of the kubernetes context on which the runtime should be installed (default is current-context) [$CF_ARG_KUBE_CONTEXT_NAME]
--runtime-kube-namespace Name of the namespace on which runtime should be installed [$CF_ARG_KUBE_NAMESPACE]
--build-annotations The kubernetes metadata.annotations as “key=value” to be used by runner build resources (default is no node selector)
--attach-runtime if set to true, auto attach runtime to agent (need to provide ….)
--agent-kube-config-path Path to kubeconfig file for the agent (default is $HOME/.kube/config) (on attach)
--agent-kube-context-name Agent kubernetes context (on attach)
--agent-kube-namespace Agent’s namespace (on attach)
--cluster-service-account service account for cluster default is default
--make-default-runtime should all pipelines run on the this runtime (default is false)
--skip-re-creation If set to true, will skip runtime creation in the platform
--skip-cluster-creation If set to true, will skip cluster integration creation for this runtime
--platform-only Set to true to create runtime on the platform side only
--verbose Print logs