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

feat(manifests): add name on workflow-controller-metrics service port #2744

Merged
merged 1 commit into from
Apr 19, 2020

Conversation

dustinspecker
Copy link
Contributor

@dustinspecker dustinspecker commented Apr 18, 2020

While adding a name is optional from a Kubernetes standpoint since there
is only one port listed, the named port makes using Prometheus easier.
There's a targetPort option for Prometheus' ServiceMonitor Custom
Resource, but this targetPort doesn't relate to the service's
targetPort, but in fact the containers' targetPort pointed at by the
service [1]. And since the workflow-controller deployment doesn't
actually explicitly list the ports the targetPort configuration on a
ServiceMonitor does nothing. So having the named port on the service's
port makes it much easier to use for Prometheus.

1 - prometheus-operator/prometheus-operator#2515

I'm not actually sure how to use this service with Prometheus-operator without this named port. I considered this commit a feature, but might actually be a fix. Please let me know if it's preferred for me to use fix instead of feat for this.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this is a chore.
  • The title of the PR is (a) conventional, (b) states what changed, and (c) suffixes the related issues number. E.g. "fix(controller): Updates such and such. Fixes #1234".
  • I've signed the CLA.
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My builds are green. Try syncing with master if they are not.
  • My organization is added to USERS.md.

While adding a name is optional from a Kubernetes standpoint since there
is only one port listed, the named port makes using Prometheus easier.
There's a targetPort option for Prometheus' ServiceMonitor Custom
Resource, but this targetPort doesn't relate to the service's
targetPort, but in fact the containers' targetPort pointed at by the
service [1]. And since the workflow-controller deployment doesn't
actually explicitly list the ports the targetPort configuration on a
ServiceMonitor does nothing. So having the named port on the service's
port makes it much easier to use for Prometheus.

1 - prometheus-operator/prometheus-operator#2515
@alexec alexec requested a review from simster7 April 18, 2020 01:30
@alexec alexec merged commit c6ef1ff into argoproj:master Apr 19, 2020
@dustinspecker dustinspecker deleted the add-metrics-port-name branch April 19, 2020 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants