Skip to content

feat: spec.secrets must be existing secrets #1961

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions deploy/cr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ spec:
apply: disabled
schedule: "0 2 * * *"
setFCV: false
secrets:
users: my-cluster-name-secrets
encryptionKey: my-cluster-name-mongodb-encryption-key
# secrets:
# users: my-cluster-name-secrets
# encryptionKey: my-cluster-name-mongodb-encryption-key
# ssl: my-cluster-name-ssl
# sslInternal: my-cluster-name-ssl-internal
# keyFile: my-cluster-name-mongodb-keyfile
Expand Down
6 changes: 6 additions & 0 deletions pkg/controller/perconaservermongodb/psmdb_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,12 @@ func (r *ReconcilePerconaServerMongoDB) Reconcile(ctx context.Context, request r
return reconcile.Result{}, errors.Wrap(err, "set CR version")
}

// Make sure that secrets specified in the manifest are preserved and not overwritten by the operator.
err = r.ensureSecretExistence(ctx, cr)
if err != nil {
return reconcile.Result{}, err
}

err = cr.CheckNSetDefaults(ctx, r.serverVersion.Platform)
if err != nil {
// If the user created a cluster with finalizers and wrong options, it would be impossible to delete a cluster.
Expand Down
67 changes: 64 additions & 3 deletions pkg/controller/perconaservermongodb/secrets.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,18 @@ import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
logf "sigs.k8s.io/controller-runtime/pkg/log"

api "github.com/percona/percona-server-mongodb-operator/pkg/apis/psmdb/v1"
"github.com/percona/percona-server-mongodb-operator/pkg/naming"
"github.com/percona/percona-server-mongodb-operator/pkg/psmdb"
"github.com/percona/percona-server-mongodb-operator/pkg/psmdb/secret"
)

func getUserSecret(ctx context.Context, cl client.Reader, cr *api.PerconaServerMongoDB, name string) (corev1.Secret, error) {
func getSecret(ctx context.Context, cl client.Reader, cr *api.PerconaServerMongoDB, name string) (corev1.Secret, error) {
secrets := corev1.Secret{}
err := cl.Get(ctx, types.NamespacedName{Name: name, Namespace: cr.Namespace}, &secrets)
return secrets, errors.Wrap(err, "get user secrets")
return secrets, err
}

func getInternalCredentials(ctx context.Context, cl client.Reader, cr *api.PerconaServerMongoDB, role api.SystemUserRole) (psmdb.Credentials, error) {
Expand All @@ -30,7 +31,7 @@ func getInternalCredentials(ctx context.Context, cl client.Reader, cr *api.Perco

func getCredentials(ctx context.Context, cl client.Reader, cr *api.PerconaServerMongoDB, name string, role api.SystemUserRole) (psmdb.Credentials, error) {
creds := psmdb.Credentials{}
usersSecret, err := getUserSecret(ctx, cl, cr, name)
usersSecret, err := getSecret(ctx, cl, cr, name)
if err != nil {
return creds, errors.Wrap(err, "failed to get user secret")
}
Expand Down Expand Up @@ -62,7 +63,65 @@ func getCredentials(ctx context.Context, cl client.Reader, cr *api.PerconaServer
return creds, nil
}

func (r *ReconcilePerconaServerMongoDB) ensureSecretExistence(ctx context.Context, cr *api.PerconaServerMongoDB) error {
if cr.Spec.Secrets == nil {
return nil
}

if cr.Spec.Secrets.Users != "" {
if _, err := getSecret(ctx, r.client, cr, cr.Spec.Secrets.Users); err != nil {
return fmt.Errorf("users '%s' secret must exist if specified in the manifest: %w", cr.Spec.Secrets.Users, err)
}
}

if cr.Spec.Secrets.SSL != "" {
if _, err := getSecret(ctx, r.client, cr, cr.Spec.Secrets.SSL); err != nil {
return fmt.Errorf("ssl '%s' secret must exist if specified in the manifest: %w", cr.Spec.Secrets.SSL, err)
}
}

if cr.Spec.Secrets.SSLInternal != "" {
if _, err := getSecret(ctx, r.client, cr, cr.Spec.Secrets.SSLInternal); err != nil {
return fmt.Errorf("ssl internal '%s' secret must exist if specified in the manifest: %w", cr.Spec.Secrets.SSLInternal, err)
}
}

if cr.Spec.Secrets.InternalKey != "" {
if _, err := getSecret(ctx, r.client, cr, cr.Spec.Secrets.InternalKey); err != nil {
return fmt.Errorf("internal key '%s' secret must exist if specified in the manifest: %w", cr.Spec.Secrets.InternalKey, err)
}
}

if cr.Spec.Secrets.EncryptionKey != "" {
if _, err := getSecret(ctx, r.client, cr, cr.Spec.Secrets.EncryptionKey); err != nil {
return fmt.Errorf("encryption key '%s' secret must exist if specified in the manifest: %w", cr.Spec.Secrets.EncryptionKey, err)
}
}

if cr.Spec.Secrets.Vault != "" {
if _, err := getSecret(ctx, r.client, cr, cr.Spec.Secrets.Vault); err != nil {
return fmt.Errorf("vault '%s' secret must exist if specified in the manifest: %w", cr.Spec.Secrets.Vault, err)
}
}

if cr.Spec.Secrets.SSE != "" {
if _, err := getSecret(ctx, r.client, cr, cr.Spec.Secrets.SSE); err != nil {
return fmt.Errorf("sse '%s' secret must exist if specified in the manifest: %w", cr.Spec.Secrets.SSE, err)
}
}

if cr.Spec.Secrets.LDAPSecret != "" {
if _, err := getSecret(ctx, r.client, cr, cr.Spec.Secrets.LDAPSecret); err != nil {
return fmt.Errorf("ldap '%s' secret must exist if specified in the manifest: %w", cr.Spec.Secrets.LDAPSecret, err)
}
}

return nil
}

func (r *ReconcilePerconaServerMongoDB) reconcileUsersSecret(ctx context.Context, cr *api.PerconaServerMongoDB) error {
log := logf.FromContext(ctx).WithName("reconcileUsersSecret")

secretObj := corev1.Secret{}
err := r.client.Get(ctx,
types.NamespacedName{
Expand Down Expand Up @@ -117,6 +176,8 @@ func (r *ReconcilePerconaServerMongoDB) reconcileUsersSecret(ctx context.Context
return fmt.Errorf("create Users secret: %v", err)
}

log.Info("Created user secrets", "secret", cr.Spec.Secrets.Users)

return nil
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ spec:
- mountPath: /opt/percona
name: bin
- mountPath: /etc/mongodb-encryption
name: my-cluster-name-mongodb-encryption-key
name: reconcile-statefulset-cr-mongodb-encryption-key
readOnly: true
- mountPath: /etc/users-secret
name: users-secret-file
Expand Down Expand Up @@ -288,11 +288,11 @@ spec:
secretName: reconcile-statefulset-cr-mongodb-keyfile
- emptyDir: {}
name: bin
- name: my-cluster-name-mongodb-encryption-key
- name: reconcile-statefulset-cr-mongodb-encryption-key
secret:
defaultMode: 288
optional: false
secretName: my-cluster-name-mongodb-encryption-key
secretName: reconcile-statefulset-cr-mongodb-encryption-key
- name: ssl
secret:
defaultMode: 288
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ spec:
- mountPath: /opt/percona
name: bin
- mountPath: /etc/mongodb-encryption
name: my-cluster-name-mongodb-encryption-key
name: reconcile-statefulset-cr-mongodb-encryption-key
readOnly: true
- mountPath: /etc/users-secret
name: users-secret-file
Expand Down Expand Up @@ -288,11 +288,11 @@ spec:
secretName: reconcile-statefulset-cr-mongodb-keyfile
- emptyDir: {}
name: bin
- name: my-cluster-name-mongodb-encryption-key
- name: reconcile-statefulset-cr-mongodb-encryption-key
secret:
defaultMode: 288
optional: false
secretName: my-cluster-name-mongodb-encryption-key
secretName: reconcile-statefulset-cr-mongodb-encryption-key
- name: ssl
secret:
defaultMode: 288
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ spec:
- mountPath: /opt/percona
name: bin
- mountPath: /etc/mongodb-encryption
name: my-cluster-name-mongodb-encryption-key
name: reconcile-statefulset-cr-mongodb-encryption-key
readOnly: true
- mountPath: /etc/users-secret
name: users-secret-file
Expand Down Expand Up @@ -288,11 +288,11 @@ spec:
secretName: reconcile-statefulset-cr-mongodb-keyfile
- emptyDir: {}
name: bin
- name: my-cluster-name-mongodb-encryption-key
- name: reconcile-statefulset-cr-mongodb-encryption-key
secret:
defaultMode: 288
optional: false
secretName: my-cluster-name-mongodb-encryption-key
secretName: reconcile-statefulset-cr-mongodb-encryption-key
- name: ssl
secret:
defaultMode: 288
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ spec:
- mountPath: /opt/percona
name: bin
- mountPath: /etc/mongodb-encryption
name: my-cluster-name-mongodb-encryption-key
name: reconcile-statefulset-cr-mongodb-encryption-key
readOnly: true
- mountPath: /etc/users-secret
name: users-secret-file
Expand Down Expand Up @@ -288,11 +288,11 @@ spec:
secretName: reconcile-statefulset-cr-mongodb-keyfile
- emptyDir: {}
name: bin
- name: my-cluster-name-mongodb-encryption-key
- name: reconcile-statefulset-cr-mongodb-encryption-key
secret:
defaultMode: 288
optional: false
secretName: my-cluster-name-mongodb-encryption-key
secretName: reconcile-statefulset-cr-mongodb-encryption-key
- name: ssl
secret:
defaultMode: 288
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ spec:
- mountPath: /opt/percona
name: bin
- mountPath: /etc/mongodb-encryption
name: my-cluster-name-mongodb-encryption-key
name: reconcile-statefulset-cr-mongodb-encryption-key
readOnly: true
- mountPath: /etc/users-secret
name: users-secret-file
Expand Down Expand Up @@ -182,11 +182,11 @@ spec:
secretName: reconcile-statefulset-cr-mongodb-keyfile
- emptyDir: {}
name: bin
- name: my-cluster-name-mongodb-encryption-key
- name: reconcile-statefulset-cr-mongodb-encryption-key
secret:
defaultMode: 288
optional: false
secretName: my-cluster-name-mongodb-encryption-key
secretName: reconcile-statefulset-cr-mongodb-encryption-key
- name: ssl
secret:
defaultMode: 288
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ spec:
- mountPath: /opt/percona
name: bin
- mountPath: /etc/mongodb-encryption
name: my-cluster-name-mongodb-encryption-key
name: reconcile-statefulset-cr-mongodb-encryption-key
readOnly: true
- mountPath: /etc/users-secret
name: users-secret-file
Expand Down Expand Up @@ -287,11 +287,11 @@ spec:
secretName: reconcile-statefulset-cr-mongodb-keyfile
- emptyDir: {}
name: bin
- name: my-cluster-name-mongodb-encryption-key
- name: reconcile-statefulset-cr-mongodb-encryption-key
secret:
defaultMode: 288
optional: false
secretName: my-cluster-name-mongodb-encryption-key
secretName: reconcile-statefulset-cr-mongodb-encryption-key
- name: ssl
secret:
defaultMode: 288
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ spec:
- mountPath: /opt/percona
name: bin
- mountPath: /etc/mongodb-encryption
name: my-cluster-name-mongodb-encryption-key
name: reconcile-statefulset-cr-mongodb-encryption-key
readOnly: true
- mountPath: /etc/users-secret
name: users-secret-file
Expand Down Expand Up @@ -288,11 +288,11 @@ spec:
secretName: reconcile-statefulset-cr-mongodb-keyfile
- emptyDir: {}
name: bin
- name: my-cluster-name-mongodb-encryption-key
- name: reconcile-statefulset-cr-mongodb-encryption-key
secret:
defaultMode: 288
optional: false
secretName: my-cluster-name-mongodb-encryption-key
secretName: reconcile-statefulset-cr-mongodb-encryption-key
- name: ssl
secret:
defaultMode: 288
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ spec:
- mountPath: /opt/percona
name: bin
- mountPath: /etc/mongodb-encryption
name: my-cluster-name-mongodb-encryption-key
name: reconcile-statefulset-cr-mongodb-encryption-key
readOnly: true
- mountPath: /etc/users-secret
name: users-secret-file
Expand Down Expand Up @@ -287,11 +287,11 @@ spec:
secretName: reconcile-statefulset-cr-mongodb-keyfile
- emptyDir: {}
name: bin
- name: my-cluster-name-mongodb-encryption-key
- name: reconcile-statefulset-cr-mongodb-encryption-key
secret:
defaultMode: 288
optional: false
secretName: my-cluster-name-mongodb-encryption-key
secretName: reconcile-statefulset-cr-mongodb-encryption-key
- name: ssl
secret:
defaultMode: 288
Expand Down