├── .gitignore ├── LICENSE ├── README.md ├── autoComputeOptimizer-template.yml ├── autocomputeoptimizer.py └── autocomputeoptimizer.zip /.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 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AutoComputeOptimizer 2 | Easy to configure automation to automatically apply AWS Compute Optimizer recommendations on EC2 instances 3 | It uses CloudFormation, Lambda (Python 3.9), CloudWatch Events and AWS Compute Optimizer (Compute Optimizer should be already working on the account) 4 | 5 | You can select the day to check the recommendatios, set the time when should be apply and the type of recommendations: Overprovisioned, Underprovisioned or Both. 6 | 7 | You can add Exceptions to never change an EC2 to a specific type, you can mark exceptions of family and size, Ex: t3, small, m4.large 8 | 9 | You have to define a TAG to select the EC2 Instances affected by the Automation. You can set SNS Notifications for this automation. 10 | 11 | If it's not working on your Region create an Issue and I will fix it. 12 | 13 | > Version 2.2.0 14 | 15 | ### Files: 16 | - autoComputeOptimizer-template.yml, CloudFormation template to Run in your account, it is already in a public S3 bucket 17 | 18 | - autocomputeoptimizer.py, Lambda code that actually do the job of implementing the recommendations, source code only for reviewing 19 | 20 | - autocomputeoptimizer.zip, Zip file used by the template to deploy de Lambda, it is already in a public S3 Bucket 21 | 22 | ## How To Deploy 23 | Use AWS CloudFormation to deploy the following template: 24 | 25 | https://higher-artifacts.s3.amazonaws.com/solutions/autoComputeOptimizer-template.yml 26 | 27 | ### Parameters: 28 | - *Env Tag*, use to identified the components of the template 29 | 30 | - *Selection Tag Key*, sets the Tag used to identify the EC2 Instances 31 | 32 | - *Selection Tag Value*, sets the Value of the Tag to identify the EC2 Instances 33 | 34 | - *Day*, specify the day of the week the recommendations will be applied (Mon-Sun) 35 | 36 | - *Time*, specify at what time the changes to the EC2 Instances will occur (downtime requiered) (UTC 24 hours syntax) 37 | 38 | - *Default Recommendation Type*, specify which kind of recommendations to apply: Underprovisioned, Overprovisioned, Both 39 | 40 | - *Tolerable Risk*, select the maximum tolerable Risk of the recommendation to apply 41 | 42 | - *Exceptions*, you can add instance types, families or sizes to NOT use, for example: t2.nano, small, t3 43 | 44 | - *Email Address*, e-mail address to receive notifications of the implemmented recommendations 45 | 46 | `If you edit the template remember to use LF end of lines.` 47 | 48 | `Update KMS user policy if you find troubles starting again the instances.` 49 | 50 | #### Notes: 51 | 52 | - Function DOES modify EC2 Instances types (this will require a reboot) 53 | 54 | - Function DOES NOT modify EC2 Instances of an AutoScaling Group 55 | 56 | - You can set a Tag Key and Value to select the group of EC2 Instances to be evaluated 57 | 58 | - UPDATE: Now you can override the behaviour per instance with: 59 | -- Selection Tag Values of ACOO-OVER to apply Oversized recomendations, ACOO-UNDER to apply Undersized recomendations, ACOO-BOTH to apply both recommendations 60 | 61 | ## To-Do 62 | - Make a more restrict EC2 and KMS policy for the Lambda 63 | 64 | - A better error management 65 | 66 | - Evaluate the AutoScaling Group Recommendations 67 | 68 | - Improve SNS Notifications 69 | -------------------------------------------------------------------------------- /autoComputeOptimizer-template.yml: -------------------------------------------------------------------------------- 1 | # igarcia 2024-05 2 | # Version 2.3.1 3 | # Automation for Compute Optimizer Recommendations 4 | # Create a Scheduled Lambda with CloudWatch Event to implements Compute Optimizer Recommendations changes on EC2 Instances 5 | # Resources to create: Lambda, CloudWatch Event, IAM Role, SNS Topic 6 | # The AWS Account should be already signed up to AWS Compute Optimizer 7 | # IMPORTANT: The EC2 instances that you want to affect should endure a restart! 8 | # You can Schedule when will the restart occur 9 | # UPDATE 10 | # Now you can override the behaviour per instance with TAGBUSQUEDA's values of ACOO-OVER, ACOO-UNDER, ACOO-BOTH 11 | # Now You can specify exceptions of family, size, or type 12 | 13 | AWSTemplateFormatVersion: 2010-09-09 14 | Description: Template to automate the Compute Optimizer Recommendatios changes - v2.3.1 15 | 16 | Metadata: 17 | AWS::CloudFormation::Interface: 18 | ParameterGroups: 19 | - 20 | Label: 21 | default: "Stack Environment" 22 | Parameters: 23 | - TemplateAmbiente 24 | - 25 | Label: 26 | default: "Compute Optimizer Auto-Changes Setup" 27 | Parameters: 28 | - pType 29 | - pExceptions 30 | - pRisk 31 | - pDia 32 | - pHora 33 | - pTagBusqueda 34 | - pTagValor 35 | - pCorreo 36 | ParameterLabels: #Define Friendly Names 37 | TemplateAmbiente: 38 | default: "Value for CloudFormation Resources Env Tag" 39 | pDia: 40 | default: "Day of the week for Maintenance Window (restart)" 41 | pHora: 42 | default: "Time for the Restart in UTC" 43 | pType: 44 | default: "Default Type of Recommendations" 45 | pExceptions: 46 | default: "EC2 Instance type Exceptions" 47 | pRisk: 48 | default: "Tolerable Risk" 49 | pTagBusqueda: 50 | default: "Selection Tag Key, sets the Tag used to identified Instances for Automation of Compute Optimizer" 51 | pTagValor: 52 | default: "Selection Tag Value, sets the Value of the Tag to identified instances" 53 | pCorreo: 54 | default: "E-Mail Address to receive Notifications about changes applied. Leave default value for NO Notifications." 55 | 56 | Parameters: 57 | TemplateAmbiente: 58 | Type: String 59 | Description: "Tag Env to set on CloudFormation resources" 60 | Default: Test 61 | MaxLength: 10 62 | MinLength: 2 63 | ConstraintDescription: "Set a simple Tag between 2 and 10 characters long" 64 | pDia: 65 | Type: String 66 | Description: "Day of the week to apply the Recommendation" 67 | Default: "Mon" 68 | AllowedValues: ["Mon","Tue","Wed","Thu","Fri","Sat","Sun"] 69 | pHora: 70 | Type: String 71 | Description: "At what time, in 24 hours UTC time format ##:##, the Change will be applied" 72 | Default: "6:01" 73 | AllowedPattern: "^[0-2]?[0-9]:[0-5][0-9]$" 74 | ConstraintDescription: "Please set a time between 0:00 a 23:59" 75 | pRisk: 76 | Type: Number 77 | Description: "Set the tolerable Risk of the recommendation, 0 No Risk - 5 Very high, Default 2 (Low)" 78 | Default: 2 79 | MaxValue: 5 80 | MinValue: 0 81 | ConstraintDescription: "Please set a value between 0 and 5" 82 | pType: 83 | Type: String 84 | Description: "Default Recommendations to apply, Underprovisioned and/or Overprovisioned" 85 | Default: "Underprovisioned" 86 | AllowedValues: ["Underprovisioned","Overprovisioned","Both"] 87 | ConstraintDescription: "Set the recommendations to apply, you must choose at least one type." 88 | pExceptions: 89 | Type: String 90 | Description: "EC2 Instance Type Exceptions, a list of types, families or sizes. Ex: t2.micro, t3, small" 91 | Default: "nano" 92 | pTagBusqueda: 93 | Type: String 94 | Description: "Tag Key that identify EC2 Instances for automation of Compute Optimizer" 95 | Default: Optimized 96 | MaxLength: 20 97 | MinLength: 1 98 | ConstraintDescription: "Set a simple Tag between 2 and 20 characters long" 99 | pTagValor: 100 | Type: String 101 | Description: "Tag Value to identify EC2 Instances" 102 | Default: Auto 103 | MaxLength: 20 104 | MinLength: 1 105 | ConstraintDescription: "Please set a simple value without spaces" 106 | pCorreo: 107 | Type: String 108 | Description: "E-mail address for Notifications" 109 | Default: "not@notify.me" 110 | MaxLength: 50 111 | MinLength: 5 112 | ConstraintDescription: "Please write a valid e-mail address." 113 | 114 | Resources: 115 | TemplateSNS: 116 | Type: AWS::SNS::Topic 117 | Properties: 118 | DisplayName: !Join [ "-", [ "AutoComputeOptimizerTopic", !Ref TemplateAmbiente ] ] 119 | TopicName: !Join [ "-", [ "AutoComputeOptimizerTopic", !Ref TemplateAmbiente ] ] 120 | Subscription: 121 | - 122 | Endpoint: !Ref pCorreo 123 | Protocol: email 124 | Tags: 125 | - Key: Env 126 | Value: !Ref TemplateAmbiente 127 | 128 | TemplateRole: #Role for Lambda 129 | Type: AWS::IAM::Role 130 | Properties: 131 | AssumeRolePolicyDocument: 132 | Version: "2012-10-17" 133 | Statement: 134 | - 135 | Effect: "Allow" 136 | Principal: 137 | Service: 138 | - "lambda.amazonaws.com" 139 | Action: 140 | - "sts:AssumeRole" 141 | Description: Role to execute autoComputeOptimizer 142 | Policies: 143 | - 144 | PolicyName: !Join [ "-", [ "PolicyLambdaExec", !Ref TemplateAmbiente ] ] 145 | PolicyDocument: 146 | Version: "2012-10-17" 147 | Statement: 148 | - 149 | Effect: "Allow" 150 | Action: 151 | - "logs:CreateLogGroup" 152 | - "logs:CreateLogStream" 153 | - "logs:PutLogEvents" 154 | Resource: "*" 155 | - 156 | PolicyName: !Join [ "-", [ "PolicyLambdaEC2", !Ref TemplateAmbiente ] ] 157 | PolicyDocument: 158 | Version: "2012-10-17" 159 | Statement: 160 | - 161 | Effect: "Allow" 162 | Action: "ec2:*" 163 | Resource: "*" 164 | - 165 | PolicyName: !Join [ "-", [ "PolicyLambdaComputeOptimizer", !Ref TemplateAmbiente ] ] 166 | PolicyDocument: 167 | Version: "2012-10-17" 168 | Statement: 169 | - 170 | Effect: "Allow" 171 | Action: 172 | - "compute-optimizer:*" 173 | Resource: "*" 174 | - 175 | PolicyName: !Join [ "-", [ "PolicyLambdaSNS", !Ref TemplateAmbiente ] ] 176 | PolicyDocument: 177 | Version: "2012-10-17" 178 | Statement: 179 | - 180 | Effect: "Allow" 181 | Action: 182 | - "sns:*" 183 | Resource: !Ref TemplateSNS 184 | - 185 | PolicyName: !Join [ "-", [ "PolicyLambdaKMS", !Ref TemplateAmbiente ] ] 186 | PolicyDocument: 187 | Version: "2012-10-17" 188 | Statement: 189 | - 190 | Effect: "Allow" 191 | Action: 192 | - "kms:Encrypt" 193 | - "kms:Decrypt" 194 | - "kms:ReEncrypt*" 195 | - "kms:GenerateDataKey*" 196 | - "kms:DescribeKey" 197 | - "kms:CreateGrant" 198 | - "kms:ListGrants" 199 | - "kms:RevokeGrant" 200 | Resource: "*" 201 | RoleName: !Join [ "-", [ "RoleforAutoComputeOptimizer", !Ref TemplateAmbiente ] ] 202 | Tags: 203 | - Key: Env 204 | Value: !Ref TemplateAmbiente 205 | 206 | TemplateLambda: #Lambda to implement Recommendations 207 | Type: AWS::Lambda::Function 208 | Properties: 209 | Code: 210 | S3Bucket: !Join [ "-", [ "higher-artifacts", !Ref "AWS::Region" ] ] 211 | S3Key: "solutions/autocomputeoptimizer.zip" 212 | Description: Implements the recommendations of AWS Compute Optimizer by automation 213 | Environment: 214 | Variables: 215 | AMBIENTE: !Ref TemplateAmbiente 216 | RISK: !Ref pRisk 217 | TYPE: !Ref pType 218 | EXCEPTIONS: !Ref pExceptions 219 | TAGBUSQUEDA: !Ref pTagBusqueda 220 | TAGVALOR: !Ref pTagValor 221 | TOPIC: !Ref TemplateSNS 222 | CORREO: !Ref pCorreo 223 | FunctionName: !Join [ "-", [ "AutoComputeOptimizerLambda", !Ref TemplateAmbiente ] ] 224 | Role: !GetAtt TemplateRole.Arn 225 | Timeout: 800 226 | Handler: autocomputeoptimizer.lambda_handler 227 | Runtime: python3.12 228 | MemorySize: 256 229 | Tags: 230 | - 231 | Key: Env 232 | Value: !Ref TemplateAmbiente 233 | 234 | TemplateEventLambda: #Event to invoke Lambda 235 | Type: AWS::Events::Rule 236 | Properties: 237 | Description: Invoke Lambda for Compute Optimizer Automation 238 | Name: !Join [ "-", [ "AutoComputeOptimizerEvent", !Ref TemplateAmbiente ] ] 239 | ScheduleExpression: !Join [ "", [ "cron(",!Select [ 1, !Split [ ":", !Ref pHora] ]," ", !Select [ 0, !Split [ ":", !Ref pHora] ], " ? ","* ",!Ref pDia," *)" ] ] 240 | State: ENABLED 241 | Targets: 242 | - 243 | Arn: !GetAtt TemplateLambda.Arn 244 | Id: !Join [ "-", [!Ref TemplateAmbiente, "AutoComputeOptimizerLambda" ] ] 245 | 246 | TemplatePermisoEventLambda: #Relaciona permisos del Event con Lambda 247 | Type: AWS::Lambda::Permission 248 | Properties: 249 | FunctionName: !GetAtt TemplateLambda.Arn 250 | Action: "lambda:InvokeFunction" 251 | Principal: events.amazonaws.com 252 | SourceArn: !GetAtt TemplateEventLambda.Arn 253 | 254 | Outputs: #Outputs of the Template 255 | FrequencyAutoCO: 256 | Description: Frequency for Auto implement Compute Optimizer recommendations 257 | Value: !Join [ " ", [ "Every", !Ref pDia, "at", !Ref pHora, "UTC" ] ] 258 | Recommendations: 259 | Description: Type of recommendatios to implement automatically 260 | Value: !Ref pType 261 | Exceptions: 262 | Description: EC2 Instance types forbidden to be used 263 | Value: !Ref pExceptions 264 | TolerableRisk: 265 | Description: Tolerable Risk for the Recommendations (0 = very low - 5 = very high) 266 | Value: !Ref pRisk 267 | NotificationsEmail: 268 | Description: Email address for Notifications 269 | Value: !Ref pCorreo 270 | -------------------------------------------------------------------------------- /autocomputeoptimizer.py: -------------------------------------------------------------------------------- 1 | # igarcia 2024-05 2 | # Version 2.3.1 3 | # Automation for Compute Optimizer Recommendations 4 | # It will change the EC2 Instance Type to a Recommendation of the AWS Compute Optimizer Service and send an email about it 5 | # It won't do anything to AutoScaling Group's Instances 6 | # You can set a TAG Value for the instances that this Lambda can manage 7 | # IMPORTANT: your EC2 instance should endure a restart! 8 | 9 | # UPDATE 10 | # Now you can override the behaviour per instance with TAGBUSQUEDA's values of ACOO-OVER, ACOO-UNDER, ACOO-BOTH 11 | # Now You can specify exceptions of family, size, or type 12 | 13 | import os 14 | import json 15 | import boto3 16 | 17 | RISK = os.environ['RISK'] #de 0 a 5, 0 es sin riesgo y 5 es mucho riesgo (No Risk, Very Low, Low, Medium, High, Very High) 18 | TYPE = os.environ['TYPE'] # Overprovisioned, Underprovisioned or Both 19 | TAGBUSQUEDA = os.environ['TAGBUSQUEDA'] 20 | TAGVALOR = os.environ['TAGVALOR'] 21 | TOPIC = os.environ['TOPIC'] 22 | CORREO = os.environ['CORREO'] 23 | MENSAJE = "" 24 | OVERRIDES = ("ACOO-OVER","ACOO-UNDER","ACOO-BOTH") 25 | EXCEPTIONS = os.getenv('EXCEPTIONS', default='nano').split(',') 26 | EXCEPTIONS = [ exception.strip().lower() for exception in EXCEPTIONS] # To trimm and lowercase 27 | risk_text = {"0":"No Risk", "1":"Very Low Risk", "2":"Low Risk", "3":"Medium Risk", "4":"High Risk", "5":"Very High Risk"} 28 | 29 | ec2 = boto3.resource('ec2') 30 | co_client = boto3.client('compute-optimizer') 31 | sns = boto3.resource('sns') 32 | 33 | def review_compute_optimizer_recos(instance): 34 | global MENSAJE 35 | cambio = 0 36 | response = "" 37 | ec2_id = instance['instanceArn'].split('/')[1] #Instance ID 38 | ec2_name = instance['instanceName'] 39 | to_do = False # Flag to determine if Instance will be examined 40 | tag_value = "" # To check for overrides 41 | 42 | ec2_instance = ec2.Instance(ec2_id) 43 | ec2_prev_type = ec2_instance.instance_type 44 | ec2_tags = ec2_instance.tags 45 | for tag in ec2_tags: 46 | if tag['Key'] == TAGBUSQUEDA: 47 | if tag['Value'] == TAGVALOR: 48 | tag_value = TYPE # The type on Recommendation to apply 49 | elif tag['Value'] in OVERRIDES: 50 | tag_value = tag['Value'] # The override Recommendation to apply 51 | 52 | # Revision sobre los OVERRIDES 53 | # TYPE = ['Underprovisioned','Overprovisioned', 'Both'] 54 | # OVERRIDES = ACOO-OVER, ACOO-UNDER, ACOO-BOTH 55 | # instance['finding'] = 'OVER_PROVISIONED' 56 | if tag_value[0:4].upper() == instance['finding'][0:4].upper() or tag_value[0:4].upper() == "BOTH": 57 | to_do = True 58 | else: 59 | to_do = False 60 | 61 | if tag_value in OVERRIDES: 62 | if tag_value[5:9].upper() == instance['finding'][0:4].upper() or tag_value[5:9].upper() == "BOTH": 63 | to_do = True 64 | else: 65 | to_do = False 66 | 67 | if to_do: 68 | for option in instance['recommendationOptions']: 69 | ec2_prev_type = ec2_instance.instance_type 70 | ec2_new_type = option['instanceType'] 71 | if ec2_new_type in EXCEPTIONS: 72 | continue 73 | else: 74 | for part in ec2_new_type.split('.'): 75 | if part in EXCEPTIONS: 76 | ec2_prev_type = ec2_new_type # Para prevenir el cambio de tipo de Instancia 77 | if (int(option['performanceRisk']) <= int(RISK)) and (ec2_prev_type != ec2_new_type): # El riesgo debe ser aceptable y el tipo de Instancia debe cambiar 78 | #Hacer Cambio Tipo de Instancia 79 | if ec2_instance.state['Name'] == 'stopped': 80 | try: 81 | response = ec2_instance.modify_attribute(InstanceType={'Value':ec2_new_type}) 82 | response = ec2_instance.start() 83 | response = ec2_instance.wait_until_running() 84 | cambio = 1 85 | MENSAJE = MENSAJE + "Info: Instance " + ec2_name + " changed to " + ec2_new_type + "\n" 86 | print("Se modificó Instancia {} - {} de {} a tipo {} ".format(ec2_id, ec2_name, ec2_prev_type, ec2_new_type)) 87 | break 88 | except: 89 | ec2_instance.stop() 90 | ec2_instance.wait_until_stopped() 91 | ec2_instance.modify_attribute(InstanceType={'Value':ec2_prev_type}) 92 | ec2_instance.start() 93 | cambio = 0 94 | MENSAJE = MENSAJE + "Error: Instance " + ec2_name + " NOT changed to " + ec2_new_type + "\n" 95 | print(response) 96 | print("No se puedo modificar Instancia {} - {} a tipo {} ".format(ec2_id, ec2_name, ec2_new_type)) 97 | break 98 | elif ec2_instance.state['Name'] == 'running': 99 | try: 100 | response = ec2_instance.stop() 101 | response = ec2_instance.wait_until_stopped() 102 | response = ec2_instance.modify_attribute(InstanceType={'Value':ec2_new_type}) 103 | response = ec2_instance.start() 104 | response = ec2_instance.wait_until_running() 105 | cambio = 1 106 | MENSAJE = MENSAJE + "Info: Instance " + ec2_name + " changed to " + ec2_new_type + "\n" 107 | print("Se modificó Instancia {} - {} de {} a tipo {} ".format(ec2_id, ec2_name, ec2_prev_type, ec2_new_type)) 108 | break 109 | except: 110 | ec2_instance.stop() 111 | ec2_instance.wait_until_stopped() 112 | ec2_instance.modify_attribute(InstanceType={'Value':ec2_prev_type}) 113 | ec2_instance.start() 114 | cambio = 0 115 | MENSAJE = MENSAJE + "Error: Instance " + ec2_name + " NOT changed to " + ec2_new_type + "\n" 116 | print(response) 117 | print("No se puedo modificar Instancia {} - {} a tipo {} ".format(ec2_id, ec2_name, ec2_new_type)) 118 | break 119 | else: 120 | print("Opción {} recomendada no viable para instancia {} - {} ".format(ec2_new_type, ec2_id, ec2_name)) 121 | 122 | if response == "": 123 | MENSAJE = MENSAJE + "Info: Instance " + ec2_name + " with no viable options. \n" 124 | else: 125 | MENSAJE = MENSAJE + "Info: Nothing to do for Instance " + ec2_name + "\n" 126 | print("No se modificó Instancia {} - {}.".format(ec2_id, ec2_name)) 127 | 128 | return cambio 129 | 130 | def lambda_handler(event, context): 131 | total = 0 132 | cambios = 0 133 | global MENSAJE 134 | 135 | #if TYPE == "Both": 136 | # R_TYPE = ['Underprovisioned','Overprovisioned'] 137 | #else: 138 | # R_TYPE = [TYPE] 139 | R_TYPE = ['Underprovisioned','Overprovisioned'] 140 | 141 | MENSAJE = "" 142 | co_recos = co_client.get_ec2_instance_recommendations(filters=[{'name':'Finding','values':R_TYPE}]) 143 | for instance in co_recos['instanceRecommendations']: 144 | total+=1 145 | cambios = cambios + review_compute_optimizer_recos(instance) 146 | 147 | while 'nextToken' in co_recos: #Pagineo 148 | co_recos = co_client.get_ec2_instance_recommendations( 149 | nextToken=co_recos['nextToken'], 150 | filters=[{'name':'Finding','values':R_TYPE}] 151 | ) 152 | for instance in co_recos['instanceRecommendations']: 153 | total+=1 154 | cambios = cambios + review_compute_optimizer_recos(instance) 155 | 156 | the_message = "EC2 Instances updated "+str(cambios)+" of "+str(total)+" total recommendations:\n" 157 | print("Se realizaron {} cambios con éxito de un total de {} sugeridos.".format(cambios,total)) 158 | print("Limite indicador de Riesgo: {}".format(risk_text[RISK])) 159 | try: 160 | if CORREO != "not@notify.me": 161 | the_topic = sns.Topic(TOPIC) 162 | the_message = the_message + MENSAJE 163 | the_message = the_message + "\nDefined risk threshold to change instance type: " + risk_text[RISK] + "." + "\nMore information on Lambda log." 164 | response = the_topic.publish(Subject="AutoComputeOptimizer Notification", Message=the_message) 165 | except: 166 | print(response) 167 | print("Fallo al enviar mensaje por SNS.") 168 | return { 169 | 'statusCode': 200, 170 | 'body': json.dumps( 171 | 'Lambda finalizada exitosamente.' 172 | ) 173 | } -------------------------------------------------------------------------------- /autocomputeoptimizer.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Higherings/AutoComputeOptimizer/69b1b4b3645d25133b7533ef52efff5d65b618ee/autocomputeoptimizer.zip --------------------------------------------------------------------------------