enhancement (CollaSet): CollaSet supports scaling and updating #22

wu8685 · 2023-08-09T07:03:30Z

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

N
Y

re #9

2. What is the scope of this PR (e.g. component or file name):

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

This PR implements basical feature of CollaSet:

Scaling Pod
Updating Pod
Pod instance ID support

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

N
Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

6. Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

github-actions · 2023-08-09T07:03:47Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

wu8685 · 2023-08-09T07:05:06Z

I have read the CLA Document and I hereby sign the CLA

…ontext reclaim controller

zoumo · 2023-08-10T07:58:31Z

apis/apps/v1alpha1/collaset_types.go

+type ByPartition struct {
+	// Partition controls the update progress by indicating how many pods should be updated.
+	// Defaults to nil (all pods will be updated)
+	Partition *int32 `json:"partition,omitempty"`


What will happen if partition is 0?
no pods will be updated?

currently
If partition is 0, no pods will be updated
if partition is not set, all pods will be updated

It is nice to put the description into the comment

apis/apps/v1alpha1/collaset_types.go

pkg/controllers/collaset/collaset_controller.go

pkg/controllers/utils/revision/revision_manager.go

wu8685 · 2023-08-10T13:11:10Z

@Eikykun all fixed
PTAL

shaofan-hs · 2023-08-10T08:56:42Z

apis/apps/v1alpha1/collaset_types.go

+	// Replicas is the most recently observed number of replicas.
+	Replicas int32 `json:"replicas,omitempty"`
+
+	// The number of pods in current version.


pods in updated version may be more clear.

shaofan-hs · 2023-08-10T10:06:55Z

apis/apps/v1alpha1/collaset_types.go

+	Status corev1.ConditionStatus `json:"status,omitempty"`
+
+	// Last time the condition transitioned from one status to another.
+	LastTransitionTime metav1.Time `json:"last_transition_time,omitempty"`


*metav1.Time may be better, unless this data is never empty.

I think it is ok. It is not allowed to be nil.

Acording to convension, the json tag should be lastTransitionTime

shaofan-hs · 2023-08-10T12:09:58Z

apis/apps/v1alpha1/collaset_types.go

+// +kubebuilder:printcolumn:name="CURRENT_REVISION",type="string",JSONPath=".status.currentRevision",description="The current revision."
+// +kubebuilder:printcolumn:name="UPDATED_REVISION",type="string",JSONPath=".status.updatedRevision",description="The updated revision."
+// +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
+// +resource:path=collasets,strategy=CollaSetStrategy


strategy in this marker is not necessary?

zoumo · 2023-08-11T02:36:59Z

apis/apps/v1alpha1/well_known_labels.go

we should standardize annotation and label key prefix to kafed.kusionstack.io or {something}.kafed.kusionstack.io

follow these rules:
If the lablel is used only by collaset, the prefix should be collaset.kafed.kusionstack.io
If the label is shared in kafed, the prefix should be kafed.kusionstack.io

good point

fixed a few labels involved in CollaSet commit

shaofan-hs · 2023-08-11T04:11:07Z

pkg/controllers/collaset/podcontrol/pod_control.go

+	return pod.Status.Phase == corev1.PodSucceeded || pod.Status.Phase == corev1.PodFailed
+}
+
+func NewPodFrom(cs *appsv1alpha1.CollaSet, revision *appsv1.ControllerRevision) (*corev1.Pod, error) {


This func is not used, maybe have been moved to pod_utils.go.

this method is removed

shaofan-hs · 2023-08-11T07:37:04Z

pkg/controllers/collaset/synccontrol/sync_control.go

+			// TODO use cache
+			pod, err := controllerutils.NewPodFrom(set, metav1.NewControllerRef(set, appsv1alpha1.GroupVersion.WithKind("CollaSet")), revision)
+			if err != nil {
+				return fmt.Errorf("fail to new pod from revision %s: %s", updatedRevision.Name, err)


revision.Name is right?

shaofan-hs · 2023-08-11T07:46:20Z

pkg/controllers/collaset/synccontrol/sync_control.go

+			// allocate new Pod a instance ID
+			newPod.Labels[appsv1alpha1.PodInstanceIDLabelKey] = fmt.Sprintf("%d", availableIDContext.ID)
+
+			if pod, err := sc.podControl.CreatePod(newPod, updatedRevision); err == nil {


We will create pod use revision?

shaofan-hs · 2023-08-11T08:14:33Z

pkg/controllers/collaset/utils/lifecycle_adapter.go

+		return false, nil
+	}
+
+	pod.GetLabels()[appsv1alpha1.PodScalingInLabelKey] = fmt.Sprintf("%d", time.Now().UnixNano())


This lable will be deleted in the right time?

remove this unused label

shaofan-hs · 2023-08-11T08:25:27Z

pkg/controllers/collaset/synccontrol/sync_control.go

+		// do delete Pod resource
+		succCount, err = controllerutils.SlowStartBatch(len(podCh), controllerutils.SlowStartInitialBatchSize, false, func(i int, _ error) error {
+			pod := <-podCh
+			if err := sc.podControl.DeletePod(pod.Pod); err == nil {


Maybe block below is easy to understand.

if err := sc.podControl.DeletePod(pod.Pod); err != nil { return err } if err := collasetutils.ActiveExpectations.ExpectDelete(set, expectations.Pod, pod.Name); err != nil { return err }

shaofan-hs · 2023-08-11T08:48:20Z

pkg/controllers/collaset/synccontrol/sync_control.go

+		if err != nil {
+			collasetutils.AddOrUpdateCondition(newStatus, appsv1alpha1.CollaSetScale, err, "ScaleOutFailed", err.Error())
+			return succCount > 0, err
+		} else {


These elses is not needed?

shaofan-hs · 2023-08-11T08:55:13Z

pkg/controllers/collaset/collaset_controller.go

+	return calculateStatus(instance, newStatus, updatedRevision, podWrappers, syncErr), syncErr
+}
+
+func doSync(instance *appsv1alpha1.CollaSet, updatedRevision *appsv1.ControllerRevision, revisions []*appsv1.ControllerRevision, newStatus *appsv1alpha1.CollaSetStatus) ([]*collasetutils.PodWrapper, *appsv1alpha1.CollaSetStatus, error) {


Giving some comments in this core func will be very nice.❤️

comment added

wu8685 · 2023-08-13T01:10:09Z

@zoumo @shaofan-hs
All fixed, PTAL

zoumo · 2023-08-14T10:52:34Z

pkg/controllers/utils/revision/revision_manager_test.go

It seems that this test file is empty, delete it pls

zoumo · 2023-08-14T11:14:20Z

apis/apps/v1alpha1/well_known_annotations.go

+	PodAvailableConditionsAnnotation = "kafed.kusionstack.io/available-conditions" // indicate the available conditions of a pod
+	// --- Begin: Annotations for RuleSet ---
+
+	AnnotationPodSkipRuleConditions = "apps.kafed.io/skip-rule-conditions"


Why is this prefix so different？

it is not used. removed

zoumo · 2023-08-14T11:42:53Z

pkg/controllers/collaset/collaset_controller.go

+
+	revisionManager = revision.NewRevisionManager(mgr.GetClient(), mgr.GetScheme(), &revisionOwnerAdapter{})
+	podControl = podcontrol.NewRealPodControl(mgr.GetClient(), mgr.GetScheme())
+	syncControl = synccontrol.NewRealSyncControl(mgr.GetClient(), podControl, recorder)


Is It more appropriate to put these three variable into CollaSetReconciler ?

It is so strange to init global var in a struct construct function.

…le in case of using native K8s

zoumo · 2023-08-15T02:54:57Z

pkg/controllers/utils/expectations/resourceversion_expectation.go

 	}
+
 	return nil


lint

simplify

} else { return r.SetExpectations(controllerKey, resourceVersion) } return nil

to

return r.SetExpectations(controllerKey, resourceVersion)

Won't fix. This will break the original logic.

zoumo

LGTM

Eikykun

lgtm

wu8685 requested review from zoumo, Eikykun and shaofan-hs August 9, 2023 07:03

wu8685 added the kind/enhancement New feature or request label Aug 9, 2023

wu8685 added 3 commits August 9, 2023 21:34

enhancement (CollaSet): CollaSet supports scaling and updating

8b8fb58

enhancement (CollaSet): add copyright

b4d310c

enhancement (CollaSet): fix compile issue

76d8e86

wu8685 force-pushed the collaset-dev branch from ea81f70 to 76d8e86 Compare August 9, 2023 14:44

wu8685 added 3 commits August 10, 2023 01:35

enhancement (CollaSet): support pod deletion indication AND resourceC…

7b531a0

…ontext reclaim controller

enhancement (CollaSet): fix linter

0c99ffe

enhancement (CollaSet): fix linter and ut

e0c8fc0

wu8685 force-pushed the collaset-dev branch from 6356263 to bd42c54 Compare August 10, 2023 07:07

enhancement (CollaSet): fix ut

7418e8e

wu8685 force-pushed the collaset-dev branch from bd42c54 to 7418e8e Compare August 10, 2023 07:09

enhancement (CollaSet): fix ut

4ecddf1

zoumo reviewed Aug 10, 2023

View reviewed changes

Eikykun requested changes Aug 10, 2023

View reviewed changes

enhancement (CollaSet): fix review issues

5982630

shaofan-hs reviewed Aug 10, 2023

View reviewed changes

Eikykun previously approved these changes Aug 11, 2023

View reviewed changes

enhancement (CollaSet): fix review issues

aecafdb

zoumo reviewed Aug 11, 2023

View reviewed changes

wu8685 dismissed Eikykun’s stale review via aecafdb August 11, 2023 03:25

shaofan-hs reviewed Aug 11, 2023

View reviewed changes

enhancement (CollaSet): fix review issues

be73018

shaofan-hs previously approved these changes Aug 13, 2023

View reviewed changes

zoumo reviewed Aug 14, 2023

View reviewed changes

enhancement (CollaSet): fix review issues

348f332

wu8685 dismissed shaofan-hs’s stale review via 348f332 August 14, 2023 13:21

enhancement (CollaSet): backoff InPlaceOnly policy to InPlaceIfPossib…

7f68973

…le in case of using native K8s

zoumo reviewed Aug 15, 2023

View reviewed changes

zoumo approved these changes Aug 15, 2023

View reviewed changes

Eikykun added the lgtm label Aug 15, 2023

Eikykun approved these changes Aug 15, 2023

View reviewed changes

shaofan-hs approved these changes Aug 15, 2023

View reviewed changes

wu8685 merged commit e1c57e5 into main Aug 15, 2023
5 checks passed

wu8685 deleted the collaset-dev branch August 15, 2023 03:24

github-actions bot locked and limited conversation to collaborators Aug 15, 2023

enhancement (CollaSet): CollaSet supports scaling and updating #22

enhancement (CollaSet): CollaSet supports scaling and updating #22

Conversation

wu8685 commented Aug 9, 2023 • edited by WeichengWang1 Loading

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

2. What is the scope of this PR (e.g. component or file name):

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

6. Release note

github-actions bot commented Aug 9, 2023 • edited Loading

wu8685 commented Aug 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wu8685 commented Aug 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shaofan-hs Aug 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wu8685 Aug 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shaofan-hs Aug 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shaofan-hs Aug 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wu8685 commented Aug 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zoumo left a comment

Choose a reason for hiding this comment

Eikykun left a comment

Choose a reason for hiding this comment

wu8685 commented Aug 9, 2023 •

edited by WeichengWang1

Loading

github-actions bot commented Aug 9, 2023 •

edited

Loading

shaofan-hs Aug 10, 2023 •

edited

Loading

wu8685 Aug 12, 2023 •

edited

Loading

shaofan-hs Aug 11, 2023 •

edited

Loading

shaofan-hs Aug 11, 2023 •

edited

Loading