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

Add Vpc image docs #613

Merged
merged 5 commits into from
Apr 12, 2022
Merged

Add Vpc image docs #613

merged 5 commits into from
Apr 12, 2022

Conversation

FischerLGLN
Copy link
Contributor

What this PR does / why we need it:
Enrich information how to build and upload a capi vm image to IBM Cloud.
Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):

Special notes for your reviewer:

/area provider/ibmcloud

@k8s-ci-robot k8s-ci-robot added the area/provider/ibmcloud Issues or PRs related to ibmcloud provider label Mar 31, 2022
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Mar 31, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

@netlify
Copy link

netlify bot commented Mar 31, 2022

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

Name Link
🔨 Latest commit 905b027
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-cluster-api-ibmcloud/deploys/625542d1ef8db400082b66cb
😎 Deploy Preview https://deploy-preview-613--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 settings.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 31, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @FischerLGLN!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-ibmcloud 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-ibmcloud has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 31, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @FischerLGLN. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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 the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 31, 2022
@mkumatag
Copy link
Member

mkumatag commented Mar 31, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

@mkumatag
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 31, 2022
@mkumatag
Copy link
Member

@wentao-zh please review this PR

@FischerLGLN
Copy link
Contributor Author

@mkumatag Regarding Personal or corporate CLA. I think this is a personal CLA, right?

@FischerLGLN
Copy link
Contributor Author

Or is it corporate CLA, because I do it during working hours?

@mkumatag
Copy link
Member

Or is it corporate CLA, because I do it during working hours?

depends on the organisation you are working in, if they have a corporate CLA signed with CNCF you can be part of that team(company sponsored) or you can choose personal(you need to confirm with your management on this), working hours doesn't really matters ;)

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 31, 2022
@FischerLGLN
Copy link
Contributor Author

Or is it corporate CLA, because I do it during working hours?

depends on the organisation you are working in, if they have a corporate CLA signed with CNCF you can be part of that team(company sponsored) or you can choose personal(you need to confirm with your management on this), working hours doesn't really matters ;)

Thank you, I signed personal, because we haven't signed something with CNCF and I work in german public sector and this is just a side project :)

@@ -1 +1,62 @@
This page is still being written - stay tuned!
Copy link
Member

Choose a reason for hiding this comment

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

This location is present to host the prebuilt images for the users to use, I'm wondering if we can move this page under Developer Guide section and refer in this page instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mkumatag Hi, how about moving my changes from vpc.md to this
https://cluster-api-ibmcloud.sigs.k8s.io/topics/vpc/prerequisites.html
prerequisites part like it is done in

https://cluster-api-ibmcloud.sigs.k8s.io/topics/powervs/prerequisites.html#build-workload-cluster-image

I would do that instead and leave this note in vpc.md

This page is still being written - stay tuned!

Copy link
Member

@mkumatag mkumatag Apr 11, 2022

Choose a reason for hiding this comment

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

I see its already here in the vpc section - https://cluster-api-ibmcloud.sigs.k8s.io/topics/vpc/prerequisites.html#build-workload-cluster-image, I prefer creating a separate page for the building the image itself and refer wherever you want. Whole information into prerequisites section will hard to digest.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mkumatag I pushed my changes to https://github.com/FischerLGLN/cluster-api-provider-ibmcloud :)
However, I don't see an update in this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, now it is there.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mkumatag
There is some confusion around markdown and html in this repo.

See here:
https://cluster-api-ibmcloud.sigs.k8s.io/machine-images/vpc.html
https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/main/docs/book/src/machine-images/vpc.md

I made a reference to a uploading-an-image.md (instead of your opened html) inside the prerequisites.md.
Does this cause this error?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mkumatag According to your screenshot, there should be a 4.1.3 in the left.
Maybe the netlify bot hasn't redeployed my changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, I can locally test with.
make serve
Same bad result, have to investigate 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mkumatag

I had to fetch some files from cluster-api-provider-ibmcloud upstream, now they are added in this pr, but netlify isn't triggered yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

/test ?

@mkumatag
Copy link
Member

mkumatag commented Apr 8, 2022

/cc @Prajyot-Parab

@k8s-ci-robot
Copy link
Contributor

@FischerLGLN: The following commands are available to trigger required jobs:

  • /test pull-cluster-api-provider-ibmcloud-build
  • /test pull-cluster-api-provider-ibmcloud-make
  • /test pull-cluster-api-provider-ibmcloud-smoke-test
  • /test pull-cluster-api-provider-ibmcloud-test
  • /test pull-cluster-api-provider-ibmcloud-verify

Use /test all to run all jobs.

In response to this:

/test ?

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.

@mkumatag mkumatag added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Apr 12, 2022
Copy link
Member

@mkumatag mkumatag left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 12, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: FischerLGLN, mkumatag

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

The pull request process is described 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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 12, 2022
@k8s-ci-robot k8s-ci-robot merged commit 3fdb551 into kubernetes-sigs:main Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/provider/ibmcloud Issues or PRs related to ibmcloud provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants