From 091561c8f203a2e5f1a19dd15623ee30d93d8051 Mon Sep 17 00:00:00 2001 From: Marco Streich Date: Thu, 23 May 2024 09:53:43 +0200 Subject: [PATCH] feat(postgres): Add resource Implements ninech/managed-services/backlog#581 --- create/create.go | 1 + create/postgres.go | 122 ++++++++++++++++++++++++++++++++++++++ create/postgres_test.go | 107 +++++++++++++++++++++++++++++++++ delete/delete.go | 1 + get/get.go | 1 + internal/test/postgres.go | 28 +++++++++ main.go | 2 +- update/update.go | 1 + 8 files changed, 262 insertions(+), 1 deletion(-) create mode 100644 create/postgres.go create mode 100644 create/postgres_test.go create mode 100644 internal/test/postgres.go diff --git a/create/create.go b/create/create.go index c25ab1b..c26f748 100644 --- a/create/create.go +++ b/create/create.go @@ -28,6 +28,7 @@ type Cmd struct { Config configCmd `cmd:"" group:"deplo.io" name:"config" help:"Create a new deplo.io Project Configuration. (Beta - requires access)"` Application applicationCmd `cmd:"" group:"deplo.io" name:"application" aliases:"app" help:"Create a new deplo.io Application. (Beta - requires access)"` MySQL mySQLCmd `cmd:"" group:"storage.nine.ch" name:"mysql" help:"Create a new MySQL instance."` + Postgres postgresCmd `cmd:"" group:"storage.nine.ch" name:"postgres" help:"Create a new PostgreSQL instance."` KeyValueStore keyValueStoreCmd `cmd:"" group:"storage.nine.ch" name:"keyvaluestore" aliases:"kvs" help:"Create a new KeyValueStore instance"` CloudVirtualMachine cloudVMCmd `cmd:"" group:"infrastructure.nine.ch" name:"cloudvirtualmachine" aliases:"cloudvm" help:"Create a new CloudVM."` } diff --git a/create/postgres.go b/create/postgres.go new file mode 100644 index 0000000..0cc206a --- /dev/null +++ b/create/postgres.go @@ -0,0 +1,122 @@ +package create + +import ( + "context" + "fmt" + "strings" + "time" + + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + "k8s.io/apimachinery/pkg/watch" + + "github.com/alecthomas/kong" + runtimev1 "github.com/crossplane/crossplane-runtime/apis/common/v1" + infra "github.com/ninech/apis/infrastructure/v1alpha1" + meta "github.com/ninech/apis/meta/v1alpha1" + storage "github.com/ninech/apis/storage/v1alpha1" + + "github.com/ninech/nctl/api" + "github.com/ninech/nctl/internal/file" +) + +type postgresCmd struct { + Name string `arg:"" default:"" help:"Name of the PostgreSQL instance. A random name is generated if omitted."` + Location string `placeholder:"${postgres_location_default}" help:"Location where the PostgreSQL instance is created. Available locations are: ${postgres_location_options}"` + MachineType infra.MachineType `placeholder:"${postgres_machine_default}" help:"Defines the sizing for a particular PostgreSQL instance. Available types: ${postgres_machine_types}"` + AllowedCidrs []storage.IPv4CIDR `placeholder:"0.0.0.0/0" help:"Specifies the IP addresses allowed to connect to the instance." ` + SSHKeys []storage.SSHKey `help:"Contains a list of SSH public keys, allowed to connect to the db server, in order to up-/download and directly restore database backups."` + SSHKeysFile string `help:"Path to a file containing a list of SSH public keys (see above), separated by newlines."` + Version string `placeholder:"${postgrees_version_default}" help:"Release version with which the PostgreSQL instance is created"` + KeepDailyBackups *int `placeholder:"${postgres_backup_retention_days}" help:"Number of daily database backups to keep. Note that setting this to 0, backup will be disabled and existing dumps deleted immediately."` + Wait bool `default:"true" help:"Wait until PostgreSQL instance is created."` + WaitTimeout time.Duration `default:"25m" help:"Duration to wait for PostgreSQL getting ready. Only relevant if --wait is set."` +} + +func (cmd *postgresCmd) Run(ctx context.Context, client *api.Client) error { + sshkeys, err := file.ReadSSHKeys(cmd.SSHKeysFile) + if err != nil { + return fmt.Errorf("error when reading SSH keys file: %w", err) + } + cmd.SSHKeys = append(cmd.SSHKeys, sshkeys...) + + fmt.Printf("Creating new postgres. This might take some time (waiting up to %s).\n", cmd.WaitTimeout) + postgres := cmd.newPostgres(client.Project) + + c := newCreator(client, postgres, "postgres") + ctx, cancel := context.WithTimeout(ctx, cmd.WaitTimeout) + defer cancel() + + if err := c.createResource(ctx); err != nil { + return err + } + + if !cmd.Wait { + return nil + } + + return c.wait(ctx, waitStage{ + objectList: &storage.PostgresList{}, + onResult: func(event watch.Event) (bool, error) { + if c, ok := event.Object.(*storage.Postgres); ok { + return isAvailable(c), nil + } + return false, nil + }, + }, + ) +} + +func (cmd *postgresCmd) newPostgres(namespace string) *storage.Postgres { + name := getName(cmd.Name) + + postgres := &storage.Postgres{ + ObjectMeta: metav1.ObjectMeta{ + Name: name, + Namespace: namespace, + }, + Spec: storage.PostgresSpec{ + ResourceSpec: runtimev1.ResourceSpec{ + WriteConnectionSecretToReference: &runtimev1.SecretReference{ + Name: "postgres-" + name, + Namespace: namespace, + }, + }, + ForProvider: storage.PostgresParameters{ + Location: meta.LocationName(cmd.Location), + MachineType: cmd.MachineType, + AllowedCIDRs: []storage.IPv4CIDR{}, // avoid missing parameter error + SSHKeys: []storage.SSHKey{}, // avoid missing parameter error + KeepDailyBackups: cmd.KeepDailyBackups, + }, + }, + } + + if cmd.AllowedCidrs != nil { + postgres.Spec.ForProvider.AllowedCIDRs = cmd.AllowedCidrs + } + if cmd.SSHKeys != nil { + postgres.Spec.ForProvider.SSHKeys = cmd.SSHKeys + } + + return postgres +} + +// ApplicationKongVars returns all variables which are used in the application +// create command +func PostgresKongVars() kong.Vars { + vmTypes := make([]string, len(infra.MachineTypes)) + for i, machineType := range infra.MachineTypes { + vmTypes[i] = string(machineType) + } + + result := make(kong.Vars) + result["postgres_machine_types"] = strings.Join(vmTypes, ", ") + result["postgres_machine_default"] = string(infra.MachineTypes[0]) + result["postgres_location_options"] = strings.Join(storage.PostgresLocationOptions, ", ") + result["postgres_location_default"] = string(storage.PostgresLocationDefault) + result["postgres_version_default"] = string(storage.PostgresVersionDefault) + result["postgres_user"] = storage.PostgresUser + result["postgres_backup_retention_days"] = fmt.Sprintf("%d", storage.PostgresBackupRetentionDaysDefault) + + return result +} diff --git a/create/postgres_test.go b/create/postgres_test.go new file mode 100644 index 0000000..bd51384 --- /dev/null +++ b/create/postgres_test.go @@ -0,0 +1,107 @@ +package create + +import ( + "context" + "errors" + "reflect" + "testing" + "time" + + infra "github.com/ninech/apis/infrastructure/v1alpha1" + storage "github.com/ninech/apis/storage/v1alpha1" + "github.com/ninech/nctl/api" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + "k8s.io/utils/ptr" + "sigs.k8s.io/controller-runtime/pkg/client" + "sigs.k8s.io/controller-runtime/pkg/client/fake" + "sigs.k8s.io/controller-runtime/pkg/client/interceptor" +) + +func TestPostgres(t *testing.T) { + tests := []struct { + name string + create postgresCmd + want storage.PostgresParameters + wantErr bool + interceptorFuncs *interceptor.Funcs + }{ + { + name: "simple", + create: postgresCmd{}, + want: storage.PostgresParameters{}, + }, + { + name: "simpleErrorOnCreation", + create: postgresCmd{}, + wantErr: true, + interceptorFuncs: &interceptor.Funcs{ + Create: func(_ context.Context, _ client.WithWatch, _ client.Object, _ ...client.CreateOption) error { + return errors.New("error on creation") + }, + }, + }, + { + name: "machineType", + create: postgresCmd{MachineType: infra.MachineType("nine-standard-1")}, + want: storage.PostgresParameters{MachineType: infra.MachineType("nine-standard-1")}, + }, + { + name: "sshKeys", + create: postgresCmd{SSHKeys: []storage.SSHKey{"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJGG5/nnivrW4zLD4ANLclVT3y68GAg6NOA3HpzFLo5e test@test"}}, + want: storage.PostgresParameters{SSHKeys: []storage.SSHKey{"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJGG5/nnivrW4zLD4ANLclVT3y68GAg6NOA3HpzFLo5e test@test"}}, + }, + { + name: "allowedCIDRs", + create: postgresCmd{AllowedCidrs: []storage.IPv4CIDR{storage.IPv4CIDR("0.0.0.0/0")}}, + want: storage.PostgresParameters{AllowedCIDRs: []storage.IPv4CIDR{storage.IPv4CIDR("0.0.0.0/0")}}, + }, + { + name: "keepDailyBackups", + create: postgresCmd{KeepDailyBackups: ptr.To(5)}, + want: storage.PostgresParameters{KeepDailyBackups: ptr.To(5)}, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + tt.create.Name = "test-" + t.Name() + tt.create.Wait = false + tt.create.WaitTimeout = time.Second + + scheme, err := api.NewScheme() + if err != nil { + t.Fatal(err) + } + builder := fake.NewClientBuilder().WithScheme(scheme) + if tt.interceptorFuncs != nil { + builder = builder.WithInterceptorFuncs(*tt.interceptorFuncs) + } + postgresClient := builder.Build() + apiClient := &api.Client{WithWatch: postgresClient, Project: "default"} + ctx := context.Background() + + if err := tt.create.Run(ctx, apiClient); (err != nil) != tt.wantErr { + t.Errorf("postgresCmd.Run() error = %v, wantErr %v", err, tt.wantErr) + } + + created := &storage.Postgres{ObjectMeta: metav1.ObjectMeta{Name: tt.create.Name, Namespace: apiClient.Project}} + if err := apiClient.Get(ctx, api.ObjectName(created), created); (err != nil) != tt.wantErr { + t.Fatalf("expected postgres to exist, got: %s", err) + } + if tt.wantErr { + return + } + + // we set defaults for the slices + if tt.want.AllowedCIDRs == nil { + tt.want.AllowedCIDRs = []storage.IPv4CIDR{} + } + if tt.want.SSHKeys == nil { + tt.want.SSHKeys = []storage.SSHKey{} + } + + if !reflect.DeepEqual(created.Spec.ForProvider, tt.want) { + t.Fatalf("expected postgres.Spec.ForProvider = %+v, got: %+v", created.Spec.ForProvider, tt.want) + } + }) + } +} diff --git a/delete/delete.go b/delete/delete.go index a3a86c5..e402602 100644 --- a/delete/delete.go +++ b/delete/delete.go @@ -22,6 +22,7 @@ type Cmd struct { MySQL mySQLCmd `cmd:"" group:"storage.nine.ch" name:"mysql" help:"Delete a MySQL instance."` KeyValueStore keyValueStoreCmd `cmd:"" group:"storage.nine.ch" name:"keyvaluestore" aliases:"kvs" help:"Delete a KeyValueStore instance."` CloudVirtualMachine cloudVMCmd `cmd:"" group:"infrastructure.nine.ch" name:"cloudvirtualmachine" aliases:"cloudvm" help:"Delete a CloudVM."` + //Postgres postgresCmd `cmd:"" group:"storage.nine.ch" name:"postgres" help:"Delete a PostgreSQL instance."` } // cleanupFunc is called after the resource has been deleted in order to do diff --git a/get/get.go b/get/get.go index d331a4e..ca02138 100644 --- a/get/get.go +++ b/get/get.go @@ -29,6 +29,7 @@ type Cmd struct { All allCmd `cmd:"" name:"all" help:"Get project content"` CloudVirtualMachine cloudVMCmd `cmd:"" group:"infrastructure.nine.ch" name:"cloudvirtualmachine" aliases:"cloudvm" help:"Get a CloudVM."` opts []runtimeclient.ListOption + //Postgres postgresCmd `cmd:"" group:"storage.nine.ch" name:"postgres" help:"Get PostgreSQL instances."` } type output string diff --git a/internal/test/postgres.go b/internal/test/postgres.go new file mode 100644 index 0000000..58454f8 --- /dev/null +++ b/internal/test/postgres.go @@ -0,0 +1,28 @@ +package test + +import ( + runtimev1 "github.com/crossplane/crossplane-runtime/apis/common/v1" + meta "github.com/ninech/apis/meta/v1alpha1" + storage "github.com/ninech/apis/storage/v1alpha1" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +) + +func Postgres(name, project, location string) *storage.Postgres { + return &storage.Postgres{ + ObjectMeta: metav1.ObjectMeta{ + Name: name, + Namespace: project, + }, + Spec: storage.PostgresSpec{ + ResourceSpec: runtimev1.ResourceSpec{ + WriteConnectionSecretToReference: &runtimev1.SecretReference{ + Name: name, + Namespace: project, + }, + }, + ForProvider: storage.PostgresParameters{ + Location: meta.LocationName(location), + }, + }, + } +} diff --git a/main.go b/main.go index 55fa34a..33a6bd2 100644 --- a/main.go +++ b/main.go @@ -149,7 +149,7 @@ func kongVariables() (kong.Vars, error) { if err != nil { return nil, fmt.Errorf("error on application create kong vars: %w", err) } - if err := merge(result, appCreateKongVars, create.MySQLKongVars()); err != nil { + if err := merge(result, appCreateKongVars, create.MySQLKongVars(), create.PostgresKongVars()); err != nil { return nil, fmt.Errorf("error when merging kong variables: %w", err) } diff --git a/update/update.go b/update/update.go index ceb2d7b..05288a0 100644 --- a/update/update.go +++ b/update/update.go @@ -15,6 +15,7 @@ type Cmd struct { MySQL mySQLCmd `cmd:"" group:"storage.nine.ch" name:"mysql" help:"Update an existing MySQL instance."` KeyValueStore keyValueStoreCmd `cmd:"" group:"storage.nine.ch" name:"keyvaluestore" aliases:"kvs" help:"Update an existing KeyValueStore instance"` CloudVirtualMachine cloudVMCmd `cmd:"" group:"infrastructure.nine.ch" name:"cloudvirtualmachine" aliases:"cloudvm" help:"Update a CloudVM."` + //Postgres postgresCmd `cmd:"" group:"storage.nine.ch" name:"postgres" help:"Update an existing PostgreSQL instance."` } type updater struct {