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

Flip CAPI support to disabled by default #3670

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

foot
Copy link
Collaborator

@foot foot commented Nov 23, 2023

Partially addresses #3658

Other issues to address:

  • [user-guide] Update the user-guide to show how to enable CAPI
  • [user-guide] Add a page about disabling / enabling CAPI support + restarting deployments
  • [user-guide] Make it more explicit that Policy still requires cert-manager (which is often implicitly installed with a capi-provider)

What changed?

  • Flip CAPI support to disabled by default
  • Also remove the explicit ".enabled: true" options in the values.yaml.

Why was this change made?

  • Also remove the explicit ".enabled: true" options in the values.yaml.

You cannot actually disable any of the controllers without a lot of things breaking. This reduces the visibility of this option and discourages users for playing with it.

How was this change implemented?

Parts of the system that recognise global.capiEnabled

  1. cluster-service: if capi is enabled then capi cluster details are queried for and returned in the /v1/clusters endpoint
  2. cluster-controller: if capi is enabled then capi clusters status is used to calculate the gitopscluster status

How did you validate the change?

  • Explain how a reviewer can verify the change themselves
  • Integration tests -- what is covered, what cannot be covered;
    or, explain why there are no new tests
  • Unit tests -- what is covered, what cannot be covered; are
    there tests that fail without the change?

Release notes

Documentation Changes

Other follow ups

- Also remove the explicit ".enabled: true" options in the values.yaml
- You cannot actually disable any of the controllers without a lot of
  things breaking
@foot foot added breaking-change to flag breaking changes similar to weave gitops oss enhancement New feature or request labels Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change to flag breaking changes similar to weave gitops oss enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant