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.

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

Add URIs to connection information #56

Open
wants to merge 2 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
27 changes: 24 additions & 3 deletions controllers/credentials_secret.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package controllers

import (
"fmt"
"net/url"

"github.com/digitalocean/godo"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand Down Expand Up @@ -32,8 +35,8 @@ func credentialsSecretForDefaultDBUser(owner client.Object, db *godo.Database) *
return secret
}

func credentialsSecretForDBUser(owner client.Object, user *godo.DatabaseUser) *corev1.Secret {
return &corev1.Secret{
func credentialsSecretForDBUser(db *godo.Database, owner client.Object, user *godo.DatabaseUser) (*corev1.Secret, error) {
secret := &corev1.Secret{
TypeMeta: metav1.TypeMeta{
APIVersion: "v1",
Kind: "Secret",
Expand All @@ -45,7 +48,25 @@ func credentialsSecretForDBUser(owner client.Object, user *godo.DatabaseUser) *c
StringData: map[string]string{
"username": user.Name,
"password": user.Password,
// TODO(awg): Construct uri and private_uri from DB info.
},
}
if db.Connection != nil {
dbUri, err := url.Parse(db.Connection.URI)
if err != nil {
return nil, fmt.Errorf("unable to parse connection uri: %s", err)
}
dbUri.User = url.UserPassword(user.Name, user.Password)
secret.StringData["uri"] = dbUri.String()
}

if db.PrivateConnection != nil {
dbPrivateUri, err := url.Parse(db.PrivateConnection.URI)
if err != nil {
return nil, fmt.Errorf("unable to parse private connection uri: %s", err)
}
dbPrivateUri.User = url.UserPassword(user.Name, user.Password)
secret.StringData["private_uri"] = dbPrivateUri.String()
}

return secret, nil
}
14 changes: 11 additions & 3 deletions controllers/databaseuser_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,11 @@ func (r *DatabaseUserReconciler) reconcileDBUser(ctx context.Context, clusterUUI
"user_name", user.Spec.Username,
)

db, resp, err := r.GodoClient.Databases.Get(ctx, clusterUUID)
if err != nil {
return ctrl.Result{}, fmt.Errorf("checking for existing DB Cluster: %v", err)
}

// The validating webhook checks that the user doesn't already exist, so we
// assume that if we find it to exist now we created it. If the user was
// created between validation passing and getting here, we could assume
Expand All @@ -193,7 +198,7 @@ func (r *DatabaseUserReconciler) reconcileDBUser(ctx context.Context, clusterUUI
controllerutil.AddFinalizer(user, finalizerName)
user.Status.Role = dbUser.Role

err = r.ensureOwnedObjects(ctx, user, dbUser)
err = r.ensureOwnedObjects(ctx, db, user, dbUser)
if err != nil {
ll.Error(err, "unable to ensure user-related objects")
return ctrl.Result{}, fmt.Errorf("ensuring user-related objects: %v", err)
Expand All @@ -202,7 +207,7 @@ func (r *DatabaseUserReconciler) reconcileDBUser(ctx context.Context, clusterUUI
return ctrl.Result{RequeueAfter: 5 * time.Minute}, nil
}

func (r *DatabaseUserReconciler) ensureOwnedObjects(ctx context.Context, user *v1alpha1.DatabaseUser, dbUser *godo.DatabaseUser) error {
func (r *DatabaseUserReconciler) ensureOwnedObjects(ctx context.Context, db *godo.Database, user *v1alpha1.DatabaseUser, dbUser *godo.DatabaseUser) error {
// For some database engines the password is not returned when fetching a
// user, only on initial creation. Avoid creating or updating the user
// credentials secret if the password is empty, so we don't clear the
Expand All @@ -211,7 +216,10 @@ func (r *DatabaseUserReconciler) ensureOwnedObjects(ctx context.Context, user *v
return nil
}

obj := credentialsSecretForDBUser(user, dbUser)
obj, err := credentialsSecretForDBUser(db, user, dbUser)
if err != nil {
return fmt.Errorf("creating secrett: %s", err)
}
controllerutil.SetControllerReference(user, obj, r.Scheme)
if err := r.Patch(ctx, obj, client.Apply, client.ForceOwnership, client.FieldOwner("do-operator")); err != nil {
return fmt.Errorf("applying object %s: %s", client.ObjectKeyFromObject(obj), err)
Expand Down
6 changes: 6 additions & 0 deletions controllers/databaseuser_controller_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package controllers

import (
"fmt"

"github.com/digitalocean/do-operator/api/v1alpha1"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
Expand Down Expand Up @@ -89,6 +91,8 @@ var _ = Describe("DatabaseUser controller", func() {
Expect(secret.OwnerReferences).To(ContainElement(dbUserOwnerReference))
Expect(string(secret.Data["username"])).To(Equal(userName))
Expect(secret.Data["password"]).NotTo(BeEmpty())
Expect(string(secret.Data["uri"])).To(Equal(fmt.Sprintf("postgresql://%s:%s@host:12345/database?sslmode=require", secret.Data["username"], secret.Data["password"])))
Expect(string(secret.Data["private_uri"])).To(Equal(fmt.Sprintf("postgresql://%s:%s@private-host:12345/private-database?sslmode=require", secret.Data["username"], secret.Data["password"])))
})

By("deleting the DatabaseUser object", func() {
Expand Down Expand Up @@ -184,6 +188,8 @@ var _ = Describe("DatabaseUser controller", func() {
Expect(secret.OwnerReferences).To(ContainElement(dbUserOwnerReference))
Expect(string(secret.Data["username"])).To(Equal(userName))
Expect(secret.Data["password"]).NotTo(BeEmpty())
Expect(string(secret.Data["uri"])).To(Equal(fmt.Sprintf("postgresql://%s:%s@host:12345/database?sslmode=require", secret.Data["username"], secret.Data["password"])))
Expect(string(secret.Data["private_uri"])).To(Equal(fmt.Sprintf("postgresql://%s:%s@private-host:12345/private-database?sslmode=require", secret.Data["username"], secret.Data["password"])))
})

By("deleting the DatabaseUser object", func() {
Expand Down
14 changes: 11 additions & 3 deletions controllers/databaseuserreference_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,11 @@ func (r *DatabaseUserReferenceReconciler) reconcileDBUserReference(ctx context.C
"user_name", userRef.Spec.Username,
)

db, _, err := r.GodoClient.Databases.Get(ctx, clusterUUID)
if err != nil {
return ctrl.Result{}, fmt.Errorf("looking up DB cluster: %v", err)
}

// The validating webhook checks that the user exists, so normally this
// should work. However, the user could have been deleted in which case
// we'll fail and back off in case it gets re-created.
Expand All @@ -145,7 +150,7 @@ func (r *DatabaseUserReferenceReconciler) reconcileDBUserReference(ctx context.C

userRef.Status.Role = dbUser.Role

err = r.ensureOwnedObjects(ctx, userRef, dbUser)
err = r.ensureOwnedObjects(ctx, db, userRef, dbUser)
if err != nil {
ll.Error(err, "unable to ensure user-related objects")
return ctrl.Result{}, fmt.Errorf("ensuring user-related objects: %v", err)
Expand All @@ -154,8 +159,11 @@ func (r *DatabaseUserReferenceReconciler) reconcileDBUserReference(ctx context.C
return ctrl.Result{RequeueAfter: 5 * time.Minute}, nil
}

func (r *DatabaseUserReferenceReconciler) ensureOwnedObjects(ctx context.Context, userRef *v1alpha1.DatabaseUserReference, dbUser *godo.DatabaseUser) error {
obj := credentialsSecretForDBUser(userRef, dbUser)
func (r *DatabaseUserReferenceReconciler) ensureOwnedObjects(ctx context.Context, db *godo.Database, userRef *v1alpha1.DatabaseUserReference, dbUser *godo.DatabaseUser) error {
obj, err := credentialsSecretForDBUser(db, userRef, dbUser)
if err != nil {
return fmt.Errorf("creating secrett: %s", err)
}
controllerutil.SetControllerReference(userRef, obj, r.Scheme)
if err := r.Patch(ctx, obj, client.Apply, client.ForceOwnership, client.FieldOwner("do-operator")); err != nil {
return fmt.Errorf("applying object %s: %s", client.ObjectKeyFromObject(obj), err)
Expand Down
6 changes: 6 additions & 0 deletions controllers/databaseuserreference_controller_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package controllers

import (
"fmt"

"github.com/digitalocean/do-operator/api/v1alpha1"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
Expand Down Expand Up @@ -83,6 +85,8 @@ var _ = Describe("DatabaseUserReference controller", func() {
Expect(secret.OwnerReferences).To(ContainElement(dbUserRefOwnerReference))
Expect(string(secret.Data["username"])).To(Equal(userName))
Expect(secret.Data["password"]).NotTo(BeEmpty())
Expect(string(secret.Data["uri"])).To(Equal(fmt.Sprintf("postgresql://%s:%s@host:12345/database?sslmode=require", secret.Data["username"], secret.Data["password"])))
Expect(string(secret.Data["private_uri"])).To(Equal(fmt.Sprintf("postgresql://%s:%s@private-host:12345/private-database?sslmode=require", secret.Data["username"], secret.Data["password"])))
})

By("deleting the DatabaseUserReference object", func() {
Expand Down Expand Up @@ -172,6 +176,8 @@ var _ = Describe("DatabaseUserReference controller", func() {
Expect(secret.OwnerReferences).To(ContainElement(dbUserRefOwnerReference))
Expect(string(secret.Data["username"])).To(Equal(userName))
Expect(secret.Data["password"]).NotTo(BeEmpty())
Expect(string(secret.Data["uri"])).To(Equal(fmt.Sprintf("postgresql://%s:%s@host:12345/database?sslmode=require", secret.Data["username"], secret.Data["password"])))
Expect(string(secret.Data["private_uri"])).To(Equal(fmt.Sprintf("postgresql://%s:%s@private-host:12345/private-database?sslmode=require", secret.Data["username"], secret.Data["password"])))
})

By("deleting the DatabaseUserReference object", func() {
Expand Down
4 changes: 2 additions & 2 deletions fakegodo/databases.go
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ func (f *FakeDatabasesService) Create(_ context.Context, req *godo.DatabaseCreat
RegionSlug: req.Region,
CreatedAt: time.Now(),
Connection: &godo.DatabaseConnection{
URI: "uri",
URI: "postgresql://user:password@host:12345/database?sslmode=require",
Database: "database",
Host: "host",
Port: 12345,
Expand All @@ -99,7 +99,7 @@ func (f *FakeDatabasesService) Create(_ context.Context, req *godo.DatabaseCreat
SSL: true,
},
PrivateConnection: &godo.DatabaseConnection{
URI: "private-uri",
URI: "postgresql://private-user:private-password@private-host:12345/private-database?sslmode=require",
Database: "private-database",
Host: "private_host",
Port: 12345,
Expand Down
Loading