cloud-init team mailing list archive
-
cloud-init team
-
Mailing list archive
-
Message #00341
Re: I need help on adding a new bistro to cloud-init
-
To:
James Falcon <james.falcon@xxxxxxxxxxxxx>
-
From:
Shreenidhi Shedi <sshedi@xxxxxxxxxx>
-
Date:
Fri, 21 May 2021 17:05:50 +0000
-
Accept-language:
en-IN, en-US
-
Arc-authentication-results:
i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=vmware.com; dmarc=pass action=none header.from=vmware.com; dkim=pass header.d=vmware.com; arc=none
-
Arc-message-signature:
i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=kmZQ4XfsEZiMCrlTReKMyPkBsBopaTYOAlKwX7RdGD8=; b=JJKUX0CZmk2oP4rGneRWeRmVAjxAZylFSY9R294aU+cGbCCGLvLF08YRLeFJAmE4Gg+pYUZxXcOgOvgTRoACOWt5aP7EOk/2JJWRFT0JvCWIfGI+Hd64I037ffWI2aegzvOpjPbN2mas41FXwe+gxScB15RY0mOGs6C6o4ukvAREf5QQeLdOT+BWzO2J5UL6vDyb7m+1E0D3ck4zurZXFi0a/WE7XK6qksM7cYEsHkRqeLXFkMznq6AK7PtBInE5t4e5AkMjvSeHoPMbmxlaDzIAHfnakfedxZfGusfXox7hOHltBmT+6TWWo6D82MOADg8sty3/ws6pdrFY4vmEyQ==
-
Arc-seal:
i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=gYL8ItxHjeWxK9N6KXduVTM6InQaBkbjFOfd9wKrgOxrcK70I0jtv9goQx8vnWAwhtOtTjK0lvnVpS5ueIEglMJztWWx3EXtwsyLo0lOs95z8+fKc0GVjVW7XO3nOiE2w3KHjtXxsrsdLoYljrHlmWCxp7EmBNUyS8AbNBybZ61ECqmVB0iX507l1l4sGuLxHws8zDhog8QwA8cNfW3rl+vKoKtXLfDGYB/Dqad/V9cl+CKUVFQ8uaxy0Ym5VCkpyGlqaBx1Yag1gylnMMmWVVu6Pbl+sm1sja7zWjTDP85LVWz/k8Wbch8Y2zMta/FLY9cmLCUV39ZTQ3sQ22EY8A==
-
Authentication-results:
canonical.com; dkim=none (message not signed) header.d=none;canonical.com; dmarc=none action=none header.from=vmware.com;
-
Cc:
"cloud-init@xxxxxxxxxxxxxxxxxxx" <cloud-init@xxxxxxxxxxxxxxxxxxx>
-
In-reply-to:
<CACncRhmbLuA-=u78zA=TEY_WkdC+h7gmTdu+usmw2hGJtfghKA@mail.gmail.com>
-
Thread-index:
AQHXTakP4DWb2eRmPEu4/TWj5giOk6rt8m0AgACVjIA=
-
Thread-topic:
[Cloud-init] I need help on adding a new bistro to cloud-init
-
User-agent:
Microsoft-MacOutlook/16.49.21050901
Thanks James. I will go through the given links and try to understand things better.
--
Shedi
On 21/05/21, 7:10 PM, "James Falcon" <james.falcon@xxxxxxxxxxxxx> wrote:
Shedi,
It looks like you've already done the hardest work, which is
overriding the Distro class for your needs. For everything else, the
easiest way to get started would be to take a look at a previous PR
that added a new distro. For example, support for AlmaLinux (a rhel
based distro) was recently added in this PR:
https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fcanonical%2Fcloud-init%2Fpull%2F872%2Ffiles&data=04%7C01%7Csshedi%40vmware.com%7C29767143338f45181cdd08d91c5e0a2c%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C1%7C637572012497413175%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=6Dz1%2FQsVmwS5scKjyEVkZdsdLbIlgx336sDJoAmWyWs%3D&reserved=0
You'll see some various distro lists, setup files, and systemd units
that you may need to add your distro to.
For testing locally, you'll see where unit tests were added in that
AlmaLinux PR. Generally, you'll want to ensure that your distro is
correctly identified and that any new behavior you add works as
expected. Unit tests can be run by calling "pytest" with the filename
you wish to test (they'll also run on our CI when you submit a PR).
Guidelines for unit tests can be found here:
https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fcloudinit.readthedocs.io%2Fen%2Flatest%2Ftopics%2Ftesting.html&data=04%7C01%7Csshedi%40vmware.com%7C29767143338f45181cdd08d91c5e0a2c%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C1%7C637572012497423168%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=aNzxa8t5sHB6eqs7awwS7aNf9k7A8AD%2B0wZ1%2BKBdIQU%3D&reserved=0
For running/debugging your distro locally, KVM is probably your best
bet. See the documentation here (using your image instead of the one
referenced):
https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fcloudinit.readthedocs.io%2Fen%2Flatest%2Ftopics%2Fdebugging.html%23analyze-quickstart-kvm&data=04%7C01%7Csshedi%40vmware.com%7C29767143338f45181cdd08d91c5e0a2c%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C1%7C637572012497423168%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=WaumWSWijVLQ5dk8ppbzpSfLMuFWwdDph1%2BHhaykkLY%3D&reserved=0
For the actual process of creating and submitting a PR, we have
documentation here:
https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fcloudinit.readthedocs.io%2Fen%2Flatest%2Ftopics%2Fhacking.html%23submitting-your-first-pull-request&data=04%7C01%7Csshedi%40vmware.com%7C29767143338f45181cdd08d91c5e0a2c%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C1%7C637572012497423168%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=UotxrJnMigQ9mYUntVs%2FA63of5a3bO4xOk9B3caOK%2FA%3D&reserved=0
Hope that helps!
- James
On Thu, May 20, 2021 at 1:51 PM Shreenidhi Shedi <sshedi@xxxxxxxxxx> wrote:
>
> Hi All,
>
>
>
> Hope you all are doing well.
>
> I am interested in contributing to cloud-init and I submitted one minor documentation fix to cloud-init sometime back.
>
> I work on VMware’s open source OS Photon - https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fvmware.github.io%2Fphoton%2Fassets%2Ffiles%2Fhtml%2F3.0%2FIntroduction.html&data=04%7C01%7Csshedi%40vmware.com%7C29767143338f45181cdd08d91c5e0a2c%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C1%7C637572012497423168%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=1BTukEpVGvJLRhxkTdHkxba1XqIxDzEJU3VozLhUbTI%3D&reserved=0
>
> We have our own distro specific things and we have https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fvmware%2Fphoton%2Fblob%2Fdev%2FSPECS%2Fcloud-init%2Fphoton-distro.patch&data=04%7C01%7Csshedi%40vmware.com%7C29767143338f45181cdd08d91c5e0a2c%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C1%7C637572012497423168%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=kdzp4MpBpgoBgfonldxIGrgf9C3%2BZoZsLKjvCUKJ5TU%3D&reserved=0
>
> And using this patch in our spec file.
>
>
>
> I want to make it a part of upstream cloud-init and would like to know how can I get started in this regard.
>
> What are the tests I need to add, how can I test my changes in my local build machine and so on.
>
>
>
> Appreciate any kind of help in this regard.
>
>
>
> --
>
> Shedi
>
>
>
> --
> Mailing list: https://nam04.safelinks.protection.outlook.com/?url=https:%2F%2Flaunchpad.net%2F~cloud-init&data=04%7C01%7Csshedi%40vmware.com%7C29767143338f45181cdd08d91c5e0a2c%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C1%7C637572012497423168%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=VRIddzNFCW0%2BTRzXTOjnLLK815llAicvFnz%2BEq1D9XE%3D&reserved=0
> Post to : cloud-init@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://nam04.safelinks.protection.outlook.com/?url=https:%2F%2Flaunchpad.net%2F~cloud-init&data=04%7C01%7Csshedi%40vmware.com%7C29767143338f45181cdd08d91c5e0a2c%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C1%7C637572012497423168%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=VRIddzNFCW0%2BTRzXTOjnLLK815llAicvFnz%2BEq1D9XE%3D&reserved=0
> More help : https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fhelp.launchpad.net%2FListHelp&data=04%7C01%7Csshedi%40vmware.com%7C29767143338f45181cdd08d91c5e0a2c%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C1%7C637572012497423168%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=9pBqjd0dtETcE4BefdCa92Zb4I6d3Im0XkUu8TPmTpU%3D&reserved=0
Follow ups
References
