summaryrefslogtreecommitdiff
path: root/doc/onboarding.texi
blob: da65aadcc01b66f45fedb08e4dd71dcd81cf3149 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename onboarding.info
@include version.texi
@settitle Notes for taler.net admins and developers @value{VERSION}

@c Define a new index for options.
@defcodeindex op
@c Combine everything into one index (arbitrarily chosen to be the
@c concept index).
@syncodeindex op cp
@c %**end of header

@copying
Howtos for taler.net admins and developers (version @value{VERSION}, @value{UPDATED}),
Copyright @copyright{} 2017 INRIA

@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.  A copy of the license is included in the section entitled
``GNU Free Documentation License''.
@end quotation
@end copying
@c If your manual is published on paper by the FSF, it should include
@c The standard FSF Front-Cover and Back-Cover Texts, as given in
@c maintain.texi.
@c
@c Titlepage
@c
@titlepage
@title Notes for taler.net admins and developers
@subtitle Version @value{VERSION}
@subtitle @value{UPDATED}
@author Marcello Stanisci (@email{marcello@@taler.net})
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

@c @summarycontents
@contents

@ifnottex
@node Top
@top Notes for taler.net admins and developers
@insertcopying
@end ifnottex

@menu
* Taler.net::                           Sysadmins notes for server at taler.net
* Standalone deployment::               Deploy Taler in your homepage
* Deployment on demo.taler.net::        Deploy Taler in a "blue/green" fashion
* Releases::                            Releases patterns
@end menu

@node Taler.net
@chapter Taler.net

@section Git

Git at @code{taler.net} is managed by @emph{gitolite}.  Creation and deletion
of repositories, as well as users management, is done entirely by editing the
@code{gitolite.conf} file within the @code{gitolite-admin} repository.

Please refer to gitolite official documentation, if more information is needed:
@code{http://gitolite.com/gitolite/}.


This section documents the set-up of our main server @code{taler.net}.

@section Buildbot

@quotation Note
'worker' and 'slave' are used interchangeably
@end quotation

The user running the buildbot master is @emph{containers}.

@subsection Master

To start the master, log in as @emph{containers}, and run:

@example
$ ~/buildbot/start.sh

# To stop it, run:
$ ~/buildbot/stop.sh
@end example

There is also a "restart" script, runnable as follows:

@example
$ ~/buildbot/restart.sh
@end example

NOTE: the following command reloads the configuration without the
need to restart the bot.

@example
$ source ~/buildbot/venv/bin/activate
$ buildbot reconfig ~/buildbot/master/
@end example

@subsection Start/stop workers

@cartouche
@quotation
Every worker is run by a dedicated user in the system, and runs in
"virtualenv".  The latter is installed within
@code{<worker_home_dir>/buildbot/venv}. The worker setup lies into
@code{<worker_home_dir>/buildbot/<worker_setup>}, where @code{<worker_setup>}
has an "obvious" name, like @code{worker}, @code{slave}, @code{<worker_username>},
@code{<builder_name>} or any combination of these.

The following commands show how to start and stop a worker.

@example
# log in as the worker user.
# cwd is $HOME.

# this activated the virtualenv.
$ source buildbot/venv/bin/activate

# this starts the worker.
$ buildbot-worker start buildbot/<worker_setup>

# this stops the worker.
$ buildbot-worker stop buildbot/<worker_setup>

@end example

@end quotation
@end cartouche

@subsection Debug worker

This worker is used to test the Buildbot and it is run by the
user @code{debug-builder}.  Its scheduler monitors @code{help.git},
which is the repository where debug pushes have to be done.

Note that this worker might not be activated all the time, as it
is not needed by any production codebase.

@subsection Python linter
This worker is responsible for running Python static analysis, and it
is served by the user @code{linter}.

@subsection Documentation worker

This worker is responsible for building all the documentation on
@code{https://docs.taler.net}.  It is run by the user @code{docbuilder},
whose home directory must have all the repositories with documentation
to be built.  Namely,

@itemize
@item @emph{exchange}
@item @emph{merchant}
@item @emph{merchant-frontend-examples}
@item @emph{deployment} - because of "onboarding" documentation
@item @emph{api}
@end itemize

@cartouche
@quotation Note
use the @code{--umask=022} option when creating this worker,
because Buildbot gives default @code{077} umask to its processes
and this makes generated files unreadable.
@end quotation
@end cartouche

@subsection Wallet worker
This worker is responsible for running wallet testcases.  It is run
by the @emph{containers} user.

@subsection Selenium worker
This worker is responsible for running the Selenium wallet test:
an automatic clicker that performs the cycle withdraw-and-spend.

The @emph{containers} user is also responsible for running the Selenium
buildbot worker.

@subsection Lcov worker

The worker is implemented by the @emph{lcovslave} user and is responsible
for generating the HTML showing the coverage of our tests, then available
on @emph{https://lcov.taler.net}.

@b{NOTE:} a Postgres "per-user" database service should always
be running, as @emph{lcovslave} is deployed in a standalone environment.

Start the database service in the following way:

@example
# Assuming you already sourced ~/activate
$ taler-deployment-arm -s
$ taler-deployment-arm -i taler-postgres-standalone
# Stop it this way:
$ taler-deployment-arm -k taler-postgres-standalone
# To stop 'arm', issue:
$ taler-deployment-arm -e
@end example

@subsection Switcher worker

Taler.net uses a "blue/green" fashion to update the code it
uses in demos.  Practically, there are two users: @emph{test-green}
and @emph{test-blue}, and only one of them is "active" at any time.

Being @emph{active} means that whenever nginx receives a HTTP request
for one of the Taler services (at our demo), it routes the request
to either test-blue or test-green via unix domain sockets.

Upon any push to any of the Taler's subprojects, this worker is
responsible for building the code hosted at the inactive user and,
if all tests succeed, switching the active user to the one whose code
has just been compiled and tested.

The worker is implemented by the @emph{testswitcher} user. This user
has some additional "sudo" rights, since it has to act as @emph{test-blue},
`test-gree@emph{$1}est` user in order to accompish its task.
Note that the "sudo file" is tracked in this (@emph{deployment}) repository,
under the @emph{sudoers} directory.

@subsection Manual switch

After the desired blue/green party has been compiled, it is possible to
log-in as @emph{test} and run the script @code{$HOME/.ln-<COLOR>.sh}, in order to make
@code{test-<COLOR>} active.

@subsection Website lcov.taler.net

The directory @code{/var/www/lcov.taler.net} contains the following
two symlinks

@itemize
@item exchange --> @code{/home/lcovslave/exchange/doc/coverage}
@item merchant --> @code{/home/lcovslave/merchant/doc/coverage}
@end itemize

The pointed locations are updated by the @emph{lcovslave}.

@subsection Hooks

Whenever a push occurs into one of Taler repositories, Buildbot gets
notified via the Git @emph{hooks} system.

We use the hook in [1].

Following a @emph{gitolite}-policy, all the hook must be committed under
@code{gitolite-admin/local/hooks/repo-specific/post-receive.buildbot},
so that gitolite will copy it in the right place -- the sysadmin does @strong{not}
have to manually move it.

Once the hook is versioned under gitolite, every repository meant to benefit
from it must get the @code{option hook.pre-receive = pre-receive.buildbot}
statement from the gitolite config file.

On the Buildbot side, we need to allow the hook to connect to the build master.
This is done by defining a @code{PBChangeSource} class in the following way:
@example
cs = changes.PBChangeSource(user='tony', passwd='hey')
@end example
NOTE: those credentials must match the ones in the hook; change the top
level variables @code{username} and @code{auth} in the hook to suit your setup.

The following line will finally "activate" the hook within the build master:
@example
c['change_source'].append(cs)
@end example

From now on, every buildbot scheduler will receive notifications from @code{cs}
and verify if there is a match with the @code{ChangeFilter} driving the scheduler.
If there is a match, the scheduler will fire its builders up, otherwise no action
is taken.

[1] @url{https://github.com/buildbot/buildbot-contrib/blob/master/master/contrib/git_buildbot.py}

@node Standalone deployment
@chapter Standalone deployment


This tecnique aims to set a thorough Taler installation up on a
machine whose nginx configuration is configured by config files
from @emph{https://git.taler.net/deployment.git/tree/etc/nginx}.

This installation assumes that all the steps are run with @code{$HOME}
as @code{$CWD}.

The first step is to fetch the @cite{deployment} repository, which hosts all
the needed scripts.

@example
# Adapt the repository's URI to your needs.
$ git clone /var/git/deployment.git/
@end example

The next step is to fetch all the codebases from all the components.

@example
$ ./deployment/bootstrap-standalone
@end example

If the previous step succeeded, a file named @code{activate} should be now
in the @code{$CWD}.  It contains environmental definitions for @code{$PATH} and
database names.

@cartouche
@quotation Note
Please @emph{ignore} the output from the previous script when it succeeds,
which is

@quotation

@smallexample
WARNING: enabling "trust" authentication for local connections
You can change this by editing pg_hba.conf or using the option -A, or
--auth-local and --auth-host, the next time you run initdb.

Success. You can now start the database server using:

/usr/lib/postgresql/9.5/bin/pg_ctl -D talerdb -l logfile start
@end smallexample

The reason is that this message is generated by Postgresql's utilities and
you never need to start your database manually; it will be started by the
init script that launches all the Taler processes.
@end quotation
@end quotation
@end cartouche

Now we need to compile and install all the downloaded codebases.

@example
# We first update `@w{`}$PATH`@w{`}, in order to make all the compilation
# and configuration utilities available.
$ source activate

# Double check if the previous step worked: $PATH should
# contain $HOME/local/bin.
$ echo $PATH

# Then we need to install GNUnet beforehand, as it provides the 'ARM'
# utility that is used to start the database service.
$ cd deployment/taler-arm/
$ make gnunet-stamp

# Now we can start the database, with ($CWD is irrelevant now):
$ taler-deployment-arm -s
$ taler-deployment-arm -i taler-postgres-standalone

# Configuration file can be generated now.
$ taler-deployment-config-generate

# If the previous commands succeeded, then we can install all the remaining
# components and run checks for them.  Issue:
$ taler-deployment-build
@end example


The following one will place signatures inside wireformat JSON files.

@example
$ taler-deployment-config-sign
@end example

The next step is to generate @cite{signkeys} and @cite{denomkeys}.
Note that it will also get the denomkeys signed by the (local mock)
auditor.

@example
$ taler-deployment-keyup
@end example

@cartouche
@quotation Note

A database error about non existent auditor-related tables might be
returned while generating keys.  Fix it by running:

@smallexample
taler-auditor -m $(taler-config -s exchange -o master_public_key) -r
@end smallexample

This is likely to happen after database resets, and @code{taler-auditor}
is responsible for creating all auditor-related tables.
@end quotation
@end cartouche


@c An error of "invalid currency name" might be related to the current
@c policy of 12-chars limit for currency names; which is likely going to
@c be changed.

It may be necessary to define database tables for the exchange.  The
following command does that.

Note that you have to manually start the database, with the following
command.

@example
taler-deployment-arm -s
taler-deployment-arm -i taler-postrges-standalone
@end example

@example
# Erase all the data!
$ taler-exchange-dbinit -r
@end example

As of the merchant backend, it creates tables at launch time, so it is
not required to define tables before launching it.  @cite{However}, if some
table's definition changed over the time, and there is a need to force
a redefinition of tables, then the following command accomplishes that
for the merchant:

@example
# Erase all the data!
$ taler-merchant-dbinit -r
@end example

If all previous steps succeeded, it is now possible to launch all the
processes.  That is accomplished by the following command:

@example
$ taler-deployment-start
@end example

@cartouche
@quotation Note
Please make sure your nginx works correctly with its configuration
at @code{<DEPLOYMENT-REPO>/etc/nginx}.
@end quotation
@end cartouche

@node Deployment on demo.taler.net
@chapter Deployment on demo.taler.net

This section describes how to upgrade the whole Taler setup on the
@url{taler.net} Web site.  Here, the deployment scripts include a
``stable'' setup at @url{demo.taler.net} and an ``experimental'' setup
at @url{test.taler.net}.  This section documents the steps for moving
the ``experimental'' logic to the ``stable'' site.  It is mostly
useful for administrators of @url{taler.net}, but given that all of
the configuration files are public, it may also make a good starting
point for others.


@c FIXME: what does this line mean?
First, make sure that the deployment @emph{AND} the deployment scripts work on the @cite{test.taler.net} deployment.

For all repositories that have a separate stable branch (currently exchange.git,
merchant.git, donations.git, blog.git, bank.git, landing.git) do:

@example
$ cd $REPO
$ git pull origin master stable
$ git checkout stable

# option a: resolve conflicts resulting from hotfixes
$ git merge master
$ ...

# option b: force stable to master
$ git update-ref refs/heads/stable master

$ git push # possibly with --force

# continue development
$ git checkout master
@end example

Log into taler.net with the account that is @emph{not} active by looking
at the @cite{sockets} symlink of the @cite{demo} account.

The following instructions wipe out the old deployment completely.

@example
$ ls -l ~demo/sockets

[...] sockets -> /home/demo-green/sockets/
@end example

In this case, @cite{demo-green} is the active deployment, and @cite{demo-blue} should be updated.
After the update is over, the @cite{/home/demo/sockets} symlink will be pointed to @cite{demo-blue}.

@example
# Remove all existing files; this won't delete dot-files.
$ rm -fr *

$ git clone /var/git/deployment.git
# Pick color depending on which one is inactive and being rebuilt.
$ ./deployment/bootstrap-bluegreen demo [blue|green]

# set environment appropriately
$ . activate
$ taler-deployment-build

# (re)generate configuration
$ taler-deployment-config-generate

# generate signatures
$ taler-deployment-config-sign

# upgrade the database!  this process depends on the specific
# version.  However, exchange and merchant have the
# taler-@{exchange,merchant@}-dbinit -r command that resets all
# the tables; the bank might need a tables reset too: refer to
# django documentation for how to apply migrations to the database.

# generate denomination keys: this is OPTIONAL,
# as the keys under ~/shared-data might be okay
# to use.
$ taler-deployment-keyup

$ taler-deployment-start

# look at the logs, verify that everything is okay
@end example

Now the symlink can be updated.

@node Releases
@chapter Releases

@section Release Process and Checklists

This document describes the process for releasing a new version of the various
Taler components to the official GNU mirrors.

The following components are published on the GNU mirrors

@itemize
@item taler-exchange (exchange.git)
@item taler-merchant (merchant.git)
@item talerdonations (donations.git)
@item talerblog (blog.git)
@item taler-bank (bank.git)
@item taler-wallet-webex (wallet-webex.git)
@end itemize

@section Tagging

Tag releases with an @b{annotated} commit, like

@example
git tag -a v0.1.0 -m "Official release v0.1.0"
git push origin v0.1.0
@end example

@section Database for tests

For tests in the exchange and merchant to run, make sure that
a database @emph{talertest} is accessible by @emph{$USER}.  Otherwise tests
involving the database logic are skipped.

@section Exchange, merchant

Set the version in @code{configure.ac}.  The commit being tagged
should be the change of the version.

For the exchange test cases to pass, @code{make install} must be run first.
Without it, test cases will fail because plugins can't be located.


@example
./bootstrap
./configure # add required options for your system
make dist
tar -xf taler-$COMPONENT-$VERSION.tar.gz
cd taler-$COMPONENT-$VERSION
make install check
@end example


@section Wallet WebExtension

The version of the wallet is in @emph{manifest.json}.  The @code{version_name} should be
adjusted, and @emph{version} should be increased independently on every upload to
the WebStore.

@example
./configure
make dist
@end example

@c FIXME: selenium test cases


@section Upload to GNU mirrors

See @emph{https://www.gnu.org/prep/maintain/maintain.html#Automated-FTP-Uploads}

Directive file:

@example
version: 1.2
directory: taler
filename: taler-exchange-0.1.0.tar.gz
@end example

Upload the files in @b{binary mode} to the ftp servers.

@bye