Add components verification step to bootstraping WGE #3675

Samra10 · 2023-11-27T01:07:59Z

Closes #3674

What changed?

Install_WGE step updated to check different components' health before proceeding to the next step.

Why was this change made?

To verify that the WGE installation is healthy before installing additional components.

How was this change implemented?

Add a new file under bootstrap utils for checking status.
use the status methods to check WGE components

How did you validate the change?

Explain how a reviewer can verify the change themselves
Using interactive or non-interactive WGE bootstrapping, after the WGE helmRepo gets rendered the health checks will start to verify the health for multiple deployments. once all the components predefined on a list are ready the health check will pass, if not all desired components not healthy after a predefined time-out it will exist.
Unit tests -- what is covered, what cannot be covered; are
there tests that fail without the change?
Components verification can't be covered on the unit-test

Release notes

Documentation Changes

Other follow ups

Samra10 · 2023-11-30T01:07:49Z

pkg/bootstrap/steps/install_wge.go

@@ -39,6 +41,10 @@ const (
 	gitopssetsHealthBindAddress       = ":8081"
 )

+var Components = []string{"cluster-controller-manager",


These are the suggested components to be checked, do u think we should add more?

I guess that we should try to see whether the list could be dynamic over static

for the installwge step, the components are being defined as part of the helm chart and its dependencies

https://github.com/weaveworks/weave-gitops-enterprise/blob/main/charts/mccp/Chart.yaml

an strategy to resolve the components could be created out of it

pkg/bootstrap/steps/install_wge.go

enekofb

Please, could you share in the PR description what are the testing scenarios that you have used and explain how could i verify the behavior?

Given the components that you want to asses health are deployed after the call to the function

https://github.com/weaveworks/weave-gitops-enterprise/pull/3675/files#diff-c8e6ae555f83215266745d9cdffeaed0e7170957687b6d10b2026465fc44becdR165-R167

I might think that are not been checked in the right moment of the flow.

Samra10 · 2023-12-03T11:48:43Z

I might think that are not been checked in the right moment of the flow.

For now I'm verifying it after the helmRealese created and pods start to be deployed, do u think there is a better place?
And should we add the same step after any extra components created or modified for example OIDC and the extra components?

enekofb · 2023-12-04T07:30:12Z

I might think that are not been checked in the right moment of the flow.

For now I'm verifying it after the helmRealese created and pods start to be deployed, do u think there is a better place?
umms, lets check in our sync, i might be missing something in the PR

enekofb · 2023-12-07T10:22:56Z

pkg/bootstrap/steps/step.go

+	Name   string
+	Input  []StepInput
+	Step   func(input []StepInput, c *Config) ([]StepOutput, error)
+	Verify func(output []StepOutput, c *Config) error


please add the internal documentation on guidance to use it

enekofb

great progress @Samra10 please see my suggestions which are in the direction of:

trying to have a dynamic set of components over static
add unit testing
complete code documentation and internal docs

verified the happy and unhappy paths 👌

enekofb · 2023-12-07T10:23:38Z

pkg/bootstrap/steps/step.go

+	Name   string
+	Input  []StepInput
+	Step   func(input []StepInput, c *Config) ([]StepOutput, error)
+	Verify func(output []StepOutput, c *Config) error


please add the internal documentation on guidance to use it

enekofb · 2023-12-07T10:24:41Z

pkg/bootstrap/steps/install_wge_test.go

@@ -148,6 +148,8 @@ func TestInstallWge_Execute(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			step := NewInstallWGEStep()
+			// skip verify step
+			step.Verify = nil


i guess that missing testing here

how to unit test this logic ... possible paths

a) mock the behaviour via interface
b) given this is based on kstatus, see how to unit test kstatus https://github.com/kubernetes-sigs/cli-utils/blob/master/pkg/kstatus/README.md

enekofb · 2023-12-07T10:25:14Z

pkg/bootstrap/utils/status.go

+	logger       logger.Logger
+}
+
+func NewStatusChecker(client k8s_client.Client, pollInterval time.Duration, timeout time.Duration, log logger.Logger) (*StatusChecker, error) {


missing comments

enekofb · 2023-12-07T10:25:21Z

pkg/bootstrap/utils/status.go

+	"sigs.k8s.io/cli-utils/pkg/object"
+)
+
+type StatusChecker struct {


missing comments as exported

enekofb · 2023-12-07T10:25:31Z

pkg/bootstrap/utils/status.go

+	}, nil
+}
+
+func (sc *StatusChecker) Assess(identifiers ...object.ObjMetadata) error {


missing comments as exported

enekofb · 2023-12-07T10:34:11Z

pkg/bootstrap/steps/install_wge.go

@@ -39,6 +41,10 @@ const (
 	gitopssetsHealthBindAddress       = ":8081"
 )

+var Components = []string{"cluster-controller-manager",


I guess that we should try to see whether the list could be dynamic over static

Add components verify step to bootstraping WGE

8937d65

Samra10 added enhancement New feature or request area/cli issues related to gitops ee cli labels Nov 27, 2023

Samra10 added 4 commits November 30, 2023 01:22

Add skipComponentCheck to isolate unit_test

24b2317

rename status.go file

171dc77

add integration test for status checker

6eb1424

Merge branch 'main' into 3647-add-verify-step

1de368e

Samra10 commented Nov 30, 2023

View reviewed changes

pkg/bootstrap/steps/install_wge.go Outdated Show resolved Hide resolved

Samra10 marked this pull request as ready for review November 30, 2023 01:13

Samra10 requested review from enekofb and waleedhammam November 30, 2023 01:13

enekofb reviewed Dec 1, 2023

View reviewed changes

Samra10 added 10 commits December 5, 2023 13:13

update verify step log type

fcdb1a2

Merge remote-tracking branch 'origin/main' into 3647-add-verify-step

f551a78

add components health to install WGE step

ef56b7f

Extend step to add verification logic

9762361

Merge branch 'main' into 3647-add-verify-step

5fe1a34

remove unnecessary flag

749bbfc

update verification step param

eabd444

undo -integration

fe93e2c

Merge branch 'main' into 3647-add-verify-step

d74deac

Merge branch 'main' into 3647-add-verify-step

bb582e4

Samra10 requested a review from enekofb December 6, 2023 21:08

enekofb reviewed Dec 7, 2023

View reviewed changes

Samra10 added 2 commits December 7, 2023 13:36

Add comments for Exported methods

90f4cc2

Merge branch 'main' into 3647-add-verify-step

5bd7d09

Samra10 added 2 commits December 7, 2023 13:45

Merge branch 'main' into 3647-add-verify-step

0d1acdc

Merge branch 'main' into 3647-add-verify-step

3be5372

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add components verification step to bootstraping WGE #3675

Add components verification step to bootstraping WGE #3675

Samra10 commented Nov 27, 2023 •

edited

Loading

Samra10 Nov 30, 2023

enekofb Dec 7, 2023

enekofb Dec 12, 2023

enekofb left a comment

Samra10 commented Dec 3, 2023

enekofb commented Dec 4, 2023

enekofb Dec 7, 2023

enekofb Dec 7, 2023

enekofb left a comment •

edited

Loading

enekofb Dec 7, 2023

enekofb Dec 7, 2023

enekofb Dec 12, 2023

enekofb Dec 7, 2023

enekofb Dec 7, 2023

enekofb Dec 7, 2023

enekofb Dec 7, 2023

Add components verification step to bootstraping WGE #3675

Are you sure you want to change the base?

Add components verification step to bootstraping WGE #3675

Conversation

Samra10 commented Nov 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

enekofb left a comment

Choose a reason for hiding this comment

Samra10 commented Dec 3, 2023

enekofb commented Dec 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

enekofb left a comment • 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

Samra10 commented Nov 27, 2023 •

edited

Loading

enekofb left a comment •

edited

Loading