-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #103 from ninech/marco/postgres
feat(postgres): Add resource
- Loading branch information
Showing
24 changed files
with
745 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| 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 []meta.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."` | ||
| PostgresVersion storage.PostgresVersion `placeholder:"${postgres_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: []meta.IPv4CIDR{}, // avoid missing parameter error | ||
| SSHKeys: []storage.SSHKey{}, // avoid missing parameter error | ||
| Version: cmd.PostgresVersion, | ||
| 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 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| package create | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "reflect" | ||
| "testing" | ||
| "time" | ||
|
|
||
| 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" | ||
| 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: []meta.IPv4CIDR{meta.IPv4CIDR("0.0.0.0/0")}}, | ||
| want: storage.PostgresParameters{AllowedCIDRs: []meta.IPv4CIDR{meta.IPv4CIDR("0.0.0.0/0")}}, | ||
| }, | ||
| { | ||
| name: "version", | ||
| create: postgresCmd{PostgresVersion: storage.PostgresVersionDefault}, | ||
| want: storage.PostgresParameters{Version: storage.PostgresVersionDefault}, | ||
| }, | ||
| { | ||
| 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 = []meta.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) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| package delete | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "k8s.io/apimachinery/pkg/types" | ||
|
|
||
| storage "github.com/ninech/apis/storage/v1alpha1" | ||
| "github.com/ninech/nctl/api" | ||
| ) | ||
|
|
||
| type postgresCmd struct { | ||
| Name string `arg:"" help:"Name of the PostgreSQL resource."` | ||
| Force bool `default:"false" help:"Do not ask for confirmation of deletion."` | ||
| Wait bool `default:"true" help:"Wait until PostgreSQL is fully deleted."` | ||
| WaitTimeout time.Duration `default:"300s" help:"Duration to wait for the deletion. Only relevant if wait is set."` | ||
| } | ||
|
|
||
| func (cmd *postgresCmd) Run(ctx context.Context, client *api.Client) error { | ||
| ctx, cancel := context.WithTimeout(ctx, cmd.WaitTimeout) | ||
| defer cancel() | ||
|
|
||
| postgres := &storage.Postgres{} | ||
| postgresName := types.NamespacedName{Name: cmd.Name, Namespace: client.Project} | ||
| if err := client.Get(ctx, postgresName, postgres); err != nil { | ||
| return fmt.Errorf("unable to get postgres %q: %w", postgres.Name, err) | ||
| } | ||
|
|
||
| return newDeleter(postgres, storage.PostgresKind).deleteResource(ctx, client, cmd.WaitTimeout, cmd.Wait, cmd.Force) | ||
| } |
Oops, something went wrong.