├── .gitignore ├── AUTHORS.in ├── LICENSE ├── MANIFEST.in ├── NEWS.md ├── README.md ├── man └── virt-bootstrap.pod ├── pylintrc ├── requirements.txt ├── run ├── setup.py ├── src └── virtBootstrap │ ├── __init__.py │ ├── progress.py │ ├── sources │ ├── __init__.py │ ├── docker_source.py │ ├── file_source.py │ └── virt_builder_source.py │ ├── utils.py │ ├── virt_bootstrap.py │ └── whiteout.py ├── tests ├── __init__.py ├── docker_source.py ├── file_source.py ├── password.txt ├── test_utils.py └── virt_builder_source.py └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | .tox 3 | .eggs 4 | dist 5 | build 6 | *.egg-info 7 | *.1 8 | -------------------------------------------------------------------------------- /AUTHORS.in: -------------------------------------------------------------------------------- 1 | virt-boostrap Authors 2 | ============================== 3 | 4 | The virt-bootstrap tool is maintained by the 5 | virt-manager development team, who can be contacted 6 | at 7 | 8 | virt-tools-list@redhat.com 9 | 10 | The individual contributors are 11 | 12 | @AUTHORS@ 13 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md LICENSE ChangeLog AUTHORS NEWS.md 2 | recursive-include src *.py 3 | recursive-include tests *.py 4 | recursive-include man * 5 | -------------------------------------------------------------------------------- /NEWS.md: -------------------------------------------------------------------------------- 1 | # Virt Bootstrap News 2 | 3 | ## Release 1.1.1 (Jul 9, 2019) 4 | 5 | * Don't expose the root password via command line 6 | * Set SElinux file context of destination folder 7 | * Use absolute destination path 8 | * safe-untar: Inherit SElinux context 9 | * don't allow overwriting of the root partition 10 | 11 | ## Release 1.1.0 (May 31, 2018) 12 | 13 | * safe_untar: check for permissions to set attribs 14 | * docker source, support blobs without .tar extension 15 | * docker-source, preserve extended file attributes 16 | * docker-source, get list of layers without `--raw` 17 | * docker-source, void skopeo copy in cache 18 | * Show error when guestfs-python or skopeo is not installed 19 | * pylint cleanups 20 | 21 | ## Release 1.0.0 (Sep 07, 2017) 22 | 23 | * Initial release 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | virt-bootstrap is a tool providing an easy way to setup the root 2 | file system for libvirt-based containers. 3 | 4 | It allows to use either a tarball containing the file system or 5 | an image on a docker registry and unpacks it either as a folder 6 | or in a qcow2 image with backing chains to mimic the docker layers. 7 | 8 | Dependencies 9 | ------------ 10 | 11 | * python 2 or 3 12 | * skopeo 13 | * virt-sandbox 14 | * libguestfs python binding 15 | * python passlib module 16 | * python mock module (for tests only) 17 | 18 | Hacking 19 | ------- 20 | 21 | To test changes without installing the package in your machine, 22 | use the run script. For example to run virt-bootstrap, use a command 23 | like the following one: 24 | 25 | ./run src/virtBootstrap/virt_bootstrap.py --help 26 | 27 | The following commands will be useful for anyone writing patches: 28 | 29 | ./setup.py test # Run local unit test suite 30 | ./setup.py pylint # Run a pylint script against the codebase 31 | 32 | Any patches shouldn't change the output of 'test' or 'pylint'. The 'pylint' requires `pylint` and `pycodestyle` to be installed. 33 | 34 | If [coverage](https://pypi.python.org/pypi/coverage/) is installed, you can generate report using: 35 | 36 | coverage run --source=virtBootstrap ./setup.py test 37 | coverage report 38 | -------------------------------------------------------------------------------- /man/virt-bootstrap.pod: -------------------------------------------------------------------------------- 1 | =encoding utf8 2 | 3 | =head1 NAME 4 | 5 | virt-bootstrap - Setup root file system for libvirt-based containers 6 | 7 | =head1 SYNOPSIS 8 | 9 | B URI DEST [OPTIONS] 10 | 11 | =head1 DESCRIPTION 12 | 13 | B is a tool providing an easy way to setup the root 14 | file system for libvirt-based containers. It allows to use either a 15 | tarball containing the file system, an image on a docker registry 16 | or virt-builder template and unpacks it either as a folder or in a 17 | 18 | =head2 Supported sources are: 19 | 20 | =over 4 21 | 22 | =item B> 23 | 24 | Tar archive which contains root file system 25 | 26 | =item B:I/I:I> 27 | 28 | Docker registry 29 | 30 | =item B> 31 | 32 | virt-builder templates 33 | 34 | =back 35 | 36 | Docker container images are downloaded and the layers are getting cached. 37 | If virt-bootstrap is running with effective UID=0 (root) the layersq 38 | are cached in C. 39 | For unprivileged users the C<~/.cache/virt-bootstrap/docker_images> directory 40 | is used. If the environment variable C is specified then this 41 | directory is used instead of C<~/.cache>. 42 | 43 | The environment variable C can be used to specify 44 | temporary directory used by virt-bootstrap or default C will be used. 45 | 46 | =head1 OPTIONS 47 | 48 | =over 4 49 | 50 | =item B<-f>, B<--format> 51 | 52 | Output format of the root file system. Possible values are B 53 | (default) and B. 54 | 55 | =item B<--root-password> SELECTOR 56 | 57 | This argument will generate hash from B, gotten from 58 | the B field, and insert the hashed value into C 59 | in the created root file system. 60 | 61 | Note that B can be one of the following: "file:". 62 | 63 | If the output format is C these modifications are applied in 64 | additional qcow2 disk image. 65 | 66 | Note that the C file must already exist in the extracted 67 | root file system of the container image and it must have entry for root 68 | user. 69 | 70 | =item B<--no-cache> 71 | 72 | When this flag is used Docker images will be downloaded in temporary 73 | directory and discarded after the root file system is extracted. 74 | 75 | =item B<--status-only> 76 | 77 | If this flag is used the log messages will be suppresses and only information 78 | about the current progress will be displayed. 79 | 80 | =item B<-q>, B<--quiet> 81 | 82 | Show only warning and error messages. 83 | 84 | =item B<-d>, B<--debug> 85 | 86 | Show debugging output messages. 87 | 88 | =item B<-h>, B<--help> 89 | 90 | Display command line help summary. 91 | 92 | =item B<--version> 93 | 94 | Show virt-bootstrap's version number and exit. 95 | 96 | =back 97 | 98 | =head2 Authentication options for accessing private Docker registry 99 | 100 | Note: If B<--username> argument is specified and B<--password> omitted 101 | password prompt will be issued. If B<--username> is omitted the B<--password> 102 | argument will be ignored. 103 | 104 | =over 4 105 | 106 | =item B<-u>, B<--username> USERNAME 107 | 108 | This argument takes USERNAME to be used to access Docker source registry. 109 | 110 | =item B<-p>, B<--password> PASSWORD 111 | 112 | This argument takes PASSWORD to be used to access Docker source registry. 113 | 114 | =item B<--not-secure> 115 | 116 | Don't require HTTPS and verification of certificates when talking to Docker registry. 117 | 118 | See L 119 | 120 | =back 121 | 122 | =head2 UID/GID mapping 123 | 124 | =over 4 125 | 126 | =item B<--uidmap> I:I:I 127 | 128 | Shift UIDs of all root file system entries with some offset. This parameter 129 | can be specified multiple times. 130 | 131 | Example: C<--uidmap 0:1000:10 --uidmap 500:1500:10> 132 | This will map the UIDs: 0-9 to 1000-1009 and 500-509 to 1500-1509 133 | 134 | See L 135 | 136 | =item B<--gidmap> I:I:I 137 | 138 | Shift GIDs of all root file system entries with some offset. This parameter 139 | can be specified multiple times. 140 | 141 | Example: C<--gidmap 0:1000:10 --gidmap 500:1500:10> 142 | This will map the GIDs: 0-9 to 1000-1009 and 500-509 to 1500-1509 143 | 144 | See L 145 | 146 | =item B<--idmap> I:I:I 147 | 148 | Remapping owner and group of all files and directories inside of the 149 | root file system. This parameter can be specified multiple times. 150 | 151 | Example: C<--idmap 0:1000:10 --idmap 500:1500:10> 152 | This will map UIDs and GIDs: 0-9 to 1000-1009 and 500-509 to 1500-1509 153 | 154 | See L 155 | 156 | =back 157 | 158 | =head1 USAGE EXAMPLES 159 | 160 | =over 4 161 | 162 | =item Create root file system using Ubuntu image docker.io registry: 163 | 164 | $ virt-bootstrap docker://ubuntu /tmp/foo 165 | 166 | =item Create root file system from image stored on private Docker registry: 167 | 168 | $ virt-bootstrap docker://localhost:5000/ubuntu /tmp/foo \ 169 | --username testuser \ 170 | --password testpassoword \ 171 | --not-secure 172 | 173 | =item Apply UIDs/GIDs mapping for root file system entries 174 | 175 | $ virt-bootstrap docker://fedora /tmp/foo \ 176 | --idmap 0:1000:10 177 | 178 | This above command will map UIDs/GIDs: B<0>-B<9> to B<1000>-B<1009> 179 | 180 | The same result can be achieved with: 181 | 182 | $ virt-bootstrap docker://fedora /tmp/foo \ 183 | --uidmap 0:1000:10 \ 184 | --gidmap 0:1000:10 185 | 186 | =item Multiple mapping values can be specified as follows: 187 | 188 | $ virt_bootstrap.py docker://ubuntu /tmp/foo \ 189 | --idmap 0:1000:10 \ 190 | --idmap 500:1500:10 191 | 192 | This will map the UID/GIDs: 193 | B<0>-B<9> to B<1000>-B<1009> and B<500>-B<509> to B<1500>-B<1509> 194 | 195 | =item Set root password 196 | 197 | $ virt_bootstrap.py docker://opensuse /tmp/foo \ 198 | --root-password file:/tmp/secret 199 | 200 | The above command will download the C container image and 201 | extract the root file system to C. Then it will generate hash 202 | of the password present in C file and insert it into 203 | C file. 204 | 205 | $ virt_bootstrap.py docker://opensuse /tmp/foo \ 206 | --root-password file:/tmp/secret \ 207 | -f qcow2 208 | 209 | Similarly for B format the container image will be downloaded and 210 | the root file system will be extracted into qcow2 disk images with backing 211 | chains. Then additional qcow2 image will be created with backing file set to 212 | the last layer and the modification of C file will be applied 213 | there. 214 | 215 | =back 216 | 217 | =head1 AUTHOR 218 | 219 | Written by Cedric Bosdonnat and Radostin Stoyanov 220 | 221 | =cut 222 | -------------------------------------------------------------------------------- /pylintrc: -------------------------------------------------------------------------------- 1 | [MASTER] 2 | 3 | # A comma-separated list of package or module names from where C extensions may 4 | # be loaded. Extensions are loading into the active Python interpreter and may 5 | # run arbitrary code 6 | #extension-pkg-whitelist= 7 | 8 | # Add files or directories to the blacklist. They should be base names, not 9 | # paths. 10 | #ignore=CVS 11 | 12 | # Add files or directories matching the regex patterns to the blacklist. The 13 | # regex matches against base names, not paths. 14 | # ignore-patterns= 15 | 16 | # Python code to execute, usually for sys.path manipulation such as 17 | # pygtk.require(). 18 | #init-hook= 19 | 20 | # Use multiple processes to speed up Pylint. 21 | jobs=1 22 | 23 | # List of plugins (as comma separated values of python modules names) to load, 24 | # usually to register additional checkers. 25 | # load-plugins= 26 | 27 | # Pickle collected data for later comparisons. 28 | persistent=yes 29 | 30 | # Specify a configuration file. 31 | #rcfile= 32 | 33 | # Allow loading of arbitrary C extensions. Extensions are imported into the 34 | # active Python interpreter and may run arbitrary code. 35 | unsafe-load-any-extension=no 36 | 37 | 38 | [MESSAGES CONTROL] 39 | 40 | # Only show warnings with the listed confidence levels. Leave empty to show 41 | # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED 42 | confidence= 43 | 44 | # Disable the message, report, category or checker with the given id(s). You 45 | # can either give multiple identifiers separated by comma (,) or put this 46 | # option multiple times (only on the command line, not in the configuration 47 | # file where it should appear only once).You can also use "--disable=all" to 48 | # disable everything first and then reenable specific checks. For example, if 49 | # you want to run only the similarities checker, you can use "--disable=all 50 | # --enable=similarities". If you want to run only the classes checker, but have 51 | # no Warning level messages displayed, use"--disable=all --enable=classes 52 | # --disable=W" 53 | 54 | # R0201 - Method could be a function 55 | # C0320 - Unnecessary parens after 'print' keyword 56 | # W0703 - Catching too general exception 57 | # R0912 - Used when a function or method has too many branches,making it hard to follow. 58 | 59 | disable=R0201,C0325,W0703,R0912 60 | 61 | 62 | # Enable the message, report, category or checker with the given id(s). You can 63 | # either give multiple identifier separated by comma (,) or put this option 64 | # multiple time (only on the command line, not in the configuration file where 65 | # it should appear only once). See also the "--disable" option for examples. 66 | enable= 67 | 68 | 69 | [REPORTS] 70 | 71 | # Python expression which should return a note less than 10 (10 is the highest 72 | # note). You have access to the variables errors warning, statement which 73 | # respectively contain the number of errors / warnings messages and the total 74 | # number of statements analyzed. This is used by the global evaluation report 75 | # (RP0004). 76 | evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) 77 | 78 | # Template used to display messages. This is a python new-style format string 79 | # used to format the message information. See doc for all details 80 | #msg-template= 81 | 82 | # Set the output format. Available formats are text, parseable, colorized, json 83 | # and msvs (visual studio).You can also give a reporter class, eg 84 | # mypackage.mymodule.MyReporterClass. 85 | output-format=text 86 | 87 | # Tells whether to display a full report or only the messages 88 | reports=no 89 | 90 | # Activate the evaluation score. 91 | score=yes 92 | 93 | 94 | [REFACTORING] 95 | 96 | # Maximum number of nested blocks for function / method body 97 | max-nested-blocks=5 98 | 99 | 100 | [SIMILARITIES] 101 | 102 | # Ignore comments when computing similarities. 103 | ignore-comments=yes 104 | 105 | # Ignore docstrings when computing similarities. 106 | ignore-docstrings=yes 107 | 108 | # Ignore imports when computing similarities. 109 | ignore-imports=no 110 | 111 | # Minimum lines number of a similarity. 112 | min-similarity-lines=4 113 | 114 | 115 | [TYPECHECK] 116 | 117 | # List of decorators that produce context managers, such as 118 | # contextlib.contextmanager. Add to this list to register other decorators that 119 | # produce valid context managers. 120 | contextmanager-decorators=contextlib.contextmanager 121 | 122 | # List of members which are set dynamically and missed by pylint inference 123 | # system, and so shouldn't trigger E1101 when accessed. Python regular 124 | # expressions are accepted. 125 | generated-members= 126 | 127 | # Tells whether missing members accessed in mixin class should be ignored. A 128 | # mixin class is detected if its name ends with "mixin" (case insensitive). 129 | ignore-mixin-members=yes 130 | 131 | # This flag controls whether pylint should warn about no-member and similar 132 | # checks whenever an opaque object is returned when inferring. The inference 133 | # can return multiple potential results while evaluating a Python object, but 134 | # some branches might not be evaluated, which results in partial inference. In 135 | # that case, it might be useful to still emit no-member and other checks for 136 | # the rest of the inferred objects. 137 | ignore-on-opaque-inference=yes 138 | 139 | # List of class names for which member attributes should not be checked (useful 140 | # for classes with dynamically set attributes). This supports the use of 141 | # qualified names. 142 | ignored-classes=optparse.Values,thread._local,_thread._local 143 | 144 | # List of module names for which member attributes should not be checked 145 | # (useful for modules/projects where namespaces are manipulated during runtime 146 | # and thus existing member attributes cannot be deduced by static analysis. It 147 | # supports qualified module names, as well as Unix pattern matching. 148 | ignored-modules= 149 | 150 | # Show a hint with possible names when a member name was not found. The aspect 151 | # of finding the hint is based on edit distance. 152 | missing-member-hint=yes 153 | 154 | # The minimum edit distance a name should have in order to be considered a 155 | # similar match for a missing member name. 156 | missing-member-hint-distance=1 157 | 158 | # The total number of similar names that should be taken in consideration when 159 | # showing a hint for a missing member. 160 | missing-member-max-choices=1 161 | 162 | 163 | [VARIABLES] 164 | 165 | # List of additional names supposed to be defined in builtins. Remember that 166 | # you should avoid to define new builtins when possible. 167 | additional-builtins=_ 168 | 169 | # Tells whether unused global variables should be treated as a violation. 170 | allow-global-unused-variables=yes 171 | 172 | # List of strings which can identify a callback function by name. A callback 173 | # name must start or end with one of those strings. 174 | callbacks=cb_,_cb 175 | 176 | # A regular expression matching the name of dummy variables (i.e. expectedly 177 | # not used). 178 | dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ 179 | 180 | # Argument names that match this expression will be ignored. Default to name 181 | # with leading underscore 182 | ignored-argument-names=_.*|^ignored_|^unused_ 183 | 184 | # Tells whether we should check for unused import in __init__ files. 185 | init-import=no 186 | 187 | # List of qualified module names which can have objects that can redefine 188 | # builtins. 189 | redefining-builtins-modules=six.moves,future.builtins 190 | 191 | 192 | [MISCELLANEOUS] 193 | 194 | # List of note tags to take in consideration, separated by a comma. 195 | # FIXME -- something which needs fixing 196 | # TODO -- future plan 197 | # XXX -- some concern 198 | notes=FIXME,XXX,TODO 199 | 200 | 201 | [BASIC] 202 | 203 | # Naming hint for argument names 204 | argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 205 | 206 | # Regular expression matching correct argument names 207 | argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 208 | 209 | # Naming hint for attribute names 210 | attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 211 | 212 | # Regular expression matching correct attribute names 213 | attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 214 | 215 | # Bad variable names which should always be refused, separated by a comma 216 | bad-names=foo,bar,baz,toto,tutu,tata 217 | 218 | # Naming hint for class attribute names 219 | class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ 220 | 221 | # Regular expression matching correct class attribute names 222 | class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ 223 | 224 | # Naming hint for class names 225 | class-name-hint=[A-Z_][a-zA-Z0-9]+$ 226 | 227 | # Regular expression matching correct class names 228 | class-rgx=[A-Z_][a-zA-Z0-9]+$ 229 | 230 | # Naming hint for constant names 231 | const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ 232 | 233 | # Regular expression matching correct constant names 234 | const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ 235 | 236 | # Minimum line length for functions/classes that require docstrings, shorter 237 | # ones are exempt. 238 | docstring-min-length=-1 239 | 240 | # Naming hint for function names 241 | function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 242 | 243 | # Regular expression matching correct function names 244 | function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 245 | 246 | # Good variable names which should always be accepted, separated by a comma 247 | good-names=i,j,k,ex,Run,_,virtBootstrap 248 | 249 | # Include a hint for the correct naming format with invalid-name 250 | include-naming-hint=yes 251 | 252 | # Naming hint for inline iteration names 253 | inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ 254 | 255 | # Regular expression matching correct inline iteration names 256 | inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ 257 | 258 | # Naming hint for method names 259 | method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 260 | 261 | # Regular expression matching correct method names 262 | method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 263 | 264 | # Naming hint for module names 265 | module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ 266 | 267 | # Regular expression matching correct module names 268 | module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ 269 | 270 | # Colon-delimited sets of names that determine each other's naming style when 271 | # the name regexes allow several styles. 272 | #name-group= 273 | 274 | # Regular expression which should only match function or class names that do 275 | # not require a docstring. 276 | no-docstring-rgx=^_|main 277 | 278 | # List of decorators that produce properties, such as abc.abstractproperty. Add 279 | # to this list to register other decorators that produce valid properties. 280 | property-classes=abc.abstractproperty 281 | 282 | # Naming hint for variable names 283 | variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 284 | 285 | # Regular expression matching correct variable names 286 | variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 287 | 288 | 289 | [FORMAT] 290 | 291 | # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. 292 | expected-line-ending-format= 293 | 294 | # Regexp for a line that is allowed to be longer than the limit. 295 | ignore-long-lines=^\s*(# )??$ 296 | 297 | # Number of spaces of indent required inside a hanging or continued line. 298 | indent-after-paren=4 299 | 300 | # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 301 | # tab). 302 | indent-string=' ' 303 | 304 | # Maximum number of characters on a single line. 305 | max-line-length=100 306 | 307 | # Maximum number of lines in a module 308 | max-module-lines=1000 309 | 310 | # List of optional constructs for which whitespace checking is disabled. `dict- 311 | # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. 312 | # `trailing-comma` allows a space between comma and closing bracket: (a, ). 313 | # `empty-line` allows space-only lines. 314 | no-space-check=trailing-comma,dict-separator 315 | 316 | # Allow the body of a class to be on the same line as the declaration if body 317 | # contains single statement. 318 | single-line-class-stmt=no 319 | 320 | # Allow the body of an if to be on the same line as the test if there is no 321 | # else. 322 | single-line-if-stmt=no 323 | 324 | 325 | [LOGGING] 326 | 327 | # Logging modules to check that the string format arguments are in logging 328 | # function parameter format 329 | logging-modules=logging 330 | 331 | 332 | [SPELLING] 333 | 334 | # Spelling dictionary name. Available dictionaries: none. To make it working 335 | # install python-enchant package. 336 | #spelling-dict= 337 | 338 | # List of comma separated words that should not be checked. 339 | #spelling-ignore-words= 340 | 341 | # A path to a file that contains private dictionary; one word per line. 342 | #spelling-private-dict-file= 343 | 344 | # Tells whether to store unknown words to indicated private dictionary in 345 | # --spelling-private-dict-file option instead of raising a message. 346 | #spelling-store-unknown-words=no 347 | 348 | 349 | [CLASSES] 350 | 351 | # List of method names used to declare (i.e. assign) instance attributes. 352 | defining-attr-methods=__init__,__new__,setUp 353 | 354 | # List of member names, which should be excluded from the protected access 355 | # warning. 356 | exclude-protected=_asdict,_fields,_replace,_source,_make 357 | 358 | # List of valid names for the first argument in a class method. 359 | valid-classmethod-first-arg=cls 360 | 361 | # List of valid names for the first argument in a metaclass class method. 362 | valid-metaclass-classmethod-first-arg=mcs 363 | 364 | 365 | [DESIGN] 366 | 367 | # Maximum number of arguments for function / method 368 | max-args=5 369 | 370 | # Maximum number of attributes for a class (see R0902). 371 | max-attributes=8 372 | 373 | # Maximum number of boolean expressions in a if statement 374 | max-bool-expr=5 375 | 376 | # Maximum number of branch for function / method body 377 | max-branches=12 378 | 379 | # Maximum number of locals for function / method body 380 | max-locals=15 381 | 382 | # Maximum number of parents for a class (see R0901). 383 | max-parents=7 384 | 385 | # Maximum number of public methods for a class (see R0904). 386 | max-public-methods=20 387 | 388 | # Maximum number of return / yield for function / method body 389 | max-returns=6 390 | 391 | # Maximum number of statements in function / method body 392 | max-statements=50 393 | 394 | # Minimum number of public methods for a class (see R0903). 395 | min-public-methods=1 396 | 397 | 398 | [IMPORTS] 399 | 400 | # Allow wildcard imports from modules that define __all__. 401 | allow-wildcard-with-all=no 402 | 403 | # Analyse import fallback blocks. This can be used to support both Python 2 and 404 | # 3 compatible code, which means that the block might have code that exists 405 | # only in one or another interpreter, leading to false positives when analysed. 406 | analyse-fallback-blocks=no 407 | 408 | # Deprecated modules which should not be used, separated by a comma 409 | deprecated-modules=regsub,TERMIOS,Bastion,rexec 410 | 411 | # Create a graph of external dependencies in the given file (report RP0402 must 412 | # not be disabled) 413 | #ext-import-graph= 414 | 415 | # Create a graph of every (i.e. internal and external) dependencies in the 416 | # given file (report RP0402 must not be disabled) 417 | import-graph= 418 | 419 | # Create a graph of internal dependencies in the given file (report RP0402 must 420 | # not be disabled) 421 | #int-import-graph= 422 | 423 | # Force import order to recognize a module as part of the standard 424 | # compatibility libraries. 425 | #known-standard-library= 426 | 427 | # Force import order to recognize a module as part of a third party library. 428 | known-third-party=enchant 429 | 430 | 431 | [EXCEPTIONS] 432 | 433 | # Exceptions that will emit a warning when being caught. Defaults to 434 | # "Exception" 435 | overgeneral-exceptions=Exception 436 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | --index-url https://pypi.python.org/simple/ 2 | 3 | passlib>=1.6.1 4 | guestfs 5 | 6 | --find-links 'http://download.libguestfs.org/python#egg=guestfs' 7 | --trusted-host 'download.libguestfs.org' 8 | -e . 9 | -------------------------------------------------------------------------------- /run: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # Authors: Cedric Bosdonnat 3 | # 4 | # Copyright (C) 2017 SUSE, Inc. 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | export PYTHONPATH=$PWD/src:$PYTHONPATH 20 | $@ 21 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8; -*- 3 | # Authors: Cedric Bosdonnat 4 | # Authors: Radostin Stoyanov 5 | # 6 | # Copyright (C) 2017 SUSE, Inc. 7 | # Copyright (C) 2017 Radostin Stoyanov 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | """ 23 | Setup script used for building, testing, and installing modules 24 | based on setuptools. 25 | """ 26 | 27 | import codecs 28 | import os 29 | import re 30 | import sys 31 | import subprocess 32 | import time 33 | import setuptools 34 | from setuptools.command.install import install 35 | from setuptools.command.sdist import sdist 36 | 37 | # pylint: disable=import-error, wrong-import-position 38 | sys.path.insert(0, 'src') # noqa: E402 39 | import virtBootstrap 40 | 41 | 42 | def read(fname): 43 | """ 44 | Utility function to read the text file. 45 | """ 46 | path = os.path.join(os.path.dirname(__file__), fname) 47 | with codecs.open(path, encoding='utf-8') as fobj: 48 | return fobj.read() 49 | 50 | 51 | class PostInstallCommand(install): 52 | """ 53 | Post-installation commands. 54 | """ 55 | def run(self): 56 | """ 57 | Post install script 58 | """ 59 | cmd = [ 60 | 'pod2man', 61 | '--center=Container bootstrapping tool', 62 | '--name=VIRT-BOOTSTRAP', 63 | '--release=%s' % virtBootstrap.__version__, 64 | 'man/virt-bootstrap.pod', 65 | 'man/virt-bootstrap.1' 66 | ] 67 | if subprocess.call(cmd) != 0: 68 | raise RuntimeError("Building man pages has failed") 69 | install.run(self) 70 | 71 | 72 | class CheckPylint(setuptools.Command): 73 | """ 74 | Check python source files with pylint and pycodestyle. 75 | """ 76 | 77 | user_options = [('errors-only', 'e', 'only report errors')] 78 | description = "Check code using pylint and pycodestyle" 79 | 80 | def initialize_options(self): 81 | """ 82 | Initialize the options to default values. 83 | """ 84 | # pylint: disable=attribute-defined-outside-init 85 | self.errors_only = False 86 | 87 | def finalize_options(self): 88 | """ 89 | Check final option values. 90 | """ 91 | pass 92 | 93 | def run(self): 94 | """ 95 | Call pycodestyle and pylint here. 96 | """ 97 | import pylint.lint 98 | import pycodestyle 99 | 100 | files = ["setup.py", "src/virtBootstrap/", "tests/"] 101 | output_format = "colorized" if sys.stdout.isatty() else "text" 102 | 103 | print(">>> Running pycodestyle ...") 104 | 105 | style_guide = pycodestyle.StyleGuide(paths=files) 106 | report = style_guide.check_files() 107 | if style_guide.options.count: 108 | sys.stderr.write(str(report.total_errors) + '\n') 109 | 110 | print(">>> Running pylint ...") 111 | 112 | pylint_opts = [ 113 | "--rcfile", "pylintrc", 114 | "--output-format=%s" % output_format 115 | ] 116 | 117 | if self.errors_only: 118 | pylint_opts.append("-E") 119 | 120 | pylint.lint.Run(files + pylint_opts) 121 | 122 | 123 | # SdistCommand is reused from the libvirt python binding (GPLv2+) 124 | class SdistCommand(sdist): 125 | """ 126 | Custom sdist command, generating a few files. 127 | """ 128 | user_options = sdist.user_options 129 | 130 | description = "Update AUTHORS and ChangeLog; build sdist-tarball." 131 | 132 | def gen_authors(self): 133 | """ 134 | Generate AUTHOS file out of git log 135 | """ 136 | fdlog = os.popen("git log --pretty=format:'%aN <%aE>'") 137 | authors = [] 138 | for line in fdlog: 139 | line = " " + line.strip() 140 | if line not in authors: 141 | authors.append(line) 142 | 143 | authors.sort(key=str.lower) 144 | 145 | with open('AUTHORS.in', 'r') as fd1, open('AUTHORS', 'w') as fd2: 146 | for line in fd1: 147 | fd2.write(line.replace('@AUTHORS@', "\n".join(authors))) 148 | 149 | def gen_changelog(self): 150 | """ 151 | Generate ChangeLog file out of git log 152 | """ 153 | cmd = "git log '--pretty=format:%H:%ct %an <%ae>%n%n%s%n%b%n'" 154 | fd1 = os.popen(cmd) 155 | fd2 = open("ChangeLog", 'w') 156 | 157 | for line in fd1: 158 | match = re.match(r'([a-f0-9]+):(\d+)\s(.*)', line) 159 | if match: 160 | timestamp = time.gmtime(int(match.group(2))) 161 | fd2.write("%04d-%02d-%02d %s\n" % (timestamp.tm_year, 162 | timestamp.tm_mon, 163 | timestamp.tm_mday, 164 | match.group(3))) 165 | else: 166 | if re.match(r'Signed-off-by', line): 167 | continue 168 | fd2.write(" " + line.strip() + "\n") 169 | 170 | fd1.close() 171 | fd2.close() 172 | 173 | def run(self): 174 | if not os.path.exists("build"): 175 | os.mkdir("build") 176 | 177 | if os.path.exists(".git"): 178 | try: 179 | self.gen_authors() 180 | self.gen_changelog() 181 | 182 | sdist.run(self) 183 | 184 | finally: 185 | files = ["AUTHORS", 186 | "ChangeLog"] 187 | for item in files: 188 | if os.path.exists(item): 189 | os.unlink(item) 190 | else: 191 | sdist.run(self) 192 | 193 | 194 | setuptools.setup( 195 | name='virt-bootstrap', 196 | version=virtBootstrap.__version__, 197 | author='Cedric Bosdonnat', 198 | author_email='cbosdonnat@suse.com', 199 | description='Container bootstrapping tool', 200 | license="GPLv3+", 201 | long_description=read('README.md'), 202 | url='https://github.com/virt-manager/virt-bootstrap', 203 | keywords='virtualization container rootfs', 204 | package_dir={"": "src"}, 205 | packages=setuptools.find_packages('src'), 206 | test_suite='tests', 207 | entry_points={ 208 | 'console_scripts': [ 209 | 'virt-bootstrap=virtBootstrap.virt_bootstrap:main', 210 | ] 211 | }, 212 | classifiers=[ 213 | 'Development Status :: 5 - Production/Stable', 214 | 'Intended Audience :: System Administrators', 215 | 'Intended Audience :: Developers', 216 | 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', # noqa: 501 217 | 'Programming Language :: Python :: 2', 218 | 'Programming Language :: Python :: 3', 219 | 220 | ], 221 | cmdclass={ 222 | 'install': PostInstallCommand, 223 | 'pylint': CheckPylint, 224 | 'sdist': SdistCommand 225 | }, 226 | 227 | data_files=[ 228 | ("share/man/man1", ['man/virt-bootstrap.1']) 229 | ], 230 | 231 | tests_require=['mock>=2.0'], 232 | 233 | extras_require={ 234 | 'dev': [ 235 | 'pylint', 236 | 'pycodestyle' 237 | ] 238 | } 239 | ) 240 | -------------------------------------------------------------------------------- /src/virtBootstrap/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Authors: 3 | # Radostin Stoyanov 4 | 5 | # Copyright (c) 2017 Radostin Stoyanov 6 | 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | 20 | r""" 21 | The virtBootstrap module provides an easy way to setup the root file system for 22 | Libvirt-LXC containers. 23 | 24 | This module exports the method bootstrap() which takes the following arguments: 25 | 26 | 27 | uri 28 | This parameter takes a string of source URI. 29 | 30 | Supported URI formats: 31 | -------------------------------------- 32 | - File (tarball) 33 | /path/to/local/rootfs.tar.xz 34 | file://path/to/local/rootfs.tar.xz 35 | 36 | - Docker registry (skopeo) 37 | docker://ubuntu:latest 38 | docker://docker.io/fedora 39 | docker://privateregistry:5000/image 40 | 41 | - virt-builder 42 | virt-builder://fedora-25 43 | virt-builder://ubuntu-16.04 44 | -------------------------------------- 45 | * If Docker registry is not specified "docker.io" is used. 46 | 47 | 48 | dest 49 | This parameter takes a string which represents absolute or real path of 50 | destination directory where the root file system will be extract or 51 | qcow2 images will be stored. 52 | 53 | 54 | fmt (optional) 55 | This parameter takes a string which represents the output format for 56 | the root file system. Possible values are: 57 | - dir (default) 58 | - qcow2 59 | 60 | 61 | username (optional) 62 | This parameter takes a string which represents the username used to 63 | access Docker source registry. See also "password" and "not_secure". 64 | 65 | If this parameter is specified and the "password" is ommited password 66 | prompt will be issued. 67 | 68 | *See https://docs.docker.com/registry/deploying/#restricting-access 69 | 70 | 71 | password (optional) 72 | This parameter takes a string which represents the password used to 73 | access Docker source registry. 74 | 75 | *See https://docs.docker.com/registry/deploying/#restricting-access 76 | 77 | 78 | root_password (optional) 79 | This parameter takes a string which represents root password. 80 | This string is hashed and inserted into /etc/shadow file of the 81 | extracted root file system. 82 | If the output format is "qcow2" the modification of /etc/shadow are 83 | applied in additional qcow2 disk image with backing file set to the 84 | last layer. 85 | 86 | *The /etc/shadow file must already exist in the rootfs of the container 87 | image and have "root" user entry. 88 | 89 | 90 | uid_map (optional) 91 | This parameter takes a list of lists which represents the translation 92 | map for UID. See also "gid_map". 93 | 94 | Format: 95 | [[, , ]] 96 | Example: 97 | [[0, 1000, 10], [500, 1500, 10]] 98 | This will map the UID: 0-9 to 1000-1009 and 500-509 to 1500-1509 99 | 100 | *When the output format is "dir" (fmt="dir") this option is available 101 | only for privileged users. 102 | 103 | 104 | gid_map (optional) 105 | This parameter is used to map group ownership of files in the 106 | extracted rootfs. It works in a similar way as "uid_map". 107 | 108 | 109 | not_secure (optional) 110 | This parameter takes a boolean which indicates whether HTTPS errors 111 | will be ignored. Default value is False. 112 | 113 | *See "--src-tls-verify" from "skopeo copy". 114 | https://www.mankier.com/1/skopeo#skopeo_copy 115 | 116 | 117 | no_cache (optional) 118 | This parameter takes a boolean which indicates whether the downloaded 119 | Docker images will be discarded after the root file system was 120 | extracted. 121 | 122 | By default downloaded images are stored in: 123 | /var/cache/virt-bootstrap/docker_images/ 124 | for non-root users: 125 | ~/.cache/share/virt-bootstrap/docker_images/ 126 | 127 | 128 | progress_cb (optional) 129 | This parameter takes a function which is called every time when the 130 | progress information is updated. Only one parameter passed to the 131 | called function - a dictionary with keys 'status' and 'value'. 132 | 133 | Examples: 134 | {'status': 'Checking cached layers', 'value': 0} 135 | {'status': 'Downloading layer (1/1)', 'value': 12.82051282051282} 136 | 137 | 138 | Usage Examples 139 | 140 | import virtBootstrap 141 | 142 | # Bootstrap latest Ubuntu container image from docker.io 143 | virtBootstrap.bootstrap(uri='docker://ubuntu', dest='/tmp/foo') 144 | 145 | # Bootstrap Fedora 25 container image from docker.io 146 | virtBootstrap.bootstrap( 147 | uri='docker://registry.fedoraproject.org/fedora:25', 148 | dest='/tmp/bar' 149 | ) 150 | 151 | # Set password for root 152 | virtBootstrap.bootstrap( 153 | uri='docker://fedora', 154 | dest='/tmp/foo', 155 | root_password='file:/tmp/secret' 156 | ) 157 | 158 | # Convert Ubuntu container image to qcow2 disk image using backing chains 159 | virtBootstrap.bootstrap( 160 | uri='docker://ubuntu', 161 | dest='/tmp/foo', 162 | fmt='qcow2' 163 | ) 164 | 165 | # Bootstrap root file system from image stored in private registry 166 | virtBootstrap.bootstrap( 167 | uri='docker://localhost:5000/opensuse', 168 | dest='/tmp/foo', 169 | username='testuser', 170 | password='testpassoword', 171 | not_secure=True 172 | ) 173 | 174 | # Apply UID/GID mapping (root privileges required). 175 | virtBootstrap.bootstrap( 176 | uri='docker://ubuntu', 177 | dest='/tmp/foo', 178 | uid_map=[[0,1000,10]], 179 | gid_map=[[0,1000,10]] 180 | ) 181 | 182 | # Use progress callback to print the current progress to stdout 183 | def show(prog): print(prog) 184 | 185 | virtBootstrap.bootstrap( 186 | uri='docker://ubuntu', 187 | dest='/tmp/foo', 188 | progress_cb=show 189 | ) 190 | 191 | Note: 192 | You don't necessarily need to be root when using virt-bootstrap with 193 | "qcow2" output format, however, for "dir" format there are some drawbacks: 194 | 1. Mapping UID/GID is not supported for unprivileged users. 195 | 2. All extracted files will be owned by the current unprivileged user. 196 | """ 197 | 198 | from virtBootstrap.virt_bootstrap import bootstrap 199 | from virtBootstrap.virt_bootstrap import __version__ 200 | -------------------------------------------------------------------------------- /src/virtBootstrap/progress.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Authors: 3 | # Cedric Bosdonnat 4 | # Radostin Stoyanov 5 | # 6 | # Copyright (c) 2017 Radostin Stoyanov 7 | # 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | 18 | # You should have received a copy of the GNU General Public License 19 | # along with this program. If not, see . 20 | 21 | """ 22 | Store the progress of virt-bootstrap 23 | """ 24 | 25 | 26 | class Progress(object): 27 | """ 28 | Store progress status and value of virt-bootstrap and 29 | inform callback method about change. 30 | """ 31 | 32 | def __init__(self, callback=None): 33 | """ 34 | If callback method is passed it will be called when the progress 35 | value has been changed. 36 | """ 37 | self.progress = {'status': '', 'value': 0} 38 | self.callback = callback 39 | 40 | def get_progress(self): 41 | """ 42 | Return "state" and "value" of the progress in python dictionary. 43 | """ 44 | return self.progress.copy() 45 | 46 | def update_progress(self, status=None, value=None, logger=None): 47 | """ 48 | Set status/value and call the callback method if available. 49 | Log information message if logger instance was passed. 50 | 51 | @param status: String representing the current state of virt-bootstrap. 52 | @param value: The new progress value of virt-bootstrap. 53 | @param logger: Reference to logger. If passed info message with 54 | including the status will be logged. 55 | """ 56 | # Note: We do not validate the values stored in progress 57 | if isinstance(status, str): 58 | self.progress['status'] = status 59 | if isinstance(value, (float, int)): 60 | self.progress['value'] = value 61 | 62 | try: 63 | if logger is not None: 64 | logger.info(status) 65 | if self.callback is not None: 66 | self.callback(self.get_progress()) 67 | except Exception as err: 68 | raise ValueError("Progress update has failed.", err) 69 | -------------------------------------------------------------------------------- /src/virtBootstrap/sources/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Authors: 3 | # Radostin Stoyanov 4 | 5 | # Copyright (c) 2017 Radostin Stoyanov 6 | 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | 20 | """ 21 | Class definitions which process container images and extract the root 22 | file system to destination directory or convert them to qcow2 disk images with 23 | backing chains. 24 | """ 25 | 26 | from virtBootstrap.sources.file_source import FileSource 27 | from virtBootstrap.sources.docker_source import DockerSource 28 | from virtBootstrap.sources.virt_builder_source import VirtBuilderSource 29 | -------------------------------------------------------------------------------- /src/virtBootstrap/sources/docker_source.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Authors: Cedric Bosdonnat 3 | # 4 | # Copyright (C) 2017 SUSE, Inc. 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | """ 20 | DockerSource aim is to download container image from Docker registry and 21 | extract the layers of root file system into destination directory or qcow2 22 | image with backing chains. 23 | """ 24 | 25 | import select 26 | import shutil 27 | import getpass 28 | import os 29 | import logging 30 | import subprocess 31 | 32 | from virtBootstrap import utils 33 | 34 | 35 | # pylint: disable=invalid-name 36 | # Create logger 37 | logger = logging.getLogger(__name__) 38 | 39 | 40 | class DockerSource(object): 41 | """ 42 | Extract files from Docker image 43 | """ 44 | 45 | # pylint: disable=too-many-instance-attributes 46 | def __init__(self, **kwargs): 47 | """ 48 | Bootstrap root filesystem from Docker registry 49 | 50 | @param uri: Address of source registry 51 | @param username: Username to access source registry 52 | @param password: Password to access source registry 53 | @param uid_map: Mappings for UID of files in rootfs 54 | @param gid_map: Mappings for GID of files in rootfs 55 | @param root_password: Root password to set in rootfs 56 | @param fmt: Format used to store image [dir, qcow2] 57 | @param not_secure: Do not require HTTPS and certificate verification 58 | @param no_cache: Whether to store downloaded images or not 59 | @param progress: Instance of the progress module 60 | 61 | Note: uid_map and gid_map have the format: 62 | [[, , ], [, , ] ...] 63 | """ 64 | 65 | # Check if skopeo is installed 66 | if not utils.is_installed('skopeo'): 67 | raise RuntimeError('skopeo is not installed') 68 | 69 | self.url = self.gen_valid_uri(kwargs['uri']) 70 | self.username = kwargs.get('username', None) 71 | self.password = kwargs.get('password', None) 72 | self.uid_map = kwargs.get('uid_map', []) 73 | self.gid_map = kwargs.get('gid_map', []) 74 | self.root_password = kwargs.get('root_password', None) 75 | self.output_format = kwargs.get('fmt', utils.DEFAULT_OUTPUT_FORMAT) 76 | self.insecure = kwargs.get('not_secure', False) 77 | self.no_cache = kwargs.get('no_cache', False) 78 | self.progress = kwargs['progress'].update_progress 79 | self.images_dir = utils.get_image_dir(self.no_cache) 80 | self.image_details = None 81 | self.layers = [] 82 | self.checksums = [] 83 | 84 | if self.username and not self.password: 85 | self.password = getpass.getpass() 86 | 87 | self.retrieve_layers_info() 88 | 89 | def retrieve_layers_info(self): 90 | """ 91 | Retrive manifest from registry and get layers' digest, 92 | sum_type, size and file_path in a list. 93 | """ 94 | image_details = utils.get_image_details(self.url, raw=False, 95 | insecure=self.insecure, 96 | username=self.username, 97 | password=self.password) 98 | 99 | if 'Layers' not in image_details or not image_details['Layers']: 100 | raise ValueError('No image layers.') 101 | 102 | # Layers are in order: 103 | # - root layer first, and then successive layered layers 104 | # Ref: https://github.com/containers/image/blob/master/image/oci.go 105 | for layer_digest in image_details['Layers']: 106 | sum_type, layer_sum = layer_digest.split(':') 107 | self.checksums.append([sum_type, layer_sum]) # Store checksums 108 | 109 | # Layers are tar files with hashsum used as name 110 | file_path = os.path.join(self.images_dir, layer_sum) 111 | # Store 'file path' and set placeholder for 'size' 112 | self.layers.append([file_path, None]) 113 | 114 | def gen_valid_uri(self, uri): 115 | """ 116 | Generate Docker URI in format accepted by skopeo. 117 | """ 118 | registry = uri.netloc 119 | image = uri.path 120 | 121 | # Convert "docker:///" to "docker://" 122 | if not registry and image.startswith('/'): 123 | image = image[1:] 124 | 125 | # Convert "docker:///" to "docker://" 126 | if image.endswith('/'): 127 | image = image[:-1] 128 | 129 | return "docker://" + registry + image 130 | 131 | def download_image(self): 132 | """ 133 | Download image layers using "skopeo copy". 134 | """ 135 | 136 | if self.no_cache: 137 | dest_dir = self.images_dir 138 | else: 139 | dest_dir = utils.get_image_dir(no_cache=True) 140 | 141 | # Note: we don't want to expose --src-cert-dir to users as 142 | # they should place the certificates in the system 143 | # folders for broader enablement 144 | skopeo_copy = ["skopeo", "copy", self.url, "dir:" + dest_dir] 145 | 146 | if self.insecure: 147 | skopeo_copy.append('--src-tls-verify=false') 148 | if self.username: 149 | skopeo_copy.append('--src-creds={}:{}'.format(self.username, 150 | self.password)) 151 | self.progress("Downloading container image", value=0, logger=logger) 152 | # Run "skopeo copy" command 153 | self.read_skopeo_progress(skopeo_copy) 154 | 155 | if not self.no_cache: 156 | os.remove(os.path.join(dest_dir, "manifest.json")) 157 | os.remove(os.path.join(dest_dir, "version")) 158 | utils.copytree(dest_dir, self.images_dir) 159 | shutil.rmtree(dest_dir) 160 | 161 | # Old versions of skopeo use '.tar' extension to blobs. 162 | # Make sure we use the correct file name. 163 | for i in range(len(self.layers)): 164 | path = self.layers[i][0] 165 | if not os.path.exists(path): 166 | if os.path.exists(path + '.tar'): 167 | self.layers[i][0] += '.tar' 168 | else: 169 | raise ValueError('Blob %s does not exist.' % path) 170 | 171 | def parse_output(self, proc): 172 | """ 173 | Read stdout from skopeo's process asynchconosly. 174 | """ 175 | current_layer, total_layers_num = 0, len(self.layers) 176 | 177 | # Process the output until the process terminates 178 | while proc.poll() is None: 179 | # Wait for data to become available 180 | stdout = select.select([proc.stdout], [], [])[0] 181 | # Split output into line 182 | output = utils.read_async(stdout[0]).strip().split('\n') 183 | for line in output: 184 | line_split = line.split() 185 | if len(line_split) > 2: # Avoid short lines 186 | if utils.is_new_layer_message(line): 187 | current_layer += 1 188 | self.progress("Downloading layer (%s/%s)" 189 | % (current_layer, total_layers_num)) 190 | # Use the single slash between layer's "downloaded" and 191 | # "total size" in the output to recognise progress message 192 | elif line_split[2] == '/': 193 | self.update_progress_from_output(line_split, 194 | current_layer, 195 | total_layers_num) 196 | 197 | # Stop parsing when manifest is copied. 198 | elif utils.is_layer_config_message(line): 199 | break 200 | else: 201 | continue # continue if the inner loop didn't break 202 | break 203 | 204 | if proc.poll() is None: 205 | proc.wait() # Wait until the process is finished 206 | return proc.returncode == 0 207 | 208 | def update_progress_from_output(self, line_split, current_l, total_l): 209 | """ 210 | Parse a line from skopeo's output to extract the downloaded and 211 | total size of image layer. 212 | 213 | Calculate percentage and update the progress of virt-bootstrap. 214 | 215 | @param current_l: Number of currently downloaded layer 216 | @param total_l: Total number of layers 217 | @param line_split: A list with format: 218 | [, , '/', , , ] 219 | Example: 220 | ['5.92', 'MB', '/', '44.96', 'MB', '[===>-----------------]'] 221 | """ 222 | 223 | if not (len(line_split) > 4 and isinstance(line_split, list)): 224 | return 225 | 226 | d_size, d_format = utils.str2float(line_split[0]), line_split[1] 227 | t_size, t_format = utils.str2float(line_split[3]), line_split[4] 228 | 229 | if d_size and t_size: 230 | downloaded_size = utils.size_to_bytes(d_size, d_format) 231 | total_size = utils.size_to_bytes(t_size, t_format) 232 | if downloaded_size and total_size: 233 | try: 234 | frac = float(1) / total_l 235 | downloaded = float(downloaded_size) / total_size 236 | layer_frac = float(max(0, current_l - 1)) / total_l 237 | 238 | progress = 50 * (layer_frac + (frac * downloaded)) 239 | 240 | self.progress(value=progress) 241 | except Exception: 242 | pass # Ignore failures 243 | 244 | def read_skopeo_progress(self, cmd): 245 | """ 246 | Parse the output from skopeo copy to track download progress. 247 | """ 248 | proc = subprocess.Popen( 249 | cmd, 250 | stdout=subprocess.PIPE, 251 | stderr=subprocess.PIPE, 252 | universal_newlines=True 253 | ) 254 | 255 | # Without `make_async`, `fd.read` in `read_async` blocks. 256 | utils.make_async(proc.stdout) 257 | if not self.parse_output(proc): 258 | raise subprocess.CalledProcessError(proc.returncode, ' '.join(cmd)) 259 | 260 | def validate_image_layers(self): 261 | """ 262 | Check if layers of container image exist in image_dir 263 | and have valid hash sum. 264 | """ 265 | self.progress("Checking cached layers", value=0, logger=logger) 266 | for index, checksum in enumerate(self.checksums): 267 | path = self.layers[index][0] 268 | sum_type, sum_expected = checksum 269 | 270 | logger.debug("Checking layer: %s", path) 271 | if (os.path.exists(path) 272 | and utils.checksum(path, sum_type, sum_expected)): 273 | continue 274 | if (not path.endswith('.tar') 275 | and os.path.exists(path + '.tar') 276 | and utils.checksum(path + '.tar', sum_type, sum_expected)): 277 | self.layers[index][0] += '.tar' 278 | else: 279 | return False 280 | return True 281 | 282 | def fetch_layers(self): 283 | """ 284 | Retrieve layers of container image. 285 | """ 286 | # Check if layers have been downloaded 287 | if not self.validate_image_layers(): 288 | self.download_image() 289 | 290 | def unpack(self, dest): 291 | """ 292 | Extract image files from Docker image 293 | 294 | @param dest: Directory path where the files to be extraced 295 | """ 296 | try: 297 | # Layers are in order - root layer first 298 | # Reference: 299 | # https://github.com/containers/image/blob/master/image/oci.go#L100 300 | self.fetch_layers() 301 | 302 | # Unpack to destination directory 303 | if self.output_format == 'dir': 304 | self.progress("Extracting container layers", value=50, 305 | logger=logger) 306 | utils.untar_layers(self.layers, dest, self.progress) 307 | elif self.output_format == 'qcow2': 308 | self.progress("Extracting container layers into qcow2 images", 309 | value=50, logger=logger) 310 | 311 | img = utils.BuildImage( 312 | layers=self.layers, 313 | dest=dest, 314 | progress=self.progress 315 | ) 316 | img.create_base_layer() 317 | img.create_backing_chains() 318 | img.set_root_password(self.root_password) 319 | if self.uid_map or self.gid_map: 320 | logger.info("Mapping UID/GID") 321 | utils.map_id_in_image( 322 | len(self.layers), # Number of layers 323 | dest, self.uid_map, 324 | self.gid_map, 325 | (self.root_password is None) # Create new disk? 326 | ) 327 | 328 | else: 329 | raise Exception("Unknown format:" + self.output_format) 330 | 331 | except Exception: 332 | raise 333 | 334 | else: 335 | self.progress("Download and extract completed!", value=100, 336 | logger=logger) 337 | logger.info("Files are stored in: %s", dest) 338 | 339 | finally: 340 | # Clean up 341 | if self.no_cache and self.images_dir != utils.DEFAULT_IMG_DIR: 342 | shutil.rmtree(self.images_dir) 343 | -------------------------------------------------------------------------------- /src/virtBootstrap/sources/file_source.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Authors: Cedric Bosdonnat 3 | # 4 | # Copyright (C) 2017 SUSE, Inc. 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | """ 20 | FileSource aim is to extract root filesystem from tar archive to destination 21 | directory or qcow2 image. 22 | """ 23 | 24 | import os 25 | import logging 26 | 27 | from virtBootstrap import utils 28 | 29 | 30 | # pylint: disable=invalid-name 31 | # Create logger 32 | logger = logging.getLogger(__name__) 33 | 34 | 35 | class FileSource(object): 36 | """ 37 | Extract root filesystem from file. 38 | """ 39 | def __init__(self, **kwargs): 40 | """ 41 | Bootstrap root filesystem from tarball 42 | 43 | @param uri: Path to tar archive file. 44 | @param fmt: Format used to store image [dir, qcow2] 45 | @param uid_map: Mappings for UID of files in rootfs 46 | @param gid_map: Mappings for GID of files in rootfs 47 | @param root_password: Root password to set in rootfs 48 | @param progress: Instance of the progress module 49 | """ 50 | self.path = kwargs['uri'].path 51 | self.output_format = kwargs.get('fmt', utils.DEFAULT_OUTPUT_FORMAT) 52 | self.root_password = kwargs.get('root_password', None) 53 | self.uid_map = kwargs.get('uid_map', []) 54 | self.gid_map = kwargs.get('gid_map', []) 55 | self.progress = kwargs['progress'].update_progress 56 | 57 | def unpack(self, dest): 58 | """ 59 | Safely extract root filesystem from tarball 60 | 61 | @param dest: Directory path where the files to be extraced 62 | """ 63 | 64 | if not os.path.isfile(self.path): 65 | raise Exception('Invalid file source "%s"' % self.path) 66 | 67 | layer = [[self.path, os.path.getsize(self.path)]] 68 | if self.output_format == 'dir': 69 | self.progress("Extracting files into destination directory", 70 | value=0, logger=logger) 71 | utils.untar_layers(layer, dest, self.progress) 72 | 73 | elif self.output_format == 'qcow2': 74 | self.progress("Extracting files into qcow2 image", value=0, 75 | logger=logger) 76 | 77 | img = utils.BuildImage( 78 | layers=layer, 79 | dest=dest, 80 | progress=self.progress 81 | ) 82 | img.create_base_layer() 83 | img.set_root_password(self.root_password) 84 | if self.uid_map or self.gid_map: 85 | logger.info("Mapping UID/GID") 86 | utils.map_id_in_image( 87 | 1, # Number of layers 88 | dest, self.uid_map, self.gid_map, 89 | (self.root_password is None) # Create new disk? 90 | ) 91 | 92 | else: 93 | raise Exception("Unknown format:" + self.output_format) 94 | 95 | self.progress("Extraction completed successfully!", value=100, 96 | logger=logger) 97 | logger.info("Files are stored in: %s", dest) 98 | -------------------------------------------------------------------------------- /src/virtBootstrap/sources/virt_builder_source.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Authors: Radostin Stoyanov 3 | # 4 | # Copyright (C) 2017 Radostin Stoyanov 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | """ 20 | VirtBuilderSource aim is to extract the root file system from VM image 21 | build with virt-builder from template. 22 | """ 23 | 24 | import os 25 | import logging 26 | import subprocess 27 | import tempfile 28 | 29 | import guestfs 30 | from virtBootstrap import utils 31 | 32 | 33 | # pylint: disable=invalid-name 34 | # Create logger 35 | logger = logging.getLogger(__name__) 36 | 37 | 38 | class VirtBuilderSource(object): 39 | """ 40 | Extract root file system from image build with virt-builder. 41 | """ 42 | def __init__(self, **kwargs): 43 | """ 44 | Create container rootfs by building VM from virt-builder template 45 | and extract the rootfs. 46 | 47 | @param uri: Template name 48 | @param fmt: Format used to store the output [dir, qcow2] 49 | @param uid_map: Mappings for UID of files in rootfs 50 | @param gid_map: Mappings for GID of files in rootfs 51 | @param root_password: Root password to set in rootfs 52 | @param progress: Instance of the progress module 53 | """ 54 | # Parsed URIs: 55 | # - "virt-builder:///