Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hakamine committed Mar 15, 2017
1 parent 5f49f96 commit d4758a5
Showing 1 changed file with 44 additions and 15 deletions.
59 changes: 44 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Role Variables

### General

- `archivematica_src_dir`: location where the source code repositories are cloned (default: user home)
- `archivematica_src_dir`: location where the source code repositories are cloned (default: /opt/archivematica)

### Projects

Expand All @@ -54,7 +54,7 @@ Role Variables
- `archivematica_src_reset_mcpdb`: set to true to re-create the MCP database (normally at runtime using `ansible-playbook` `--extra-vars` switch)
- `archivematica_src_reset_shareddir`: set to true to re-create the shared directory (normally at runtime using `ansible-playbook` `--extra-vars` switch)
- `archivematica_src_reset_es`: set to true to delete the ElasticSearch indexes (normally at runtime using `ansible-playbook` `--extra-vars` switch)
- `archivematica_src_reset_am_all`: set to true to re-create the MCP db, clear the shared directory and reset ElasticSearch indexes (normally at runtime using `ansible-playbook` `--extra-vars` switch). If true, it overrides the two vars above.
- `archivematica_src_reset_am_all`: set to true to re-create the MCP db, clear the shared directory and reset ElasticSearch indexes (normally at runtime using `ansible-playbook` `--extra-vars` switch). If true, it overrides the reset vars above.
- `archivematica_src_reset_ss_db`: set to true to re-create the SS database (normally at runtime using `ansible-playbook` `--extra-vars` switch)

### Legacy support
Expand Down Expand Up @@ -86,7 +86,9 @@ Role Variables
- `archivematica_src_ssl_fullchain`: (no default provided, shall be defined in the playbook or host_vars if SSL enabled)
- `archivematica_src_ssl_privkey`: (no default provided, shall be defined in the playbook or host_vars if SSL enabled)

### Pipeline venvs (added for 1.6.x)

- `archivematica_src_am_multi_venvs`: create separate virtualenvs for each pipeline component (dashboard, MCPServer, MCPClient) (default:`no`)

Tags
----
Expand Down Expand Up @@ -123,11 +125,18 @@ N/A yet.
Example Playbooks
----------------

Please note that a complete Archivematica installation includes software not installed by this role. See https://github.com/artefactual/deploy-pub/tree/master/playbooks/archivematica for a more complete example.
Please note that a complete Archivematica installation includes software not installed by this role, in particular:

It is also recommended to take backups of you system (Archivematica and Storage Service databases, AIPS, DIPS, etc) prior to running an upgrade.
- MySQL compatible database server (MySQL, MariaDB, Percona)
- ElasticSearch
- ClamAV (daemon and client)

1) For installing AM v1.4 (with SS v0.7):
See https://github.com/artefactual/deploy-pub/tree/master/playbooks/archivematica for a more complete example.

It is also recommended to take backups of your system (Archivematica and Storage Service databases, AIPS, DIPS, etc) prior to running an upgrade.


### Install AM v1.6 (with SS v0.10) using gunicorn/nginx, with virtualenv for pipeline components

```yaml
---
Expand All @@ -136,17 +145,19 @@ It is also recommended to take backups of you system (Archivematica and Storage
- role: "archivematica-src"
vars:
archivematica_src_dir: "/opt/archivematica"
archivematica_src_am_version: "stable/1.4.x"
archivematica_src_ss_version: "stable/0.7.x"
archivematica_src_am_version: "stable/1.6.x"
archivematica_src_ss_version: "stable/0.10.x"
archivematica_src_ss_env_django_secret_key: "mysecretkey"
archivematica_src_ss_run_syncdb: "true"
archivematica_src_ss_pip_missing_deps: "true"
archivematica_src_externals_repo: "ppa:archivematica/1.4"
archivematica_src_ss_gunicorn: "true"
archivematica_src_am_dashboard_gunicorn: "true"
archivematica_src_am_multi_venvs: "yes"

become: "yes"
```
2) For installing AM v1.5 (with SS v0.8) using gunicorn/nginx:
### Install AM v1.5 (with SS v0.9) using gunicorn/nginx
```yaml
---
Expand All @@ -156,15 +167,15 @@ It is also recommended to take backups of you system (Archivematica and Storage
vars:
archivematica_src_dir: "/opt/archivematica"
archivematica_src_am_version: "stable/1.5.x"
archivematica_src_ss_version: "stable/0.8.x"
archivematica_src_ss_version: "stable/0.9.x"
archivematica_src_ss_env_django_secret_key: "mysecretkey"
archivematica_src_ss_gunicorn: "true"
archivematica_src_am_dashboard_gunicorn: "true"

become: "yes"
```
3) For installing AM v1.5 (with SS v0.8) using gunicorn/nginx, with SSL:
### Install AM v1.5 (with SS v0.9) using gunicorn/nginx, with SSL
```yaml
---
Expand All @@ -174,7 +185,7 @@ It is also recommended to take backups of you system (Archivematica and Storage
vars:
archivematica_src_dir: "/opt/archivematica"
archivematica_src_am_version: "stable/1.5.x"
archivematica_src_ss_version: "stable/0.8.x"
archivematica_src_ss_version: "stable/0.9.x"
archivematica_src_ss_env_django_secret_key: "mysecretkey"
archivematica_src_ss_gunicorn: "true"
archivematica_src_am_dashboard_gunicorn: "true"
Expand All @@ -186,8 +197,26 @@ It is also recommended to take backups of you system (Archivematica and Storage
become: "yes"
```
### Install AM v1.4 (with SS v0.7)
```yaml
---
- hosts: "myserver"
roles:
- role: "archivematica-src"
vars:
archivematica_src_dir: "/opt/archivematica"
archivematica_src_am_version: "stable/1.4.x"
archivematica_src_ss_version: "stable/0.7.x"
archivematica_src_ss_env_django_secret_key: "mysecretkey"
archivematica_src_ss_run_syncdb: "true"
archivematica_src_ss_pip_missing_deps: "true"
archivematica_src_externals_repo: "ppa:archivematica/1.4"

become: "yes"
```
4) To upgrade a source-based AM v1.4 installation to v1.5 (SS v0.7 to v0.8) :
### Upgrade a source-based AM v1.4 installation to v1.5 (SS v0.7 to v0.8)
```yaml
---
Expand Down

0 comments on commit d4758a5

Please sign in to comment.