openshiftprov_config.json reference

The Red Hat® OpenShift® provider configuration file, which contains authentication credentials for provisioning from OpenShift on Linux®.

Location

The openshiftprov_config.json file is located at $HF_TOP/$HF_VERSION/providerplugins/openshift/sampleconf/ directory.
Tip: The openshiftprov_config.json sample file is renamed to openshiftinstprov_config.json when copied into the configuration directory location, for example: $HF_CONFDIR/providers/openshiftinst/.

Parameter

OPENSHIFT_KUBECONFIG
Optional. Absolute path to the kubeconfig file to access the OpenShift cluster. This parameter is reserved for future enhancement; specify an empty string for now.
OPENSHIFT_NAMESPACE
Required. The namespace into which the pods are created by host factory.
OPENSHIFT_POD_OWNER_APIVERSION
Required. The API version of the pod owner specified in OPENSHIFT_POD_OWNER_NAME.
OPENSHIFT_POD_OWNER_KIND
Required. The kind of the pod owner object specified in OPENSHIFT_POD_OWNER_NAME, for example SymphonyCluster.
OPENSHIFT_POD_OWNER_NAME
Required. The name of the object to be assigned as owner of the provisioned pods. For example, symcluster731 object of kind SymphonyCluster created by using the Symphony operator.
KUBERNETES_SERVICE_HOST
Required. The value defined in the Kubernetes environment variable KUBERNETES_SERVICE_HOST on the pod where host factory is running. Required to access the Kubernetes API server.
KUBERNETES_SERVICE_PORT
Required. The value defined in the Kubernetes environment variable KUBERNETES_SERVICE_PORT on the pod where host factory is running. Required to access the Kubernetes API server.
LOG_LEVEL
Optional. Log level for the HostFactory service, similar to any other EGO service. Valid value is one of the following options:
  • LOG_ERR: Logs those messages that indicate error conditions.
  • LOG_WARNING: Logs those messages that are warnings or more serious messages.
  • LOG_INFO: Logs all informational messages and more serious messages. LOG_INFO is the default level.
  • LOG_DEBUG: Logs are very verbose and fills up your log files quickly, which can adversely affect performance.
  • LOG_TRACE: Logs all available messages.
Default: If no value is set for this level parameter or the value is not valid, the value of the HF_LOGLEVEL parameter from HostFactory service (hostfactoryconf.json) is used instead. For more information about the HF_LOGLEVEL parameter, see hostfactoryconf.json reference topic.
LOG_MAX_FILE_SIZE
Optional. Maximum size of the HostFactory service log file in megabytes (MB). The default file directory of the log file is $EGO_TOP/hostfactory/log. Valid value is a file size in MB the range 1 - 1999.
Default: If no value is set for this max_file_size parameter or the value is not valid, the value of the HF_LOG_MAX_FILE_SIZE parameter from HostFactory service (hostfactoryconf.son) is used instead. For more information about the HF_LOG_MAX_FILE_SIZE parameter, see hostfactoryconf.json reference topic.
LOG_MAX_ROTATE
Optional. Maximum backup count of log files. Valid value is either 0 or a backup count of log files in the range of 1 - 1000.
Note: If the value for max_rotate parameters is set to 0, this setting disables the log rotation, the size of the log file continues to expand, and the value of max_file_size is ignored.
Default: If no value is set for this max_rotate parameter or the value is not valid, the value of the HF_LOG_MAX_ROTATE parameter from HostFactory service (hostfactoryconf.son) is used instead. For more information about the HF_LOG_MAX_ROTATE parameter, see hostfactoryconf.json reference topic.