├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── backup.py ├── run.sh ├── wait-for-it.LICENSE └── wait-for-it.sh /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | local_settings.py 55 | 56 | # Flask stuff: 57 | instance/ 58 | .webassets-cache 59 | 60 | # Scrapy stuff: 61 | .scrapy 62 | 63 | # Sphinx documentation 64 | docs/_build/ 65 | 66 | # PyBuilder 67 | target/ 68 | 69 | # IPython Notebook 70 | .ipynb_checkpoints 71 | 72 | # pyenv 73 | .python-version 74 | 75 | # celery beat schedule file 76 | celerybeat-schedule 77 | 78 | # dotenv 79 | .env 80 | 81 | # virtualenv 82 | venv/ 83 | ENV/ 84 | 85 | # Spyder project settings 86 | .spyderproject 87 | 88 | # Rope project settings 89 | .ropeproject 90 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.5.2-alpine 2 | MAINTAINER Miku Laitinen 3 | 4 | RUN apk update \ 5 | && apk add python py-pip bash \ 6 | && pip install boto3 requests ConfigArgParse \ 7 | && apk add curl \ 8 | && curl -L --insecure https://github.com/odise/go-cron/releases/download/v0.0.6/go-cron-linux.gz | zcat > /usr/local/bin/go-cron \ 9 | && chmod u+x /usr/local/bin/go-cron \ 10 | && apk del curl \ 11 | && apk del py-pip \ 12 | && rm -rf /var/cache/apk/* 13 | 14 | ENV ODOO_HOST 'odoo' 15 | ENV ODOO_PORT '8069' 16 | ENV ODOO_MASTER_PASSWORD 'admin' 17 | ENV ODOO_VERSION '13' 18 | 19 | # A comma separated list of databases to backup 20 | ENV DATABASES '' 21 | 22 | ENV AWS_ACCESS_KEY_ID '' 23 | ENV AWS_SECRET_ACCESS_KEY '' 24 | ENV AWS_REGION 'eu-central-1' 25 | ENV S3_BUCKET '' 26 | ENV S3_PATH 'backup' 27 | ENV RESTORE_FILENAME '' 28 | 29 | ENV SCHEDULE 'single' 30 | ENV CHECK_URL '' 31 | 32 | # USER backup 33 | 34 | COPY run.sh /run.sh 35 | COPY backup.py /backup.py 36 | COPY wait-for-it.sh /wait-for-it.sh 37 | 38 | ENTRYPOINT ["/run.sh"] 39 | CMD ["backup"] 40 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # odoo-backup-restore-s3 2 | Authors: 3 | - Miku Laitinen / [Avoin.Systems](https://avoin.systems) 4 | - Atte Isopuro / [Avoin.Systems](https://avoin.systems) 5 | 6 | Backup Odoo databases (with filestore) to S3 and restore them upon request. Supported Odoo versions: 8, 9, 10, 11, 12, 13. 7 | [![Docker Repository on Quay](https://quay.io/repository/avoinsystems/odoo-backup-restore-s3/status "Docker Repository on Quay")](https://quay.io/repository/avoinsystems/odoo-backup-restore-s3) 8 | 9 | ## Backup usage examples 10 | 11 | Docker: 12 | ```sh 13 | $ docker run \ 14 | --link odoo \ 15 | --network= \ 16 | -e AWS_ACCESS_KEY_ID= \ 17 | -e AWS_SECRET_ACCESS_KEY= \ 18 | -e S3_BUCKET= \ 19 | -e S3_PREFIX= \ 20 | -e ODOO_MASTER_PASSWORD= \ 21 | -e DATABASES= \ 22 | -e SCHEDULE= \ 23 | quay.io/avoinsystems/odoo-backup-restore-s3 24 | ``` 25 | 26 | Docker Compose: 27 | ```yaml 28 | odoo: 29 | image: odoo 30 | 31 | backup: 32 | image: quay.io/avoinsystems/odoo-backup-restore-s3 33 | depends_on: 34 | - odoo 35 | environment: 36 | SCHEDULE: '@daily' 37 | AWS_REGION: region 38 | AWS_ACCESS_KEY_ID: key 39 | AWS_SECRET_ACCESS_KEY: secret 40 | S3_BUCKET: my-bucket 41 | S3_PATH: backup 42 | DATABASES: dbname1,dbname2 43 | ODOO_MASTER_PASSWORD: password 44 | 45 | ``` 46 | 47 | ## Restore usage examples 48 | Docker: 49 | ```sh 50 | $ docker run \ 51 | --link \ 52 | --network= \ 53 | -e AWS_ACCESS_KEY_ID= \ 54 | -e AWS_SECRET_ACCESS_KEY= \ 55 | -e S3_BUCKET= \ 56 | -e S3_PREFIX= \ 57 | -e ODOO_MASTER_PASSWORD= \ 58 | -e DATABASES= \ 59 | -e SCHEDULE= \ 60 | quay.io/avoinsystems/odoo-backup-restore-s3 \ 61 | restore 62 | ``` 63 | 64 | Docker Compose: 65 | ```sh 66 | $ docker-compose run --rm -e DATABASES= backup restore 67 | ``` 68 | 69 | ## Configuration 70 | 71 | Configuration options can be passed as environment variables. 72 | 73 | | Variable | Purpose |Default | 74 | | ----------------------- | ------------------------- | -------- | 75 | | `ODOO_HOST` | Odoo container hostname | `odoo` | 76 | | `ODOO_PORT` | Odoo container port | `8069` | 77 | | `ODOO_MASTER_PASSWORD` | Odoo master password | `admin` | 78 | | `ODOO_VERSION` | Odoo version number (8, 9, 10, 11, 12 or 13) | `13` | 79 | | `DATABASES` | A single database or comma-separated list of databases | | 80 | | `AWS_ACCESS_KEY_ID` | Amazon AWS Access Key ID | | 81 | | `AWS_SECRET_ACCESS_KEY` | Amazon AWS Secret Access Key | | 82 | | `AWS_REGION` | The default AWS region | | 83 | | `S3_BUCKET` | Amazon AWS S3 bucket name | | 84 | | `S3_PATH` | The backup path inside the bucket, a.k.a. prefix |`backup` | 85 | | `RESTORE_FILENAME` | Which backup file to restore. Only used when restoring backup. If empty, the latest backup will be restored | | 86 | | `SCHEDULE` | Backup frequency. `single` = backup only once. See all available options [here](http://godoc.org/github.com/robfig/cron#hdr-Predefined_schedules). |`single` | 87 | | `CHECK_URL` | A URL to call with a GET request after a successful backup | | 88 | | `PROTOCOL` | The protocol to use (`xmlrpc`, `http`). HTTP is more memory-efficient. | `xmlrpc` | 89 | 90 | ## Reliability 91 | There are some issues with both XMLRPC and HTTP protocols. 92 | 93 | The XMLRPC method will store the backup in memory and if the database 94 | size exceeds the available free memory, the backup fails. 95 | 96 | The HTTP method calls the `/web/database/backup` endpoint of Odoo and 97 | stores the database backup temporarily on the disk before uploading it 98 | to S3. However, Odoo doesn't provide the size of the database dump in 99 | its HTTP headers, so if Odoo times out while the database dump is being 100 | downloaded, the incomplete database dump is uploaded to S3 without any 101 | sort of errors. 102 | 103 | If you want to get alerts of the Odoo timeouts and failed backups, 104 | consider installing the [`backup_size_header`](https://github.com/avoinsystems/avoinsystems-addons) module to your Odoo. 105 | It overrides the default backup method and adds the `Content-Length` 106 | header to the response. -------------------------------------------------------------------------------- /backup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | import base64 4 | from datetime import datetime 5 | from xmlrpc import client 6 | 7 | import configargparse 8 | from tempfile import TemporaryFile 9 | import os 10 | import sys 11 | import time 12 | 13 | from boto3.session import Session 14 | import logging 15 | from logging.config import dictConfig 16 | 17 | from io import BytesIO 18 | 19 | logging_config = dict( 20 | version=1, 21 | formatters={ 22 | 'f': {'format': '%(levelname)-8s %(message)s'} 23 | }, 24 | handlers={ 25 | 'h': {'class': 'logging.StreamHandler', 26 | 'formatter': 'f', 27 | 'level': logging.INFO} 28 | }, 29 | root={ 30 | 'handlers': ['h'], 31 | 'level': logging.INFO, 32 | }, 33 | ) 34 | 35 | dictConfig(logging_config) 36 | _logger = logging.getLogger() 37 | 38 | actions = dict() 39 | 40 | def main(args): 41 | # Create the AWS S3 connection 42 | aws_conn = Session( 43 | args['aws_access_key_id'], 44 | args['aws_secret_access_key'], 45 | region_name=args['aws_region'] 46 | ) 47 | args['s3'] = aws_conn.resource('s3') 48 | if args['protocol'] == 'xmlrpc': 49 | args['conn'] = client.ServerProxy( 50 | 'http://{odoo_host}:{odoo_port}/xmlrpc/db'.format(**args) 51 | ) 52 | action_name = args['mode'] + '_' + args['protocol'] 53 | return actions[action_name](**args) 54 | 55 | 56 | def backup_xmlrpc(s3, conn, databases, odoo_host, odoo_port, odoo_master_password, odoo_version, 57 | aws_access_key_id, aws_secret_access_key, aws_region, s3_bucket, 58 | s3_path, **kwargs): 59 | 60 | # Get the database list 61 | db_list = conn.list() 62 | dbs_not_found = set(databases) - set(db_list) 63 | if dbs_not_found: 64 | raise Exception( 65 | "Unable to perform backup. " 66 | "Database(s) {} can't be found.".format(dbs_not_found)) 67 | 68 | # Iterate through the databases to backup 69 | for database in databases: 70 | filename = "{}_{}.zip".format(database, 71 | time.strftime('%Y-%m-%d_%H-%M-%S')) 72 | 73 | # Download the backup dump from Odoo 74 | if odoo_version == '8': 75 | data = conn.dump(odoo_master_password, database) 76 | else: # >= 9 77 | data = conn.dump(odoo_master_password, database, 'zip') 78 | 79 | data = base64.b64decode(data) 80 | 81 | _logger.info(u"Successfully dumped database '{}'. Uploading to S3 ..." 82 | .format(database)) 83 | 84 | # Upload the dump to S3 85 | upload_path = s3_path + '/' + filename 86 | s3.Bucket(s3_bucket).put_object(Key=upload_path, Body=data) 87 | _logger.info(u"Upload to S3 finished. Database '{}' dump saved as {}" 88 | .format(database, filename)) 89 | 90 | actions['backup_xmlrpc'] = backup_xmlrpc 91 | 92 | 93 | def backup_http(s3, databases, odoo_host, odoo_port, odoo_master_password, odoo_version, 94 | aws_access_key_id, aws_secret_access_key, aws_region, s3_bucket, 95 | s3_path, **kwargs): 96 | import requests 97 | 98 | # Iterate through the databases to backup 99 | backup_url = "http://{}:{}/web/database/backup".format(odoo_host, odoo_port) 100 | 101 | if odoo_version == '8': 102 | pwd_field = 'backup_pwd' 103 | db_field = 'backup_db' 104 | else: 105 | pwd_field = 'master_pwd' 106 | db_field = 'name' 107 | 108 | request_data = { 109 | pwd_field: odoo_master_password, 110 | 'backup_format': 'zip' 111 | } 112 | 113 | if odoo_version == '8': 114 | request_data['token'] = 'dummy' 115 | 116 | request_args = dict( 117 | url=backup_url, 118 | stream=True, 119 | data=request_data 120 | ) 121 | for database in databases: 122 | filename = "{}_{}.zip".format(database, 123 | time.strftime('%Y-%m-%d_%H-%M-%S')) 124 | request_data[db_field] = database 125 | # Download the backup dump from Odoo 126 | response = requests.post(**request_args) 127 | 128 | if response.status_code >= 400: 129 | raise Exception("Odoo returned error {} when trying to " 130 | "backup database {}.".format( 131 | response.status_code, 132 | database 133 | )) 134 | 135 | headers = response.headers 136 | if 'Content-Type' in headers \ 137 | and 'application/octet-stream' not in headers['Content-Type']: 138 | raise Exception( 139 | "Received an invalid Content-Type form Odoo. This could be " 140 | "caused by a non-existant database or insufficient rights. " 141 | "Check the name of the database and the master password.") 142 | 143 | _logger.info("Successfully dumped database '{}'. " 144 | "Saving to a temporary file ...".format(database)) 145 | 146 | with TemporaryFile() as file: 147 | 148 | for chunk in response.iter_content(chunk_size=1024*12): 149 | if chunk: 150 | file.write(chunk) 151 | 152 | response.close() 153 | file_size = file.tell() 154 | 155 | if 'Content-Length' in headers \ 156 | and file_size < int(headers['Content-Length']): 157 | raise Exception( 158 | "Backup download was interrupted and the backup file is " 159 | "incomplete. This is most likely caused by too low Odoo " 160 | "timeout limits.") 161 | 162 | file.seek(0) 163 | 164 | _logger.info("Successfully saved '{}' to a temporary file. " 165 | "Uploading to S3 ...".format(database)) 166 | 167 | uploaded_bytes = 0 168 | 169 | def update_uploaded_bytes(up_bytes, **kwargs): 170 | nonlocal uploaded_bytes 171 | uploaded_bytes += up_bytes 172 | 173 | # Upload the dump to S3 174 | upload_path = s3_path + '/' + filename 175 | s3.Bucket(s3_bucket).upload_fileobj(file, Key=upload_path, 176 | Callback=update_uploaded_bytes) 177 | 178 | if uploaded_bytes < file_size: 179 | raise Exception("Upload to S3 was interrupted and the backup " 180 | "file uploaded to S3 is incomplete.") 181 | 182 | _logger.info("Upload to S3 finished. Database '{}' dump saved as {}" 183 | .format(database, filename)) 184 | 185 | 186 | actions['backup_http'] = backup_http 187 | 188 | 189 | def restore_xmlrpc(conn, s3, databases, odoo_host, odoo_port, odoo_master_password, 190 | aws_access_key_id, aws_secret_access_key, aws_region, s3_bucket, 191 | s3_path, restore_filename, **kwargs): 192 | if databases: 193 | assert len(databases) == 1, 'You can only restore one database ' \ 194 | 'at once' 195 | database = databases[0] 196 | 197 | # Add path to restore filename 198 | restore_key = s3_path + '/' + restore_filename \ 199 | if restore_filename else False 200 | 201 | # Get the database list 202 | db_list = conn.list() 203 | bucket = s3.Bucket(s3_bucket) 204 | restore_key = check_and_fix_restore_key(bucket, database, restore_key, s3_bucket, s3_path) 205 | 206 | if not database: 207 | database = guess_database_from_restore_key(restore_key) 208 | 209 | if database in db_list: 210 | raise Exception( 211 | "Unable to perform restore. " 212 | "Database '{}' already exists.".format(database)) 213 | 214 | # Download the backup from S3 215 | _logger.info('Downloading {} from S3 ...'.format(restore_key)) 216 | file = BytesIO() 217 | bucket.download_fileobj(restore_key, file) 218 | data = base64.encodebytes(file.getvalue()).decode('utf-8') 219 | 220 | _logger.info('Successfully downloaded {} from S3. Restoring dump ' 221 | 'to database {}'.format(restore_key, 222 | database)) 223 | 224 | # Restore the backup 225 | conn.restore(odoo_master_password, database, data) 226 | 227 | _logger.info(u"Successfully restored {} to database '{}'." 228 | .format(restore_key, database)) 229 | 230 | actions['restore_xmlrpc'] = restore_xmlrpc 231 | 232 | 233 | def restore_http(s3, databases, odoo_host, odoo_port, odoo_master_password, 234 | aws_access_key_id, aws_secret_access_key, aws_region, s3_bucket, 235 | s3_path, restore_filename, odoo_version, **kwargs): 236 | import requests 237 | import tempfile 238 | if databases: 239 | assert len(databases) == 1, 'You can only restore one database ' \ 240 | 'at once' 241 | database = databases[0] 242 | 243 | # Add path to restore filename 244 | restore_key = s3_path + '/' + restore_filename \ 245 | if restore_filename else False 246 | 247 | base_url = 'http://{}:{}/web/database/'.format(odoo_host, odoo_port) 248 | 249 | # Get the database list 250 | if odoo_version in ('8', '9'): 251 | # Only 10+ supports getting dblist via HTTP 252 | conn = client.ServerProxy( 253 | 'http://{odoo_host}:{odoo_port}/xmlrpc/db'.format(odoo_host=odoo_host, odoo_port=odoo_port) 254 | ) 255 | db_list = conn.list() 256 | else: 257 | response = requests.post( 258 | base_url + 'list', 259 | headers={'content-type': 'application/json'}, 260 | data='{}' 261 | ) 262 | db_list = response.json()['result'] 263 | 264 | # Get a list of the backup files in the path 265 | bucket = s3.Bucket(s3_bucket) 266 | restore_key = check_and_fix_restore_key(bucket, database, restore_key, s3_bucket, s3_path) 267 | 268 | if not database: 269 | database = guess_database_from_restore_key(restore_key) 270 | 271 | if database in db_list: 272 | raise Exception( 273 | "Unable to perform restore. " 274 | "Database '{}' already exists.".format(database)) 275 | 276 | _logger.info('Downloading {} from S3 ...'.format(restore_key)) 277 | 278 | with tempfile.TemporaryFile() as file: 279 | bucket.download_fileobj(restore_key, file) 280 | file.seek(0) 281 | 282 | _logger.info('Successfully downloaded {} from S3. Restoring dump ' 283 | 'to database {}'.format(restore_key, 284 | database)) 285 | 286 | # Post the file to Odoo 287 | if odoo_version == '8': 288 | pwd_field = 'restore_pwd' 289 | db_field = 'new_db' 290 | file_field = 'db_file' 291 | else: 292 | pwd_field = 'master_pwd' 293 | db_field = 'name' 294 | file_field = 'backup_file' 295 | 296 | data = { 297 | pwd_field: odoo_master_password, 298 | db_field: database 299 | } 300 | 301 | if odoo_version == '8': 302 | data['mode'] = 'restore' 303 | 304 | response = requests.post( 305 | base_url + 'restore', 306 | files={file_field: ('s3_db.zip', file, 'application/zip')}, 307 | data=data, 308 | ) 309 | 310 | # Ugly af, I know. 311 | if response.status_code >= 400 or 'Database restore error:' in response.text: 312 | if 'Database restore error:' in response.text: 313 | text = response.text.split("Database restore error:", 1)[1].split("\n", 1)[0] 314 | else: 315 | text = response.text 316 | raise Exception("There was an error restoring the database to Odoo.\n{}".format(text)) 317 | 318 | _logger.info(u"Successfully restored {} to database '{}'." 319 | .format(restore_key, database)) 320 | 321 | 322 | def check_and_fix_restore_key(bucket, database, restore_key, s3_bucket, s3_path): 323 | backup_files = bucket.objects.filter(Prefix=s3_path) 324 | if restore_key and all(restore_key != file.key for file in backup_files): 325 | raise FileNotFoundError( 326 | 'Backup file {} not found in S3 bucket {}.' 327 | .format(restore_key, s3_bucket)) 328 | elif not restore_key: 329 | # If the filename is not specified, find the latest dump 330 | latest = False 331 | 332 | for iter_file in backup_files: 333 | if not latest or iter_file.last_modified > latest: 334 | latest = iter_file.last_modified 335 | restore_key = iter_file.key 336 | 337 | if database and database not in restore_key: 338 | _logger.warning("Latest dump key is {} but it doesn't " 339 | "contain the database name '{}'." 340 | .format(restore_key, database)) 341 | 342 | return restore_key 343 | 344 | def guess_database_from_restore_key(restore_key): 345 | # path/database_2017-08-07_13-05-43.zip 346 | # If key is a path, the filename is the last level 347 | path_parts = restore_key.split('/') 348 | restore_key = path_parts[-1] 349 | trim = 0 350 | if restore_key.endswith('.zip') or restore_key.endswith('.sql'): 351 | trim = 4 352 | elif restore_key.endswith('.dump'): 353 | trim = 5 354 | return restore_key[0:len(restore_key) - trim] 355 | 356 | actions['restore_http'] = restore_http 357 | 358 | 359 | 360 | if __name__ == "__main__": 361 | 362 | env = os.environ 363 | supported_versions = ('8', '9', '10', '11', '12', '13') 364 | 365 | parser = configargparse.ArgParser() 366 | parser.add_argument('mode', default='backup', choices=('backup', 'restore')) 367 | parser.add_argument('-c', '--config', is_config_file=True, help='Path to configuration file. Either .ini or .yaml syntax accepted') 368 | parser.add_argument('--databases', env_var='DATABASES', required=True, type=lambda s: s.split(',')) 369 | parser.add_argument('--odoo-host', env_var='ODOO_HOST', default='odoo') 370 | parser.add_argument('--odoo-port', env_var='ODOO_PORT', default=8069) 371 | parser.add_argument('--odoo-master-password', env_var='ODOO_MASTER_PASSWORD', default='admin') 372 | parser.add_argument('--odoo-version', env_var='ODOO_VERSION', default=supported_versions[-1], choices=supported_versions) 373 | parser.add_argument('--aws-access-key-id', env_var='AWS_ACCESS_KEY_ID', required=True) 374 | parser.add_argument('--aws-secret-access-key', env_var='AWS_SECRET_ACCESS_KEY', required=True) 375 | parser.add_argument('--aws-region', env_var='AWS_REGION', required=True) 376 | parser.add_argument('--s3-bucket', env_var='S3_BUCKET', required=True) 377 | parser.add_argument('--s3-path', env_var='S3_PATH', default='backup') 378 | parser.add_argument('--check-url', env_var='CHECK_URL', help="After every backup, send an HTTP GET request to this address. Designed with healthchecks.io in mind.") 379 | parser.add_argument('--restore-filename', env_var='RESTORE_FILENAME') 380 | parser.add_argument('--protocol', env_var='PROTOCOL', default='xmlrpc', choices=('xmlrpc', 'http')) 381 | 382 | args = parser.parse_args() 383 | 384 | if not args.databases: 385 | if args.mode == 'backup': 386 | raise ValueError("--databases is required when in backup mode") 387 | 388 | main(vars(args)) 389 | 390 | if args.check_url: 391 | import requests 392 | 393 | requests.get(args.check_url) 394 | -------------------------------------------------------------------------------- /run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | 5 | if [ "${SCHEDULE}" = "single" ] || [ "$1" = "restore" ]; then 6 | exec /wait-for-it.sh --strict --timeout=20 -h "$ODOO_HOST" -p "$ODOO_PORT" -- python backup.py "$@" 7 | else 8 | exec go-cron "$SCHEDULE" python backup.py "$@" 9 | fi 10 | -------------------------------------------------------------------------------- /wait-for-it.LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | Copyright (c) 2016 Giles Hall 3 | 4 | Permission is hereby granted, free of charge, to any person obtaining a copy of 5 | this software and associated documentation files (the "Software"), to deal in 6 | the Software without restriction, including without limitation the rights to 7 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 8 | of the Software, and to permit persons to whom the Software is furnished to do 9 | so, subject to the following conditions: 10 | 11 | The above copyright notice and this permission notice shall be included in all 12 | copies or substantial portions of the Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 20 | SOFTWARE. 21 | -------------------------------------------------------------------------------- /wait-for-it.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Use this script to test if a given TCP host/port are available 3 | 4 | cmdname=$(basename $0) 5 | 6 | echoerr() { if [[ $QUIET -ne 1 ]]; then echo "$@" 1>&2; fi } 7 | 8 | usage() 9 | { 10 | cat << USAGE >&2 11 | Usage: 12 | $cmdname host:port [-s] [-t timeout] [-- command args] 13 | -h HOST | --host=HOST Host or IP under test 14 | -p PORT | --port=PORT TCP port under test 15 | Alternatively, you specify the host and port as host:port 16 | -s | --strict Only execute subcommand if the test succeeds 17 | -q | --quiet Don't output any status messages 18 | -t TIMEOUT | --timeout=TIMEOUT 19 | Timeout in seconds, zero for no timeout 20 | -- COMMAND ARGS Execute command with args after the test finishes 21 | USAGE 22 | exit 1 23 | } 24 | 25 | wait_for() 26 | { 27 | if [[ $TIMEOUT -gt 0 ]]; then 28 | echoerr "$cmdname: waiting $TIMEOUT seconds for $HOST:$PORT" 29 | else 30 | echoerr "$cmdname: waiting for $HOST:$PORT without a timeout" 31 | fi 32 | start_ts=$(date +%s) 33 | while : 34 | do 35 | if [[ $ISBUSY -eq 1 ]]; then 36 | nc -z $HOST $PORT 37 | result=$? 38 | else 39 | (echo > /dev/tcp/$HOST/$PORT) >/dev/null 2>&1 40 | result=$? 41 | fi 42 | if [[ $result -eq 0 ]]; then 43 | end_ts=$(date +%s) 44 | echoerr "$cmdname: $HOST:$PORT is available after $((end_ts - start_ts)) seconds" 45 | break 46 | fi 47 | sleep 1 48 | done 49 | return $result 50 | } 51 | 52 | wait_for_wrapper() 53 | { 54 | # In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692 55 | if [[ $QUIET -eq 1 ]]; then 56 | timeout $BUSYTIMEFLAG $TIMEOUT $0 --quiet --child --host=$HOST --port=$PORT --timeout=$TIMEOUT & 57 | else 58 | timeout $BUSYTIMEFLAG $TIMEOUT $0 --child --host=$HOST --port=$PORT --timeout=$TIMEOUT & 59 | fi 60 | PID=$! 61 | trap "kill -INT -$PID" INT 62 | wait $PID 63 | RESULT=$? 64 | if [[ $RESULT -ne 0 ]]; then 65 | echoerr "$cmdname: timeout occurred after waiting $TIMEOUT seconds for $HOST:$PORT" 66 | fi 67 | return $RESULT 68 | } 69 | 70 | # process arguments 71 | while [[ $# -gt 0 ]] 72 | do 73 | case "$1" in 74 | *:* ) 75 | hostport=(${1//:/ }) 76 | HOST=${hostport[0]} 77 | PORT=${hostport[1]} 78 | shift 1 79 | ;; 80 | --child) 81 | CHILD=1 82 | shift 1 83 | ;; 84 | -q | --quiet) 85 | QUIET=1 86 | shift 1 87 | ;; 88 | -s | --strict) 89 | STRICT=1 90 | shift 1 91 | ;; 92 | -h) 93 | HOST="$2" 94 | if [[ $HOST == "" ]]; then break; fi 95 | shift 2 96 | ;; 97 | --host=*) 98 | HOST="${1#*=}" 99 | shift 1 100 | ;; 101 | -p) 102 | PORT="$2" 103 | if [[ $PORT == "" ]]; then break; fi 104 | shift 2 105 | ;; 106 | --port=*) 107 | PORT="${1#*=}" 108 | shift 1 109 | ;; 110 | -t) 111 | TIMEOUT="$2" 112 | if [[ $TIMEOUT == "" ]]; then break; fi 113 | shift 2 114 | ;; 115 | --timeout=*) 116 | TIMEOUT="${1#*=}" 117 | shift 1 118 | ;; 119 | --) 120 | shift 121 | CLI=("$@") 122 | break 123 | ;; 124 | --help) 125 | usage 126 | ;; 127 | *) 128 | echoerr "Unknown argument: $1" 129 | usage 130 | ;; 131 | esac 132 | done 133 | 134 | if [[ "$HOST" == "" || "$PORT" == "" ]]; then 135 | echoerr "Error: you need to provide a host and port to test." 136 | usage 137 | fi 138 | 139 | TIMEOUT=${TIMEOUT:-15} 140 | STRICT=${STRICT:-0} 141 | CHILD=${CHILD:-0} 142 | QUIET=${QUIET:-0} 143 | 144 | # check to see if timeout is from busybox? 145 | # check to see if timeout is from busybox? 146 | TIMEOUT_PATH=$(realpath $(which timeout)) 147 | if [[ $TIMEOUT_PATH =~ "busybox" ]]; then 148 | ISBUSY=1 149 | BUSYTIMEFLAG="-t" 150 | else 151 | ISBUSY=0 152 | BUSYTIMEFLAG="" 153 | fi 154 | 155 | if [[ $CHILD -gt 0 ]]; then 156 | wait_for 157 | RESULT=$? 158 | exit $RESULT 159 | else 160 | if [[ $TIMEOUT -gt 0 ]]; then 161 | wait_for_wrapper 162 | RESULT=$? 163 | else 164 | wait_for 165 | RESULT=$? 166 | fi 167 | fi 168 | 169 | if [[ $CLI != "" ]]; then 170 | if [[ $RESULT -ne 0 && $STRICT -eq 1 ]]; then 171 | echoerr "$cmdname: strict mode, refusing to execute subprocess" 172 | exit $RESULT 173 | fi 174 | exec "${CLI[@]}" 175 | else 176 | exit $RESULT 177 | fi 178 | --------------------------------------------------------------------------------