SQL-based Fedora object persistence (Issue 1244) (#8)

* support SQL-based persistence

* support SQL-based object persistence

* use templates instead of default repository.json

* add missing quotes

* use ansible variables in repository.json instead of tomcat JAVA_OPTS

* remove outdated note

README.md

@@ -49,6 +49,30 @@ Path to put Fedora data directory
 fcrepo_data_dir: "{{ fcrepo_home_dir }}/fcrepo4-data"
 ```
 
+Path to put the Fedora data binaries directory
+```
+fcrepo_binary_directory: "{{ fcrepo_data_dir}}/binaries"
+```
+
+Which Fedora object persistence configuration to use
+```
+fcrepo_persistence: file-simple
+```
+
+If 'file-simple persistence' is used (default), where to keep the modeshape repository file
+```
+fcrepo_object_directory: "{{ fcrepo_data_dir}}/objects"
+```
+
+If either 'jdbc-mysql' or 'jdbc-postgres' are used for object persistence, the database settings
+```
+fcrepo_db_name: fcrepo
+fcrepo_db_user: fcrepo
+fcrepo_db_password: fcrepo
+fcrepo_db_host: "127.0.0.1"
+fcrepo_db_port: "3306"
+```
+
 Islandora uses the HeaderProvider to pass the users roles into Fedora. To use this you will need to set the below variable.
 
 Header name to acquire roles from
@@ -80,21 +104,6 @@ fcrepo_allowed_external_content:
       roles:
         - { role: islandora.fcrepo }
 
-## Notes
-
-This role only uses the fcrepo_data_dir to create a directory. To tell Fedora
-to use this directory you either need to incorporate the value into the
-[repository.json template](templates/repository.json) or add it to the Tomcat
-Java Opts. For example, if using
-[ansible-role-tomcat8](https://github.com/Islandora-Devops/ansible-role-tomcat8)
-adding the following to your inventory:
-```
-fcrepo_data_dir: "/data/fcrepo-data"
-
-tomcat8_java_opts:
-  - -Dfcrepo.binary.directory={{ fcrepo_data_dir }}
-```
-
 ## License
 
 MIT

defaults/main.yml

@@ -1,11 +1,25 @@
 fcrepo_version: 4.7.2
 fcrepo_user: "{{ tomcat8_server_user }}"
 fcrepo_data_dir: /var/lib/tomcat8/fcrepo4-data
+fcrepo_binary_directory: "{{ fcrepo_data_dir}}/binaries"
 fcrepo_war_path: "{{ tomcat8_home }}/webapps/fcrepo.war"
 fcrepo_home_dir: /opt/fcrepo
 fcrepo_activemq_template: activemq.xml.j2
 fcrepo_config_dir: "{{ fcrepo_home_dir }}/configs"
 
+# For file-simple object persistence.
+fcrepo_object_directory: "{{ fcrepo_data_dir}}/objects"
+
+# For production use either "jdbc-mysql" or "jdbc-postgresql"
+fcrepo_persistence: file-simple
+
+# Used for mysql or postgres object persistence. Please change the password locally!
+fcrepo_db_name: fcrepo
+fcrepo_db_user: fcrepo
+fcrepo_db_password: fcrepo
+fcrepo_db_host: "127.0.0.1"
+fcrepo_db_port: "3306"
+
 # External content paths can be directories or urls,
 # and they MUST end in /
 fcrepo_allowed_external_content:

tasks/config.yml

@@ -6,10 +6,17 @@
     group: "{{ fcrepo_user }}"
   with_items:
     - claw.cnd
-    - repository.json
     - fcrepo-config.xml
   notify: restart tomcat8
 
+- name: Copy templated repository.json
+  template:
+    src: "{{ fcrepo_persistence }}-repository.json"
+    dest: "{{ fcrepo_home_dir }}/configs/repository.json"
+    owner: "{{ fcrepo_user }}"
+    group: "{{ fcrepo_user }}"
+  notify: restart tomcat8
+
 - name: Copy fedora activemq configuration
   template:
     src: "{{ fcrepo_activemq_template }}"

tasks/db-mysql.yml

@@ -0,0 +1,14 @@
+---
+
+- name: Create Fedora DB (mysql)
+  mysql_db:
+    name: "{{ fcrepo_db_name }}"
+    state: present
+  register: fcrepo_db_exists
+
+- name: Create Fedora DB User (mysql)
+  mysql_user:
+    name: "{{ fcrepo_db_user }}"
+    password: "{{ fcrepo_db_password }}"
+    state: present
+    priv: "{{fcrepo_db_name}}.*:ALL"

tasks/db-pgsql.yml

@@ -0,0 +1,13 @@
+---
+
+- name: Create Fedora DB User (pgsql)
+  postgresql_user:
+    name: "{{ fcrepo_db_user }}"
+    password: "{{ fcrepo_db_password }}"
+
+- name: Create Fedora DB (pgsql)
+  postgresql_db:
+    name: "{{ fcrepo_db_name }}"
+    state: present
+    owner: "{{ fcrepo_db_user }}"
+  register: fcrepo_db_exists

tasks/main.yml

@@ -3,6 +3,21 @@
     - fcrepo
     - fcrepo-install
 
+- include: db-mysql.yml
+  when: fcrepo_persistence == 'jdbc-mysql'
+  tags:
+    - fedora
+    - fedora-install
+    - fedora-db
+
+- include: db-pgsql.yml
+  when: fcrepo_persistence == 'jdbc-postgresql'
+  become: yes
+  tags:
+    - fedora
+    - fedora-install
+    - fedora-db
+
 - include: config.yml
   tags:
     - fcrepo

templates/repository.json → templates/file-simple-repository.json

@@ -9,11 +9,11 @@
     "storage" : {
         "persistence": {
             "type": "file",
-            "path" : "${fcrepo.object.directory:target/objects}"
+            "path" : "{{ fcrepo_object_directory }}"
         },
         "binaryStorage" : {
             "type" : "file",
-            "directory" : "${fcrepo.binary.directory:target/binaries}",
+            "directory" : "{{ fcrepo_binary_directory }}",
             "minimumBinarySizeInBytes" : 4096
         }
     },

templates/jdbc-mysql-repository.json

@@ -0,0 +1,39 @@
+{
+    "name" : "repo",
+    "jndiName" : "",
+    "workspaces" : {
+        "predefined" : ["default"],
+        "default" : "default",
+        "allowCreation" : true,
+        "cacheSize" : 10000
+    },
+    "storage" : {
+        "persistence": {
+            "type" : "db",
+            "connectionUrl": "jdbc:mysql://{{ fcrepo_db_host }}:{{ fcrepo_db_port }}/{{ fcrepo_db_name }}?createDatabaseIfNotExist=true",
+            "driver" : "com.mysql.jdbc.Driver",
+            "username" : "{{ fcrepo_db_user }}",
+            "password" : "{{ fcrepo_db_password }}"
+        },
+        "binaryStorage" : {
+            "type" : "file",
+            "directory" : "{{ fcrepo_binary_directory }}",
+            "minimumBinarySizeInBytes" : 4096
+        }
+    },
+    "security" : {
+        "anonymous" : {
+            "roles" : ["readonly","readwrite","admin"],
+            "useOnFailedLogin" : false
+        },
+        "providers" : [
+            { "classname" : "org.fcrepo.auth.common.BypassSecurityServletAuthenticationProvider" }
+        ]
+    },
+    "garbageCollection" : {
+        "threadPool" : "modeshape-gc",
+        "initialTime" : "00:00",
+        "intervalInHours" : 24
+    },
+    "node-types" : ["fedora-node-types.cnd", "file:/opt/fcrepo/configs/claw.cnd"]
+}

templates/jdbc-postgresql-repository.json

@@ -0,0 +1,39 @@
+{
+    "name" : "repo",
+    "jndiName" : "",
+    "workspaces" : {
+        "predefined" : ["default"],
+        "default" : "default",
+        "allowCreation" : true,
+        "cacheSize" : 10000
+    },
+    "storage" : {
+        "persistence": {
+            "type" : "db",
+            "connectionUrl": "jdbc:postgresql://{{ fcrepo_db_host }}:{{ fcrepo_db_port }}/{{ fcrepo_db_name }}",
+            "driver" : "org.postgresql.Driver",
+            "username" : "{{ fcrepo_db_user }}",
+            "password" : "{{ fcrepo_db_password }}"
+        },
+        "binaryStorage" : {
+            "type" : "file",
+            "directory" : "{{ fcrepo_binary_directory }}",
+            "minimumBinarySizeInBytes" : 4096
+        }
+    },
+    "security" : {
+        "anonymous" : {
+            "roles" : ["readonly","readwrite","admin"],
+            "useOnFailedLogin" : false
+        },
+        "providers" : [
+            { "classname" : "org.fcrepo.auth.common.BypassSecurityServletAuthenticationProvider" }
+        ]
+    },
+    "garbageCollection" : {
+        "threadPool" : "modeshape-gc",
+        "initialTime" : "00:00",
+        "intervalInHours" : 24
+    },
+    "node-types" : ["fedora-node-types.cnd", "file:/opt/fcrepo/configs/claw.cnd"]
+}