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 example from --runtime-extension flag in clusterctl #9796

Closed
cahillsf opened this issue Dec 3, 2023 · 11 comments · Fixed by #10084
Closed

Remove example from --runtime-extension flag in clusterctl #9796

cahillsf opened this issue Dec 3, 2023 · 11 comments · Fixed by #10084
Assignees
Labels
area/clusterctl Issues or PRs related to clusterctl good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@cahillsf
Copy link
Member

cahillsf commented Dec 3, 2023

The clusterctl help text for the --runtime-extension options provides an example:
Runtime extension providers and versions (e.g. test:v0.0.1) to add to the management cluster.

Applying this option and example param results in the following error:
Error: failed to get configuration for the RuntimeExtensionProvider with name test. Please check the provider name and/or add configuration for new providers using the .clusterctl config

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Dec 3, 2023
@cahillsf cahillsf changed the title [clusterctl] Add CAPI runtime-extension-components to default runtime extenstion providers [clusterctl] Add CAPI runtime-extension-components to default runtime extension providers Dec 3, 2023
@cahillsf
Copy link
Member Author

cahillsf commented Dec 3, 2023

/kind feature
/area clusterctl

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. area/clusterctl Issues or PRs related to clusterctl labels Dec 3, 2023
@sbueringer
Copy link
Member

Sounds good!

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 5, 2023
@cahillsf
Copy link
Member Author

cahillsf commented Dec 5, 2023

/assign cahillsf

@fabriziopandini
Copy link
Member

I don't think we should expose test extensions without some docs about what they are and how to use them.

Frankly speaking, I would simply remove the example from the flag description, plus eventually add a note that clusterctl doesn't include any default runtime extensions.

Runtime extension providers and versions to add to the management cluster; please note that clusterctl doesn't include any default runtime extensions and thus it is required to use custom configuration files to register runtime extensions.

@sbueringer
Copy link
Member

sbueringer commented Jan 16, 2024

I'm fine either way. The reason I wrote sounds good is because I thought it is similar to CAPD.

@fabriziopandini
Copy link
Member

The reason I wrote sounds good is because I thought it is similar to CAPD.

They are the kind the same, but for CAPD we have a quick start doc that tells users when and how to use CAPD (while we don't have an equivalent for test extensions).
Also, test extensions were mostly implemented to exercise some code path or as a code example, we never really focused on things like user experience or simulating use cases that could make sense for a final user, and thus I fear they might be confusing for people approaching it just because a flag uses it as an example value.

@sbueringer
Copy link
Member

Makes sense and I agree. Let's keep it "more internal" for the time being.

@cahillsf
Copy link
Member Author

sounds good, ill close out the existing PR and cut a new one with the doc/help text update suggested

@fabriziopandini fabriziopandini changed the title [clusterctl] Add CAPI runtime-extension-components to default runtime extension providers Remove example from --runtime-extension flag in clusterctl Jan 18, 2024
@fabriziopandini
Copy link
Member

/good-first-issue

@k8s-ci-robot
Copy link
Contributor

@fabriziopandini:
This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Jan 18, 2024
@avaneesh634
Copy link
Contributor

/assign avaneesh634

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/clusterctl Issues or PRs related to clusterctl good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
5 participants