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

Always use dc.ObjectMeta.Name-pdb for the PodDisruptionBudget #734

Merged
merged 1 commit into from
Nov 19, 2024
Merged
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Changelog for Cass Operator, new PRs should update the `main / unreleased` secti

## unreleased

* [CHANGE] [#720](https://github.com/k8ssandra/cass-operator/issues/720) Always use ObjectMeta.Name for the PodDisruptionBudget resource name, not the DatacenterName
* [FEATURE] [#651](https://github.com/k8ssandra/cass-operator/issues/651) Add tsreload task for DSE deployments and ability to check if sync operation is available on the mgmt-api side
* [BUGFIX] [#705](https://github.com/k8ssandra/cass-operator/issues/705) Ensure ConfigSecret has annotations map before trying to set a value

Expand Down
4 changes: 2 additions & 2 deletions pkg/reconciliation/constructor.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/client"
)

// Create a PodDisruptionBudget object for the Datacenter
// newPodDisruptionBudgetForDatacenter creates a PodDisruptionBudget object for the Datacenter
func newPodDisruptionBudgetForDatacenter(dc *api.CassandraDatacenter) *policyv1.PodDisruptionBudget {
minAvailable := intstr.FromInt(int(dc.Spec.Size - 1))
labels := dc.GetDatacenterLabels()
Expand All @@ -31,7 +31,7 @@ func newPodDisruptionBudgetForDatacenter(dc *api.CassandraDatacenter) *policyv1.

pdb := &policyv1.PodDisruptionBudget{
ObjectMeta: metav1.ObjectMeta{
Name: dc.LabelResourceName() + "-pdb",
Name: dc.Name + "-pdb",
Copy link

@frivoire frivoire Nov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why use a -pdb suffix here ?
It seems useless to me, since K8S resource name only needs to be unique for a given kind of resource.

So, I would suggest to:

Suggested change
Name: dc.Name + "-pdb",
Name: dc.Name,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right that it would be enough without the pdb suffix, but in this case the name was picked years ago. For most clusters created with cass-operator, this change will make no difference and the backwards compatibility is retained without any extra objects.

Namespace: dc.Namespace,
Labels: labels,
Annotations: anns,
Expand Down
31 changes: 31 additions & 0 deletions pkg/reconciliation/constructor_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package reconciliation

import (
"testing"

api "github.com/k8ssandra/cass-operator/apis/cassandra/v1beta1"
"github.com/stretchr/testify/assert"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func TestPodDisruptionBudget(t *testing.T) {
assert := assert.New(t)

dc := &api.CassandraDatacenter{
ObjectMeta: metav1.ObjectMeta{
Name: "dc1",
Namespace: "test",
},
Spec: api.CassandraDatacenterSpec{
DatacenterName: "dc1-override",
Size: 3,
},
}

// create a PodDisruptionBudget object
pdb := newPodDisruptionBudgetForDatacenter(dc)
assert.Equal("dc1-pdb", pdb.Name)
assert.Equal("test", pdb.Namespace)
assert.Equal("dc1", pdb.Spec.Selector.MatchLabels["cassandra.datastax.com/datacenter"])
assert.Equal(pdb.Spec.MinAvailable.IntVal, int32(dc.Spec.Size-1))
}
Loading