Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added doc.go for imgconfig controller #2064

Merged
merged 2 commits into from
Apr 19, 2022
Merged

added doc.go for imgconfig controller #2064

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84952a8
added doc.go for imgconfig controller
Apr 19, 2022
81260b9
Merge branch 'master' of https://github.com/Azure/ARO-RP into karan/i…
Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions pkg/operator/controllers/imageconfig/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

*/