oauth controllers: add doc about controller actions to each

Author: stlaz

pkg/console/controllers/oauthclients/oauthclients.go

@@ -36,6 +36,14 @@ import (
 	secretsub "github.com/openshift/console-operator/pkg/console/subresource/secret"
 )
 
+// oauthClientsController:
+//
+//	updates:
+//	- oauthclient.oauth.openshift.io/console (created by CVO)
+//	writes:
+//	- consoles.operator.openshift.io/cluster .status.conditions:
+//		- type=OAuthClientSyncProgressing
+//		- type=OAuthClientSyncDegraded
 type oauthClientsController struct {
 	oauthClient    oauthv1client.OAuthClientsGetter
 	operatorClient v1helpers.OperatorClient
@@ -47,8 +55,6 @@ type oauthClientsController struct {
 	routesLister                routev1listers.RouteLister
 	ingressConfigLister         configv1lister.IngressLister
 	targetNSSecretsLister       corev1listers.SecretLister
-
-	authStatusHandler *status.AuthStatusHandler
 }
 
 func NewOAuthClientsController(

pkg/console/controllers/oauthclientsecret/oauthclientsecret.go

@@ -36,6 +36,14 @@ import (
 //   - None - do nothing
 //
 // The secret written is 'openshift-console/console-oauth-config' in .Data['clientSecret']
+//
+// ==========
+//
+//	writes:
+//	- secrets.console-oauth-config -n openshift-console .Data['clientSecret']
+//	- consoles.operator.openshift.io/cluster .status.conditions:
+//		- type=OAuthClientSecretSyncProgressing
+//		- type=OAuthClientSecretSyncDegraded
 type oauthClientSecretController struct {
 	operatorClient v1helpers.OperatorClient
 	secretsClient  corev1clients.SecretsGetter

pkg/console/controllers/oidcsetup/oidcsetup.go

@@ -33,6 +33,22 @@ import (
 	utilsub "github.com/openshift/console-operator/pkg/console/subresource/util"
 )
 
+// oidcSetupController:
+//
+//	writes:
+//	- authentication.config.openshift.io/cluster .status.oidcClients:
+//		- componentName=console
+//		- componentNamespace=openshift-console
+//		- currentOIDCClients
+//		- conditions:
+//			- Available
+//			- Progressing
+//			- Degraded
+//	- consoles.operator.openshift.io/cluster .status.conditions:
+//		- type=OIDCClientConfigProgressing
+//		- type=OIDCClientConfigDegraded
+//		- type=AuthStatusHandlerProgressing
+//		- type=AuthStatusHandlerDegraded
 type oidcSetupController struct {
 	operatorClient v1helpers.OperatorClient