added vmware metadata provider, closes #3507 #3526

brlbil · 2020-05-15T14:43:50Z

cloud-init data from vmware guest info as it described in the link below
https://github.com/vmware/cloud-init-vmware-guestinfo

closes #3507

- What I did
Implemented a vmware metadata provider that leverages vmware guest info
- How I did it
Implemented Provider interface. Added provider_vmware file and added vmware to cdrom providers in main.go
- How to verify it
Guest info can be set for a vm using govc tool and can be tested in that vm as described.
https://github.com/vmware/cloud-init-vmware-guestinfo
- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

rn

A few nits, but you'd also need to add a signed-off-by line to the commit. See https://github.com/linuxkit/linuxkit/blob/master/CONTRIBUTING.md#sign-your-work

pkg/metadata/main.go

pkg/metadata/provider_vmware.go

pkg/metadata/main.go

brlbil · 2021-02-05T12:14:31Z

I know it took a lot of time to fix missing bits and pieces. It seems all the checks are passing now, so can we merge this now?
@rn

brlbil · 2021-02-15T10:22:41Z

I know everyone is busy and it is not realistic to expect things always go fast for opensource projects.
But I would like to see this included in k3os asap. So can anyone take a look at the PR and get it rolling, please?

voima-eetu · 2021-02-16T10:34:23Z

I know everyone is busy and it is not realistic to expect things always go fast for opensource projects.
But I would like to see this included in k3os asap. So can anyone take a look at the PR and get it rolling, please?

A bit off-topic; I built k3os image with this your merge request and deployed it to VMware virtual datacenter using vcloud director, so thanks for this patch!

But for some reason my k3os installation on latest version of VMware cloud director wasn't able to read 'vmware' provider. On boot K3OS wasn't able to read guest-properties that I had added('guestinfo.user-data') and gave me just message "No metadata/userdata found. Bye".

Have you got this provider working? If yes, with what platform and which guest-properties?

brlbil · 2021-02-16T13:31:38Z

As you said I am sure we should discuss these issues here either. I think the problem is key should be set as guestinfo.userdata not guestinfo.user-data

edvinerikson · 2021-05-07T12:57:35Z

What's blocking this to be merged?

edvinerikson · 2021-05-07T12:59:53Z

pkg/metadata/provider_vmware.go

+
+// Probe checks if we are running on VMware
+func (p *ProviderVMware) Probe() bool {
+	c, err := exec.LookPath("vmware-rpctool")


Will this really be available if built with linuxkit? Wouldn't this tool only be available in the open-vm-tools image?

It will be available if open-vm-tools is intalled, which is sort of a requirement if you want to make RPC calls through VMCI to get guestinfo data.... I dont understand what is being requested.

This mirrors the functionality of vmware's cloud-init https://github.com/vmware/cloud-init-vmware-guestinfo/blob/master/DataSourceVMwareGuestInfo.py which functions the same way.

Since edvinerikson has brought it up I had checked if it would be possible not to use the command-line tool and use a library instead. It is possible to use this library. But this pull request has been idle for so long I am not sure maintainers have any interest in accepting it. I do not want to work on it if it is not going to be ignored.

I made a small PR to your source branch, as an example, with the said library 8 days ago: brlbil#1
This would give you the possibility of removing the vmware-rpctool

thehedgefrog · 2021-10-19T19:26:52Z

Any updates to this?

observ3r · 2021-10-25T10:27:44Z

Also looking for an update on this. Any thoughts? @rn

chris93111 · 2021-11-17T19:51:08Z

Any updates to this?

observ3r · 2022-02-02T20:44:14Z

Hello @rn - could you review/approve this?

observ3r · 2022-03-09T23:38:38Z

@deitch Could you take a look at this?

deitch · 2022-03-10T15:18:54Z

This looks pretty good, and you did address @rn's comments.

The only questions I have are:

Can you get @robertkaelin 's proposed changes here in, so that you do not have the dependency on vmware-rpctool? That would also mean documenting it, showing how to ensure it is available, etc. etc. His library solution is much better.
Is there any way to add a test for this? We only have a test for metadata on a CD here, so I can hardly be a stickler for it, but if it is possible, it would be good.

deitch · 2022-03-10T15:19:23Z

Completely separately, I see several people interested here. How are you using this (linuxkit in general)?

brlbil · 2022-03-10T15:40:07Z

@deitch originally I open this PR because linuxkit's metadata package is used in k3os

When it comes to your questions,

Changes suggested by @robertkaelin make sense I can add them. In fact, we have been running a forked version of the metadata package with these changes for some time now.
If we do the changes to use the VMware library then I do not know how can we add tests for it. It is meant to be run in a VMware virtual env. If it is run any other env it panics.

Since there is an interest I will make the changes and push them.

deitch · 2022-03-10T15:44:35Z

Go for it.

And when done, please squash all of your commits.

thehedgefrog · 2022-03-10T15:47:31Z

Completely separately, I see several people interested here. How are you using this (linuxkit in general)?

I'm using K3os in a homelab environment. I deploy Packer images with Terraform, so the quick and easy way is to use the provider.

My current workaround is to use the File provisioner to write a config file at deployment, that K3os then loads to configure. This however does not leverage the capabilities of cloud-init.

brlbil · 2022-03-11T12:39:00Z

I do not have access to a vcenter currently, so I will test the latest changes next week just to make sure everything works as expected.

brlbil · 2022-03-15T13:33:30Z

@deitch I have tested the package on a VMWare VM, and it works as expected.
Also, rebase and squash my commits as requested.

deitch

LGTM

deitch · 2022-03-21T15:07:51Z

Looks fine to me. Let CI go green and we can merge in.

deitch · 2022-03-21T15:29:35Z

I just remembered, we need to build and push out the updated images, then run the script.

scripts/update-components-sha.sh --image $(linuxkit package show-tag pkg/metadata)

That can be a separate commit.

Either way, though, CI is failing. Can you see what is causing it?

KittyKatt · 2022-05-09T05:53:37Z

@brlbil Any update on this? Really looking forward to configure k3os on vSphere without having to keep open a fork of linuxkit and build it every time I want a new ISO.

brlbil · 2022-05-09T08:21:33Z

@KittyKatt Unfortunately, I do not have any spare time to track the error that the pipeline throws. I have to do this on my own time. If anyone can help to track the error in the pipeline I would appreciate it.

observ3r · 2022-07-19T18:32:54Z

Appears the logs have expired for the Action that failed. Could it be re-run?

observ3r · 2022-07-25T11:04:05Z

@brlbil @deitch I don't have permission to rerun looks like. Could someone rerun it to generate the logs of the failed job?

brlbil · 2022-07-25T11:45:04Z

@observ3r I cannot run them either.

KittyKatt · 2022-08-11T17:11:42Z

@KittyKatt Unfortunately, I do not have any spare time to track the error that the pipeline throws. I have to do this on my own time. If anyone can help to track the error in the pipeline I would appreciate it.

I tried looking into the errors when it was available and correcting/building locally, but unfortunately I am not anywhere near an expert in Go and couldn't make heads nor tails of it. Sorry!

observ3r · 2022-11-29T17:06:56Z

Hey @deitch , are you able to rerun it?

deitch · 2022-11-30T18:27:39Z

The rerun button isn't there. 🤷‍♂️

Might as well rebase it to get the parallelization we did for actions (runs much more quickly), and push it out, which will cause CI to kick off again anyways.

observ3r · 2022-12-07T23:03:44Z

Oh awesome, lookin good! I suppose just waiting on @rn at this point?

observ3r · 2023-03-02T19:49:42Z

@brlbil Wanna rebase it? I don't think I can

brlbil · 2023-03-03T12:36:39Z

@observ3r @deitch I rebased, but I think the workflow requires approval

deitch · 2023-03-03T13:10:42Z

Looks like something relating to the added packages failed? Maybe a go mod tidy followed by a go mod vendor? 🤷‍♂️

brlbil · 2023-03-03T13:27:36Z

I think I see what is going on. The github.com/vmware/vmw-guestinfo package does not support arm64 so it fails to build. We can open an issue upstream to add support for it.

@deitch how to best avoid including VMware metadata in some of the architectures? I am pretty sure VMWare-tools is not supported on all the architectures that linuxkit is supporting like the arm.

deitch · 2023-03-03T13:34:57Z

Really? No arm64 support? That is surprising.

Do a dedicated file like provider_vmware_amd64.go and provider_vmware_unsupported.go, use //build directives at each, one for all other arch unsupported, one for amd64; for the amd64, return a valid struct, for all others, return nil, and add an if == nil check before adding it.

brlbil · 2023-03-03T13:43:21Z

Opened an issue for adding support for arm64 vmware-archive/vmw-guestinfo#25

@deitch I think we should proceed without arm64 support added. I have a feeling it would take a long time for it would be added upstream. If it is added then we can add support here as well. What do you think?

deitch · 2023-03-03T13:49:09Z

Agreed. Just do the build directives based on the suggestion above.

brlbil · 2023-03-03T22:06:14Z

@deitch ci passed on my fork, needs your touch here.

cloud-init data from vmware guest info as it described in the link below https://github.com/vmware/cloud-init-vmware-guestinfo Signed-off-by: Birol Bilgin <birolbilgin@gmail.com>

brlbil · 2023-03-04T06:41:42Z

I fixed if check, the provider was added to the list when it is nil.

rn requested changes Jul 26, 2020

View reviewed changes

pkg/metadata/main.go Show resolved Hide resolved

pkg/metadata/provider_vmware.go Outdated Show resolved Hide resolved

brlbil force-pushed the master branch from 2009d8e to 46f5908 Compare November 19, 2020 07:08

brlbil force-pushed the master branch from 68e3977 to 535bba8 Compare January 5, 2021 11:57

voima-eetu reviewed Jan 5, 2021

View reviewed changes

pkg/metadata/main.go Show resolved Hide resolved

brlbil requested a review from rn January 6, 2021 23:59

edvinerikson reviewed May 7, 2021

View reviewed changes

robertkaelin mentioned this pull request May 18, 2021

[Question][Suggestion] How to provision k3os servers usual way? rancher/k3os#314

Open

johnlaur mentioned this pull request Jun 11, 2021

vSphere Guestinfo Datasource rancher/k3os#413

Open

schnerring mentioned this pull request Oct 26, 2021

Feature request: create VHD images for Azure cloud rancher/k3os#101

Open

brlbil force-pushed the master branch from bc13ae8 to 3ecefe1 Compare March 11, 2022 12:36

brlbil force-pushed the master branch from 3ecefe1 to 5b7c1a1 Compare March 15, 2022 13:30

deitch previously approved these changes Mar 21, 2022

View reviewed changes

mateuszdrab mentioned this pull request Nov 29, 2022

cloud-init version BlueKrypto/k3os#6

Closed

brlbil dismissed deitch’s stale review via 4b810db March 3, 2023 12:32

brlbil force-pushed the master branch from dae8da8 to 4b810db Compare March 3, 2023 12:32

deitch previously approved these changes Mar 3, 2023

View reviewed changes

brlbil dismissed deitch’s stale review via dbe7749 March 3, 2023 19:07

brlbil force-pushed the master branch from 4b810db to dbe7749 Compare March 3, 2023 19:07

added vmware metadata provider

e396f52

cloud-init data from vmware guest info as it described in the link below https://github.com/vmware/cloud-init-vmware-guestinfo Signed-off-by: Birol Bilgin <birolbilgin@gmail.com>

brlbil force-pushed the master branch from dbe7749 to e396f52 Compare March 4, 2023 06:32

deitch approved these changes Mar 4, 2023

View reviewed changes

deitch merged commit d4a8e28 into linuxkit:master Mar 4, 2023

added vmware metadata provider, closes #3507 #3526

added vmware metadata provider, closes #3507 #3526

Conversation

brlbil commented May 15, 2020 • edited

rn left a comment

Choose a reason for hiding this comment

brlbil commented Feb 5, 2021 • edited

brlbil commented Feb 15, 2021

voima-eetu commented Feb 16, 2021

brlbil commented Feb 16, 2021

edvinerikson commented May 7, 2021

edvinerikson May 7, 2021

Choose a reason for hiding this comment

johnlaur May 27, 2021

Choose a reason for hiding this comment

brlbil May 28, 2021

Choose a reason for hiding this comment

robertkaelin May 28, 2021

Choose a reason for hiding this comment

thehedgefrog commented Oct 19, 2021

observ3r commented Oct 25, 2021 • edited

chris93111 commented Nov 17, 2021

observ3r commented Feb 2, 2022

observ3r commented Mar 9, 2022

deitch commented Mar 10, 2022

deitch commented Mar 10, 2022

brlbil commented Mar 10, 2022

deitch commented Mar 10, 2022

thehedgefrog commented Mar 10, 2022

brlbil commented Mar 11, 2022

brlbil commented Mar 15, 2022

deitch left a comment

Choose a reason for hiding this comment

deitch commented Mar 21, 2022

deitch commented Mar 21, 2022

KittyKatt commented May 9, 2022

brlbil commented May 9, 2022

observ3r commented Jul 19, 2022

observ3r commented Jul 25, 2022

brlbil commented Jul 25, 2022

KittyKatt commented Aug 11, 2022

observ3r commented Nov 29, 2022

deitch commented Nov 30, 2022

observ3r commented Dec 7, 2022

observ3r commented Mar 2, 2023

brlbil commented Mar 3, 2023

deitch commented Mar 3, 2023

brlbil commented Mar 3, 2023

deitch commented Mar 3, 2023

brlbil commented Mar 3, 2023

deitch commented Mar 3, 2023

brlbil commented Mar 3, 2023

brlbil commented Mar 4, 2023

brlbil commented May 15, 2020 •

edited

brlbil commented Feb 5, 2021 •

edited

observ3r commented Oct 25, 2021 •

edited