Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml,v diff -u -r1.10 -r1.11 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml 18 Feb 2004 14:51:18 -0000 1.10 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml 20 Feb 2004 15:13:49 -0000 1.11 @@ -380,7 +380,7 @@ By Joel Aufrecht - This section describes minimal-risk methods for deploying changes on a production network. The important characteristics of a safe change deployment include: + This section describes minimal-risk methods for deploying changes on a production network. The important characteristics of a safe change deployment include: (THIS SECTION IN DEVELOPMENT) Control: You know for sure that the change you are making is the change that you intend to make and is the change that you tested. @@ -389,61 +389,87 @@ Rollback: If anything goes wrong, you can return to the previous working configuration safely and quickly. + + + Deployment with CVS + With this method, we control the files on a site via CVS. In this example, there is one development site and one production site. The only way files should move between the two is via cvs. The production site could run "HEAD" from cvs (raw example from chat log:) + +1) change the file on dev as desired +2) test the new file +3) commit the file: +if the file is /web/foo-dev/www/index.adp, do: + +cd /web/foo-dev/www +cvs diff index.adp (this is optional; it's just a +reality check) +the lines starting > will be added and the lines +starting < will be removed, when you commit +if that looks okay, commit with: +cvs -m "changing text on front page for February conference" index.adp +the stuff in -m "foo" is a comment visible only from within cvs commands +4) update the file on production: +cd /web/foo-prod/www +cvs up index.adp +The drawback to using HEAD as the live code is that you cannot commit new work on the development server without erasing the definition of 'working production code.' So a better method is to use a tag. This guarantees that, at any time in the future, you can retrieve exactly the same set of code. This is useful for both of the characteristics of safe change deployment. For control, you can use tags to define a body of code, test that code, and then know that what you are deploying is exactly that code. For rollback, you can use return to the last working tag if the new tag (or new, untagged changes) cause problems. .... example of using tags to follow ... + + + A/B Deployment The approach taken in this section is to always create a new service with the desired changes, running in parallel with the existing site. This guarantees control, at least at the final step of the process: you know what changes you are about to make because you can see them directly. It does not, by itself, guarantee the entire control chain. You need additional measures to make sure that the change you are making is exactly and completely the change you intended to make and tested previously, and nothing more. Those additional measures typically take the form of source control tags and system version numbers. The parallel-server approach also guarantees rollback because the original working service is not touched; it is merely set aside. This approach can has limitations. If the database or file system regularly receiving new data, you must interrupt this function or risk losing data in the shuffle. It also requires extra steps if the database will be affected. - - Simple Deployment: Database is not changed + + Simple A/B Deployment: Database is not changed
- Simple Deployment - Step 1 + Simple A/B Deployment - Step 1
- Simple Deployment - Step 2 + Simple A/B Deployment - Step 2
- Simple Deployment - Step 3 + Simple A/B Deployment - Step 3
-
- - Complex Deployment: Database is changed + + + Complex A/B Deployment: Database is changed
- Complex Deployment - Step 1 + Complex A/B Deployment - Step 1
- Complex Deployment - Step 2 + Complex A/B Deployment - Step 2
- Complex Deployment - Step 3 + Complex A/B Deployment - Step 3
+
@@ -661,3 +687,4 @@ ($Id$) + \ No newline at end of file