Skip to content

Commit c92ac68

Browse files
maysunfaisalmaysunfaisal
committed
Remove global attributes from plugin overrides
Signed-off-by: Maysun J Faisal <[email protected]>
1 parent ea9b822 commit c92ac68

21 files changed

+59
-234
lines changed

Diff for: ‎crds/workspace.devfile.io_devworkspaces.v1beta1.yaml

+7-17
Original file line numberDiff line numberDiff line change
@@ -4142,9 +4142,12 @@ spec:
41424142
properties:
41434143
attributes:
41444144
description: Map of implementation-dependant free-form YAML attributes.
4145-
Attribute values can be referenced through out the devfile in
4145+
Attribute values can be referenced throughout the devfile in
41464146
string type fields in the form {{attribute-key}} except for
4147-
schemaVersion and metadata
4147+
schemaVersion and metadata. Exception to the string field include
4148+
element's key identifiers(command id, component name, endpoint
4149+
name, project name, etc.) and string enums(command group kind,
4150+
endpoint exposure, etc.)
41484151
type: object
41494152
x-kubernetes-preserve-unknown-fields: true
41504153
commands:
@@ -4830,12 +4833,6 @@ spec:
48304833
- required:
48314834
- kubernetes
48324835
properties:
4833-
attributes:
4834-
description: Overrides of attributes encapsulated in
4835-
a parent devfile or a plugin. Overriding is done according
4836-
to K8S strategic merge patch standard rules.
4837-
type: object
4838-
x-kubernetes-preserve-unknown-fields: true
48394836
commands:
48404837
description: Overrides of commands encapsulated in a
48414838
parent devfile or a plugin. Overriding is done according
@@ -5576,8 +5573,8 @@ spec:
55765573
properties:
55775574
attributes:
55785575
description: Overrides of attributes encapsulated in a parent
5579-
devfile or a plugin. Overriding is done according to K8S
5580-
strategic merge patch standard rules.
5576+
devfile. Overriding is done according to K8S strategic merge
5577+
patch standard rules.
55815578
type: object
55825579
x-kubernetes-preserve-unknown-fields: true
55835580
commands:
@@ -6198,13 +6195,6 @@ spec:
61986195
- required:
61996196
- kubernetes
62006197
properties:
6201-
attributes:
6202-
description: Overrides of attributes encapsulated
6203-
in a parent devfile or a plugin. Overriding is
6204-
done according to K8S strategic merge patch standard
6205-
rules.
6206-
type: object
6207-
x-kubernetes-preserve-unknown-fields: true
62086198
commands:
62096199
description: Overrides of commands encapsulated
62106200
in a parent devfile or a plugin. Overriding is

Diff for: ‎crds/workspace.devfile.io_devworkspaces.yaml

+7-17
Original file line numberDiff line numberDiff line change
@@ -4140,9 +4140,12 @@ spec:
41404140
properties:
41414141
attributes:
41424142
description: Map of implementation-dependant free-form YAML attributes.
4143-
Attribute values can be referenced through out the devfile in
4143+
Attribute values can be referenced throughout the devfile in
41444144
string type fields in the form {{attribute-key}} except for
4145-
schemaVersion and metadata
4145+
schemaVersion and metadata. Exception to the string field include
4146+
element's key identifiers(command id, component name, endpoint
4147+
name, project name, etc.) and string enums(command group kind,
4148+
endpoint exposure, etc.)
41464149
type: object
41474150
x-kubernetes-preserve-unknown-fields: true
41484151
commands:
@@ -4835,12 +4838,6 @@ spec:
48354838
- required:
48364839
- kubernetes
48374840
properties:
4838-
attributes:
4839-
description: Overrides of attributes encapsulated in
4840-
a parent devfile or a plugin. Overriding is done according
4841-
to K8S strategic merge patch standard rules.
4842-
type: object
4843-
x-kubernetes-preserve-unknown-fields: true
48444841
commands:
48454842
description: Overrides of commands encapsulated in a
48464843
parent devfile or a plugin. Overriding is done according
@@ -5581,8 +5578,8 @@ spec:
55815578
properties:
55825579
attributes:
55835580
description: Overrides of attributes encapsulated in a parent
5584-
devfile or a plugin. Overriding is done according to K8S
5585-
strategic merge patch standard rules.
5581+
devfile. Overriding is done according to K8S strategic merge
5582+
patch standard rules.
55865583
type: object
55875584
x-kubernetes-preserve-unknown-fields: true
55885585
commands:
@@ -6203,13 +6200,6 @@ spec:
62036200
- required:
62046201
- kubernetes
62056202
properties:
6206-
attributes:
6207-
description: Overrides of attributes encapsulated
6208-
in a parent devfile or a plugin. Overriding is
6209-
done according to K8S strategic merge patch standard
6210-
rules.
6211-
type: object
6212-
x-kubernetes-preserve-unknown-fields: true
62136203
commands:
62146204
description: Overrides of commands encapsulated
62156205
in a parent devfile or a plugin. Overriding is

Diff for: ‎crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml

+6-16
Original file line numberDiff line numberDiff line change
@@ -3916,9 +3916,11 @@ spec:
39163916
properties:
39173917
attributes:
39183918
description: Map of implementation-dependant free-form YAML attributes.
3919-
Attribute values can be referenced through out the devfile in string
3919+
Attribute values can be referenced throughout the devfile in string
39203920
type fields in the form {{attribute-key}} except for schemaVersion
3921-
and metadata
3921+
and metadata. Exception to the string field include element's key
3922+
identifiers(command id, component name, endpoint name, project name,
3923+
etc.) and string enums(command group kind, endpoint exposure, etc.)
39223924
type: object
39233925
x-kubernetes-preserve-unknown-fields: true
39243926
commands:
@@ -4578,12 +4580,6 @@ spec:
45784580
- required:
45794581
- kubernetes
45804582
properties:
4581-
attributes:
4582-
description: Overrides of attributes encapsulated in a parent
4583-
devfile or a plugin. Overriding is done according to K8S
4584-
strategic merge patch standard rules.
4585-
type: object
4586-
x-kubernetes-preserve-unknown-fields: true
45874583
commands:
45884584
description: Overrides of commands encapsulated in a parent
45894585
devfile or a plugin. Overriding is done according to K8S
@@ -5298,8 +5294,8 @@ spec:
52985294
properties:
52995295
attributes:
53005296
description: Overrides of attributes encapsulated in a parent
5301-
devfile or a plugin. Overriding is done according to K8S strategic
5302-
merge patch standard rules.
5297+
devfile. Overriding is done according to K8S strategic merge
5298+
patch standard rules.
53035299
type: object
53045300
x-kubernetes-preserve-unknown-fields: true
53055301
commands:
@@ -5899,12 +5895,6 @@ spec:
58995895
- required:
59005896
- kubernetes
59015897
properties:
5902-
attributes:
5903-
description: Overrides of attributes encapsulated in
5904-
a parent devfile or a plugin. Overriding is done according
5905-
to K8S strategic merge patch standard rules.
5906-
type: object
5907-
x-kubernetes-preserve-unknown-fields: true
59085898
commands:
59095899
description: Overrides of commands encapsulated in a
59105900
parent devfile or a plugin. Overriding is done according

Diff for: ‎crds/workspace.devfile.io_devworkspacetemplates.yaml

+6-16
Original file line numberDiff line numberDiff line change
@@ -3914,9 +3914,11 @@ spec:
39143914
properties:
39153915
attributes:
39163916
description: Map of implementation-dependant free-form YAML attributes.
3917-
Attribute values can be referenced through out the devfile in string
3917+
Attribute values can be referenced throughout the devfile in string
39183918
type fields in the form {{attribute-key}} except for schemaVersion
3919-
and metadata
3919+
and metadata. Exception to the string field include element's key
3920+
identifiers(command id, component name, endpoint name, project name,
3921+
etc.) and string enums(command group kind, endpoint exposure, etc.)
39203922
type: object
39213923
x-kubernetes-preserve-unknown-fields: true
39223924
commands:
@@ -4583,12 +4585,6 @@ spec:
45834585
- required:
45844586
- kubernetes
45854587
properties:
4586-
attributes:
4587-
description: Overrides of attributes encapsulated in a parent
4588-
devfile or a plugin. Overriding is done according to K8S
4589-
strategic merge patch standard rules.
4590-
type: object
4591-
x-kubernetes-preserve-unknown-fields: true
45924588
commands:
45934589
description: Overrides of commands encapsulated in a parent
45944590
devfile or a plugin. Overriding is done according to K8S
@@ -5303,8 +5299,8 @@ spec:
53035299
properties:
53045300
attributes:
53055301
description: Overrides of attributes encapsulated in a parent
5306-
devfile or a plugin. Overriding is done according to K8S strategic
5307-
merge patch standard rules.
5302+
devfile. Overriding is done according to K8S strategic merge
5303+
patch standard rules.
53085304
type: object
53095305
x-kubernetes-preserve-unknown-fields: true
53105306
commands:
@@ -5904,12 +5900,6 @@ spec:
59045900
- required:
59055901
- kubernetes
59065902
properties:
5907-
attributes:
5908-
description: Overrides of attributes encapsulated in
5909-
a parent devfile or a plugin. Overriding is done according
5910-
to K8S strategic merge patch standard rules.
5911-
type: object
5912-
x-kubernetes-preserve-unknown-fields: true
59135903
commands:
59145904
description: Overrides of commands encapsulated in a
59155905
parent devfile or a plugin. Overriding is done according

Diff for: ‎pkg/apis/workspaces/v1alpha2/devworkspaceTemplateSpec.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ type DevWorkspaceTemplateSpec struct {
1515
// +devfile:overrides:generate
1616
type DevWorkspaceTemplateSpecContent struct {
1717
// Map of implementation-dependant free-form YAML attributes.
18-
// Attribute values can be referenced through out the devfile in string type fields in the form {{attribute-key}}
19-
// except for schemaVersion and metadata
18+
// Attribute values can be referenced throughout the devfile in string type fields in the form {{attribute-key}}
19+
// except for schemaVersion and metadata. Exception to the string field include element's key identifiers(command id,
20+
// component name, endpoint name, project name, etc.) and string enums(command group kind, endpoint exposure, etc.)
2021
// +optional
2122
// +patchStrategy=merge
22-
// +devfile:overrides:include:description=Overrides of attributes encapsulated in a parent devfile or a plugin.
23+
// +devfile:overrides:include:omitInPlugin=true,description=Overrides of attributes encapsulated in a parent devfile.
2324
Attributes attributes.Attributes `json:"attributes,omitempty" patchStrategy:"merge"`
2425

2526
// List of the workspace components, such as editor and plugins,

Diff for: ‎pkg/apis/workspaces/v1alpha2/zz_generated.deepcopy.go

-14
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go

+1-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎pkg/apis/workspaces/v1alpha2/zz_generated.plugin_overrides.go

-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎pkg/utils/overriding/keys.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func checkKeys(doCheck checkFn, toplevelListContainers ...workspaces.TopLevelLis
4141
attributeValue = value.FieldByName("Attributes")
4242
}
4343

44-
if attributeValue.CanInterface() {
44+
if attributeValue.IsValid() && attributeValue.CanInterface() {
4545
attributes := attributeValue.Interface().(attributesPkg.Attributes)
4646
var attributeKeys []string
4747
for k := range attributes {

Diff for: ‎schemas/latest/dev-workspace-template-spec.json

+2-12
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"title": "DevWorkspaceTemplateSpec schema - Version 2.1.0-alpha",
55
"properties": {
66
"attributes": {
7-
"description": "Map of implementation-dependant free-form YAML attributes. Attribute values can be referenced through out the devfile in string type fields in the form {{attribute-key}} except for schemaVersion and metadata",
7+
"description": "Map of implementation-dependant free-form YAML attributes. Attribute values can be referenced throughout the devfile in string type fields in the form {{attribute-key}} except for schemaVersion and metadata. Exception to the string field include element's key identifiers(command id, component name, endpoint name, project name, etc.) and string enums(command group kind, endpoint exposure, etc.)",
88
"type": "object",
99
"additionalProperties": true
1010
},
@@ -679,11 +679,6 @@
679679
}
680680
],
681681
"properties": {
682-
"attributes": {
683-
"description": "Overrides of attributes encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
684-
"type": "object",
685-
"additionalProperties": true
686-
},
687682
"commands": {
688683
"description": "Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
689684
"type": "array",
@@ -1345,7 +1340,7 @@
13451340
],
13461341
"properties": {
13471342
"attributes": {
1348-
"description": "Overrides of attributes encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
1343+
"description": "Overrides of attributes encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.",
13491344
"type": "object",
13501345
"additionalProperties": true
13511346
},
@@ -1911,11 +1906,6 @@
19111906
}
19121907
],
19131908
"properties": {
1914-
"attributes": {
1915-
"description": "Overrides of attributes encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
1916-
"type": "object",
1917-
"additionalProperties": true
1918-
},
19191909
"commands": {
19201910
"description": "Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
19211911
"type": "array",

0 commit comments

Comments
 (0)