Add labels to templates

[csrwng]

Adds a new field to templates that includes a set of labels to apply to all objects during template processing.

[csrwng]

@bparees fyi

[bparees]

https://trello.com/c/rETHEzhs/501-5-add-arbitrary-labels-during-template-processing-composition-codefreeze

[bparees]

awesome! can we get a test case?

[csrwng]

Added test case to template/registry

[bparees]

lgtm, you want anyone else to review or more edits before merging?

[smarterclayton]

Labels

[mfojtik]

Why we can't just re-use the ObjectMeta labels? And apply/merge them with labels defined for the items?

[bparees]

@mfojtik that seems slightly abusive, particularly once we have a template repository and might want templates to actually have their own labels for their own purposes.

[mfojtik]

@bparees how about making it more explicit then? ItemLabels as they are intended to apply to all 'items' ?

[bparees]

@mfojtik it's ok with me, but i think @smarterclayton is going to reply with "Labels" again :)

[smarterclayton]

Also, none of these objects should really be in the root of the template - a template should have a section that is specifically for the items, and one specifically for the things to change.

It should really be something like:

{
  "metadata": { // meta about the template },
  "objects": [] // not "items", because then Template is interpreted by generic behavior to be a List
  "spec": {
    "parameters": [], // environment substitution
    "label": {
      "operation": "Add",
      "labels":    {} // these get added
    }
  }
}

We don't have to do that in v1beta1, but for v1beta2 it should be easy to clear the "spec" (or whatever it should be called) in one operation.

----- Original Message -----

@@ -16,6 +16,10 @@ type Template struct {
// Optional: Parameters is an array of Parameters used during the
// Template to Config transformation.
Parameters []Parameter json:"parameters,omitempty"
+

• // Optional: ObjectLabels is a set of labels that are applied to every
• // object during the Template to Config transformation
• ObjectLabels map[string]string json:"objectlabels,omitempty"

@mfojtik it's ok with me, but i think @smarterclayton is going to reply with
"Labels" again :)

---

Reply to this email directly or view it on GitHub:
https://github.com/openshift/origin/pull/982/files#r24756230

[csrwng]

@smarterclayton @bparees @mfojtik - if the change suggested above is for v1beta2, then for now should it be called ObjectLabels? or ItemLabels? (I'm ok with either one). We can't call it Labels because it overrides the one in ObjectMetadata.

[smarterclayton]

You can call it Labels externally and ObjectLabels internally.

----- Original Message -----

@@ -16,6 +16,10 @@ type Template struct {
// Optional: Parameters is an array of Parameters used during the
// Template to Config transformation.
Parameters []Parameter json:"parameters,omitempty"
+

• // Optional: ObjectLabels is a set of labels that are applied to every
• // object during the Template to Config transformation
• ObjectLabels map[string]string json:"objectlabels,omitempty"

@smarterclayton @bparees @mfojtik - if the change suggested above is for
v1beta2, then for now should it be called ObjectLabels? or ItemLabels? (I'm
ok with either one). We can't call it Labels because it overrides the one in
ObjectMetadata.

---

Reply to this email directly or view it on GitHub:
https://github.com/openshift/origin/pull/982/files#r24821525

[csrwng]

@smarterclayton - by externally vs internally do you mean internal api vs versioned api ?

[smarterclayton]

Yes, the versioned API can be labels (since that's JSON, and in JSON it's clear) and internally you can use ObjectLabels.

----- Original Message -----

@@ -16,6 +16,10 @@ type Template struct {
// Optional: Parameters is an array of Parameters used during the
// Template to Config transformation.
Parameters []Parameter json:"parameters,omitempty"
+

• // Optional: ObjectLabels is a set of labels that are applied to every
• // object during the Template to Config transformation
• ObjectLabels map[string]string json:"objectlabels,omitempty"

@smarterclayton - by externally vs internally do you mean internal api vs
versioned api ?

---

Reply to this email directly or view it on GitHub:
https://github.com/openshift/origin/pull/982/files#r24905989

[csrwng]

Updated json annotation to use 'labels' for ObjectLabels

[smarterclayton]

Please change the field name in the Go struct in the external version.

[csrwng]

done.

[smarterclayton]

Add it to the Resource printer for templates as a column and to the describer and you're good

[smarterclayton]

Actually, don't put it in the printer. In the describer be sure to associate it with the objects (since labels gets shown at the top

[csrwng]

@smarterclayton - I'll look into the upstream code to find out why DefaultConvert is overwriting Labels on the base object and not just the one in ObjectMetadata. For now, the ordering of the convert calls is important. I added a comment to that part of the code.

[smarterclayton]

LGTM [merge]

[openshift-bot]

continuous-integration/openshift-jenkins/merge SUCCESS (https://ci.openshift.redhat.com/jenkins/job/merge_pull_requests_openshift3/980/) (Image: devenv-fedora_851)

[openshift-bot]

Evaluated for origin up to 22541e1