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

Cluster API Operator Quickstart #9473

Closed
dtzar opened this issue Sep 20, 2023 · 3 comments · Fixed by #9706
Closed

Cluster API Operator Quickstart #9473

dtzar opened this issue Sep 20, 2023 · 3 comments · Fixed by #9706
Assignees
Labels
area/documentation Issues or PRs related to documentation kind/documentation Categorizes issue or PR as related to documentation. 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

@dtzar
Copy link
Contributor

dtzar commented Sep 20, 2023

What would you like to be added (User Story)?

As an operator, I would like to have quickstart instructions install cluster API and all dependencies utilizing the Cluster API Operator so that I can have a more scalable, GitOps-friendly, and better overall lifecycle for my CAPI management cluster(s).

Detailed Description

Would like to have an alternate path to the current quickstart guidance which only utilizes the operator (not clusterctl). This is important to have in the cluster API project book for visibility.

Anything else you would like to add?

Rough proposal would be to have a separate quickstart flow/path/page linked to at the top of the existing clusterctl quickstart page. Open for discussion on this thread.

Label(s) to be applied

/kind feature
/kind documentation
/area documentation

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. kind/documentation Categorizes issue or PR as related to documentation. area/documentation Issues or PRs related to documentation needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 20, 2023
@killianmuldoon
Copy link
Contributor

/triage accepted

Sounds like a good idea. Do we know if the current CAPI operator Getting Started is up to date? If we could separate out a doc like that in the operator repo we would be able to embed it in the CAPI book. This is similar to what we're doing for the autoscaler today.

@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 Sep 20, 2023
@dtzar
Copy link
Contributor Author

dtzar commented Sep 20, 2023

I like the embed idea! The getting started is up to date, but not streamlined for being embeded as a CAPI book quickstart. I'd be happy to help with this.
Step 1 - refactor getting started in operator repo
Step 2 - PR to CAPI to add a new quickstart which has that article embeded.

@alexander-demicev
Copy link
Contributor

I would like to work on that. Yes, we try to keep the operator's docs up to date.
/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation kind/documentation Categorizes issue or PR as related to documentation. 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
Development

Successfully merging a pull request may close this issue.

4 participants