Skip to content

Latest commit

 

History

History
301 lines (227 loc) · 10.1 KB

File metadata and controls

301 lines (227 loc) · 10.1 KB

Common Environment variables

These needs to be initialized as per requirements before deploying on any platform.

PUBLIC_KEY

Default: ~/.ssh/id_rsa.pub Public ssh key file for Ansible.

PRIVATE_KEY

Default: ~/.ssh/id_rsa Private ssh key file for Ansible.

ORCHESTRATION_USER

Default: root User for Ansible to log in as. Must authenticate with PUBLIC_KEY/PRIVATE_KEY.

OPENSHIFT_CLEANUP

Default: false Controls if previously deployed cluster will be destroyed prior to installing a new one.

OPENSHIFT_INSTALL

Default: true Controls if cluster create and install portion of playbook is ran. The only reason to disable this is if you have a cluster already and wanted to run OPENSHIFT_POST_INSTALL, OPENSHIFT_POST_CONFIG, and/or OPENSHIFT_DEBUG_CONFIG against an existing cluster.

OPENSHIFT_POST_INSTALL

Default: true Controls if day 2 operations are ran against this cluster. Day 2 operations includes creating infra nodes, creating a workload node, adding remote write config and steering infra workloads to infra nodes.

ENABLE_DITTYBOPPER

default: true Controls wheather a mutable Grafana instance is launched.

OPENSHIFT_POST_CONFIG

Default: true Controls if "post-config" options are ran for this specific cluster. This opens the security groups for this cluster to permit more network tests to execute from the openshift-scale/workloads repo.

OPENSHIFT_DEBUG_CONFIG

Default: false This enables easier debugging for a cluster by populating the initially installed cluster nodes with the kubeconfig and ssh keys for quicker out of band and hands on debugging.

OPENSHIFT_CLIENT_LOCATION

Default: No default. Location to download and unpack the OpenShift client tool oc. The latest client can be found https://mirror.openshift.com/pub/openshift-v4/clients/ocp/latest/ or https://mirror.openshift.com/pub/openshift-v4/clients/ocp-dev-preview

OPENSHIFT_INSTALL_RELEASE_IMAGE_OVERRIDE

Default: No default. The release image override payload. Also where the install openshift-install binary is extracted from. Find the latest test images at https://openshift-release.svc.ci.openshift.org/

OPENSHIFT_INSTALL_BINARY_URL

Default: No default. Link to the binary url tarball to extract the openshift-install from. Find the latest builds at https://mirror.openshift.com/pub/openshift-v4/clients/ocp-dev-preview

OPENSHIFT_INSTALL_APIVERSION

Default: v1 Depending upon the version of the payload tested this version string might need to be adjusted.

OPENSHIFT_INSTALL_SSH_PUB_KEY_FILE

Default: ~/.ssh/id_rsa.pub Public ssh key file to be used in the install-config.yaml.

OPENSHIFT_INSTALL_PULL_SECRET

Default: No default. The pull secret to be used in installing the cluster.

OPENSHIFT_INSTALL_QUAY_REGISTRY_TOKEN

Default: No default. The token used to download and extract the installer binary from quay.

OPENSHIFT_INSTALL_IMAGE_REGISTRY

Default: registry.ci.openshift.org The registry which contains the install image.

OPENSHIFT_INSTALL_REGISTRY_TOKEN

Default: No default. The token used to download and extract the installer binary from the registry.

OPENSHIFT_INSTALL_INSTALLER_FROM_SOURCE

Default: false Option to build the installer binary from source instead of extract method. Not recommended.

OPENSHIFT_INSTALL_INSTALLER_FROM_SOURCE_VERSION

Default: master Branch to build installer from if OPENSHIFT_INSTALL_INSTALLER_FROM_SOURCE is set to true.

GOPATH

Default: /root/.go When building from source the gopath must be set.

OPENSHIFT_CIDR

Default: 10.128.0.0/14 The block of IP addresses from which Pod IP addresses are allocated.

OPENSHIFT_MACHINE_CIDR

Default: 10.0.0.0/16 The block of IP addresses used for hosts.

OPENSHIFT_SERVICE_NETWORK

Default: 172.30.0.0/16 The block of IP addresses for services.

OPENSHIFT_HOST_PREFIX

Default: 23 The subnet prefix length to assign to each individual node for Pod IP addresses.

OPENSHIFT_NETWORK_TYPE

Default: OpenShiftSDN The network type used for the cluster, for OVN set it to OVNKubernetes.

OPENSHIFT_POST_INSTALL_POLL_ATTEMPTS

Default: 600 The number of times to poll to check while the infra and workload node are being created and added to the cluster.

OPENSHIFT_TOGGLE_INFRA_NODE

Default: true Enable infra nodes to be created with the OPENSHIFT_POST_INSTALL step.

OPENSHIFT_TOGGLE_WORKLOAD_NODE

Default: true Enable a workload node to be created with the OPENSHIFT_POST_INSTALL step.

KUBECONFIG_PATH

Default: ~/.kube/config Path to kube_config.

CERBERUS_CONFIG_PATH

Default: ~/cerberus.yaml Path to cerberus_config.

CERBERUS IMAGE

Default: quay.io/openshift-scale/cerberus:latest Image to be pulled to run the containerized version of cerberus.

CERBERUS_URL

Default: "http://0.0.0.0:8080" Optional arguement for cerberus configuration if cerberus is using a different URL than the default.

DISTRIBUTION

Default: openshift Distribution type supported by cerberus can be kubernetes or openshift.

CERBERUS_PORT

Default: 8080 http server port where cerberus status is published.

WATCH NODES

Default: true Set to True for the cerberus to monitor the cluster nodes.

WATCH CLUSTER OPERATORS

Default: true Set to True for the cerberus to monitor the cluster operators.

WATCH_URL_ROUTES

Default: [] Route url's to be monitored by cerberus.

WATCH NAMESPACES

Default: '[openshift-etcd, openshift-apiserver, openshift-kube-apiserver, openshift-monitoring, openshift-kube-controller-manager, openshift-machine-api, openshift-kube-scheduler, openshift-ingress, openshift-sdn, openshift-ovn-kubernetes]' List the namespaces to be monitored by cerberus.

CERBERUS_PUBLISH_STATUS

Default: true When enabled, cerberus starts a light weight http server and publishes the status.

INSPECT_COMPONENTS

Default: false Enable it only when OpenShift client is supported to run. When enabled, cerberus collects logs, events and metrics of failed components.

PROMETHEUS_URL

Default: '' The prometheus url.

PROMETHEUS_BEARER_TOKEN

Default: '' The prometheus bearer token is needed to authenticate with prometheus.

SLACK_INTEGRATION

Default: false When enabled, cerberus reports the the failed interations and sends the report for the same on a slack channel.

SLACK_API_TOKEN

Default: No default. It refers to Bot User OAuth Access Token used for cerberus.

SLACK_CHANNEL

Default: No default. It refers to the slack channel ID the user wishes to receive the notifications for cerberus failures.

WATCHER_SLACK_ID

Default: '{Monday: , Tuesday: , Wednesday: , Thursday: , Friday: , Saturday: , Sunday: }' When slack_integration is enabled, a watcher can be assigned for each day. The watcher of the day is tagged while reporting failures in a slack channel. Values are slack member ID's.

SLACK_TEAM_ALIAS

Default: No default. The slack team alias to be tagged while reporting failures in the slack channel when no cop is assigned.

ITERATIONS

Default: 5 Iterations to loop before stopping the watch in cerberus monitoring. It will be replaced with infinity when the daemon mode is enabled.

SLEEP_TIME

Default: 60 Sleep duration between each iteration in cerberus monitoring.

KUBE_API_REQUEST_CHUNK_SIZE

Default: 250 Large requests will be broken into the specified chunk size to reduce the load on API server and improve responsiveness while retrieving node and pod status in cerberus.

DAEMON_MODE

Default: true Iterations are set to infinity which means that the cerberus will monitor the resources forever.

CORES_USAGE_PERCENTAGE

Default: 0.5 The fraction of cores to be used for multiprocessing.

DATABASE_PATH

Default: /tmp/cerberus.db Path where cerberus database needs to be stored.

REUSE_DATABASE

Default: false When enabled, cerberus database is reused to store the failures.

CERBERUS_ENABLE

Default: false Controls whether the monitoring of Kubernetes/OpenShift cluster components by cerberus should be enabled or not.

KUBECONFIG_AUTH_DIR_PATH

Default: No default. For use with Flexy built clusters, in which only the post-install steps are ran

DATA_SERVER_ENABLE

Default: false Controls whether the data server is launched.

DATA_SERVER_IMAGE

Default: quay.io/openshift-scale/snappy-data-server Latest, maintained image of the snappy data server.

DATA_SERVER_LOG_LVL

Default: info
Data server log level. Current Uvicorn server options: *'critical', 'error', 'warning', 'info', 'debug', 'trace'.

DATA_SERVER_PORT

Default: 7070
Data server service port.

DATA_SERVER_PUBLIC_HOST

Default: localhost
URL to public host of data server.

DATA_SERVER_ROOT_PATH

Default: ~/data_server Absolute path to the data server's host's directory.

DATA_SERVER_SECRET

Default: No default. Secret to encode passwords in database.

FIRST_SUPERUSER

Default: No default. Username for the first super user.

FIRST_SUPERUSER_PASSWORD

Default: No default. Password for the first super user.

POSTGRES_PASSWORD

Default: No default. Postgresql database super user password.

RHACS_ENABLE

Default: False An option to enable installation of ACS.

RHACS_IMAGE_MAIN_REGISTRY

Default: '' Specify the image source when installing ACS. The most recent public release is the default install.

RHACS_IMAGE_MAIN_TAG

Default: '' Specify the image tag when installing ACS. The most recent public release is the default install.

RHACS_IMAGE_PULL_SECRET_USERNAME

Default: '' The username to allow access to a registry that requires authentication when installing ACS.

RHACS_IMAGE_PULL_SECRET_PASSWORD

Default: '' The passowrd to allow access to a registry that requires authentication when installing ACS.

THANOS_ENABLE

Default: False Turn on remote_write to a thanos instance

THANOS_RECEIVER_URL

URL for the receiver to remote_write to.