Skip to content

Commit 4ee607e

Browse files
levkowetzlevkowetz
committed
Added a note on secretariat releases. Reformatted to resolve rst markup mistakes -- '$ rst2pdf INSTALL' now works.
 - Legacy-Id: 5556
1 parent 6820b49 commit 4ee607e

1 file changed

Lines changed: 83 additions & 62 deletions

File tree

‎INSTALL‎

Lines changed: 83 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ and finally restart apache::
3232

3333
sudo /etc/init.d/apache2 restart
3434

35-
It's now also a good idea to go to the datatracker front page:
35+
It's now also a good idea to go to the datatracker front page::
3636

3737
http://datatracker.ietf.org/
3838

@@ -51,88 +51,109 @@ datatracker is only intended to be deployed from scratch once, these instruction
5151
don't cover this. The general Django depoloyment instructions are relevant, however.
5252

5353

54+
Installing a Secretariat Release
55+
================================
56+
57+
Secretariat releases are based on a regular tagged release, but contain
58+
updated code in the ietf/secr/ tree. They are named with a trailing
59+
'.secr<N>' version number. If the tagged release is for instance 4.42, the
60+
first secretariat release based on that would have release number 4.42.secr1,
61+
and the second secretariat release based on it would be numbered 4.42.secr2.
62+
63+
Secretariat releases are deployed in the same manner as regular releases, with
64+
the addition that patches made to the regular release needs to be picked up
65+
and applied. Assuming we'releasing 4.42.secr2, then after we've cd'd into
66+
the release diretory to run migrations, we'd also run a patch step to pick
67+
up the current patches to the current production release, which is pointed
68+
to by ../web::
69+
70+
/a/www/ietf-datatracker/4.42.secr2 $ svn diff ../web/ | patch -p2
71+
72+
Assuming that runs without error messages, the deployment is continued as
73+
usual, with re-pointing the symlink and restarting apache.
74+
5475
Additional Version-Specific Instructions
5576
========================================
5677

5778
Version 4.42
5879
------------
5980

60-
- In order to serve the secretariat tools static pages (such as image, css and js
61-
files) the exceptions to which urls need to be handled by the python-handler
62-
must be updated.
63-
64-
In the datatracker test server, the following configuration has been used to
65-
make apache handle the static files, and Django the dynamic pages. The new
66-
part is the <LocationMatch/> which mentions /secr/. Adapt as needed for ietfa.
67-
68-
----------------
69-
# Logging and document root settings omitted
70-
71-
<Location "/">
72-
PythonPath "['/srv/www/ietfdb'] + sys.path"
73-
SetHandler python-program
74-
PythonHandler django.core.handlers.modpython
75-
SetEnv DJANGO_SETTINGS_MODULE ietf.settings
76-
PythonDebug On
77-
</Location>
78-
79-
<LocationMatch "^/(robots.txt|favicon.ico|images|css|js|media|error)(/|$)">
80-
SetHandler None
81-
</LocationMatch>
82-
83-
# New for secretariat tools:
84-
<LocationMatch "^/secr/(img|css|js|error)">
85-
SetHandler None
86-
</LocationMatch>
87-
88-
<Location "/accounts/login/">
89-
AuthType Digest
90-
AuthName "IETF"
91-
AuthUserFile /var/local/loginmgr/digest
92-
AuthGroupFile /var/local/loginmgr/groups
93-
AuthDigestDomain http://tools.ietf.org/
94-
Require valid-user
95-
</Location>
96-
97-
# Caching and compression settings omitted
98-
----------------
81+
- In order to serve the secretariat tools static pages (such as image, css and js
82+
files) the exceptions to which urls need to be handled by the python-handler
83+
must be updated.
84+
85+
In the datatracker test server, the following configuration has been used to
86+
make apache handle the static files, and Django the dynamic pages. The new
87+
part is the <LocationMatch/> which mentions /secr/. Adapt as needed for ietfa::
88+
89+
----------------
90+
# Logging and document root settings omitted
91+
92+
<Location "/">
93+
PythonPath "['/srv/www/ietfdb'] + sys.path"
94+
SetHandler python-program
95+
PythonHandler django.core.handlers.modpython
96+
SetEnv DJANGO_SETTINGS_MODULE ietf.settings
97+
PythonDebug On
98+
</Location>
99+
100+
<LocationMatch "^/(robots.txt|favicon.ico|images|css|js|media|error)(/|$)">
101+
SetHandler None
102+
</LocationMatch>
103+
104+
# New for secretariat tools:
105+
<LocationMatch "^/secr/(img|css|js|error)">
106+
SetHandler None
107+
</LocationMatch>
108+
109+
<Location "/accounts/login/">
110+
AuthType Digest
111+
AuthName "IETF"
112+
AuthUserFile /var/local/loginmgr/digest
113+
AuthGroupFile /var/local/loginmgr/groups
114+
AuthDigestDomain http://tools.ietf.org/
115+
Require valid-user
116+
</Location>
117+
118+
# Caching and compression settings omitted
119+
----------------
99120

100121
Version 4.40
101122
------------
102123

103-
- (DONE) Add ianasync user with an auth role in the "iana" group and an
104-
rfceditorsync user with an auth role in the "rfceditor" group (don't
105-
think Group(acronym="rfceditor") exists yet); IANA and RFC Editor need
106-
to know the passwords for the poke mechanism
107-
124+
- (DONE) Add ianasync user with an auth role in the "iana" group and an
125+
rfceditorsync user with an auth role in the "rfceditor" group (don't
126+
think Group(acronym="rfceditor") exists yet); IANA and RFC Editor need
127+
to know the passwords for the poke mechanism
128+
108129

109-
- (DONE) Make sure mailing list for iab-stream@iab.org is up (since we're now
110-
emailing that)
130+
- (DONE) Make sure mailing list for iab-stream@iab.org is up (since we're now
131+
emailing that)
111132

112-
- (DONE) Set rfc_must_published_later_than date in bin/iana-protocols-updates to today
133+
- (DONE) Set rfc_must_published_later_than date in bin/iana-protocols-updates to today
113134

114-
- (DONE) Run the 3 new doc South migrations
135+
- (DONE) Run the 3 new doc South migrations
115136

116-
- (DONE) New polling scripts, to be run every hour::
137+
- (DONE) New polling scripts, to be run every hour::
117138

118-
web/ietf/bin/iana-changes-updates
119-
web/ietf/bin/iana-protocols-updates
120-
web/ietf/bin/rfc-editor-index-updates (replaces mirror_rfc_index)
121-
web/ietf/bin/rfc-editor-queue-updates (replaces mirror_rfc_queue)
139+
web/ietf/bin/iana-changes-updates
140+
web/ietf/bin/iana-protocols-updates
141+
web/ietf/bin/rfc-editor-index-updates (replaces mirror_rfc_index)
142+
web/ietf/bin/rfc-editor-queue-updates (replaces mirror_rfc_queue)
122143

123-
- (DONE) Import old events from IANA::
144+
- (DONE) Import old events from IANA::
124145

125-
bin/iana-changes-updates --from="2005-01-01 00:00:00" --to="2013-01-31 00:00:00" --no-email
146+
bin/iana-changes-updates --from="2005-01-01 00:00:00" --to="2013-01-31 00:00:00" --no-email
126147

127-
- (DONE) Pipe IANA review emails to the datatracker. There used to be an action to pipe
128-
such mails to henrik@levkowetz.com, for testing this feature, but I haven't seen
129-
any in a little while, so I don't know if this has broken. Anyway, the iana review
130-
emails should be piped into::
148+
- (DONE) Pipe IANA review emails to the datatracker. There used to be an action to pipe
149+
such mails to henrik@levkowetz.com, for testing this feature, but I haven't seen
150+
any in a little while, so I don't know if this has broken. Anyway, the iana review
151+
emails should be piped into::
131152

132-
/www/ietf-datatracker/web/ietf/bin/iana-review-email
153+
/www/ietf-datatracker/web/ietf/bin/iana-review-email
133154

134155

135-
- (DONE) Tell IANA we're doing this for real now.
156+
- (DONE) Tell IANA we're doing this for real now.
136157

137158

138159
Version 4.34

0 commit comments

Comments
 (0)