How to correctly do Automatic Proxy Injection?

[hongbo-miao]

Hi everyone! I am reading Automatic Proxy Injection section, I thought if I add

      annotations:
        linkerd.io/inject: enabled

like

apiVersion: apps/v1
kind: Deployment
metadata:
  name: api-go-deployment
  namespace: hm
spec:
  ...
  template:
    metadata:
      labels:
        component: api-go
      annotations:
        linkerd.io/inject: enabled

After deploying by, for example, Helm by helm install mychart mychart, it will be auto injected instead of manually running

kubectl get deployments --namespace=hm --output=yaml | linkerd inject - | kubectl apply -f -

But turns out I am wrong.

I am wondering what is the right way for Automatic Proxy Injection? Thanks!

[cpretzer]

@hongbo-miao that configuration looks correct.

As long as your application is deployed with helm after Linkerd is installed, then I'd expect the proxy-injector component to detect the annotation and inject the proxy into the pod.

[hongbo-miao]

Thanks @cpretzer ! I found it needs to be at two places to make it work. If add it to only either only one place, it won't work.
BTW, I am new so I am still trying to understand the meaning / difference of these two places.

[kleimkuhler]

@hongbo-miao You are correct in the original description that the annotation should only be needed in the template field of a deployment; it should not be required as an annotation on the deployment itself.

You can confirm that when the annotation is only in the template field, your deployments are not being injected? If that is the case, it sounds like it'd be worth opening an issue to get a little more information from you and figure out why that is the case.

[hongbo-miao]

Hi @kleimkuhler I will test again for the case when the annotation is only in the template field today and report back!

[hongbo-miao]

@cpretzer and @kleimkuhler are correct. Thanks!
I tested again, my code in the question is correct.
I am guessing the issue happened before is because I start to install my helm chart before Linkerd is ready.

[kleimkuhler]

Awesome thanks for the follow-up @hongbo-miao! Let us know if you have any other questions.