README.rst 3.42 KB
Newer Older
Denis Laxalde's avatar
Denis Laxalde committed
1
2
3
.. image:: https://travis-ci.org/logilab/saemref-formula.svg?branch=master
    :target: https://travis-ci.org/logilab/saemref-formula

Philippe Pepiot's avatar
init  
Philippe Pepiot committed
4
5
6
7
===============
saemref-formula
===============

8
9
A saltstack formula handling installation of `saem_ref`_.

10
11
12
13
14
15
The formula will run two web application server, one dedicated to OAIPMH
request to serve ``/oai`` on port 8081 and one for other requests on port 8080.

To use them in a single port you may configure a reverse proxy, such as apache2
or nginx, on front of the instances.

Philippe Pepiot's avatar
init  
Philippe Pepiot committed
16
17
18
19
20
21
Available states
================

.. contents::
    :local:

Philippe Pepiot's avatar
Philippe Pepiot committed
22
23
24
25
26
``saemref``
-----------

Equivalent to ``saemref.install`` and ``saemref.config``.

27
28
29
``saemref.install``
-------------------

Philippe Pepiot's avatar
Philippe Pepiot committed
30
31
32
33
34
35
36
37
Installs the saemref package from logilab repositories and create an instance
for user ``saemref``.

Cubicweb config files are located in ``~saemref/etc/cubicweb.d/saemref`` and
``cubicweb-ctl`` can be invoked as user ``saemref`` with environment variable
``CW_MODE=user``.

The state require the installation of `epel-formula`_ and `postgres-formula`_
38
with version 9.4 (see ``pillar.example``).
39
40
41
42

``saemref.config``
------------------

Philippe Pepiot's avatar
Philippe Pepiot committed
43
44
45
46
47
Only manage instance configuration files.

``saemref.db-create``
---------------------

48
49
50
51
52
53
Create instance database with ``cubicweb-ctl db-create`` (call implicitly ``db-init``).

``saemref.db-init``
---------------------

Initialize instance database schema with ``cubicweb-ctl db-init``.
54
55
56
57
58

``saemref.supervisor``
----------------------

Install and manage `supervisor`_ configuration for the saemref installation.
59
60
61
62
Here is some useful commands:

- restart instance: ``supervisorctl restart saemref``
- restart supervisor: ``systemctl restart supervisord``
63

Philippe Pepiot's avatar
Philippe Pepiot committed
64

65
66
67
68
69
Requirements
============

If using postgres as database driver, ensure the `postgres contrib`_ package is
installed on server side.
Philippe Pepiot's avatar
Philippe Pepiot committed
70

71
72
73
74
75
76
77

Testing
=======

The script `run-test.py` can help to develop and test the formula using
`docker`_ and `testinfra`_.

Sylvain Thenault's avatar
Sylvain Thenault committed
78
79
The command ``./run-test.py dev centos7`` will build image from
``test/centos7.Dockerfile`` and span a shell in a new container with mounted
80
81
82
volumes from the host (so you can develop formula on the host and test it in
the container with ``salt-call``).

Sylvain Thenault's avatar
Sylvain Thenault committed
83
The command ``./run-test.py dev centos7 --salt`` is the same as above but will
84
85
provision the container (eg. calling ``salt-call state.highstate``)

Sylvain Thenault's avatar
Sylvain Thenault committed
86
The command ``./run-test.py test centos7`` built a provisioned image
87
88
89
(highstate) and run testinfra tests on it.

Note that you can add any parameters that testinfra (pytest) accept, for
Sylvain Thenault's avatar
Sylvain Thenault committed
90
instance ``./run-test.py test centos7 -- -k idempotence --pdb``.
91

Philippe Pepiot's avatar
init  
Philippe Pepiot committed
92

Philippe Pepiot's avatar
Philippe Pepiot committed
93
94
95
96
97
98
99
100
101
102
103
104
Testing migration
=================

Add dumps generated by ``cubicweb-ctl db-dump`` in the ``test/dumps`` directory, then::

    # To test upgrade against latest public changeset of http://hg.logilab.org/master/cubes/saem_ref
    ./run-tests.py test centos7 -- test/test_migration.py --upgrade-revision master

    # To test against any revision from http://hg.logilab.org/review/cubes/saem_ref
    ./run-tests.py test centos7 -- test/test_migration.py --upgrade-revision REV


105
106
107
108
.. _saem_ref: https://www.cubicweb.org/project/cubicweb-saem_ref
.. _supervisor: http://supervisord.org
.. _docker: https://www.docker.com/
.. _testinfra: https://testinfra.readthedocs.org/
Philippe Pepiot's avatar
Philippe Pepiot committed
109
110
.. _epel-formula: https://github.com/saltstack-formulas/epel-formula
.. _postgres-formula: https://github.com/saltstack-formulas/postgres-formula
111
.. _postgres contrib: https://www.postgresql.org/docs/current/static/contrib.html