python deployment process based on buildout and mr.developer
bda.recipe.deployment offers a deployment cycle and helper scripts for buildout based projects.
While in small projects pinning checkout revisions or package versions in order to deploy reconstructable setups works fine, the same strategy runs out of it’s possibilities as soon as it comes to deployment of projects where steps needed to publish a new feature not always follow a consistent and repeating cycle.
Consider following example. A customer comes up with two feature requests. The customer always communicates with the project manager, from customer point of view the cycle is clear. Each feature must be tested and after approving the rollout could be made. Now the developer imlements feature one, and while the first feature waits for testing and approval, he wants to implement second one without influence to the approval cycle.
The deployment cycle consists of three possible installations, further called environments:
- The development environment is used to develop features on developers local maschine.
- Release Candidate
- The environment on the testing maschine accessible for customers testing.
- The tested and stable live system.
- Developer uses dev.cfg. If changes were done bin/deploy candidate MODULENAME NEWVERSION is called. Modules RC-branch is created/synced and the sources section in file for rc environment is modified and committed.
- Release Manager uses rc.cfg on its testing checkout. After svn/git update and buildout (re-)run the setup contains all release candidates branches. Software can be tested. In a second cycle Release Manager can merge changes from development branch into rc branch.
- Release Manager decides to release a package after testing for live-usage. In rc-environment bin/deploy release MODULENAME is called and the egg is uploaded to the configured eggserver or saved local. The live-versions section in file for live-environment is modifed and committed.
- Live-System-Administrator uses live.cfg on the live-deployment maschine. After git/svn up and buildout (re-)run the most recent releases are available.
Optional (if configured) the RC steps 2 and 3 can be omitted and a release may happen from dev direct to live.
While Developer and Release Candidate needs the add-on mr.developer, Live does not it.
Proposed buildout structure:
dev.cfg (manual) rc.cfg (manual) live.cfg (manual) etc/base.cfg (manual) etc/deployment.cfg (manual) etc/sources-dev.cfg (manual) etc/sources-rc.cfg (generated) etc/versions-rc.cfg (generated) etc/versions-live.cfg (generated) cfg/versions-global.cfg (manual, optional)
Contains parts for local development, includes developer tools if necessary. Included parts:
Contains parts for local on a test-server. Included parts:
Contains parts for deployment on a live-server. Included parts:
- contains all common sections and settingsof the buildout needed by all three types of environment.
- Contains deployment specific sections and settings, such as parameters for deployment and list of managed packages and which dist-server to use.
- Contains the common version section. In smaller projects this can be put in base.cfg
- Contains the sources-section for all developer controlled sources.
- Contains the sources for Release-Candidate setup. This file is generated by scripts. It points to the automatically created branches.
- Contains the versions of developer controlled sources used in rc-deployment. This are the packages which do not need a RC step. This file is generated by scripts.
- Contains the versions of developer controlled sources used in live-deployment. This file is generated by scripts.
In buildouts bin directory there are two main commands which itself have a bunch of sub commands, the deploy and the bda_deployment_helper. Latter is rarely used, i.e. you may need it to fix things. So the main tool for the daily usage is deploy.
Main command for all daily tasks.
Subcommands are context sensitive. In dev environment there are other commands available than in RC enviroment.
So in dev environment this are:
- sets the username/ password for the pypi server
- prints info about managed packages.
- prints version of a package.
- prepare a release candidate for a package, this includes creation of a branch.
- make a release of a package, this includes tagging and upload to the index (or local file release) and setting the version in versions-rc.cfg and versions-live.cfg.
In rc environment the commands are:
- see above.
- see above.
- see above.
- make a release of a package, this includes tagging and upload to the index (or local file release) and setting the version in versions-live.cfg.
- merge current trunk/master branch of a package into the rc branch.
All commands and subcommands have a help to find their paramaters.
The sources are in a GIT DVCS with its main branches at github.
We’d be happy to see many forks and pull-requests to make it even better.
- Jens W. Klein <jk [at] kleinundpartner [dot] at>
- Robert Niederrreiter <rnix [at] squarewave [dot] at>
Copyright (c) 2010-2012, BlueDynamics Alliance, Austria, Switzerland, Germany
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The “Program”, below, refers to any such program or work, and a “work based on the Program” means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term “modification”.) Each licensee is addressed as “you”.
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
You may copy and distribute verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
- 2 You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients’ exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
- BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS