Documentation
¶
Overview ¶
Package images is intended to support deploying the operator on restricted networks. It contains utilities for translating images referenced by environment variables to regular image references, allowing images that are defined by a tag to be replaced by digests automatically. This allows all images used by the controller to be defined as environment variables on the controller deployment.
All images defined must be referenced by an environment variable of the form RELATED_IMAGE_<name>. Functions in this package can be called to replace references to ${RELATED_IMAGE_<name>} with the corresponding environment variable.
Index ¶
- func FillPluginEnvVars(pluginDWT *devworkspace.DevWorkspaceTemplate) (*devworkspace.DevWorkspaceTemplate, error)
- func GetOpenShiftOAuthProxyImage() string
- func GetPVCCleanupJobImage() string
- func GetWebTerminalToolingImage() string
- func GetWebhookCertJobImage() string
- func GetWebhookServerImage() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FillPluginEnvVars ¶
func FillPluginEnvVars(pluginDWT *devworkspace.DevWorkspaceTemplate) (*devworkspace.DevWorkspaceTemplate, error)
FillPluginEnvVars replaces plugin devworkspaceTemplate .spec.components[].container.image environment variables of the form ${RELATED_IMAGE_*} with values from environment variables with the same name.
Returns error if any referenced environment variable is undefined.
func GetOpenShiftOAuthProxyImage ¶
func GetOpenShiftOAuthProxyImage() string
GetOpenShiftOAuthProxyImage returns the image reference for the openshift OAuth proxy image, used for openshift-oauth workspace routingClass. Returns empty string if env var RELATED_IMAGE_openshift_oauth_proxy is not defined.
func GetPVCCleanupJobImage ¶
func GetPVCCleanupJobImage() string
GetPVCCleanupJobImage returns the image reference for the PVC cleanup job used to clean workspace files from the common PVC in a namespace.
func GetWebTerminalToolingImage ¶
func GetWebTerminalToolingImage() string
GetWebTerminalToolingImage returns the image reference for the default web tooling image. Returns the empty string if environment variable RELATED_IMAGE_web_terminal_tooling is not defined
func GetWebhookCertJobImage ¶
func GetWebhookCertJobImage() string
GetWebhookCertJobImage returns the image reference for the webhook cert job image. Returns the empty string if environment variable RELATED_IMAGE_default_tls_secrets_creation_job is not defined
func GetWebhookServerImage ¶
func GetWebhookServerImage() string
GetWebhookServerImage returns the image reference for the webhook server image. Returns the empty string if environment variable RELATED_IMAGE_devworkspace_webhook_server is not defined
Types ¶
This section is empty.
Source Files