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

Remove docs that imply components are optional #70

Open
nwneisen opened this issue Jul 29, 2024 · 2 comments
Open

Remove docs that imply components are optional #70

nwneisen opened this issue Jul 29, 2024 · 2 comments
Assignees
Labels
Docs-B Should Do

Comments

@nwneisen
Copy link
Collaborator

Based on a slack conversion: https://miracloud.slack.com/archives/C05Q9JN9M7C/p1721751883354439

It was cleared up that components are required and cannot be disabled. This has led to the removal of the Enabled field that was a part of each component in the config.

Since these are being removed, we should remove any references to them in the docs. We should also remove any wording that suggests a component can be removed or replaced with another option.

In the future, we hope to support multiple components for the same functionality but for now we are focused one of each.

Note
This is for the enabled field on the overall components, not their individual features such as authentication's SAML, OIDC, and LDAP

@KoryKessel-Mirantis KoryKessel-Mirantis self-assigned this Aug 29, 2024
@KoryKessel-Mirantis
Copy link
Collaborator

KoryKessel-Mirantis commented Aug 30, 2024

@nwneisen, please confirm that the Information directive on the Migrate from MKE 3.x topic should remain.

image

@nwneisen
Copy link
Collaborator Author

@KoryKessel-Mirantis Yes that should remain

The idea of no components being removable just got muddied. I would leave this as a reminder but There isn't an official decision on this yet.

We now will have 3 types of components

core - components that are required for MKE and can't be disabled (auth, ingress, metrics)
supported - components that we support and make easy to install but aren't required (gpu, metallb)
un-supported - components that customers may want to run but we don't know anything about. This list is endless. If it runs on k8s and has a helm chart, it can be ran

I would leave this ticket open as a reminder but maybe wait until hwat falls into each category is finalized.

@KoryKessel-Mirantis KoryKessel-Mirantis added the Docs-B Should Do label Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs-B Should Do
Projects
None yet
Development

No branches or pull requests

2 participants