Skip to main content

Configuration

Following are environment variables you can use to configure your instance of Cyclops. You can set those environment variables directly on the cyclops-ui Kubernetes deployment.

Cyclops controller​

NameDescriptionDefault value
PORTSpecify a port to expose the controller API8080
DISABLE_TELEMETRYBy default, Cyclops controller emits usage metrics. If this env variable is set to true, the usage metrics are not exposed. You can read more about usage metrics herefalse
WATCH_NAMESPACEKubernetes namespace used for all Cyclops custom resources like Modules, TemplateStores and TemplateAuthRules. Cyclops is aware only of the custom resources in this namespace. Cyclops controller will not react to changes on Modules on other namespacescyclops
MODULE_TARGET_NAMESPACEBy default, Cyclops can manage resources created from Modules in the whole cluster. If this environment variable is set, Cyclops can manage Module child resources only in the namespace specified in the variable- (empty means cluster scope)
WATCH_NAMESPACE_HELMBy default, Cyclops can list, get and upgrade Helm releases in the whole cluster. If this environment variable is set, Cyclops can manage releases and their resources only in the namespace specified in the variable- (empty means cluster scope)

Cyclops UI​

NameDescriptionDefault value
REACT_APP_CYCLOPS_CTRL_HOSTHost of your Cyclops controllerhttp://cyclops-ctrl.cyclops:8080
REACT_APP_ENABLE_STREAMINGConfigures whether the Cyclops UI will subscribe to resource status SSE stream from cyclops controller. If false, resource status is polled each 15 secondstrue