osiris icon indicating copy to clipboard operation
osiris copied to clipboard

Rename the annotation used to inject the proxy

Open vbehar opened this issue 6 years ago • 4 comments

Following #47 here, let's rename the annotation used to inject the proxy in the pods:

  • previous annotation key: osiris.deislabs.io/enabled
  • new annotation key: osiris.deislabs.io/injectProxy

so that we can avoid confusion between the deployments and pods annotations

vbehar avatar Oct 24 '19 08:10 vbehar

@vbehar I'm wondering about maybe using an annotation that references purpose more than implementation. What about osiris.deislabs.io/collectMetrics? That doesn't say how the metrics are collected and doesn't invite users to concern themselves with that detail.

krancour avatar Oct 24 '19 17:10 krancour

Codecov Report

Merging #49 into master will decrease coverage by 0.05%. The diff coverage is 60%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #49      +/-   ##
==========================================
- Coverage   58.77%   58.72%   -0.06%     
==========================================
  Files          11       11              
  Lines         638      642       +4     
==========================================
+ Hits          375      377       +2     
- Misses        234      236       +2     
  Partials       29       29
Impacted Files Coverage Δ
pkg/kubernetes/osiris.go 94.44% <60%> (-5.56%) :arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3f71d07...ef8e139. Read the comment docs.

codecov-io avatar Oct 25 '19 06:10 codecov-io

@krancour yes, good idea

vbehar avatar Oct 25 '19 06:10 vbehar

@vbehar thanks for updating this to osiris.deislabs.io/collectMetrics. I think the original, ambiguous osiris.deislabs.io/enabled still appears on deployment and service resources. I'm thinking they deserve the same treatment as part of this PR. Something like osiris.deislabs.io/manageEndpoints for service resources and something like osiris.deislabs.io/enableScaling for deployments.

krancour avatar Oct 28 '19 13:10 krancour