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

Add label version in deployment specification for compatibility with istio #1579

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Arpit529Srivastava
Copy link

@Arpit529Srivastava Arpit529Srivastava commented Jan 16, 2025

What will this PR will do ?

This PR updates the Helm Deployment template to include Istio-recommended labels in the pod metadata. These labels enhance the telemetry and observability capabilities provided by Istio, ensuring better integration and contextual metrics collection.

Changes Made

  • Added Istio-Specific Labels:
    service.istio.io/canonical-name: Identifies the canonical name of the application.
    service.istio.io/canonical-revision: Specifies the version or revision of the application.
  • Added Kubernetes Standard Labels:
    app.kubernetes.io/name: Indicates the name of the application.
    app.kubernetes.io/version: Defines the version of the application.

Fixes jenkins-x/jx#2705

@jenkins-x-bot
Copy link
Contributor

Hi @Arpit529Srivastava. Thanks for your PR.

I'm waiting for a jenkins-x member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the jenkins-x/lighthouse repository.

@jenkins-x-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign skisocks
You can assign the PR to them by writing /assign @skisocks in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@Arpit529Srivastava
Copy link
Author

/assign @Skisocks

Copy link
Member

@msvticket msvticket left a comment

Choose a reason for hiding this comment

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

Thank you for the PR!

I think the PR should be kept minimal while solving the issue. In the istio documentation it say:

  • Application name: service.istio.io/canonical-name, app.kubernetes.io/name, or app.
  • Application version: service.istio.io/canonical-revision, app.kubernetes.io/version, or version.

The application name is already specified with the label app, so as the issue describes it is only the version that is needed.

Of the version labels I think you should keep app.kubernetes.io/version, since that is the one listed here as well.

@Arpit529Srivastava
Copy link
Author

Arpit529Srivastava commented Jan 16, 2025

@msvticket should i hard code it to this ?
app.kubernetes.io/version: "5.7.21"

let me know if there is any changes you want.

@msvticket
Copy link
Member

@msvticket should i hard code it to this ? app.kubernetes.io/version: "5.7.21"

let me know if there is any changes you want.

Hard code the value? No... {{ .Chart.Version }} is good as the value.

Here they recommend {{ .Chart.AppVersion }}, but in our case that doesn't really matter since our default pipelines put the same value for Version and AppVersion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add label version in deployment specification for compatibility with istio
4 participants