K8SPG-710: Make spec.backups optional

[egegunes]

CHANGE DESCRIPTION

This PR allows creating a PerconaPGCluster with backups disabled. To create a cluster with backups disabled, remove spec.backups section from deploy/cr.yaml and apply.

If you want to disable backups in a running cluster, you need to annotate PerconaPGCluster with pgv2.percona.com/authorizeBackupRemoval: true otherwise operator won't reconcile cluster and backup related objects won't be removed.

Once backups are disabled, operator will delete repo-host PVC. So any backups stored in that PVC will be deleted. Backups in cloud storages won't be deleted.

Helm chart PR: percona/percona-helm-charts#516

CHECKLIST

Jira

• Is the Jira ticket created and referenced properly?
• Does the Jira ticket have the proper statuses for documentation (Needs Doc) and QA (Needs QA)?
• Does the Jira ticket link to the proper milestone (Fix Version field)?

Tests

• Is an E2E test/test case added for the new feature/change?
• Are unit tests added where appropriate?

Config/Logging/Testability

• Are all needed new/changed options added to default YAML files?
• Are all needed new/changed options added to the Helm Chart?
• Did we add proper logging messages for operator actions?
• Did we ensure compatibility with the previous version or cluster upgrade process?
• Does the change support oldest and newest supported PG version?
• Does the change support oldest and newest supported Kubernetes version?

[gkech]

I think we should document here that this works like that because backups were enabled by default before these changes, by looking it with fresh eyes, seems like inconsistency/bug.

I think we can also add a unit test like the following

func TestPerconaPGCluster_BackupsEnabled(t *testing.T) {
	trueVal := true
	falseVal := false

	tests := map[string]struct {
		spec     PerconaPGClusterSpec
		expected bool
	}{

		"Enabled is nil - should return true <explain reason maybe>": {
			spec:     PerconaPGClusterSpec{Backups: Backups{Enabled: nil}},
			expected: true,
		},
		"Enabled is true, should return true": {
			spec:     PerconaPGClusterSpec{Backups: Backups{Enabled: &trueVal}},
			expected: true,
		},
		"Enabled is false - should return false": {
			spec:     PerconaPGClusterSpec{Backups: Backups{Enabled: &falseVal}},
			expected: false,
		},
	}

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			actual := tt.spec.BackupsEnabled()
			assert.Equal(t, tt.expected, actual)
		})
	}
}

[egegunes]

4485a3e

[gkech]

I think that given that we introduce this function, we should first add this function with Backups receiver since it is its own responsibility to determine if it is enabled or not, and then this new function can be used here because PerconaPGClusterSpec knows Backups

[gkech]

we can then use this new function with the backups receiver, here

func (b Backups) ToCrunchy(version string) crunchyv1beta1.Backups {
	if b.Enabled != nil && !*b.Enabled {
		return crunchyv1beta1.Backups{}
	}

[egegunes]

4485a3e

[nmarukovich]

Maybe we can add one more state like skipped or disabled? Technically it's not failed it's just disabled.

[egegunes]

In K8SPSMDB we also set backup state to Failed if cluster is not ready. I don't think we need to complicate things.

[JNKPercona]

Test name	Status
backup-enable-disable	passed
custom-extensions	passed
custom-tls	passed
demand-backup	passed
finalizers	passed
init-deploy	passed
monitoring	passed
monitoring-pmm3	passed
one-pod	passed
operator-self-healing	passed
pitr	passed
scaling	passed
scheduled-backup	passed
self-healing	passed
sidecars	passed
start-from-backup	passed
tablespaces	passed
telemetry-transfer	passed
upgrade-consistency	passed
upgrade-minor	passed
users	passed
We run 21 out of 21

commit: bbbe9cc
image: perconalab/percona-postgresql-operator:PR-1021-bbbe9ccaf