Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Onboarding CLI | Add verify step to ensure that the cli is in a consistent state #3674

Open
Tracked by #3026
Samra10 opened this issue Nov 27, 2023 · 1 comment · May be fixed by #3675
Open
Tracked by #3026

Onboarding CLI | Add verify step to ensure that the cli is in a consistent state #3674

Samra10 opened this issue Nov 27, 2023 · 1 comment · May be fixed by #3675
Assignees
Labels
area/cli issues related to gitops ee cli priority_high team/timber-wolf

Comments

@Samra10
Copy link
Member

Samra10 commented Nov 27, 2023

Add verify step to ensure that we leave cli bootstrapping in a consistent state ~ same as flux bootstrap does where checks that component are healthy.

AC

  • After install weave gitops enterprise the application and controllers are either healthy or bootstrap command should exist with the unhealthy error
@Samra10 Samra10 added team/timber-wolf area/cli issues related to gitops ee cli labels Nov 27, 2023
@Samra10 Samra10 self-assigned this Nov 27, 2023
@Samra10 Samra10 changed the title Add verify step to ensure that CLI bootstrapping is in a consistent state Onboarding CLI | Add verify step to ensure that CLI is in a consistent state Nov 27, 2023
@Samra10 Samra10 changed the title Onboarding CLI | Add verify step to ensure that CLI is in a consistent state Onboarding CLI | Add verify step to ensure that the cli is in a consistent state Nov 27, 2023
@Samra10 Samra10 linked a pull request Nov 27, 2023 that will close this issue
2 tasks
@enekofb
Copy link
Contributor

enekofb commented Dec 5, 2023

In order to achieve the ticket beahviour we have the following options:

  1. extend the step lifecycle to include a verification stage to be executed after the step and outputs are created.
  2. to leverage helm release wait lifecycle: to use existing flux verify logic to do the heavy lifting for us
  3. to create verification steps - verify wge step.
  4. to embed within the step business logic

Preferred options:

  1. option 2: helm release: because does not require custom implementation
    // limitation: is it feasible to achieve it with helm release with dependencies
    // scenario: i wait for enterprise helm release ->
    // - cluster-services deploy ok but cluster-controller fails ... would the helm release wait fail?
  2. option 1: extend step lifecycle: because allows custom verification logic and it is common to any step

Verify preferred options with the following two scenarios:

  1. if cluster-service is deployed correctly and cluster-xx controller fails (as example of a dependency installed via wge helm chart), then install wge install step fails with error
  2. if cluster-service and all controllers deploy successfully, then install wge step does not fail.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cli issues related to gitops ee cli priority_high team/timber-wolf
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants