├── LICENSE ├── README.md ├── ansible.cfg ├── config.yml ├── files └── rclone.sh ├── host_vars ├── nas01.mmoffice.net.yml └── nas02.mmoffice.net.yml ├── hosts.yml ├── main.yml ├── resources ├── hl15-hardware.jpeg └── raspberrypi-5-hardware.jpeg ├── tasks ├── rclone.yml ├── replication.yml ├── samba.yml └── users.yml └── templates └── smb-share.conf.j2 /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 | {{ project }} Copyright (C) {{ year }} {{ organization }} 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 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Arm NAS 2 | 3 | Ansible playbook to configure my Arm NASes: 4 | 5 | - [HL15 with Ampere Altra](#primary-nas) 6 | - [Raspberry Pi 5 SATA NAS](#secondary-nas) 7 | 8 | ## Hardware 9 | 10 | ### Primary NAS - 45Drives HL15 11 | 12 |

45Homelab HL15 with Jeff Geerling hardware

13 | 14 | The current iteration of the HL15 I'm running contains the following hardware: 15 | 16 | - (Motherboard) [ASRock Rack ALTRAD8UD-1L2T](https://reurl.cc/qrnXNp) ([specs](https://reurl.cc/67jk0V)) 17 | - (Case) [45Homelab HL15 + backplane + PSU](https://store.45homelab.com/configure/hl15) 18 | - (PSU) [Corsair RM750e](https://amzn.to/3OyDQ79) 19 | - (RAM) [8x Samsung 16GB 1Rx4 ECC RDIMM M393A2K40DB3-CWE PC25600](https://amzn.to/49lCtkb) 20 | - (NVMe) [Kioxia XG8 2TB NVMe SSD](https://amzn.to/3Uzag5d) 21 | - (CPU) [Ampere Altra Q32-17](https://amperecomputing.com/briefs/ampere-altra-family-product-brief) 22 | - (SSDs) [4x Samsung 8TB 870 QVO 2.5" SATA](https://amzn.to/3OylbZk) 23 | - (HDDs) [6x Seagate EXOS 20TB SATA HDD](https://amzn.to/3OA2CDM) 24 | - (HBA) [Broadcom MegaRAID 9405W-16i](https://amzn.to/3srcZOh) 25 | - (Cooler) [Noctua NH-D9 AMP-4926 4U](https://noctua.at/en/nh-d9-amp-4926-4u) 26 | - (Case Fans) [6x Noctua NF-A12x25 PWM](https://amzn.to/3SUReE7) 27 | - (Fan Hub) [Noctua NA-FH1 8 channel Fan Hub](https://amzn.to/3SVPL01) 28 | 29 | Some of the above links are affiliate links. I have a series of videos showing how I put this system together: 30 | 31 | - Part 1: [How efficient can I build the 100% Arm NAS?](https://www.youtube.com/watch?v=Hz5k5WgTkcc) 32 | - Part 2: [Silencing the 100% Arm NAS—while making it FASTER?](https://www.youtube.com/watch?v=iD9awxmOGG4) 33 | 34 | ### Secondary NAS - Raspberry Pi 5 with SATA HAT 35 | 36 |

Raspberry Pi 5 with Jeff Geerling hardware

37 | 38 | The current iteration of the Raspberry Pi 5 SATA NAS I'm running contains the following hardware: 39 | 40 | - (SBC) [Raspberry Pi 5](https://www.raspberrypi.com/products/raspberry-pi-5/) 41 | - (HAT) [Radxa Penta SATA HAT for Pi 5](https://amzn.to/3UyWXBr) 42 | - (SSDs) [Samsung 870 QVO 8TB SATA SSD](https://amzn.to/3y2nrSR) 43 | - (microSD) [Kingston Industrial 16GB A1](https://amzn.to/3y2noGF) 44 | - (Network) [Plugable 2.5GB USB Ethernet Adapter](https://amzn.to/4b9QMt1) 45 | - (Power) [TMEZON 12V 5A AC adapter](https://amzn.to/3QhYKIw) 46 | 47 | Some of the above links are affiliate links. I have a series of videos showing how I put this system together: 48 | 49 | - Part 1: [The ULTIMATE Raspberry Pi 5 NAS](https://www.youtube.com/watch?v=l30sADfDiM8) 50 | - Part 2: [Big NAS, Lil NAS](https://www.youtube.com/watch?v=D8EIs8s303k) 51 | 52 | ## Preparing the hardware 53 | 54 | The HL15 should not require any special prep, besides having Ubuntu installed. The Raspberry Pi 5 is running Debian (Pi OS) and needs its PCIe connection enabled. To do that: 55 | 56 | 1. Edit the boot config: `sudo nano /boot/firmware/config.txt` 57 | 2. Add in the following config at the bottom and save the file: 58 | 59 | ``` 60 | dtparam=pciex1 61 | dtparam=pciex1_gen=3 62 | ``` 63 | 64 | 3. Reboot 65 | 66 | Confirm the SATA drives are recognized with `lsblk`. 67 | 68 | ## Running the playbook 69 | 70 | Ensure you have Ansible installed, and can SSH into the NAS using `ssh user@nas-ip-or-address` without entering a password, then run: 71 | 72 | ``` 73 | ansible-playbook main.yml 74 | ``` 75 | 76 | ## Accessing Samba Shares 77 | 78 | After the playbook runs, you should be able to access Samba shares, for example the `hddpool/jupiter` share, by connecting to the server at the path: 79 | 80 | ``` 81 | smb://nas01.mmoffice.net/hddpool_jupiter 82 | ``` 83 | 84 | Until [issue #2](https://github.com/geerlingguy/hl15-arm64-nas/issues/2) is resolved, there is one manual step required to add a password for the `jgeerling` user (one time). Log into the server via SSH, run the following command, and enter a password when prompted: 85 | 86 | ``` 87 | sudo smbpasswd -a jgeerling 88 | ``` 89 | 90 | The same thing goes for the Pi, if you want to access it's ZFS volume. 91 | 92 | ## Replication / Backups 93 | 94 | Backups of the primary NAS (nas01) to the secondary NAS (nas02) are handled using [Sanoid](https://github.com/jimsalterjrs/sanoid) (and it's included `syncoid` replication tool). 95 | 96 | Sanoid is configured on nas01 to store a set of monthly, daily, and hourly snapshots. Syncoid is run on cron on nas02 to pull snapshots nightly. 97 | 98 | Sanoid should prune snapshots on nas01, and Syncoid on nas02. 99 | 100 | You can check on snapshot health with: 101 | 102 | - nas01: `sudo sanoid --monitor-snapshots && zfs list -t snapshot` 103 | - nas02: `zfs list -t snapshot` 104 | 105 | For example: 106 | 107 | ``` 108 | jgeerling@nas01:~$ sudo sanoid --monitor-snapshots 109 | OK: all monitored datasets (hddpool/jupiter) have fresh snapshots 110 | ``` 111 | 112 | ### Offsite Backups to Amazon Glacier 113 | 114 | Following the [1-2-3 Backup Principle](https://www.jeffgeerling.com/blog/2021/my-backup-plan), I have an offsite replica of all my data stored on an Amazon S3 Glacier Deep Archive-backed bucket. 115 | 116 | This keeps offsite storage costs minimal (about $1/TB/month), and using `rclone`, it is easy enough to keep things in sync between my onsite backups and S3. 117 | 118 | The S3 bucket is owned by IAM user `rclone`, and is named `mm-archive`. 119 | 120 | Locally, `rclone config` is set up with an Access Key and Secret Access Key for that `rclone` IAM user, and allows NAS02 to synchronize directories straight into the Amazon S3 bucket. 121 | 122 | Full documentation of the setup is in [this GitHub issue](https://github.com/geerlingguy/arm-nas/issues/14). 123 | 124 | #### Office Backup Retrieval 125 | 126 | TODO: We'll cross this bridge if we come to it. The only time I've ever had to retrieve a folder, I used rclone to sync down the directory but it was a bit of a hassle, since Deep Archive means you have to request files to be put back online for retrieval, and this can take 6-24 hours! 127 | 128 | ## Benchmarks 129 | 130 | I like to verify the performance of my NAS storage pools on the device itself, using my [`disk-benchmark.sh` script](https://github.com/geerlingguy/pi-cluster/blob/master/benchmarks/disk-benchmark.sh). 131 | 132 | You can run it by copying it to the server, making it executable, and running it with `sudo`: 133 | 134 | ``` 135 | wget https://raw.githubusercontent.com/geerlingguy/pi-cluster/master/benchmarks/disk-benchmark.sh 136 | chmod +x disk-benchmark.sh 137 | sudo MOUNT_PATH=/nvmepool/mercury TEST_SIZE=20g ./disk-benchmark.sh 138 | ``` 139 | 140 | ## Troubleshooting 141 | 142 | ### Samba Monitoring 143 | 144 | If you're having trouble mounting a share or authenticating with Samba, run `sudo watch smbstatus` to monitor connections to the server. Logs inside `/var/log/samba` aren't useful by default. 145 | 146 | ### ZFS Command Line Cheat Sheet 147 | 148 | ``` 149 | # Check pool health (should return 'all pools are healthy') 150 | zpool status -x 151 | 152 | # List all zfs pools and datasets 153 | zfs list 154 | 155 | # List all zfs pool info 156 | zpool list 157 | 158 | # List single zfs pool info (verbose) 159 | zpool status -v [pool_name] 160 | 161 | # List all properties for a pool 162 | zfs get all [pool_name] 163 | 164 | # Scrub a pool manually (check progress with `zpool status -v`) 165 | zpool scrub [pool_name] 166 | 167 | # Monitor zfs I/O statistics (update every 2s) 168 | zpool iostat 2 169 | ``` 170 | 171 | ## License 172 | 173 | GPLv3 or later 174 | 175 | ## Author 176 | 177 | Jeff Geerling 178 | -------------------------------------------------------------------------------- /ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | inventory=hosts.yml 3 | -------------------------------------------------------------------------------- /config.yml: -------------------------------------------------------------------------------- 1 | --- 2 | security_sudoers_passwordless: 3 | - "{{ ansible_user }}" 4 | 5 | samba_daemon: smbd 6 | 7 | # These variables must be defined per-host, in host_vars. 8 | # zfs_pools: [] 9 | # zfs_samba_shares: [] 10 | # sanoid_conf: "" 11 | 12 | # Ownership for the samba share directories. 13 | zfs_samba_owner: "{{ ansible_user }}" 14 | zfs_samba_group: sudo 15 | 16 | rclone_arch: "arm64" 17 | -------------------------------------------------------------------------------- /files/rclone.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | # Rclone script to archive important data to an Amazon S3 bucket. 4 | # 5 | # Basic usage: 6 | # ./rclone.sh 7 | # 8 | # Script requires valid credentials - set up with `rclone config`. 9 | 10 | RCLONE=/usr/local/bin/rclone 11 | 12 | # Check if rclone is installed. 13 | if ! [ -x "$(command -v $RCLONE)" ]; then 14 | echo 'Error: rclone is not installed.' >&2 15 | exit 1 16 | fi 17 | 18 | # Don't run if an instance of rclone is already running. 19 | if ps -ef | grep -v grep | grep rclone ; then 20 | exit 0 21 | fi 22 | 23 | # Variables. 24 | rclone_remote=mm-archive 25 | rclone_s3_bucket=mm-archive 26 | bandwidth_limit=200M 27 | 28 | # Make sure bucket exists. 29 | $RCLONE mkdir $rclone_remote:$rclone_s3_bucket 30 | 31 | # List of directories to clone. MUST be absolute path, beginning with /. 32 | declare -a dirs=( 33 | "/ssdpool/backup/jupiter" 34 | ) 35 | 36 | # Clone each directory. Add `--progress` for nicer (but more verbose) output. 37 | for i in "${dirs[@]}" 38 | do 39 | echo "Syncing Directory: $i" 40 | despaced="${i// /_}" 41 | $RCLONE sync "$i" $rclone_remote:$rclone_s3_bucket"$despaced" --skip-links --bwlimit $bandwidth_limit 42 | done 43 | -------------------------------------------------------------------------------- /host_vars/nas01.mmoffice.net.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # HL15 Variables. 3 | 4 | # For `members` key, format as the end of the `zpool create` command. 5 | zfs_pools: 6 | - name: hddpool 7 | members: >- 8 | raidz2 9 | /dev/disk/by-id/wwn-0x5000c500e3da1887 10 | /dev/disk/by-id/wwn-0x5000c500e3d9c525 11 | /dev/disk/by-id/wwn-0x5000c500e3d9c560 12 | /dev/disk/by-id/wwn-0x5000c500e3d61ce0 13 | /dev/disk/by-id/wwn-0x5000c500e3d4848c 14 | /dev/disk/by-id/wwn-0x5000c500e3d5107b 15 | - name: nvmepool 16 | members: >- 17 | mirror 18 | /dev/disk/by-id/nvme-KIOXIA_KCD8XRUG15T3_8240A01KTY97 19 | /dev/disk/by-id/nvme-KIOXIA_KCD8XRUG15T3_8240A01MTY97 20 | 21 | zfs_samba_shares: 22 | - name: hddpool/jupiter 23 | extra_zfs_properties: 24 | casesensitivity: 'mixed' 25 | compression: 'lz4' 26 | smb_share_name: jupiter 27 | smb_comment: Archival storage pool on HDDs. 28 | - name: nvmepool/mercury 29 | extra_zfs_properties: 30 | casesensitivity: 'mixed' 31 | compression: 'lz4' 32 | smb_share_name: mercury 33 | smb_comment: Fast storage pool on NVMe. 34 | - name: nvmepool/ingest 35 | extra_zfs_properties: 36 | casesensitivity: 'mixed' 37 | compression: 'lz4' 38 | owner: zowiebox 39 | group: sudo 40 | smb_share_name: ingest 41 | smb_comment: Ingest storage pool on NVMe. 42 | 43 | sanoid_conf: > 44 | [hddpool/jupiter] 45 | use_template = production 46 | recursive = yes 47 | 48 | [nvmepool/mercury] 49 | use_template = production 50 | recursive = yes 51 | 52 | [template_production] 53 | frequently = 0 54 | hourly = 24 55 | daily = 30 56 | monthly = 3 57 | yearly = 0 58 | autosnap = yes 59 | autoprune = yes 60 | -------------------------------------------------------------------------------- /host_vars/nas02.mmoffice.net.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Raspberry Pi 5 Variables. 3 | 4 | # For `members` key, format as the end of the `zpool create` command. 5 | zfs_pools: 6 | - name: ssdpool 7 | members: >- 8 | raidz1 9 | /dev/disk/by-id/ata-Samsung_SSD_870_QVO_8TB_S5VUNG0NA00552B 10 | /dev/disk/by-id/ata-Samsung_SSD_870_QVO_8TB_S5VUNG0R403210A 11 | /dev/disk/by-id/ata-Samsung_SSD_870_QVO_8TB_S5VUNJ0R801559R 12 | /dev/disk/by-id/ata-Samsung_SSD_870_QVO_8TB_S5VUNJ0R802311N 13 | 14 | zfs_samba_shares: 15 | - name: ssdpool/backup 16 | extra_zfs_properties: 17 | casesensitivity: 'mixed' 18 | compression: 'lz4' 19 | smb_share_name: backup 20 | smb_comment: Backup storage pool on SSDs. 21 | 22 | # Note: --delete-target-snapshots will be available in syncoid after 2.3.x. 23 | # I would like to use that instead of running sanoid on the target, to keep all 24 | # sanoid/syncoid snapshots in perfect sync. 25 | sanoid_conf: > 26 | [ssdpool/backup] 27 | use_template = production 28 | recursive = yes 29 | 30 | [template_production] 31 | frequently = 0 32 | hourly = 24 33 | daily = 30 34 | monthly = 3 35 | yearly = 0 36 | autosnap = no 37 | autoprune = yes 38 | -------------------------------------------------------------------------------- /hosts.yml: -------------------------------------------------------------------------------- 1 | --- 2 | all: 3 | hosts: 4 | # HL15 5 | nas01.mmoffice.net: 6 | ansible_user: jgeerling 7 | 8 | # Raspberry Pi 5 9 | nas02.mmoffice.net: 10 | ansible_user: pi 11 | -------------------------------------------------------------------------------- /main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | become: true 4 | gather_facts: true 5 | 6 | vars_files: 7 | - config.yml 8 | 9 | roles: 10 | - geerlingguy.security 11 | - geerlingguy.samba 12 | - geerlingguy.sanoid 13 | 14 | tasks: 15 | - name: Configure user accounts. 16 | include_tasks: tasks/users.yml 17 | 18 | - name: Install ZFS and prerequisites. 19 | ansible.builtin.package: 20 | name: 21 | - linux-headers-generic 22 | - zfs-dkms 23 | - zfsutils-linux 24 | - samba 25 | tags: ['zfs'] 26 | 27 | - name: Create ZFS pools. 28 | ansible.builtin.command: 29 | cmd: zpool create {{ item.name }} {{ item.members }} -f 30 | creates: /{{ item.name }} 31 | loop: "{{ zfs_pools }}" 32 | tags: ['zfs'] 33 | 34 | - name: Create volumes for Samba shares. 35 | community.general.zfs: 36 | name: "{{ item.name }}" 37 | state: present 38 | extra_zfs_properties: "{{ item.extra_zfs_properties }}" 39 | loop: "{{ zfs_samba_shares }}" 40 | tags: ['zfs', 'samba'] 41 | 42 | - name: Configure Samba shares. 43 | include_tasks: tasks/samba.yml 44 | 45 | - name: Configure user for ZFS replication. 46 | include_tasks: tasks/replication.yml 47 | 48 | - name: Set up rclone. 49 | include_tasks: tasks/rclone.yml 50 | -------------------------------------------------------------------------------- /resources/hl15-hardware.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geerlingguy/arm-nas/d6c2b3caab91880912285bb2bf782a7fc41875e4/resources/hl15-hardware.jpeg -------------------------------------------------------------------------------- /resources/raspberrypi-5-hardware.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/geerlingguy/arm-nas/d6c2b3caab91880912285bb2bf782a7fc41875e4/resources/raspberrypi-5-hardware.jpeg -------------------------------------------------------------------------------- /tasks/rclone.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # General structure gleaned from stefangweichinger.ansible_rclone 3 | - block: 4 | 5 | - name: Get latest rclone version. 6 | ansible.builtin.uri: 7 | url: https://downloads.rclone.org/version.txt 8 | return_content: true 9 | register: rclone_latest_version 10 | check_mode: false 11 | 12 | - name: Set version to latest stable version. 13 | ansible.builtin.set_fact: 14 | rclone_version: "{{ rclone_latest_version.content | replace('rclone v', '', 1) | trim }}" 15 | 16 | - name: Download rclone. 17 | ansible.builtin.unarchive: 18 | src: https://downloads.rclone.org/v{{ rclone_version }}/rclone-v{{ rclone_version }}-linux-{{ rclone_arch }}.zip 19 | dest: "/tmp" 20 | remote_src: true 21 | mode: '0744' 22 | creates: "/tmp/rclone-v{{ rclone_version }}-linux-{{ rclone_arch }}" 23 | changed_when: false 24 | 25 | - name: Copy rclone binary into place. 26 | ansible.builtin.copy: 27 | src: "/tmp/rclone-v{{ rclone_version }}-linux-{{ rclone_arch }}/rclone" 28 | dest: '/usr/local/bin/rclone' 29 | mode: '0755' 30 | owner: root 31 | group: root 32 | force: true 33 | remote_src: true 34 | 35 | - name: Copy rclone backup script into place. 36 | ansible.builtin.copy: 37 | src: files/rclone.sh 38 | dest: /home/pi/rclone.sh 39 | mode: 0755 40 | become: false 41 | 42 | - name: Add cron job to run rclone backup weekly, at 0100 on Sundays. 43 | ansible.builtin.cron: 44 | name: Run rclone backup script. 45 | minute: "0" 46 | hour: "1" 47 | weekday: "0" 48 | job: /home/pi/rclone.sh 49 | state: present 50 | become: false 51 | 52 | run_once: true 53 | delegate_to: nas02.mmoffice.net 54 | -------------------------------------------------------------------------------- /tasks/replication.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure SSH keypair on Pi. 3 | block: 4 | - name: Ensure .ssh directory exists on Pi. 5 | ansible.builtin.file: 6 | path: /home/pi/.ssh 7 | state: directory 8 | mode: 0700 9 | 10 | - name: Generate SSH keypair for pi user on Pi. 11 | community.crypto.openssh_keypair: 12 | path: /home/pi/.ssh/id_rsa_zfs 13 | type: rsa 14 | size: 4096 15 | state: present 16 | owner: pi 17 | group: pi 18 | 19 | - name: Retrieve SSH pubkey for pi user on Pi. 20 | ansible.builtin.slurp: 21 | src: /home/pi/.ssh/id_rsa_zfs.pub 22 | register: pi_zfs_pubkey 23 | 24 | - name: Accept hostkey for HL15 on Pi. 25 | ansible.builtin.known_hosts: 26 | name: nas01.mmoffice.net 27 | key: nas01.mmoffice.net ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGttqA5odftU8N9AN05zByZxOzcuHkNNRGcZQfsLT6V/ 28 | path: /etc/ssh/ssh_known_hosts 29 | state: present 30 | 31 | # Check permissions with `zfs allow [pool/vol]` 32 | - name: Configure ZFS so pi user can perform ZFS actions. 33 | ansible.builtin.command: 34 | cmd: zfs allow -u pi compression,mountpoint,create,mount,receive,rollback,destroy ssdpool/backup 35 | changed_when: false 36 | run_once: true 37 | delegate_to: nas02.mmoffice.net 38 | 39 | - name: Configure pi user on HL15. 40 | block: 41 | - name: Create pi user on HL15. 42 | ansible.builtin.user: 43 | name: pi 44 | shell: /bin/bash 45 | create_home: true 46 | state: present 47 | 48 | - name: Ensure pi user homedir is owned by pi. 49 | ansible.builtin.file: 50 | path: /home/pi 51 | owner: pi 52 | group: pi 53 | 54 | - name: Add pi user's SSH key to account on HL15. 55 | ansible.posix.authorized_key: 56 | user: pi 57 | state: present 58 | key: "{{ pi_zfs_pubkey['content'] | b64decode | trim }} pi@nas02" 59 | 60 | # Check permissions with `zfs allow [pool/vol]` 61 | - name: Configure ZFS so pi user can perform ZFS actions. 62 | ansible.builtin.command: 63 | cmd: "zfs allow -u pi send,hold,mount,snapshot,destroy {{ item }}" 64 | changed_when: false 65 | loop: 66 | - hddpool 67 | - nvmepool 68 | run_once: true 69 | delegate_to: nas01.mmoffice.net 70 | 71 | - name: Configure nightly syncoid task on Pi. 72 | ansible.builtin.cron: 73 | name: "{{ item.name }}" 74 | minute: "13" 75 | hour: "{{ item.hour }}" 76 | job: >- 77 | /usr/sbin/syncoid 78 | --sshkey=/home/pi/.ssh/id_rsa_zfs 79 | --recursive 80 | --no-privilege-elevation 81 | {{ item.job }} 82 | user: pi 83 | loop: 84 | - name: "Nightly syncoid replication - jupiter" 85 | hour: "7" 86 | job: pi@nas01.mmoffice.net:hddpool/jupiter ssdpool/backup/jupiter 87 | - name: "Nightly syncoid replication - mercury" 88 | hour: "8" 89 | job: pi@nas01.mmoffice.net:nvmepool/mercury ssdpool/backup/mercury 90 | run_once: true 91 | delegate_to: nas02.mmoffice.net 92 | -------------------------------------------------------------------------------- /tasks/samba.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Configure Samba. 3 | community.general.ini_file: 4 | path: /etc/samba/smb.conf 5 | section: global 6 | option: "{{ item.option }}" 7 | value: "{{ item.value }}" 8 | backup: false 9 | mode: 0644 10 | loop: 11 | - { option: usershare path, value: /var/lib/samba/usershares } 12 | - { option: usershare max shares, value: 100 } 13 | - { option: usershare allow guests, value: 'yes' } 14 | - { option: usershare owner only, value: 'no' } 15 | - { option: vfs objects, value: 'catia fruit streams_xattr' } 16 | - { option: fruit:nfs_aces, value: 'no' } 17 | notify: restart smb 18 | tags: ['samba'] 19 | 20 | - name: Configure Samba usershares. 21 | ansible.builtin.template: 22 | src: templates/smb-share.conf.j2 23 | dest: /var/lib/samba/usershares/{{ item.smb_share_name }} 24 | owner: root 25 | group: root 26 | mode: 0644 27 | loop: "{{ zfs_samba_shares }}" 28 | notify: restart smb 29 | tags: ['samba'] 30 | 31 | - name: Configure ownership on Samba shares. 32 | ansible.builtin.file: 33 | path: "/{{ item.name }}" 34 | state: directory 35 | owner: "{{ item.owner | default(zfs_samba_owner) }}" 36 | group: "{{ item.group | default(zfs_samba_group) }}" 37 | mode: 0775 38 | loop: "{{ zfs_samba_shares }}" 39 | tags: ['samba'] 40 | 41 | # TODO: See https://stackoverflow.com/a/46428282/100134 42 | # For now, manually run `sudo smbpasswd -a [samba username]` 43 | # Current accounts: jgeerling, zowiebox 44 | - name: Configure Samba passwords (not yet implemented). 45 | ansible.builtin.meta: noop 46 | tags: ['samba'] 47 | -------------------------------------------------------------------------------- /tasks/users.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Create zowiebox user on HL15 for ingest. 3 | ansible.builtin.user: 4 | name: zowiebox 5 | shell: /usr/sbin/nologin 6 | create_home: false 7 | state: present 8 | run_once: true 9 | delegate_to: nas01.mmoffice.net 10 | -------------------------------------------------------------------------------- /templates/smb-share.conf.j2: -------------------------------------------------------------------------------- 1 | #VERSION 2 2 | path=/{{ item.name }} 3 | comment={{ item.smb_comment }} ({{ ansible_managed }}) 4 | usershare_acl=S-1-1-0:F 5 | guest_ok=n 6 | sharename={{ item.smb_share_name }} 7 | --------------------------------------------------------------------------------