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

By default, it will not enable any component #186

Closed
adelton opened this issue Sep 15, 2023 · 6 comments · Fixed by #192
Closed

By default, it will not enable any component #186

adelton opened this issue Sep 15, 2023 · 6 comments · Fixed by #192

Comments

@adelton
Copy link
Contributor

adelton commented Sep 15, 2023

The 2.X installation instructions at https://opendatahub.io/docs/quick-installation-new-operator/ say about the Create DataScienceCluster operation:

in the components section, by clicking > it expands currently supported core components. To enable any component, specifically tick the box in each component section. By default, it will not enable any component.

However, with the 2.1.0 operator that I get from the OperatorHub today, I see the following enabled by default:

  • dashboard
  • datasciencepipelines
  • modelmeshserving
  • workbenches

Should the documentation be updated, or is it incorrect that by default in the form view, these four are enabled?

@VaishnaviHire
Copy link
Member

The default example ensures that the core components are set to enabled. Users can then opt out of installing those.

Note: The documentation for DatasciencCluster will be updated for ODH 1.10 release to reflect latest API changes - https://github.com/opendatahub-io/opendatahub-operator#example-datasciencecluster

@adelton
Copy link
Contributor Author

adelton commented Sep 15, 2023

So do you say that the installation instructions are not correct in stating "By default, it will not enable any component"?

Updates of the documentation for other releases seem like a separate topic. It might be useful to start staging documentation updates for that in draft pull requests though.

@VaishnaviHire
Copy link
Member

VaishnaviHire commented Sep 15, 2023

Yep, I think a better wording would be The default example set core components as enabled. Users can unset the values if needed during the creation of DataScienceCluster.

However, we do want to also note, that by default if for a component the value for enabled is not set, it is set to be false.

Regarding the upcoming release, created a tracking issue #191

@adelton
Copy link
Contributor Author

adelton commented Sep 15, 2023

I've added #192 to fix the "by default, nothing is enabled" problem.

@adelton
Copy link
Contributor Author

adelton commented Sep 15, 2023

However, we do want to also note, that by default if for a component the value for enabled is not set, it is set to be false.

In the form view, there is no fiddling with the enabled text value.

If you think it makes sense to amend the YAML view section, please do it in separate PR. That section might also use a fresh screenshot to show all the components that the user can expect to find in the YAML by default, so there might be more work to be done for that case.

@adelton
Copy link
Contributor Author

adelton commented Sep 25, 2023

With #192 merged, this issue is resolved.

@adelton adelton closed this as completed Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants