The annotations added on the bundle/metadata/annotations.yaml are not ending up in the bundle.Dockerfile

[camilamacedo86]

Bug Report

What did you do?

• Add new annotations in bundle/metadata/annotations.yaml
• Run make a bundle

What did you expect to see?

• Then, the new annotations would need to end up in the bundle.Dockerfile but they have been lost

What did you see instead? Under which circumstances?

Environment

SDK 1.5.0

Additional context

We need first to check its behaviour on master, it might is fixed already.
Seems like the make bundle is re-scaffold the annotations when should not.

[camilamacedo86]

c/c @estroz do you have thoughts about here? Have we an annotation file in the config/ dir?

[msugakov]

Here's what I observed. I added annotations

  com.redhat.openshift.versions: 'v4.6'
  com.redhat.delivery.operator.bundle: true
  com.redhat.delivery.backport: false

to bundle/metadata/annotations.yaml, ran make bundle, and these annotations were gone from bundle/metadata/annotations.yaml. They were also not added to bundle.Dockerfile contrary to what one might expect.

I tried both operator-sdk 1.5.2 and 1.8.0.

[estroz]

Changes made to bundle/metadata/annotations.yaml should be persisted, so this is a bug. However, bundle.Dockerfile needs to be kept in sync manually because not all annotations can/should be synced as Dockerfile LABELs, just those in the bundle spec. This design decision was explicitly made when adding bundle support, and is mentioned in the docs. @camilamacedo86 can you retitle this issue to reflect that?

/cc @varshaprasad96

[camilamacedo86]

Hi @estroz,

Thank you for give a look here.

Could you please clarifies However, bundle.Dockerfile needs to be kept in sync manually because not all annotations can/should be synced as Dockerfile LABELs,just those in the bundle spec.? Can you please provide an example of annotations that should be synced or not?

[estroz]

Bundle spec labels should be in sync as per the spec. All others are defined elsewhere and therefore operator-sdk generate bundle cannot know if they should be synced or not.

[camilamacedo86]

Hi @estroz,

Why we sync just those ones and not all? What is the motivation to sync only the bundle spec and not all?
PS.:Technically, would not be indeed simpler to sync all instead of check what annotation is part or not of the bundle spec?

[camilamacedo86]

Hi @varshaprasad96,

As agreed, following the issues created:

• (Sync all annotations in bundle/metadata/annotations.yaml to the bundle.Dockerfile) - Sync all annotations in bundle/metadata/annotations.yaml to the bundle.Dockerfile  #5002
• (Check how the annotations for metrics has been set and if we should/ought to update them) - Check how the annotations for metrics has been set and if we should/ought to update them #5003