implementation of component mutable and versioning mechanism #35

wonderflow · 2020-06-03T07:17:10Z

ref: #29
fixes #34

Add Component Mutable demo
Add Rollout trait using revision as demo
Add more tests

.gitignore

apis/core/v1alpha2/core_types.go

ryanzhang-oss · 2020-06-05T03:44:53Z

apis/core/v1alpha2/core_types.go

+	// affect from the prior revision to the new one. This is mutually exclusive
+	// with RevisionName.
+	// +optional
 	ComponentName string `json:"componentName"`


Is there a way for Json tag enforce mutually exclusive fields? or we have to use an admission controller

We have to use admission controller for this

Let's create an admission then. Maybe make it part of oam controllers local if it's not clear for now how to do it in crossplane release? /cc @ryanzhang-oss

examples/containerized-workload/sample_trait_definition.yaml

pkg/controller/oam/applicationconfiguration/applicationconfiguration.go

pkg/controller/oam/applicationconfiguration/component.go

pkg/controller/oam/applicationconfiguration/render.go

2. component change will be recorded in controllerRevision 3. According to trait.createRevision to decide whether to use componentName or revisionName to create workload instance. 4. Garbage collection will not collect old revision workload Signed-off-by: 天元 <[email protected]>

Signed-off-by: 天元 <[email protected]>

hongchaodeng

Nice work!
LGTM

examples/component-versioning/Component-Mutable.md

examples/component-versioning/versioning-mechanism.md

ryanzhang-oss · 2020-06-23T01:34:37Z

examples/component-versioning/versioning-mechanism.md

+```shell script
+$ kubectl get simplerollouttraits.extend.oam.dev
+NAME                AGE
+example-component   3m16s


why is a trait's name called xxx-component?

Currently，we directly use componentName as a trait name.

We could raise another issue for it. I also thinks it's not appropriate.

ryanzhang-oss · 2020-06-23T01:46:15Z

examples/component-versioning/versioning-mechanism.md

+    kind: ContainerizedWorkload
+    name: example-component-brngj9ript3e8125vhf0
+status:
+  currentWorkloadRef:


why does the "currentWorkloadRef" only have the previous workloadRef?

Status shows real, Spec means expect. They are different, so the rolling update start. After the rolling finished, the status will align with the spec.

examples/component-versioning/versioning-mechanism.md

Signed-off-by: 天元 <[email protected]>

resouer

LGTM

zzxwill · 2020-06-24T05:39:06Z

LGTM

ryanzhang-oss · 2020-06-23T04:47:25Z

pkg/controller/oam/applicationconfiguration/component.go

+	l          logging.Logger
+}
+
+// Create implements EventHandler


highly recommend to add

var _ handler.EventHandler = &ComponentHandler{}

to make both code more readable and have a basic guard against any future breaking change.

pkg/controller/oam/applicationconfiguration/component.go

ryanzhang-oss · 2020-06-24T06:37:36Z

pkg/controller/oam/applicationconfiguration/render.go

+	t.SetNamespace(namespace)
+}
+
+func (r *components) getTraitDefinition(ctx context.Context, t *unstructured.Unstructured) (v1alpha2.TraitDefinition, error) {


You can use the utility function in the addon-k8s now

ryanzhang-oss · 2020-06-24T06:39:15Z

pkg/controller/oam/applicationconfiguration/render.go

+func setTraitProperties(t *unstructured.Unstructured, componentName, namespace string, ref *metav1.OwnerReference) {
+	// Set metadata name for `Trait` if the metadata name is NOT set.
+	if t.GetName() == "" {
+		t.SetName(componentName)


let's at least make the name look like it's a "trait"

ryanzhang-oss · 2020-06-24T06:43:14Z

pkg/controller/oam/applicationconfiguration/render.go

+	group, _ := addon.ApiVersion2GroupVersion(u.GetAPIVersion())
+	resources := []string{addon.Kind2Resource(u.GetKind())}
+	if group != "" {
+		resources = append(resources, group)
 	}


I think there is a new function called GetGVResource that one can use now instead of calling two functions.

resouer · 2020-07-05T19:47:04Z

What will happen if user set parameterValues and then update it thru kubectl apply -f appconfig.yaml?

wonderflow · 2020-07-06T06:19:20Z

@resouer parameterValues will be regarded as trait, values from parameterValues will finnally cover data of component.

1. component versioning implemented by crossplane#35 2. dependency implemented by crossplane#74 and crossplane#53 3. rollout model don't need any change, it's best practice Signed-off-by: 天元 <[email protected]>

wonderflow force-pushed the component branch 2 times, most recently from f27fcd9 to e9b8821 Compare June 4, 2020 07:41

wonderflow requested a review from ryanzhang-oss June 4, 2020 07:42

wonderflow marked this pull request as draft June 4, 2020 07:43

wonderflow marked this pull request as ready for review June 4, 2020 07:44

wonderflow marked this pull request as draft June 4, 2020 07:46

wonderflow force-pushed the component branch 4 times, most recently from febc501 to 3a06cf7 Compare June 5, 2020 06:23

wonderflow marked this pull request as ready for review June 5, 2020 06:23

wonderflow changed the title ~~WIP implementation of component mutable and versioning mechanism~~ implementation of component mutable and versioning mechanism Jun 5, 2020

wonderflow requested review from hasheddan, hongchaodeng, negz and resouer June 5, 2020 06:24

ryanzhang-oss reviewed Jun 7, 2020

View reviewed changes

wonderflow mentioned this pull request Jun 10, 2020

design: one pager component mutable and versioning mechanism for OAM #29

Merged

wonderflow force-pushed the component branch 2 times, most recently from 74cfac6 to 8d85905 Compare June 16, 2020 15:39

captainroy-hy mentioned this pull request Jun 19, 2020

[Trait] Add simple-rollout trait kubevela/catalog#27

Merged

3 tasks

wonderflow force-pushed the component branch from b607789 to 6d484b5 Compare June 21, 2020 13:42

wonderflow added 4 commits June 21, 2020 21:43

update

5edb7fd

Signed-off-by: 天元 <[email protected]>

fix according comments

60acf9f

Signed-off-by: 天元 <[email protected]>

add Component Mutable demo doc

ce71861

Signed-off-by: 天元 <[email protected]>

add versioning mechanism demo doc

9a89fdf

Signed-off-by: 天元 <[email protected]>

wonderflow force-pushed the component branch 3 times, most recently from aa1a35c to e117df1 Compare June 22, 2020 05:40

wonderflow force-pushed the component branch 6 times, most recently from a09ccd0 to b343bdb Compare June 22, 2020 09:43

add tests

bf5d471

Signed-off-by: 天元 <[email protected]>

wonderflow force-pushed the component branch from b343bdb to bf5d471 Compare June 22, 2020 09:53

hongchaodeng approved these changes Jun 22, 2020

View reviewed changes

ryanzhang-oss reviewed Jun 23, 2020

View reviewed changes

wonderflow force-pushed the component branch from 3946a00 to 8fcd2de Compare June 23, 2020 02:59

address comments

f1707c8

Signed-off-by: 天元 <[email protected]>

wonderflow force-pushed the component branch from 8fcd2de to f1707c8 Compare June 23, 2020 03:14

resouer approved these changes Jun 24, 2020

View reviewed changes

ryanzhang-oss merged commit 3f4e315 into crossplane:master Jun 24, 2020

ryanzhang-oss reviewed Jun 24, 2020

View reviewed changes

zzxwill mentioned this pull request Jun 26, 2020

[Trait ]update go.mod to follow latest oam-k8s-runtime; update README.md; kubevela/catalog#36

Merged

3 tasks

wonderflow deleted the component branch July 6, 2020 06:19

wonderflow mentioned this pull request Jul 21, 2020

update status of some proposals. #115

Merged

implementation of component mutable and versioning mechanism #35

implementation of component mutable and versioning mechanism #35

Uh oh!

Conversation

wonderflow commented Jun 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hongchaodeng left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

resouer left a comment

Choose a reason for hiding this comment

Uh oh!

zzxwill commented Jun 24, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

resouer commented Jul 5, 2020

Uh oh!

wonderflow commented Jul 6, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

wonderflow commented Jun 3, 2020 •

edited

Loading