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.

Sign up for GitHub

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

Jump to bottom

Refactor documentation #1786

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Refactor documentation #1786

wants to merge 3 commits into from

Conversation

Amulyam24
Copy link
Contributor

@Amulyam24 Amulyam24 commented May 20, 2024 •
edited
Loading

What this PR does / why we need it:
This PR refactors the documentation for

  • VPC cluster creation
  • PowerVS cluster creation
  • minor simplifications

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

/area provider/ibmcloud

  1. Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

Release note:

Refactor documentation

@k8s-ci-robot k8s-ci-robot added the area/provider/ibmcloud Issues or PRs related to ibmcloud provider label May 20, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Amulyam24
Once this PR has been reviewed and has the lgtm label, please assign prajyot-parab for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 20, 2024
@netlify Netlify
Copy link

netlify bot commented May 20, 2024 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-cluster-api-ibmcloud ready!

Name Link
🔨 Latest commit fbfa4f0
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-cluster-api-ibmcloud/deploys/66757a2eb1a999000824aebb
😎 Deploy Preview https://deploy-preview-1786--kubernetes-sigs-cluster-api-ibmcloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 20, 2024
@Amulyam24
Copy link
Contributor Author

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 20, 2024
@Amulyam24 Amulyam24 changed the title minor doc fixes [WIP]minor doc fixes May 20, 2024
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 20, 2024
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 20, 2024
@Amulyam24 Amulyam24 changed the title [WIP]minor doc fixes Refactor VPC cluster creation document May 20, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 20, 2024
@Amulyam24 Amulyam24 changed the title Refactor VPC cluster creation document Refactor VPC cluster creation documentation May 20, 2024
@Amulyam24
Copy link
Contributor Author

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 20, 2024
Karthik-K-N
Karthik-K-N reviewed May 21, 2024
View reviewed changes
Copy link
Contributor

@Karthik-K-N Karthik-K-N left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small change otherwise LGTM

docs/book/src/developer/tilt.md Outdated Show resolved Hide resolved
@Amulyam24 Amulyam24 changed the title Refactor VPC cluster creation documentation [WIP}Refactor VPC cluster creation documentation May 21, 2024
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 21, 2024
@Amulyam24 Amulyam24 changed the title [WIP}Refactor VPC cluster creation documentation [WIP]Refactor VPC cluster creation documentation May 22, 2024
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 19, 2024
@Amulyam24 Amulyam24 changed the title [WIP]Refactor VPC cluster creation documentation Refactor documentation Jun 19, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 19, 2024
@Amulyam24
Copy link
Contributor Author

This PR is ready for review. PTAL!

Karthik-K-N
Karthik-K-N reviewed Jun 20, 2024
View reviewed changes
docs/book/src/topics/powervs/creating-a-cluster.md Outdated Show resolved Hide resolved
docs/book/src/topics/powervs/creating-a-cluster.md
--target-namespace default \
--control-plane-machine-count=3 \
--worker-machine-count=1 \
--from ./cluster-template-powervs-create-infra.yaml | kubectl apply -f -
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think we can use --flavor instead of --from now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll try it out and update the change accordingly.

@mkumatag
Copy link
Member

/cc @dharaneeshvrd @Prajyot-Parab

ptal

dharaneeshvrd
dharaneeshvrd reviewed Jun 25, 2024
View reviewed changes
docs/book/src/topics/powervs/creating-a-cluster.md
--control-plane-machine-count=3 \
--worker-machine-count=1 \
--flavor=powervs | kubectl apply -f -
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add more content here on explaining the usage of existing resources and the different combinations user can pass like TG, VPC and PowerVS service instance?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently the user provided TG expects to have both PowerVS and VPC connections.

  1. When connections are not there create the connection and during delete phase clean up only the connection. It requires another field to be added in status to mark whether connection is created by controller or not.
  2. We can expect combination of powervs, vpc and Tg to be passed and their connection should already be there.
    If we are going with 2nd approach, we need to document that. IMO we can go with second approach and keep things simple for reuse approach.
    Wdyt? @Amulyam24 @Karthik-K-N @mkumatag

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think its better to go with second approach and document it.

@mkumatag mkumatag added this to the v0.9.0 milestone Jul 23, 2024
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dharaneeshvrd dharaneeshvrd dharaneeshvrd left review comments

@Karthik-K-N Karthik-K-N Karthik-K-N left review comments

@mkumatag mkumatag Awaiting requested review from mkumatag

@Prajyot-Parab Prajyot-Parab Awaiting requested review from Prajyot-Parab

Assignees
No one assigned
Labels
area/provider/ibmcloud Issues or PRs related to ibmcloud provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
v0.9.0
Development

Successfully merging this pull request may close these issues.
5 participants
@Amulyam24 @k8s-ci-robot @mkumatag @dharaneeshvrd @Karthik-K-N