├── LICENSE ├── README.md ├── revert_test_vms.sh └── tailmox.sh /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 | 635 | Copyright (C) 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 | Copyright (C) 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # tailmox 2 | cluster proxmox over tailscale 3 | 4 | --- 5 | 6 | ### 🗣️ SOME THOUGHTS ON MODERATION 🗣️ 7 | 8 | The [Reddit post](https://www.reddit.com/r/Proxmox/comments/1k3ykbu/introducing_tailmox_cluster_proxmox_via_tailscale/) I made on “r/Proxmox” to announce this project seems to have generated some interest in this idea, which I am very thankful for. I have received more activity and stars on this project in less than 24 hours than my now 2nd most starred project has that I began in 2014. 9 | 10 | Unfortunately, the post was locked after I was told by a moderator account to be respectful after replying civilly to another member who used an expletive twice in replying to me (leaving me at no fault, with the same said member poking fun at me in a separate post by another user from the previous day). By locking the post, those with genuine questions and comments are prevented from doing so. While I will state that locking the post is within their moderation powers to perform, it doesn’t make it palatable or correct, especially considering who is at fault, and being that this is within the open source community - and I fervently and firmly disagree with their decision. 11 | 12 | --- 13 | 14 | ### ‼️ DANGER ‼️ 15 | 16 | In the interest of complete transparency, if you follow this guide or use this project, there’s a very minuscule but non-zero chance that you may violate the Bekenstein bound, at which the resulting black hole may swallow the earth whole. You have been warned! 17 | 18 | --- 19 | 20 | ### ⚠️ WARNING ⚠️ 21 | - This project is for development, testing, and research purposes only. This guide comes with no guarantee or warranty that these steps will work within your environment. Should you attempt within a production environment, any negative outcomes are not the fault of this guide or its author. 22 | - It is recommended to use this script within a testing or development environment on freshly installed Proxmox v8 hosts. Testing has not been performed on hosts with further configuration and running this project on said hosts may break them. 23 | 24 | --- 25 | 26 | ### 📖 Overview 📖 27 | 28 | This project was originally started as a [gist](https://gist.github.com/willjasen/df71ca4ec635211d83cdc18fe7f658ca) guide on how to cluster Proxmox servers together using Tailscale so that hosts not physically located together could participate in a cluster. While a how-to is great, being able to replicate the steps in code and sharing that with others was always been the goal. 29 | 30 | Tailmox also uses the project [tailscale-cert-services](https://github.com/willjasen/tailscale-cert-services) in order to generate and maintain each host's Tailscale certificate as it applies to Proxmox. 31 | 32 | --- 33 | 34 | ### 😮 Controversy 😮 35 | 36 | Many, many people will expend a lot of effort and noise to proclaim that this architecture is impossible and will never work. It is often cited that corosync requires a super extra-low amount of latency in order to work properly. While corosync is latency sensitive, there is some freedom within that constraint. My experience with issues clustering in this way has been very minimal, but I am only me, with a handful of Proxmox hosts in a case study of one. 37 | 38 | --- 39 | 40 | ### ✏️ Preparation ✏️ 41 | 42 | Because Tailscale allows for an access control list, if you use an ACL, then it should be prepared for cluster communications. The script will check that TCP 22 and TCP 8006 are available on all other hosts and will exit if not. 43 | 44 | This script uses the tag of "tailmox" to determine which Tailscale machines are using this project to establish a cluster together. The "tailmox" tag should be specified under "tagOwners": 45 | ``` 46 | "tagOwners": { 47 | "tag:tailmox": [ 48 | "autogroup:owner", 49 | ], 50 | } 51 | ``` 52 | 53 | Proxmox clustering requires TCP 22, TCP 8006, and UDP 5405 through 5412. Using the now established tag of "tailmox", we can create access control rules that allow all hosts with this tag to communicate with all other hosts with the tag as well. There is also an included rule at the end to allow all devices within the tailnet to access the web interface of the hosts with the tag. 54 | ``` 55 | "acls": [ 56 | /// ... ACL rules before 57 | 58 | // allow Tailmox 59 | {"action": "accept", "proto": "tcp", "src": ["tag:tailmox"], "dst": ["tag:tailmox:22"]}, // Tailmox SSH 60 | {"action": "accept", "proto": "tcp", "src": ["tag:tailmox"], "dst": ["tag:tailmox:8006"]}, // Tailmox web 61 | {"action": "accept", "proto": "udp", "src": ["tag:tailmox"], "dst": ["tag:tailmox:5405"]}, // Tailmox clustering 62 | {"action": "accept", "proto": "udp", "src": ["tag:tailmox"], "dst": ["tag:tailmox:5406"]}, // Tailmox clustering 63 | {"action": "accept", "proto": "udp", "src": ["tag:tailmox"], "dst": ["tag:tailmox:5407"]}, // Tailmox clustering 64 | {"action": "accept", "proto": "udp", "src": ["tag:tailmox"], "dst": ["tag:tailmox:5408"]}, // Tailmox clustering 65 | {"action": "accept", "proto": "udp", "src": ["tag:tailmox"], "dst": ["tag:tailmox:5409"]}, // Tailmox clustering 66 | {"action": "accept", "proto": "udp", "src": ["tag:tailmox"], "dst": ["tag:tailmox:5410"]}, // Tailmox clustering 67 | {"action": "accept", "proto": "udp", "src": ["tag:tailmox"], "dst": ["tag:tailmox:5411"]}, // Tailmox clustering 68 | {"action": "accept", "proto": "udp", "src": ["tag:tailmox"], "dst": ["tag:tailmox:5412"]}, // Tailmox clustering 69 | 70 | // allow Proxmox web from all other devices 71 | {"action": "accept", "proto": "tcp", "src": ["*"], "dst": ["tag:tailmox:8006"]}, // Tailmox web 72 | 73 | /// ... ACL rules after 74 | ] 75 | ``` 76 | 77 | --- 78 | 79 | ### 🖥️ Usage 🖥️ 80 | 81 | `tailmox.sh` can be run without any parameters, but if the host is not logged into Tailscale, then when the script performs `tailscale up`, Tailscale will provide a link to use to login with. 82 | 83 | In order to make the Tailscale functions easier to handle, `tailmox.sh` accepts the "--auth-key" parameter, followed by a Tailscale auth key, which can be generated via their [Keys](https://login.tailscale.com/admin/settings/keys) page. It is recommended that the key generated is reusable. 84 | 85 | --- 86 | 87 | ### 🧪 Testing 🧪 88 | 89 | This project has been tested to successfully join a cluster of three Proxmox v8 hosts together into a cluster via Tailscale. It has been tested up to the point of achieving this goal and not further. It is possible that further testing with other features related to clustering (like high availability and ZFS replication) may not work, though bugs can be patched appropriately when known. 90 | 91 | `revert_test_vms.sh` is used to revert VMs installed with Proxmox to a state before the `tailmox.sh` script has been first run and erase any clustering processes and data within those VMs, to quickly restore to a state in which the `tailmox.sh` script can be tried again. 92 | 93 | --- 94 | 95 | ### 🤓 The Scripts 🤓 96 | 97 | `tailmox.sh` - this is the main script of the project 98 | - checks that the host is Proxmox v8, installs dependencies and Tailscale, then starts Tailscale 99 | - once Tailscale is running, the host will generate a certificate from Tailscale (to be used with the web interface/API) 100 | - it will then retrieve other Tailscale machines with tag of "tailmox", then check if it can reach them via ping (ICMP) and TCP 8006 (HTTPS for Proxmox); if these checks do not pass, the script will exit as these are required for Proxmox clustering 101 | - after the checks pass, the host will check if it is in a cluster; if it is not, it will check the other Tailscale machines with the tag of "tailmox" to see if they are part of a cluster; when it finds a matching host in a cluster, it will then attempt to join to the cluster using it; if another host isn't found, then a new cluster will be prompted to be created 102 | 103 | `revert_test_vms.sh` - this is a testing script used to revert VMs being tested with 104 | - I currently have three Proxmox VMs with Proxmox installed inside of each 105 | - this script reverts each VM to a snapshot named "ready-for-testing" that was taken after dependencies are installed and the "tailmox" project was cloned into the VM, but right before the script has been run for the first time 106 | - this allows testing `tailmox.sh` easily by reverting the VMs before the clustering processes and data have been created 107 | 108 | --- 109 | --- 110 | 111 | ### 🗺️ The Guide 🗺️ 112 | 113 | The [gist](https://gist.github.com/willjasen/df71ca4ec635211d83cdc18fe7f658ca) guide is now being procured below. The gist at its original location will no longer be updated. 114 | 115 | --- 116 | --- 117 | 118 | ### 📝 Prologue 📝 119 | - This example uses "host1" and "host2" as example names for the hosts 120 | - This example uses "example-test.ts.net" as a Tailscale MagicDNS domain 121 | - The Tailscale IP for host1 is 100.64.1.1 122 | - The Tailscale IP for host2 is 100.64.2.2 123 | 124 | --- 125 | 126 | ### 📋 Steps 📋 127 | 1. Setup two Proxmox hosts 128 | 2. Install Tailscale on the hosts: 129 | ```curl -fsSL https://tailscale.com/install.sh | sh;``` 130 | 3. Update /etc/hosts on all hosts with the proper host entries: 131 | - ```100.64.1.1 host1.example-test.ts.net host1``` 132 | - ```100.64.2.2 host2.example-test.ts.net host2``` 133 | 134 | 4. Since DNS queries will be served via Tailscale, ensure that your global DNS server via Tailscale can resolve host1 as 100.64.1.1 and host2 as 100.64.2.2 135 | 5. If you need to allow for the traffic within your Tailscale ACL, allow TCP 22, TCP 8006, and UDP 5405 - 5412; example as follows: 136 | ```// allow Proxmox clustering 137 | {"action": "accept", "proto": "tcp", "src": ["host1", "host2"], "dst": ["host1:22"]}, // SSH 138 | {"action": "accept", "proto": "tcp", "src": ["host1", "host2"], "dst": ["host2:22"]}, // SSH 139 | {"action": "accept", "proto": "tcp", "src": ["host1", "host2"], "dst": ["host1:8006"]}, // Proxmox web 140 | {"action": "accept", "proto": "tcp", "src": ["host1", "host2"], "dst": ["host2:8006"]}, // Proxmox web 141 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host1:5405"]}, // corosync 142 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host1:5406"]}, // corosync 143 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host1:5407"]}, // corosync 144 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host1:5408"]}, // corosync 145 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host1:5409"]}, // corosync 146 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host1:5410"]}, // corosync 147 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host1:5411"]}, // corosync 148 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host1:5412"]}, // corosync 149 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host2:5405"]}, // corosync 150 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host2:5406"]}, // corosync 151 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host2:5407"]}, // corosync 152 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host2:5408"]}, // corosync 153 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host2:5409"]}, // corosync 154 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host2:5410"]}, // corosync 155 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host2:5411"]}, // corosync 156 | {"action": "accept", "proto": "udp", "src": ["host1", "host2"], "dst": ["host2:5412"]}, // corosync 157 | ``` 158 | 6. Create the cluster using host1 (so that host2 has a cluster to join to) 159 | 160 | 7. In order for clustering to initially succeed, all cluster members must only have a link0 within corosync associated with Tailscale (if any other links exists within corosync, they must be temporarily removed for this initial cluster member addition to succeed); to have host2 join the cluster of host1, then run from host2 (replacing "magic-dns" with your Magic DNS domain slug): 161 | ```pvecm add host1.magic-dns.ts.net --link0 100.64.2.2``` 162 | 8. You should SSH in from host1 to host2 and vice versa; if this isn't done, then tasks like migrations and replications may not work until performed: 163 | - ```ssh host1``` 164 | - ```ssh host2``` 165 | 9. That should do it! Test, test, test! 166 | 167 | To add a third member to the cluster (and so on), repeat these similar steps. 168 | 169 | --- 170 | 171 | ## 🔧 Troubleshooting 🔧 172 | 173 | ### Adding to the Cluster 174 | 175 | Should clustering not be successful, you'll need to do two things: 176 | 177 | 1. Remove the err'd member from host1 by running: 178 | ```pvecm delnode host2``` 179 | 2. Reset clustering on host2 by running: 180 | ```systemctl stop pve-cluster corosync; pmxcfs -l; rm -rf /etc/corosync/*; rm /etc/pve/corosync.conf; killall pmxcfs; systemctl start pve-cluster; pvecm updatecerts;``` 181 | 182 | Then try again. 183 | 184 | ### Maintaining Quorum 185 | 186 | You may find in a large cluster (5 or more members) that features like the web interface won't work properly between cluster members. This is likely because quorum via corosync hasn't been properly achieved. The file at `/etc/pve/.members` may show a node or nodes as `"online": 1` indicating that it is online and communicable to in some form, but the `ip` value never shows. In circumstances where one of the members has an underperforming network connection in relation to the other cluster members (particularly in reference to a high latency measured in 200-300 ms), then corosync should be stopped and disabled on that member temporarily. To do that, run `systemctl stop corosync; systemctl disable corosync;`. To enable and start it again, run `systemctl enable corosync; systemctl start corosync;`. 187 | 188 | --- 189 | *END OF GUIDE* 190 | -------------------------------------------------------------------------------- /revert_test_vms.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # filepath: ./revert-test-vms.sh 3 | 4 | ### 5 | ### This script is used for testing purposes only. 6 | ### When testing, this script can stop, revert to a snapshot, then start the Proxmox VMs being tested with. 7 | ### 8 | 9 | # Define color codes for better output 10 | RED='\033[0;31m' 11 | GREEN='\033[0;32m' 12 | YELLOW='\033[1;33m' 13 | BLUE='\033[0;34m' 14 | PURPLE='\033[0;35m' 15 | RESET='\033[0m' 16 | 17 | # Function to stop a single VM 18 | function stop_single_vm() { 19 | local vm_id=$1 20 | 21 | # Check if VM exists 22 | if qm status "$vm_id" &>/dev/null; then 23 | # Get current VM status 24 | local status=$(qm status "$vm_id" | awk '{print $2}') 25 | 26 | if [ "$status" == "running" ]; then 27 | echo -e "${BLUE}Stopping VM $vm_id...${RESET}" 28 | qm stop "$vm_id" 29 | 30 | # Wait for VM to stop 31 | local timeout=60 32 | local count=0 33 | while [ "$count" -lt "$timeout" ]; do 34 | status=$(qm status "$vm_id" | awk '{print $2}') 35 | if [ "$status" == "stopped" ]; then 36 | echo -e "${GREEN}VM $vm_id successfully stopped.${RESET}" 37 | break 38 | fi 39 | count=$((count + 1)) 40 | sleep 1 41 | done 42 | 43 | if [ "$count" -ge "$timeout" ]; then 44 | echo -e "${RED}Failed to stop VM $vm_id within timeout period.${RESET}" 45 | fi 46 | else 47 | echo -e "${PURPLE}VM $vm_id is already stopped or in state: $status${RESET}" 48 | fi 49 | else 50 | echo -e "${RED}VM with ID $vm_id does not exist.${RESET}" 51 | fi 52 | } 53 | 54 | # Function to stop specified VMs in parallel 55 | function stop_vms() { 56 | local vm_ids=("$@") 57 | 58 | echo -e "${YELLOW}Attempting to stop VMs with IDs: ${vm_ids[*]}${RESET}" 59 | 60 | # Array to keep track of background processes 61 | pids=() 62 | 63 | for vm_id in "${vm_ids[@]}"; do 64 | # Start each VM stop operation in the background 65 | stop_single_vm "$vm_id" & 66 | pids+=($!) 67 | done 68 | 69 | # Wait for all background processes to complete 70 | for pid in "${pids[@]}"; do 71 | wait $pid 72 | done 73 | 74 | echo -e "${GREEN}All VM stop operations completed.${RESET}" 75 | } 76 | 77 | # Function to start a single VM 78 | function start_single_vm() { 79 | local vm_id=$1 80 | 81 | # Check if VM exists 82 | if qm status "$vm_id" &>/dev/null; then 83 | # Get current VM status 84 | local status=$(qm status "$vm_id" | awk '{print $2}') 85 | 86 | if [ "$status" != "running" ]; then 87 | echo -e "${BLUE}Starting VM $vm_id...${RESET}" 88 | qm start "$vm_id" 89 | 90 | # Wait for VM to start 91 | local timeout=60 92 | local count=0 93 | while [ "$count" -lt "$timeout" ]; do 94 | status=$(qm status "$vm_id" | awk '{print $2}') 95 | if [ "$status" == "running" ]; then 96 | echo -e "${GREEN}VM $vm_id successfully started.${RESET}" 97 | break 98 | fi 99 | count=$((count + 1)) 100 | sleep 1 101 | done 102 | 103 | if [ "$count" -ge "$timeout" ]; then 104 | echo -e "${RED}Failed to start VM $vm_id within timeout period.${RESET}" 105 | fi 106 | else 107 | echo -e "${PURPLE}VM $vm_id is already running.${RESET}" 108 | fi 109 | else 110 | echo -e "${RED}VM with ID $vm_id does not exist.${RESET}" 111 | fi 112 | } 113 | 114 | # Function to start specified VMs in parallel 115 | function start_vms() { 116 | local vm_ids=("$@") 117 | 118 | echo -e "${YELLOW}Attempting to start VMs with IDs: ${vm_ids[*]}${RESET}" 119 | 120 | # Array to keep track of background processes 121 | pids=() 122 | 123 | for vm_id in "${vm_ids[@]}"; do 124 | # Start each VM start operation in the background 125 | start_single_vm "$vm_id" & 126 | pids+=($!) 127 | done 128 | 129 | # Wait for all background processes to complete 130 | for pid in "${pids[@]}"; do 131 | wait $pid 132 | done 133 | 134 | echo -e "${GREEN}All VM start operations completed.${RESET}" 135 | } 136 | 137 | # Function to revert a single VM to a snapshot 138 | function revert_single_vm() { 139 | local vm_id=$1 140 | local snapname=$2 141 | 142 | # Check if VM exists 143 | if qm status "$vm_id" &>/dev/null; then 144 | # Check if the snapshot exists 145 | # if qm snapshot "$vm_id" list | grep -q "$snapname"; then 146 | echo -e "${BLUE}Reverting VM $vm_id to snapshot '$snapname'...${RESET}" 147 | 148 | # Roll back to the snapshot 149 | qm rollback $vm_id $snapname 150 | 151 | if [ $? -eq 0 ]; then 152 | echo -e "${GREEN}Successfully reverted VM $vm_id to snapshot '$snapname'.${RESET}" 153 | else 154 | echo -e "${RED}Failed to revert VM $vm_id to snapshot '$snapname'.${RESET}" 155 | fi 156 | # else 157 | # echo -e "${RED}Snapshot '$snapname' not found for VM $vm_id.${RESET}" 158 | #fi 159 | else 160 | echo -e "${RED}VM with ID $vm_id does not exist.${RESET}" 161 | fi 162 | } 163 | 164 | # Function to revert VMs to specified snapshots in parallel 165 | function revert_vms_to_snapshot() { 166 | local snapname="ready-for-testing" 167 | local vm_ids=("$@") 168 | 169 | echo -e "${YELLOW}Attempting to revert VMs ${vm_ids[*]} to snapshot '$snapname' in parallel${RESET}" 170 | 171 | # Array to keep track of background processes 172 | pids=() 173 | 174 | for vm_id in "${vm_ids[@]}"; do 175 | # Start each VM revert operation in the background 176 | revert_single_vm "$vm_id" "$snapname" & 177 | pids+=($!) 178 | done 179 | 180 | # Wait for all background processes to complete 181 | for pid in "${pids[@]}"; do 182 | wait $pid 183 | done 184 | 185 | echo -e "${GREEN}All VM revert operations completed.${RESET}" 186 | } 187 | 188 | # Function to test if a VM's guest agent is working 189 | function test_guest_agent() { 190 | local vm_id=$1 191 | local max_attempts=$2 192 | local wait_seconds=$3 193 | 194 | # Default values if not provided 195 | max_attempts=${max_attempts:-30} 196 | wait_seconds=${wait_seconds:-10} 197 | 198 | echo -e "${YELLOW}Testing guest agent for VM $vm_id (max $max_attempts attempts, ${wait_seconds}s interval)...${RESET}" 199 | 200 | # Check if VM exists and is running 201 | if qm status "$vm_id" &>/dev/null; then 202 | local status=$(qm status "$vm_id" | awk '{print $2}') 203 | if [ "$status" != "running" ]; then 204 | echo -e "${RED}VM $vm_id is not running (status: $status). Cannot test guest agent.${RESET}" 205 | return 1 206 | fi 207 | 208 | # Try to ping the guest agent 209 | local attempt=1 210 | while [ "$attempt" -le "$max_attempts" ]; do 211 | echo -e "${BLUE}Attempt $attempt/$max_attempts: Checking guest agent on ${vm_id}...${RESET}" 212 | 213 | # Use qm agent command to check if agent is responsive 214 | if qm agent "$vm_id" ping &>/dev/null; then 215 | echo -e "${GREEN}Guest agent on VM $vm_id is responsive!${RESET}" 216 | return 0 217 | else 218 | echo -e "${PURPLE}Guest agent on ${vm_id} not responsive yet. Waiting ${wait_seconds}s...${RESET}" 219 | sleep "$wait_seconds" 220 | fi 221 | 222 | attempt=$((attempt + 1)) 223 | done 224 | 225 | echo -e "${RED}Guest agent on VM $vm_id failed to respond after $max_attempts attempts.${RESET}" 226 | return 1 227 | else 228 | echo -e "${RED}VM with ID $vm_id does not exist.${RESET}" 229 | return 1 230 | fi 231 | } 232 | 233 | # Function to test guest agents for multiple VMs in parallel 234 | function test_guest_agents() { 235 | local vm_ids=("$@") 236 | local max_attempts=${max_attempts:-30} 237 | local wait_seconds=${wait_seconds:-1} 238 | 239 | echo -e "${YELLOW}Testing guest agents for VMs with IDs: ${vm_ids[*]}${RESET}" 240 | 241 | # Array to keep track of background processes 242 | pids=() 243 | results=() 244 | 245 | for vm_id in "${vm_ids[@]}"; do 246 | # Start each guest agent test in the background 247 | test_guest_agent "$vm_id" "$max_attempts" "$wait_seconds" & 248 | pids+=($!) 249 | done 250 | 251 | # Wait for all background processes to complete 252 | for pid in "${pids[@]}"; do 253 | wait $pid 254 | results+=($?) 255 | done 256 | 257 | # Check if all tests were successful 258 | all_success=true 259 | for i in "${!vm_ids[@]}"; do 260 | if [ ${results[$i]} -ne 0 ]; then 261 | all_success=false 262 | echo -e "${RED}Guest agent test failed for VM ${vm_ids[$i]}${RESET}" 263 | fi 264 | done 265 | 266 | if $all_success; then 267 | echo -e "${GREEN}All guest agent tests completed successfully.${RESET}" 268 | return 0 269 | else 270 | echo -e "${RED}Some guest agent tests failed.${RESET}" 271 | return 1 272 | fi 273 | } 274 | 275 | # Run the functions 276 | stop_vms 10000 10001 10002 277 | revert_vms_to_snapshot 10000 10001 10002 278 | start_vms 10000 10001 10002 279 | test_guest_agents 10000 10001 10002 280 | 281 | echo -e "${GREEN}The script has completed successfully!${RESET}" -------------------------------------------------------------------------------- /tailmox.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # filepath: ./tailmox.sh 3 | 4 | # Define color variables 5 | YELLOW="\e[33m" 6 | RED="\e[31m" 7 | GREEN="\e[32m" 8 | BLUE="\e[34m" 9 | PURPLE="\e[35m" 10 | RESET="\e[0m" 11 | 12 | ### 13 | ### ---FUNCTIONS--- 14 | ### 15 | 16 | # Check if Proxmox is installed 17 | function check_proxmox_8_installed() { 18 | echo -e "${YELLOW}Checking if Proxmox is installed...${RESET}" 19 | 20 | # Check for common Proxmox binaries and version file 21 | if [[ ! -f /usr/bin/pveversion ]]; then 22 | echo -e "${RED}Proxmox VE does not appear to be installed on this system.${RESET}" 23 | return 1 24 | fi 25 | 26 | # Check if it's version 8.x 27 | local pve_version=$(pveversion | grep -oP 'pve-manager/\K[0-9]+' | head -1) 28 | 29 | if [[ "$pve_version" == "8" ]]; then 30 | echo -e "${GREEN}Proxmox VE 8.x detected.${RESET}" 31 | return 0 32 | else 33 | echo -e "${RED}Proxmox VE 8.x is required. Found version: $pve_version${RESET}" 34 | return 1 35 | fi 36 | } 37 | 38 | # Install dependencies 39 | function install_dependencies() { 40 | echo -e "${YELLOW}Checking for required dependencies...${RESET}" 41 | if ! command -v jq &>/dev/null; then 42 | echo -e "${YELLOW}jq not found. Installing...${RESET}" 43 | apt update -qq; 44 | DEBIAN_FRONTEND=noninteractive apt install jq -y 45 | else 46 | # echo -e "${GREEN}jq is already installed.${RESET}" 47 | : 48 | fi 49 | 50 | if ! command -v expect &>/dev/null; then 51 | echo -e "${YELLOW}expect not found. Installing...${RESET}" 52 | apt update -qq; 53 | DEBIAN_FRONTEND=noninteractive apt install expect -y 54 | else 55 | # echo -e "${GREEN}expect is already installed.${RESET}" 56 | : 57 | fi 58 | # echo -e "${GREEN}All dependencies are installed.${RESET}" 59 | } 60 | 61 | # Install Tailscale if it is not already installed 62 | function install_tailscale() { 63 | if ! command -v tailscale &>/dev/null; then 64 | echo -e "${YELLOW}Tailscale not found. Installing...${RESET}" 65 | apt install curl -y 66 | curl -fsSL https://pkgs.tailscale.com/stable/debian/bookworm.noarmor.gpg | tee /usr/share/keyrings/tailscale-archive-keyring.gpg >/dev/null 67 | curl -fsSL https://pkgs.tailscale.com/stable/debian/bookworm.tailscale-keyring.list | tee /etc/apt/sources.list.d/tailscale.list 68 | apt update 69 | apt install tailscale -y 70 | else 71 | # echo -e "${GREEN}Tailscale is already installed.${RESET}" 72 | : 73 | fi 74 | } 75 | 76 | # Bring up Tailscale 77 | function start_tailscale() { 78 | local auth_key="$1" 79 | echo -e "${GREEN}Starting Tailscale with --advertise-tags 'tag:tailmox'...${RESET}" 80 | 81 | if [ -n "$auth_key" ]; then 82 | # Use the provided auth key 83 | tailscale up --auth-key="$auth_key" --advertise-tags "tag:tailmox" 84 | else 85 | # Fall back to interactive authentication 86 | tailscale up --advertise-tags "tag:tailmox" 87 | fi 88 | 89 | if [ $? -ne 0 ]; then 90 | echo -e "${RED}Failed to start Tailscale.${RESET}" 91 | exit 1 92 | fi 93 | 94 | # Retrieve the assigned Tailscale IPv4 address 95 | local TAILSCALE_IP="" 96 | while [ -z "$TAILSCALE_IP" ]; do 97 | echo -e "${YELLOW}Waiting for Tailscale to come online...${RESET}" 98 | sleep 1 99 | TAILSCALE_IP=$(tailscale ip -4) 100 | done 101 | 102 | TAILSCALE_DNS_NAME=$(tailscale status --json | jq -r '.Self.DNSName' | sed 's/\.$//') 103 | echo -e "${GREEN}This host's Tailscale IPv4 address: $TAILSCALE_IP ${RESET}" 104 | echo -e "${GREEN}This host's Tailscale MagicDNS name: $TAILSCALE_DNS_NAME ${RESET}" 105 | } 106 | 107 | # Run Tailscale certificate services 108 | function run_tailscale_cert_services() { 109 | if [ ! -d "/opt/tailscale-cert-services" ]; then 110 | echo -e "${YELLOW}Tailscale certificate services not found. Cloning repository...${RESET}" 111 | git clone --quiet https://github.com/willjasen/tailscale-cert-services /opt/tailscale-cert-services; 112 | else 113 | echo -e "${GREEN}Tailscale certificate services already cloned.${RESET}" 114 | fi 115 | cd /opt/tailscale-cert-services; 116 | VERSION="v1.1.0"; 117 | git -c advice.detachedHead=false checkout tags/${VERSION} --quiet 118 | ./proxmox-cert.sh; 119 | cd /opt/tailmox; 120 | } 121 | 122 | # Check if all peers with the "tailmox" tag are online 123 | function check_all_peers_online() { 124 | echo -e "${YELLOW}Checking if all tailmox peers are online...${RESET}" 125 | local all_peers_online=true 126 | local offline_peers="" 127 | 128 | # Get the peers data 129 | local peers_data=$(tailscale status --json | jq -r '.Peer[] | select(.Tags != null and (.Tags[] | contains("tailmox")))') 130 | 131 | # If no peers are found, return 1 132 | if [ -z "$peers_data" ]; then 133 | echo -e "${YELLOW}No tailmox peers were found.${RESET}" 134 | return 1 135 | fi 136 | 137 | # Check each peer's status 138 | echo "$peers_data" | jq -c '.HostName + ":" + (.Online|tostring)' | while read -r peer_status; do 139 | local hostname=$(echo "$peer_status" | cut -d: -f1) 140 | local is_online=$(echo "$peer_status" | cut -d: -f2) 141 | 142 | if [ "$is_online" != "true" ]; then 143 | all_peers_online=false 144 | offline_peers="${offline_peers}${hostname}, " 145 | fi 146 | done 147 | 148 | if [ "$all_peers_online" = true ]; then 149 | echo -e "${GREEN}All tailmox peers are online.${RESET}" 150 | return 0 151 | else 152 | offline_peers=${offline_peers%, } 153 | echo -e "${RED}Not all tailmox peers are online. Offline peers: $offline_peers" 154 | return 1 155 | fi 156 | } 157 | 158 | # Ensure that each Proxmox host in the cluster has the Tailscale MagicDNS hostnames of all other hosts in the cluster 159 | function require_hostnames_in_cluster() { 160 | # Update /etc/hosts for local resolution of Tailscale hostnames for the clustered Proxmox nodes 161 | echo "This host's hostname: $HOSTNAME" 162 | MAGICDNS_DOMAIN_NAME=$(tailscale status --json | jq -r '.Self.DNSName' | cut -d'.' -f2- | sed 's/\.$//'); 163 | echo "MagicDNS domain name for this tailnet: $MAGICDNS_DOMAIN_NAME" 164 | 165 | ### Need to add the "tailmox" tag to the Tailscale ACL some way 166 | # "tag:tailmox" [ 167 | # "autogroup:owner", 168 | # ] 169 | 170 | # Exit the script if all peers are not online 171 | if ! check_all_peers_online; then 172 | echo -e "${RED}No peers exist or not all tailmox peers are online. Exiting...${RESET}" 173 | exit 1 174 | fi 175 | 176 | # Ensure each peer's /etc/hosts file contains all other peers' entries 177 | # For each peer, remote into it and add each other peer's entry to its /etc/hosts 178 | echo -e "${GREEN}Ensuring all peers have other peers' information...${RESET}" 179 | echo "$ALL_PEERS" | jq -c '.[]' | while read -r target_peer; do 180 | TARGET_HOSTNAME=$(echo "$target_peer" | jq -r '.hostname') 181 | TARGET_IP=$(echo "$target_peer" | jq -r '.ip') 182 | TARGET_DNSNAME=$(echo "$target_peer" | jq -r '.dnsName' | sed 's/\.$//') 183 | 184 | echo -e "${BLUE}Updating /etc/hosts on $TARGET_HOSTNAME ($TARGET_IP)...${RESET}" 185 | 186 | # Loop through all peers and update the target peer's /etc/hosts as needed 187 | for peer_to_add in $(echo "$ALL_PEERS" | jq -c '.[]'); do 188 | PEER_HOSTNAME=$(echo "$peer_to_add" | jq -r '.hostname') 189 | PEER_IP=$(echo "$peer_to_add" | jq -r '.ip') 190 | PEER_DNSNAME=$(echo "$peer_to_add" | jq -r '.dnsName' | sed 's/\.$//') 191 | PEER_ENTRY="$PEER_IP $PEER_HOSTNAME $PEER_DNSNAME" 192 | 193 | echo "Adding $PEER_HOSTNAME to $TARGET_HOSTNAME's /etc/hosts" 194 | ssh-keyscan -H "$TARGET_HOSTNAME" >> ~/.ssh/known_hosts 2>/dev/null 195 | ssh "$TARGET_HOSTNAME" "grep -q '$PEER_ENTRY' /etc/hosts || echo '$PEER_ENTRY' >> /etc/hosts" 196 | done 197 | 198 | echo -e "${GREEN}Finished updating hosts file on $TARGET_HOSTNAME${RESET}" 199 | done 200 | } 201 | 202 | # Ensure the local node can ping all nodes via Tailscale 203 | function ensure_ping_reachability() { 204 | echo -e "${YELLOW}Ensuring the local node can ping all other nodes...${RESET}" 205 | 206 | # Get all peers with the "tailmox" tag 207 | local peers=$(tailscale status --json | jq -r '[.Peer[] | select(.Tags != null and (.Tags[] | contains("tailmox"))) | .TailscaleIPs[0]]') 208 | 209 | # If no peers are found, exit with an error 210 | if [ -z "$peers" ]; then 211 | echo -e "${RED}No peers found with the 'tailmox' tag. Exiting...${RESET}" 212 | return 1 213 | fi 214 | 215 | # Check ping reachability for each peer 216 | echo "$peers" | jq -r '.[]' | while read -r peer_ip; do 217 | echo -e "${BLUE}Pinging $peer_ip...${RESET}" 218 | if ! ping -c 1 -W 2 "$peer_ip" &>/dev/null; then 219 | echo -e "${RED}Failed to ping $peer_ip.${RESET}" 220 | return 1 221 | else 222 | echo -e "${GREEN}Successfully pinged $peer_ip.${RESET}" 223 | fi 224 | done 225 | } 226 | 227 | # Report on the latency of each peer 228 | function report_peer_latency() { 229 | echo -e "${YELLOW}Reporting peer latency...${RESET}" 230 | 231 | # Get all peers with the "tailmox" tag 232 | local peers=$(tailscale status --json | jq -r '[.Peer[] | select(.Tags != null and (.Tags[] | contains("tailmox"))) | .TailscaleIPs[0]]') 233 | 234 | # If no peers are found, exit with an error 235 | if [ -z "$peers" ]; then 236 | echo -e "${RED}No peers found with the 'tailmox' tag. Exiting...${RESET}" 237 | return 1 238 | fi 239 | 240 | # Calculate average latency for each peer 241 | echo "$peers" | jq -r '.[]' | while read -r peer_ip; do 242 | local ping_count=25 243 | local ping_interval=0.1 244 | echo -e "${BLUE}Calculating average latency for $peer_ip ($ping_count pings with an interval of $ping_interval seconds)...${RESET}" 245 | avg_latency=$(ping -c $ping_count -i $ping_interval "$peer_ip" | awk -F'/' 'END {print $5}') 246 | if [ -n "$avg_latency" ]; then 247 | echo -e "${GREEN}Average latency to $peer_ip: ${avg_latency} ms${RESET}" 248 | else 249 | echo -e "${RED}Failed to calculate latency for $peer_ip.${RESET}" 250 | fi 251 | done 252 | } 253 | 254 | # Check if TCP port 8006 is available on all nodes 255 | function are_hosts_tcp_port_8006_reachable() { 256 | echo -e "${YELLOW}Checking if TCP port 8006 is available on all nodes...${RESET}" 257 | 258 | # Iterate through all peers 259 | echo "$ALL_PEERS" | jq -c '.[]' | while read -r peer; do 260 | local peer_ip=$(echo "$peer" | jq -r '.ip') 261 | local peer_hostname=$(echo "$peer" | jq -r '.hostname') 262 | 263 | echo -e "${BLUE}Checking TCP port 8006 on $peer_hostname ($peer_ip)...${RESET}" 264 | if ! nc -z -w 2 "$peer_ip" 8006 &>/dev/null; then 265 | echo -e "${RED}TCP port 8006 is not available on $peer_hostname ($peer_ip).${RESET}" 266 | return 1 267 | else 268 | echo -e "${GREEN}TCP port 8006 is available on $peer_hostname ($peer_ip).${RESET}" 269 | fi 270 | done 271 | } 272 | 273 | # Check if UDP port 5405 is open on all nodes (corosync) 274 | function check_udp_ports_5405_to_5412() { 275 | echo -e "${YELLOW}Checking if UDP ports 5405 through 5412 (Corosync) are available on all nodes...${RESET}" 276 | 277 | # Iterate through all peers 278 | local peer_unavailable=false 279 | echo "$ALL_PEERS" | jq -c '.[]' | while read -r peer; do 280 | local peer_ip=$(echo "$peer" | jq -r '.ip') 281 | local peer_hostname=$(echo "$peer" | jq -r '.hostname') 282 | 283 | for port in {5405..5412}; do 284 | echo -e "${BLUE}Checking UDP port $port on $peer_hostname ($peer_ip)...${RESET}" 285 | 286 | # For UDP, we'll use nc with -u flag and a short timeout 287 | # nc -v -u -z -w 3 prox2.risk-mermaid.ts.net 5405 288 | if ! timeout 2 bash -c "echo -n > /dev/udp/$peer_hostname/$port" 2>/dev/null; then 289 | echo -e "${RED}UDP port $port is not available on $peer_hostname ($peer_ip).${RESET}" 290 | peer_unavailable=true 291 | else 292 | echo -e "${GREEN}UDP port $port is available on $peer_hostname ($peer_ip).${RESET}" 293 | fi 294 | done 295 | done 296 | 297 | if $peer_unavailable; then 298 | echo -e "${RED}Some peers have UDP ports 5405 through 5412 unavailable. These ports are required for Corosync cluster communication.${RESET}" 299 | exit 1 300 | else 301 | echo -e "${GREEN}All peers have UDP ports 5405 through 5412 available.${RESET}" 302 | fi 303 | } 304 | 305 | # Check if this node is already part of a Proxmox cluster 306 | # Returns true/false ? 307 | function check_local_node_cluster_status() { 308 | echo -e "${YELLOW}Checking if this node is already part of a Proxmox cluster...${RESET}" 309 | 310 | # Check if the pvecm command exists (should be installed with Proxmox) 311 | if ! command -v pvecm &>/dev/null; then 312 | echo -e "${RED}pvecm command not found. Is this a Proxmox VE node?${RESET}" 313 | return 1 314 | fi 315 | 316 | # Get cluster status 317 | local cluster_status=$(pvecm status 2>&1) 318 | 319 | # Check if the node is part of a cluster 320 | if echo "$cluster_status" | grep -q "is this node part of a cluster"; then 321 | echo -e "${BLUE}This node is not part of any cluster.${RESET}" 322 | return 1 323 | elif echo "$cluster_status" | grep -q "Cluster information"; then 324 | local cluster_name=$(pvecm status | grep "Name:" | awk '{print $2}') 325 | echo -e "${GREEN}This node is already part of cluster named: $cluster_name${RESET}" 326 | return 0 327 | else 328 | echo -e "${RED}Unable to determine cluster status. Output: $cluster_status${RESET}" 329 | return 1 330 | fi 331 | } 332 | 333 | # Check if a remote node is already part of a Proxmox cluster 334 | # Returns true/false ? 335 | function check_remote_node_cluster_status() { 336 | local node_ip=$1 337 | echo -e "${YELLOW}Checking if remote node $node_ip is part of a Proxmox cluster...${RESET}" 338 | 339 | # Check if the pvecm command exists (should be installed with Proxmox) 340 | if ! command -v pvecm &>/dev/null; then 341 | echo -e "${RED}pvecm command not found. Is this a Proxmox VE node?${RESET}" 342 | exit 1 343 | fi 344 | 345 | # Get cluster status 346 | ssh-keyscan -H "$TARGET_HOSTNAME" >> ~/.ssh/known_hosts 2>/dev/null 347 | local cluster_status=$(ssh "$node_ip" "pvecm status" 2>&1) 348 | 349 | # Check if the node is part of a cluster 350 | if echo "$cluster_status" | grep -q "is this node part of a cluster"; then 351 | echo -e "${BLUE}Remote node $node_ip is not part of any cluster.${RESET}" 352 | return 1 353 | elif echo "$cluster_status" | grep -q "Cluster information"; then 354 | local cluster_name=$(ssh "$TARGET_HOSTNAME" "pvecm status" | grep "Name:" | awk '{print $2}') 355 | echo -e "${GREEN}Remote node $node_ip is already part of cluster named: $cluster_name${RESET}" 356 | return 0 357 | else 358 | echo -e "${RED}Unable to determine cluster status for remote node $node_ip. Output: $cluster_status${RESET}" 359 | exit 1 360 | fi 361 | 362 | } 363 | 364 | # Get the certificate fingerprint for a Proxmox node 365 | # - parameter $1: hostname or IP address 366 | function get_pve_certificate_fingerprint() { 367 | local hostname=$1 368 | local port=8006 369 | 370 | # echo -e "${YELLOW}Getting certificate fingerprint for $hostname:$port...${RESET}" 371 | 372 | # Use OpenSSL to connect to the server and get the certificate info 373 | local fingerprint=$(echo | openssl s_client -connect $hostname:$port 2>/dev/null | 374 | openssl x509 -fingerprint -sha256 -noout | 375 | cut -d'=' -f2) 376 | 377 | if [ -n "$fingerprint" ]; then 378 | # echo -e "${GREEN}Certificate fingerprint for $hostname:$port: $fingerprint${RESET}" 379 | echo "$fingerprint" 380 | else 381 | echo -e "${RED}Failed to get certificate fingerprint for $hostname:$port${RESET}" 382 | return 1 383 | fi 384 | } 385 | 386 | # Create a new Proxmox cluster named "tailmox" 387 | function create_cluster() { 388 | local TAILSCALE_IP=$(tailscale ip -4) 389 | echo -e "${YELLOW}Creating a new Proxmox cluster named 'tailmox'...${RESET}" 390 | pvecm create tailmox --link0 address=$TAILSCALE_IP 391 | } 392 | 393 | # Add this local node into a cluster if it exists 394 | function add_local_node_to_cluster() { 395 | if check_local_node_cluster_status; then 396 | echo -e "${PURPLE}This node is already in a cluster.${RESET}" 397 | else 398 | echo -e "${BLUE}This node is not in a cluster. Creating or joining a cluster is required.${RESET}" 399 | 400 | # Find if a cluster amongst peers already exists 401 | echo "$OTHER_PEERS" | jq -c '.[]' | while read -r target_peer; do 402 | TARGET_HOSTNAME=$(echo "$target_peer" | jq -r '.hostname') 403 | TARGET_IP=$(echo "$target_peer" | jq -r '.ip') 404 | TARGET_DNSNAME=$(echo "$target_peer" | jq -r '.dnsName' | sed 's/\.$//') 405 | 406 | echo -e "${BLUE}Checking cluster status on $TARGET_HOSTNAME ($TARGET_IP)...${RESET}" 407 | if check_remote_node_cluster_status "$TARGET_HOSTNAME"; then 408 | local LOCAL_TAILSCALE_IP=$(tailscale ip -4) 409 | local target_fingerprint=$(get_pve_certificate_fingerprint "$TARGET_HOSTNAME") 410 | 411 | echo -e "${GREEN}Found an existing cluster on $TARGET_HOSTNAME. Joining the cluster...${RESET}" 412 | 413 | # Prompt for root password of the remote node 414 | # echo -e "${YELLOW}Please enter the root password for ${TARGET_HOSTNAME}:${RESET}" 415 | read -s -p "Please enter the root password for ${TARGET_HOSTNAME}: " ROOT_PASSWORD < /dev/tty 416 | echo 417 | 418 | # Use expect to handle the password prompt with proper authentication 419 | expect -c " 420 | set timeout 60 421 | spawn pvecm add \"$TARGET_HOSTNAME\" --link0 address=$LOCAL_TAILSCALE_IP --fingerprint $target_fingerprint 422 | expect { 423 | \"*?assword:*\" { 424 | send \"$ROOT_PASSWORD\r\" 425 | exp_continue 426 | } 427 | \"*?assword for*\" { 428 | send \"$ROOT_PASSWORD\r\" 429 | exp_continue 430 | } 431 | \"*authentication failure*\" { 432 | puts \"Authentication failed. Please check your password.\" 433 | exit 1 434 | } 435 | timeout { 436 | puts \"Command timed out.\" 437 | exit 1 438 | } 439 | eof 440 | } 441 | catch wait result 442 | exit [lindex \$result 3] 443 | " 444 | 445 | # Check if successful 446 | if [ $? -eq 0 ]; then 447 | echo -e "${GREEN}Successfully joined cluster with $TARGET_HOSTNAME.${RESET}" 448 | exit 0 449 | else 450 | echo -e "${RED}Failed to join cluster with $TARGET_HOSTNAME. Check the password and try again.${RESET}" 451 | exit 1 452 | fi 453 | else 454 | echo -e "${YELLOW}No cluster found on $TARGET_HOSTNAME.${RESET}" 455 | fi 456 | done 457 | 458 | fi 459 | } 460 | 461 | #### 462 | #### ---MAIN SCRIPT--- 463 | #### 464 | 465 | if ! check_proxmox_8_installed; then 466 | echo -e "${RED}Proxmox VE 8.x is required. Exiting...${RESET}" 467 | exit 1 468 | fi 469 | 470 | install_dependencies 471 | install_tailscale 472 | 473 | # Start Tailscale; use auth key if supplied 474 | AUTH_KEY="" 475 | while [[ "$#" -gt 0 ]]; do 476 | case $1 in 477 | --auth-key) AUTH_KEY="$2"; echo "Using auth key for Tailscale..."; shift; ;; 478 | *) echo "Unknown parameter: $1"; exit 1 ;; 479 | esac 480 | shift 481 | done 482 | start_tailscale $AUTH_KEY 483 | 484 | ### Now that Tailscale is running... 485 | 486 | run_tailscale_cert_services 487 | 488 | # Get all nodes with the "tailmox" tag as a JSON array 489 | TAILSCALE_IP=$(tailscale ip -4) 490 | MAGICDNS_DOMAIN_NAME=$(tailscale status --json | jq -r '.Self.DNSName' | cut -d'.' -f2- | sed 's/\.$//'); 491 | LOCAL_PEER=$(jq -n --arg hostname "$HOSTNAME" --arg ip "$TAILSCALE_IP" --arg dnsName "$HOSTNAME.$MAGICDNS_DOMAIN_NAME" --arg online "true" '{hostname: $hostname, ip: $ip, dnsName: $dnsName, online: ($online == "true")}'); 492 | OTHER_PEERS=$(tailscale status --json | jq -r '[.Peer[] | select(.Tags != null and (.Tags[] | contains("tailmox"))) | {hostname: .HostName, ip: .TailscaleIPs[0], dnsName: .DNSName, online: .Online}]'); 493 | ALL_PEERS=$(echo "$OTHER_PEERS" | jq --argjson localPeer "$LOCAL_PEER" '. + [$localPeer]'); 494 | 495 | # Check that all Tailmox peers are online 496 | if ! check_all_peers_online; then 497 | echo -e "${RED}Not all tailmox peers are online. Exiting...${RESET}" 498 | exit 1 499 | fi 500 | 501 | # Ensure that all peers have the Tailscale MagicDNS hostnames of all other hosts in the cluster 502 | # Doesn't seem to be required at the moment... 503 | # require_hostnames_in_cluster 504 | 505 | # Ensure that all peers are pingable 506 | if ! ensure_ping_reachability; then 507 | echo -e "${RED}Some peers are unreachable via ping. Please check the network configuration.${RESET}" 508 | exit 1 509 | else 510 | echo -e "${GREEN}All Tailmox peers are reachable via ping.${RESET}" 511 | fi 512 | 513 | # Report on the latency of each peer 514 | report_peer_latency 515 | 516 | # Ensure that all peers are reachable via TCP port 8006 517 | if ! are_hosts_tcp_port_8006_reachable; then 518 | echo -e "${RED}Some peers have TCP port 8006 unavailable. Please check the network configuration.${RESET}" 519 | exit 1 520 | else 521 | echo -e "${GREEN}All Tailmox peers have TCP port 8006 available.${RESET}" 522 | fi 523 | 524 | # Check if the local node is already in a cluster 525 | if ! check_local_node_cluster_status; then 526 | echo -e "${YELLOW}This node is not part of a cluster. Attempting to create or join a cluster...${RESET}" 527 | else 528 | echo -e "${GREEN}This node is already part of a cluster, nothing further to do.${RESET}" 529 | exit 1 530 | fi 531 | 532 | # Add this local node to a cluster if it exists 533 | add_local_node_to_cluster 534 | 535 | # If local node is now in the cluster... 536 | if ! check_local_node_cluster_status; then 537 | echo -e "${BLUE}No existing cluster found amongst any peers.${RESET}" 538 | echo -e "${YELLOW}Do you want to create a cluster on this node?${RESET}" 539 | read -p "Enter 'y' to create a new cluster or 'n' to exit: " choice 540 | if [[ "$choice" == "y" || "$choice" == "Y" ]]; then 541 | create_cluster 542 | echo -e "${GREEN}Cluster created successfully.${RESET}" 543 | else 544 | echo -e "${RED}Exiting without creating a cluster.${RESET}" 545 | exit 1 546 | fi 547 | fi 548 | 549 | echo -e "${GREEN}The script has exited successfully!${RESET}" 550 | 551 | ### This version is working when tested with 3 nodes! --------------------------------------------------------------------------------