Skip to content

OCPBUGS-15365: *: use correct clients in the secretannotator #563

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

Merged
openshift-merge-robot merged 1 commit into from
Jul 12, 2023
Merged

OCPBUGS-15365: *: use correct clients in the secretannotator #563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion manifests/01-cluster-role.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ rules:
- ""
resources:
- secrets
- configmaps
- events
verbs:
- get
Expand Down
10 changes: 9 additions & 1 deletion manifests/01-role.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,20 @@ rules:
- ""
resources:
- secrets
- configmaps
- events
- serviceaccounts
- services
verbs:
- "*"
- apiGroups:
- ""
resources:
- configmaps
resourceNames:
- cloud-credential-operator-config
- cloud-credential-operator-leader
verbs:
- "*"
- apiGroups:
- apps
resources:
Expand Down
19 changes: 10 additions & 9 deletions pkg/operator/secretannotator/aws/reconciler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ const (
AwsSecretAccessKeyName = "aws_secret_access_key"
)

func NewReconciler(mgr manager.Manager) reconcile.Reconciler {
c := mgr.GetClient()
func NewReconciler(c client.Client, mgr manager.Manager) reconcile.Reconciler {
r := &ReconcileCloudCredSecret{
Client: c,
RootCredClient: mgr.GetClient(),
Logger: log.WithField("controller", constants.SecretAnnotatorControllerName),
AWSClientBuilder: awsutils.ClientBuilder,
}
Expand All @@ -56,9 +56,9 @@ func cloudCredSecretObjectCheck(secret metav1.Object) bool {
return secret.GetNamespace() == constants.CloudCredSecretNamespace && secret.GetName() == constants.AWSCloudCredSecretName
}

func Add(mgr manager.Manager, r reconcile.Reconciler) error {
func Add(mgr, rootCredMgr manager.Manager, r reconcile.Reconciler) error {
// Create a new controller
c, err := controller.New(constants.SecretAnnotatorControllerName, mgr, controller.Options{Reconciler: r})
c, err := controller.New(constants.SecretAnnotatorControllerName, rootCredMgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
Expand All @@ -75,12 +75,12 @@ func Add(mgr manager.Manager, r reconcile.Reconciler) error {
return cloudCredSecretObjectCheck(e.Object)
},
}
err = c.Watch(source.Kind(mgr.GetCache(), &corev1.Secret{}), &handler.EnqueueRequestForObject{}, p)
err = c.Watch(source.Kind(rootCredMgr.GetCache(), &corev1.Secret{}), &handler.EnqueueRequestForObject{}, p)
if err != nil {
return err
}

err = secretutils.WatchCCOConfig(c, types.NamespacedName{
err = secretutils.WatchCCOConfig(mgr.GetCache(), c, types.NamespacedName{
Copy link
Contributor Author

@stevekuznetsov stevekuznetsov Jul 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit tricky - we're triggering reconciliation in the controller (based on the root cred manager) by using events for the CCO config that come from the other manager's cache. We did the same in the actuators but in the other direction, one cache with configmap events driving the other reconciler.

Namespace: constants.CloudCredSecretNamespace,
Name: constants.AWSCloudCredSecretName,
}, mgr)
Expand All @@ -94,7 +94,8 @@ func Add(mgr manager.Manager, r reconcile.Reconciler) error {
var _ reconcile.Reconciler = &ReconcileCloudCredSecret{}

type ReconcileCloudCredSecret struct {
client.Client
Client client.Client
RootCredClient client.Client
Logger log.FieldLogger
AWSClientBuilder func(accessKeyID, secretAccessKey []byte, c client.Client) (ccaws.Client, error)
}
Expand Down Expand Up @@ -133,7 +134,7 @@ func (r *ReconcileCloudCredSecret) Reconcile(ctx context.Context, request reconc
}

secret := &corev1.Secret{}
err = r.Get(context.Background(), request.NamespacedName, secret)
err = r.RootCredClient.Get(context.Background(), request.NamespacedName, secret)
if err != nil {
if errors.IsNotFound(err) {
r.Logger.Info("parent credential secret does not exist")
Expand Down Expand Up @@ -232,5 +233,5 @@ func (r *ReconcileCloudCredSecret) updateSecretAnnotations(secret *corev1.Secret
secretAnnotations[constants.AnnotationKey] = value
secret.SetAnnotations(secretAnnotations)

return r.Update(context.Background(), secret)
return r.RootCredClient.Update(context.Background(), secret)
}
54 changes: 39 additions & 15 deletions pkg/operator/secretannotator/aws/reconciler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,16 +89,19 @@ func TestSecretAnnotatorReconcile(t *testing.T) {
tests := []struct {
name string
existing []runtime.Object
existingRootCred []runtime.Object
expectErr bool
mockAWSClient func(mockCtrl *gomock.Controller) *mockaws.MockClient
validateAnnotationValue string
}{
{
name: "cred minter mode",
existing: []runtime.Object{
testSecret(),
testOperatorConfig(""),
},
existingRootCred: []runtime.Object{
testSecret(),
},
mockAWSClient: func(mockCtrl *gomock.Controller) *mockaws.MockClient {
mockAWSClient := mockaws.NewMockClient(mockCtrl)
mockGetUser(mockAWSClient)
Expand All @@ -111,24 +114,30 @@ func TestSecretAnnotatorReconcile(t *testing.T) {
{
name: "operator disabled via configmap",
existing: []runtime.Object{
testSecret(),
testOperatorConfigMap("true"),
testOperatorConfig(""),
},
existingRootCred: []runtime.Object{
testSecret(),
},
},
{
name: "operator disabled",
existing: []runtime.Object{
testSecret(),
testOperatorConfig(operatorv1.CloudCredentialsModeManual),
},
existingRootCred: []runtime.Object{
testSecret(),
},
},
{
name: "detect root user creds",
existing: []runtime.Object{
testSecret(),
testOperatorConfig(""),
},
existingRootCred: []runtime.Object{
testSecret(),
},
mockAWSClient: func(mockCtrl *gomock.Controller) *mockaws.MockClient {
mockAWSClient := mockaws.NewMockClient(mockCtrl)
mockGetRootUser(mockAWSClient)
Expand All @@ -140,9 +149,11 @@ func TestSecretAnnotatorReconcile(t *testing.T) {
{
name: "cred passthrough mode",
existing: []runtime.Object{
testSecret(),
testOperatorConfig(""),
},
existingRootCred: []runtime.Object{
testSecret(),
},
mockAWSClient: func(mockCtrl *gomock.Controller) *mockaws.MockClient {
mockAWSClient := mockaws.NewMockClient(mockCtrl)
mockGetUser(mockAWSClient)
Expand All @@ -158,9 +169,11 @@ func TestSecretAnnotatorReconcile(t *testing.T) {
{
name: "cred passthrough mode wrong region permission",
existing: []runtime.Object{
testSecret(),
testOperatorConfig(""),
},
existingRootCred: []runtime.Object{
testSecret(),
},
mockAWSClient: func(mockCtrl *gomock.Controller) *mockaws.MockClient {
mockAWSClient := mockaws.NewMockClient(mockCtrl)
mockGetUser(mockAWSClient)
Expand All @@ -176,9 +189,11 @@ func TestSecretAnnotatorReconcile(t *testing.T) {
{
name: "useless creds",
existing: []runtime.Object{
testSecret(),
testOperatorConfig(""),
},
existingRootCred: []runtime.Object{
testSecret(),
},
mockAWSClient: func(mockCtrl *gomock.Controller) *mockaws.MockClient {
mockAWSClient := mockaws.NewMockClient(mockCtrl)
mockGetUser(mockAWSClient)
Expand All @@ -202,6 +217,9 @@ func TestSecretAnnotatorReconcile(t *testing.T) {
name: "secret missing key",
expectErr: true,
existing: []runtime.Object{
testOperatorConfig(""),
},
existingRootCred: []runtime.Object{
&corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: testSecretName,
Expand All @@ -212,28 +230,32 @@ func TestSecretAnnotatorReconcile(t *testing.T) {
"not_aws_secret_access_key": []byte(testAWSSecretAccessKey),
},
},
testOperatorConfig(""),
},
},
{
name: "annotation matches forced mode",
existing: []runtime.Object{
testSecret(),
testOperatorConfig(operatorv1.CloudCredentialsModeMint),
},
existingRootCred: []runtime.Object{
testSecret(),
},
validateAnnotationValue: constants.MintAnnotation,
},
{
name: "unknown mode",
existing: []runtime.Object{
testSecret(),
testOperatorConfig("notARealMode"),
},
existingRootCred: []runtime.Object{
testSecret(),
},
expectErr: true,
},
{
name: "error on missing config CR",
existing: []runtime.Object{
name: "error on missing config CR",
existing: []runtime.Object{},
existingRootCred: []runtime.Object{
testSecret(),
},
expectErr: true,
Expand Down Expand Up @@ -263,15 +285,17 @@ func TestSecretAnnotatorReconcile(t *testing.T) {
existing := append(test.existing, infra)

fakeClient := fake.NewClientBuilder().WithRuntimeObjects(existing...).Build()
fakeRootCredClient := fake.NewClientBuilder().WithRuntimeObjects(test.existingRootCred...).Build()

fakeAWSClient := mockaws.NewMockClient(mockCtrl)
if test.mockAWSClient != nil {
fakeAWSClient = test.mockAWSClient(mockCtrl)
}

rcc := &annaws.ReconcileCloudCredSecret{
Client: fakeClient,
Logger: log.WithField("controller", "testController"),
Client: fakeClient,
RootCredClient: fakeRootCredClient,
Logger: log.WithField("controller", "testController"),
AWSClientBuilder: func(accessKeyID, secretAccessKey []byte, c client.Client) (ccaws.Client, error) {
return fakeAWSClient, nil
},
Expand All @@ -289,7 +313,7 @@ func TestSecretAnnotatorReconcile(t *testing.T) {
}

if test.validateAnnotationValue != "" {
validateSecretAnnotation(fakeClient, t, test.validateAnnotationValue)
validateSecretAnnotation(fakeRootCredClient, t, test.validateAnnotationValue)
}
})
}
Expand Down
25 changes: 13 additions & 12 deletions pkg/operator/secretannotator/azure/reconciler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,16 @@ import (
var _ reconcile.Reconciler = &ReconcileCloudCredSecret{}

type ReconcileCloudCredSecret struct {
client.Client
Logger log.FieldLogger
Client client.Client
RootCredClient client.Client
Logger log.FieldLogger
}

func NewReconciler(mgr manager.Manager) reconcile.Reconciler {
c := mgr.GetClient()
func NewReconciler(c client.Client, mgr manager.Manager) reconcile.Reconciler {
r := &ReconcileCloudCredSecret{
Client: c,
Logger: log.WithField("controller", constants.SecretAnnotatorControllerName),
Client: c,
RootCredClient: mgr.GetClient(),
Logger: log.WithField("controller", constants.SecretAnnotatorControllerName),
}

s := status.NewSecretStatusHandler(c)
Expand All @@ -50,9 +51,9 @@ func NewReconciler(mgr manager.Manager) reconcile.Reconciler {
return r
}

func Add(mgr manager.Manager, r reconcile.Reconciler) error {
func Add(mgr, rootCredMgr manager.Manager, r reconcile.Reconciler) error {
// Create a new controller
c, err := controller.New(constants.SecretAnnotatorControllerName, mgr, controller.Options{Reconciler: r})
c, err := controller.New(constants.SecretAnnotatorControllerName, rootCredMgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
Expand All @@ -69,12 +70,12 @@ func Add(mgr manager.Manager, r reconcile.Reconciler) error {
return cloudCredSecretObjectCheck(e.Object)
},
}
err = c.Watch(source.Kind(mgr.GetCache(), &corev1.Secret{}), &handler.EnqueueRequestForObject{}, p)
err = c.Watch(source.Kind(rootCredMgr.GetCache(), &corev1.Secret{}), &handler.EnqueueRequestForObject{}, p)
if err != nil {
return err
}

secretutils.WatchCCOConfig(c, types.NamespacedName{
secretutils.WatchCCOConfig(mgr.GetCache(), c, types.NamespacedName{
Namespace: constants.CloudCredSecretNamespace,
Name: constants.AzureCloudCredSecretName,
}, mgr)
Expand Down Expand Up @@ -115,7 +116,7 @@ func (r *ReconcileCloudCredSecret) Reconcile(ctx context.Context, request reconc
// From here down we must be in Passthrough mode

secret := &corev1.Secret{}
err = r.Get(context.Background(), request.NamespacedName, secret)
err = r.RootCredClient.Get(context.Background(), request.NamespacedName, secret)
if err != nil {
r.Logger.Debugf("secret not found: %v", err)
return reconcile.Result{}, err
Expand Down Expand Up @@ -151,5 +152,5 @@ func (r *ReconcileCloudCredSecret) updateSecretAnnotations(secret *corev1.Secret
secretAnnotations[constants.AnnotationKey] = value
secret.SetAnnotations(secretAnnotations)

return r.Update(context.Background(), secret)
return r.RootCredClient.Update(context.Background(), secret)
}
10 changes: 6 additions & 4 deletions pkg/operator/secretannotator/azure/reconciler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,13 @@ func TestAzureSecretAnnotatorReconcile(t *testing.T) {
t.Run(test.name, func(t *testing.T) {
credsSecret := getInputSecret()

fakeClient := fake.NewClientBuilder().WithObjects(credsSecret, test.operatorConfig).Build()
fakeClient := fake.NewClientBuilder().WithObjects(test.operatorConfig).Build()
fakeRootCredClient := fake.NewClientBuilder().WithRuntimeObjects(credsSecret).Build()

rcc := &ReconcileCloudCredSecret{
Client: fakeClient,
Logger: log.WithField("controller", "testSecretAnnotatorController"),
Client: fakeClient,
RootCredClient: fakeRootCredClient,
Logger: log.WithField("controller", "testSecretAnnotatorController"),
}

_, err := rcc.Reconcile(context.TODO(), reconcile.Request{
Expand All @@ -84,7 +86,7 @@ func TestAzureSecretAnnotatorReconcile(t *testing.T) {
require.NoError(t, err, "unexpected error in secret annotator controller")

secret := &corev1.Secret{}
err = fakeClient.Get(context.TODO(), client.ObjectKey{Name: TestSecretName, Namespace: TestNamespace}, secret)
err = fakeRootCredClient.Get(context.TODO(), client.ObjectKey{Name: TestSecretName, Namespace: TestNamespace}, secret)
require.NoError(t, err, "error fetching object from fake client")

assert.Equal(t, string(test.expectedAnnotation), string(secret.ObjectMeta.Annotations[constants.AnnotationKey]))
Expand Down
Loading