Update labels to use kubernetes recommended labels #4722

therealdwright · 2024-05-09T02:39:36Z

What does this PR do?

Kubernetes have not used the app or k8s-app for some time
and have provided guidance on what the recommended labels are
for some time as seen in their docs.

This commit updates all manifests/docs to use this approach.

Why is it important?

Users who choose to adopt kubernetes label best practises will not have to fork elastic manifests and can instead rely on the upstream ones directly.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in ./changelog/fragments using the changelog tool
I have added an integration test or an E2E test

Disruptive User Impact

Users will need to upgrade using kubectl replace as some of the labels are immutable

cla-checker-service · 2024-05-09T02:39:40Z

💚 CLA has been signed

mergify · 2024-05-09T02:40:18Z

This pull request does not have a backport label. Could you fix it @therealdwright? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-v./d./d./d is the label to automatically backport to the 8./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

elasticmachine · 2024-05-10T06:31:43Z

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

gizas

Looks good!

blakerouse

Definitely need a changelog entry for this change, as this affects users.

pierrehilbert · 2024-05-12T07:50:56Z

@therealdwright Thanks for your contribution and signing the CLA.
As @blakerouse mentioned, could you please add de changelog entry to let our users be aware of this change?

therealdwright · 2024-05-12T22:03:11Z

could you please add de changelog entry to let our users be aware of this change?

I've pushed a change log entry as requested.

blakerouse

Thanks for the changelog.

therealdwright · 2024-05-15T01:55:18Z

@blakerouse I have rebased on main as the SonarQube Code Analysis and buildkite/elastic-agent were stuck in waiting for status to be reported. LMK if this is something maintainers must manually trigger.

blakerouse · 2024-05-15T18:28:23Z

@therealdwright Yes it requires an authorized user to approve and run the workflows. This ensures we can review the change before we allow it to run on an actual machine.

ycombinator · 2024-05-24T02:01:05Z

CI failures look relevant

How do contributors get access to CI logs?

Oops, sorry about that, @therealdwright! Here are the logs that are relevant:

diff --git a/deploy/kubernetes/elastic-agent-managed-kubernetes.yaml b/deploy/kubernetes/elastic-agent-managed-kubernetes.yaml
--
  | index 074a15daa1..b54834c313 100644
  | a/deploy/kubernetes/elastic-agent-managed-kubernetes.yaml | 0s
  | b/deploy/kubernetes/elastic-agent-managed-kubernetes.yaml | 0s
  | @@ -212,7 +212,7 @@ kind: ClusterRole
  | metadata:
  | name: elastic-agent
  | labels:
  | -    app.kubernetes.io/name.kubernetes.io/name: elastic-agent
  | +    app.kubernetes.io/name: elastic-agent
  | rules:
  | - apiGroups: [""]
  | resources:
  | @@ -284,7 +284,7 @@ metadata:
  | # Should be the namespace where elastic-agent is running
  | namespace: kube-system
  | labels:
  | -    app.kubernetes.io/name.kubernetes.io/name: elastic-agent
  | +    app.kubernetes.io/name: elastic-agent
  | rules:
  | - apiGroups:
  | - coordination.k8s.io
  | @@ -298,7 +298,7 @@ metadata:
  | name: elastic-agent-kubeadm-config
  | namespace: kube-system
  | labels:
  | -    app.kubernetes.io/name.kubernetes.io/name: elastic-agent
  | +    app.kubernetes.io/name: elastic-agent
  | rules:
  | - apiGroups: [""]
  | resources:
  | @@ -313,5 +313,5 @@ metadata:
  | name: elastic-agent
  | namespace: kube-system
  | labels:
  | -    app.kubernetes.io/name.kubernetes.io/name: elastic-agent
  | +    app.kubernetes.io/name: elastic-agent
  | ---
  | deploy/kubernetes/elastic-agent-managed-kubernetes.yaml: needs update
  | make[1]: *** [Makefile:59: check-no-changes] Error 1
  | make[1]: Leaving directory '/opt/buildkite-agent/builds/bk-agent-prod-gcp-1716236865505762234/elastic/elastic-agent'
  | make: *** [Makefile:40: check-ci] Error 2

To fix that, I ran make generate-k8s from the deploy/kubernetes folder and pushed up 04de6e6 with the changes.

ycombinator · 2024-05-24T17:18:21Z

buildkite test this

elastic-sonarqube · 2024-05-24T17:48:23Z

Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

mergify · 2024-09-11T13:14:25Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b update-app-labels upstream/update-app-labels
git merge upstream/main
git push upstream update-app-labels

jlind23 · 2024-10-07T16:50:33Z

buildkite test it

jlind23 · 2024-10-07T17:00:12Z

@gizas Unfortunately this PR hasn't been looked at for quite a while, would you mind reviewing it again in light of all the recent changes that could have affected the kustomize templates?

pkoutsovasilis · 2024-10-07T17:00:48Z

...ze/ksm-autosharding/elastic-agent-standalone/extra/elastic-agent-standalone-statefulset.yaml

@@ -66,6 +66,8 @@ spec:
              valueFrom:
                fieldRef:
                  fieldPath: metadata.name
+            - name: STATE_PATH


@gizas this isn't a label change, so is this change required?

Same as above, not needed

pkoutsovasilis · 2024-10-07T17:01:13Z

...omize/ksm-autosharding/elastic-agent-standalone/base/elastic-agent-standalone-daemonset.yaml

@@ -66,6 +66,8 @@ spec:
              valueFrom:
                fieldRef:
                  fieldPath: metadata.name
+            - name: STATE_PATH


@gizas this isn't a label change, so is this change required?

Indeed is not needed

It was not me that added this but I will rebase and remove.

elastic-sonarqube · 2024-10-07T17:32:51Z

Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

swiatekm

Looks good to me, minus @pkoutsovasilis comment about the STATE_PATH variable.

Kubernetes have not used the `app` or `k8s-app` for some time and have provided guidance on what the recommended labels are for some time as seen in their [docs](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/). This commit updates all manifests/docs to use this approach.

jlind23 · 2024-10-11T07:31:26Z

Sonar and CI check will never run as there was no code change hence force merging this as both @swiatekm and @blakerouse approved.

jlind23 · 2024-10-11T07:32:16Z

Thanks @therealdwright for pushing this through!

Kubernetes have not used the `app` or `k8s-app` for some time and have provided guidance on what the recommended labels are for some time as seen in their [docs](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/). This commit updates all manifests/docs to use this approach. Co-authored-by: Julien Lind <julien.lind@elastic.co> (cherry picked from commit f2af90f)

Kubernetes have not used the `app` or `k8s-app` for some time and have provided guidance on what the recommended labels are for some time as seen in their [docs](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/). This commit updates all manifests/docs to use this approach. Co-authored-by: Julien Lind <julien.lind@elastic.co> (cherry picked from commit f2af90f) Co-authored-by: Daniel Wright <danielwright@bitgo.com>

therealdwright requested review from a team as code owners May 9, 2024 02:39

therealdwright requested review from MichaelKatsoulis, tetianakravchenko, blakerouse and andrzej-stencel May 9, 2024 02:39

mergify bot assigned therealdwright May 9, 2024

mergify bot added the backport-skip label May 9, 2024

ycombinator requested review from michalpristas and removed request for andrzej-stencel May 9, 2024 21:48

therealdwright force-pushed the update-app-labels branch 2 times, most recently from 0832609 to 711f3f1 Compare May 9, 2024 21:53

pierrehilbert added the Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team label May 10, 2024

pierrehilbert added the Team:Cloudnative-Monitoring Label for the Cloud Native Monitoring team label May 10, 2024

gizas approved these changes May 10, 2024

View reviewed changes

blakerouse requested changes May 10, 2024

View reviewed changes

therealdwright force-pushed the update-app-labels branch from 711f3f1 to 4cc5930 Compare May 12, 2024 22:02

therealdwright requested a review from blakerouse May 12, 2024 22:02

blakerouse approved these changes May 13, 2024

View reviewed changes

blakerouse enabled auto-merge (squash) May 13, 2024 14:15

auto-merge was automatically disabled May 15, 2024 01:54
Head branch was pushed to by a user without write access

therealdwright force-pushed the update-app-labels branch from 4cc5930 to 8f6c679 Compare May 15, 2024 01:54

blakerouse enabled auto-merge (squash) May 15, 2024 18:29

ycombinator removed request for MichaelKatsoulis, tetianakravchenko and michalpristas May 28, 2024 19:48

ycombinator force-pushed the update-app-labels branch from 04de6e6 to c96ec46 Compare May 28, 2024 19:48

auto-merge was automatically disabled June 4, 2024 06:35
Head branch was pushed to by a user without write access

therealdwright force-pushed the update-app-labels branch from c96ec46 to 114baf8 Compare June 4, 2024 06:35

v1v added the backport-8.x Automated backport to the 8.x branch with mergify label Sep 11, 2024

jlind23 requested a review from pkoutsovasilis October 7, 2024 16:50

jlind23 requested review from swiatekm and gizas October 7, 2024 16:52

pkoutsovasilis reviewed Oct 7, 2024

View reviewed changes

swiatekm reviewed Oct 8, 2024

View reviewed changes

therealdwright force-pushed the update-app-labels branch from deb2225 to a39df6d Compare October 8, 2024 08:34

swiatekm approved these changes Oct 8, 2024

View reviewed changes

Merge branch 'main' into update-app-labels

88bd8bb

jlind23 merged commit f2af90f into elastic:main Oct 11, 2024
6 checks passed

mergify bot mentioned this pull request Oct 11, 2024

[8.x](backport #4722) Update labels to use kubernetes recommended labels #5759

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update labels to use kubernetes recommended labels #4722

Update labels to use kubernetes recommended labels #4722

therealdwright commented May 9, 2024

cla-checker-service bot commented May 9, 2024 •

edited

Loading

mergify bot commented May 9, 2024

elasticmachine commented May 10, 2024

gizas left a comment

blakerouse left a comment

pierrehilbert commented May 12, 2024

therealdwright commented May 12, 2024

blakerouse left a comment

therealdwright commented May 15, 2024

blakerouse commented May 15, 2024

ycombinator commented May 24, 2024

ycombinator commented May 24, 2024

elastic-sonarqube bot commented May 24, 2024

mergify bot commented Sep 11, 2024

jlind23 commented Oct 7, 2024

jlind23 commented Oct 7, 2024

pkoutsovasilis Oct 7, 2024

gizas Oct 8, 2024

pkoutsovasilis Oct 7, 2024

gizas Oct 8, 2024

therealdwright Oct 8, 2024

elastic-sonarqube bot commented Oct 7, 2024

swiatekm left a comment

jlind23 commented Oct 11, 2024

jlind23 commented Oct 11, 2024

Update labels to use kubernetes recommended labels #4722

Update labels to use kubernetes recommended labels #4722

Conversation

therealdwright commented May 9, 2024

What does this PR do?

Why is it important?

Checklist

Disruptive User Impact

cla-checker-service bot commented May 9, 2024 • edited Loading

mergify bot commented May 9, 2024

elasticmachine commented May 10, 2024

gizas left a comment

Choose a reason for hiding this comment

blakerouse left a comment

Choose a reason for hiding this comment

pierrehilbert commented May 12, 2024

therealdwright commented May 12, 2024

blakerouse left a comment

Choose a reason for hiding this comment

therealdwright commented May 15, 2024

blakerouse commented May 15, 2024

ycombinator commented May 24, 2024

ycombinator commented May 24, 2024

elastic-sonarqube bot commented May 24, 2024

Quality Gate passed

mergify bot commented Sep 11, 2024

jlind23 commented Oct 7, 2024

jlind23 commented Oct 7, 2024

pkoutsovasilis Oct 7, 2024

Choose a reason for hiding this comment

gizas Oct 8, 2024

Choose a reason for hiding this comment

pkoutsovasilis Oct 7, 2024

Choose a reason for hiding this comment

gizas Oct 8, 2024

Choose a reason for hiding this comment

therealdwright Oct 8, 2024

Choose a reason for hiding this comment

elastic-sonarqube bot commented Oct 7, 2024

Quality Gate passed

swiatekm left a comment

Choose a reason for hiding this comment

jlind23 commented Oct 11, 2024

jlind23 commented Oct 11, 2024

cla-checker-service bot commented May 9, 2024 •

edited

Loading