From 84952a8816e070787407dda97a87b1a6a6a1b717 Mon Sep 17 00:00:00 2001 From: "Karan.Magdani" Date: Tue, 19 Apr 2022 10:52:02 -0700 Subject: [PATCH] added doc.go for imgconfig controller Signed-off-by: Karan.Magdani --- pkg/operator/controllers/imageconfig/doc.go | 29 +++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 pkg/operator/controllers/imageconfig/doc.go diff --git a/pkg/operator/controllers/imageconfig/doc.go b/pkg/operator/controllers/imageconfig/doc.go new file mode 100644 index 00000000000..76b98cabd38 --- /dev/null +++ b/pkg/operator/controllers/imageconfig/doc.go @@ -0,0 +1,29 @@ +package imageconfig + +// Copyright (c) Microsoft Corporation. +// Licensed under the Apache License 2.0. + +/* + +The controller in this package aims to ensure that ImageConfig manifest +allows / does not block images registries that are essential to smooth cluster operation. + +There is one flag which controls the operations performed by this controller: + +aro.imageconfig.enabled: +- When set to false, the controller will noop and not perform any further action +- When set to true, the controller will attempt to reconcile the image.config manifest + +If aro.imageconfig.enabled=true and manifest contains AllowedRegistries: +- The controller will ensure the required registries are part of allowed registries, so as to allow traffic from essential registries + +If aro.imageconfig.enabled=true and manifest contains Blocked Registries: +- The controller will ensure the required registries are NOT part of blocked registries + +If aro.imageconfig.enabled=true and manifest contains both AllowedRegistries & BlockedRegistries: +- The controller will fail silently and not requeue as this is not a supported action + +More information on image.config resource can be found here: +https://docs.openshift.com/container-platform/4.6/openshift_images/image-configuration.html + +*/