Skip to content
This repository has been archived by the owner on Feb 22, 2022. It is now read-only.

[incubator/jaeger] Allow globally and individual overrides for names of components #3461

Merged
merged 4 commits into from
Feb 2, 2018

Conversation

davidvonthenen
Copy link
Collaborator

@davidvonthenen davidvonthenen commented Jan 26, 2018

This PR provides a consistent method for a given user to override the default names of components in the Jaeger chart. This is required in order for charts using Jaeger as a dependency to allow the Jaeger components have a consistent naming conventions for the parent charts components. Previously, there was some functionality to do name overrides only for select components, but this PR creates a consistent method for all components in Jaeger.

Currently, the default format all component names are prefixed with --. As an example, if the helm release name is called myrel, the collector deployment is named myrel-jaeger-collector. This PR implements 2 methods of overriding the prefix (-). The first is an option for globally changing the prefix for all components and the second is allowing the individual override of a single component. If both the global override and an individual override of a component is used, the individual component override takes precedence over the global. Please see examples below.

If --set fullnameOverride=mycomponents, the Jaeger components that get deployed will be named:

  • mycomponents-collector
  • mycomponents-query
  • mycomponents-agent

If --set fullnameOverride=mycomponent and --set query.fullnameOverride=yourcomponents, the Jaeger components that get deployed will be named:

  • mycomponents-collector
  • yourcomponent-query
  • mycomponents-agent

If --set collector.fullnameOverride=thiscomponent and the name of the release is called myrel, the Jaeger components that get deployed will be named:

  • thiscomponent-collector
  • myrel-jaeger-query
  • myrel-jaeger-agent

These nameOverride options are considered very advanced and should only be used by implementers of charts where Jaeger is a dependency chart OR for very advanced users. As such, the README will not be updated to reflect these options.

Tested on kubernetes 1.7 and 1.8 and also tested using Jaeger as a dependent chart to have consistent names with the parent chart.

UPDATE: to reflect the new variable fullnameOverride

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 26, 2018
@davidvonthenen
Copy link
Collaborator Author

cc @unguiculus

@unguiculus
Copy link
Member

The fullname template you get with helm create has recently been updated. Could you base your changes on that?

See https://github.com/kubernetes/helm/blob/master/pkg/chartutil/create.go#L265-L281

@unguiculus unguiculus self-assigned this Jan 30, 2018
@davidvonthenen
Copy link
Collaborator Author

Let me do a sanity check on it... it should be good since the defines havent changed.

@davidvonthenen
Copy link
Collaborator Author

@unguiculus Ok tested the different combinations and it behaves as expected.

@unguiculus
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 2, 2018
@unguiculus
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Feb 2, 2018
@unguiculus
Copy link
Member

/lgtm

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dvonthenen, unguiculus

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

Needs approval from an approver in each of these OWNERS Files:

You can indicate your approval by writing /approve in a comment
You can cancel your approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit fee41a9 into helm:master Feb 2, 2018
@davidvonthenen
Copy link
Collaborator Author

Thanks @unguiculus

@davidvonthenen davidvonthenen deleted the feature/jaegeroverride branch September 10, 2019 14:02
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants