add ArtifactStore implementation for MongoDB

Co-authored-by: Chetan Mehrotra <[email protected]>
Co-authored-by: jiangpengcheng <[email protected]>

Author: jiangpengcheng

ansible/README.md

@@ -98,6 +98,15 @@ db_host=
 db_port=
 ```
 
+or
+```bash
+db_username=
+db_password=
+mongodb_replicaSet=
+mongodb_database=
+```
+if you want to use MongoDB.
+
 This file is generated automatically if you are using an ephermeral CouchDB instance. Otherwise, you must create it explicitly.
 For convenience, you can use shell environment variables that are read by the playbook to generate the required `db_local.ini` file as shown below.
 
@@ -121,8 +130,13 @@ export OW_DB_PASSWORD=<your cloudant password>
 export OW_DB_PROTOCOL=https
 export OW_DB_HOST=<your cloudant user>.cloudant.com
 export OW_DB_PORT=443
+# below variables are for mongodb
+export OW_MONGODB_REPLICASER=<your mongodb replicaset name>
+export OW_MONGODB_DATABASE=<your mongodb database name>
 
 ansible-playbook -i environments/<environment> couchdb.yml --tags ini
+# or below for mongodb
+ansible-playbook -i environments/<environment> mongodb.yml --tags ini
 ```
 
 #### Install Prerequisites
@@ -187,6 +201,24 @@ data that include actions and activations are lost.
 
 Use `ansible-playbook -i environments/<environment> openwhisk.yml` to avoid wiping the data store. This is useful to start OpenWhisk after restarting your Operating System.
 
+### Deploying Using MongoDB
+-   Make sure your `db_local.ini` file is [setup for](#setup) MongoDB then execute:
+
+```
+cd <openwhisk_home>
+./gradlew distDocker
+cd ansible
+ansible-playbook -i environments/<environment> mongodb.yml
+ansible-playbook -i environments/<environment> initdb.yml -e database_backend=MongoDB
+ansible-playbook -i environments/<environment> wipe.yml -e database_backend=MongoDB
+ansible-playbook -i environments/<environment> apigateway.yml
+ansible-playbook -i environments/<environment> openwhisk.yml
+ansible-playbook -i environments/<environment> postdeploy.yml
+```
+You need to run `initdb.yml` **every time** you do a fresh deploy MongoDB to initialize the subjects database.
+The playbooks `wipe.yml` and `postdeploy.yml` should be run on a fresh deployment only, otherwise all transient
+data that include actions and activations are lost.
+
 ### Configuring the installation of `wsk` CLI
 There are two installation modes to install `wsk` CLI: remote and local.
 

ansible/environments/distributed/group_vars/all

@@ -10,6 +10,9 @@ db_password: couch_password
 db_host: "{{ groups['db'] | first }}"
 db_prefix: whisk_distributed_
 
+mongodb_database: whisks
+mongodb_replicaSet: whisk_replica_set
+
 whisk_version_name: distributed
 config_root_dir: /tmp/wskconf
 whisk_logs_dir: /tmp/wsklogs

ansible/environments/docker-machine/group_vars/all

@@ -25,6 +25,8 @@ db_password: "{{ lookup('ini', 'db_password section=db_creds file={{ playbook_di
 db_protocol: "{{ lookup('ini', 'db_protocol section=db_creds file={{ playbook_dir }}/db_local.ini') }}"
 db_host: "{{ lookup('ini', 'db_host section=db_creds file={{ playbook_dir }}/db_local.ini') }}"
 db_port: "{{ lookup('ini', 'db_port section=db_creds file={{ playbook_dir }}/db_local.ini') }}"
+mongodb_database: "{{ lookup('ini', 'mongodb_database section=db_creds file={{ playbook_dir }}/db_local.ini') }}"
+mongodb_replicaSet: "{{ lookup('ini', 'mongodb_replicaSet section=db_creds file={{ playbook_dir }}/db_local.ini') }}"
 
 # API GW connection configuration
 apigw_auth_user: ""

ansible/environments/local/group_vars/all

@@ -19,6 +19,8 @@ db_password: "{{ lookup('ini', 'db_password section=db_creds file={{ playbook_di
 db_protocol: "{{ lookup('ini', 'db_protocol section=db_creds file={{ playbook_dir }}/db_local.ini') }}"
 db_host: "{{ lookup('ini', 'db_host section=db_creds file={{ playbook_dir }}/db_local.ini') }}"
 db_port: "{{ lookup('ini', 'db_port section=db_creds file={{ playbook_dir }}/db_local.ini') }}"
+mongodb_database: "{{ lookup('ini', 'mongodb_database section=db_creds file={{ playbook_dir }}/db_local.ini') }}"
+mongodb_replicaSet: "{{ lookup('ini', 'mongodb_replicaSet section=db_creds file={{ playbook_dir }}/db_local.ini') }}"
 
 # API GW connection configuration
 apigw_auth_user: ""

ansible/group_vars/all

@@ -205,6 +205,8 @@ nginx:
 # The key db.whisk.auth is the name of the authentication database where all keys of all users are stored.
 # The db_prefix is defined for each environment on its own. The CouchDb credentials are also defined for each environment on its own.
 db:
+  backend: "{{ database_backend | default('CouchDB') }}"
+  confdir: "{{ config_root_dir }}/database"
   instances: "{{ groups['db'] | length }}"
   authkeys:
   - guest
@@ -213,6 +215,17 @@ db:
     actions: "{{ db_prefix }}whisks"
     activations: "{{ db_prefix }}activations"
     auth: "{{ db_prefix }}subjects"
+  mongodb:
+    port: "{{ mongodb_port | default('27017') }}"
+    version: 3.6.3
+    data_volume: "{{ mongodb_data_volume | default('mongo-data') }}"
+
+database_spi: "{% if db.backend == 'MongoDB' %}whisk.core.database.mongodb.MongoDbStoreProvider{% else %}whisk.core.database.CouchDbStoreProvider{% endif %}"
+mongodb_connect_string: "{% set ret = [] %}\
+                         {% for host in groups['db'] %}\
+                           {{ ret.append( hostvars[host].ansible_host + ':' + db.mongodb.port) }}\
+                         {% endfor %}\
+                         {{ ret | join(',') }}"
 
 apigateway:
   port:

ansible/initdb.yml

@@ -7,3 +7,4 @@
 - hosts: ansible
   tasks:
   - include_tasks: tasks/initdb.yml
+    run_once: True

ansible/mongodb.yml

@@ -0,0 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more contributor
+# license agreements; and to You under the Apache License, Version 2.0.
+---
+# This playbook deploys a MongoDB for Openwhisk.
+
+- hosts: localhost
+  tasks:
+  - name: check if db_local.ini exists?
+    tags: ini
+    stat: path="{{ playbook_dir }}/db_local.ini"
+    register: db
+
+  - name: prepare db_local.ini
+    tags: ini
+    local_action: template src="db_local.ini.j2" dest="{{ playbook_dir }}/db_local.ini"
+    when: not db.stat.exists
+
+- hosts: db
+  roles:
+    - mongodb
+
+  post_tasks:
+    - import_tasks: tasks/initMongoDBReplicaSet.yml
+      when: mode == "deploy"

ansible/roles/controller/tasks/deploy.yml

@@ -170,6 +170,14 @@
       "CONFIG_whisk_couchdb_databases_WhiskEntity": "{{ db.whisk.actions }}"
       "CONFIG_whisk_couchdb_databases_WhiskActivation":
         "{{ db.whisk.activations }}"
+      "CONFIG_whisk_mongodb_hosts": "{{ mongodb_connect_string }}"
+      "CONFIG_whisk_mongodb_username": "{{ db_username }}"
+      "CONFIG_whisk_mongodb_password": "{{ db_password }}"
+      "CONFIG_whisk_mongodb_replicaSet": "{{ mongodb_replicaSet}}"
+      "CONFIG_whisk_mongodb_database": "{{ mongodb_database }}"
+      "CONFIG_whisk_mongodb_collections_WhiskAuth": "{{ db.whisk.auth }}"
+      "CONFIG_whisk_mongodb_collections_WhiskEntity": "{{ db.whisk.actions }}"
+      "CONFIG_whisk_mongodb_collections_WhiskActivation": "{{ db.whisk.activations }}"
       "CONFIG_whisk_db_actionsDdoc": "{{ db_whisk_actions_ddoc | default() }}"
       "CONFIG_whisk_db_activationsDdoc": "{{ db_whisk_activations_ddoc | default() }}"
       "CONFIG_whisk_db_activationsFilterDdoc": "{{ db_whisk_activations_filter_ddoc | default() }}"
@@ -232,6 +240,7 @@
       "CONFIG_whisk_spi_LogStoreProvider": "{{ userLogs.spi }}"
       "CONFIG_whisk_spi_LoadBalancerProvider":
         "{{ controller.loadbalancer.spi }}"
+      "CONFIG_whisk_spi_ArtifactStoreProvider": "{{ database_spi }}"
       "CONFIG_logback_log_level": "{{ controller.loglevel }}"
 
       "CONFIG_whisk_transactions_header": "{{ transactions.header }}"

ansible/roles/invoker/tasks/deploy.yml

@@ -170,6 +170,14 @@
       "CONFIG_whisk_couchdb_databases_WhiskAuth": "{{ db.whisk.auth }}"
       "CONFIG_whisk_couchdb_databases_WhiskEntity": "{{ db.whisk.actions }}"
       "CONFIG_whisk_couchdb_databases_WhiskActivation": "{{ db.whisk.activations }}"
+      "CONFIG_whisk_mongodb_hosts": "{{ mongodb_connect_string }}"
+      "CONFIG_whisk_mongodb_username": "{{ db_username }}"
+      "CONFIG_whisk_mongodb_password": "{{ db_password }}"
+      "CONFIG_whisk_mongodb_replicaSet": "{{ mongodb_replicaSet}}"
+      "CONFIG_whisk_mongodb_database": "{{ mongodb_database }}"
+      "CONFIG_whisk_mongodb_collections_WhiskAuth": "{{ db.whisk.auth }}"
+      "CONFIG_whisk_mongodb_collections_WhiskEntity": "{{ db.whisk.actions }}"
+      "CONFIG_whisk_mongodb_collections_WhiskActivation": "{{ db.whisk.activations }}"
       "DB_WHISK_ACTIONS": "{{ db.whisk.actions }}"
       "DB_WHISK_ACTIVATIONS": "{{ db.whisk.activations }}"
       "DB_WHISK_AUTHS": "{{ db.whisk.auth }}"
@@ -200,6 +208,7 @@
       "CONFIG_kamon_statsd_hostname": "{{ metrics.kamon.host }}"
       "CONFIG_kamon_statsd_port": "{{ metrics.kamon.port }}"
       "CONFIG_whisk_spi_LogStoreProvider": "{{ userLogs.spi }}"
+      "CONFIG_whisk_spi_ArtifactStoreProvider": "{{ database_spi }}"
       "CONFIG_logback_log_level": "{{ invoker.loglevel }}"
       "CONFIG_whisk_memory_min": "{{ limit_action_memory_min | default() }}"
       "CONFIG_whisk_memory_max": "{{ limit_action_memory_max | default() }}"

ansible/roles/mongodb/tasks/clean.yml

@@ -0,0 +1,26 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more contributor
+# license agreements; and to You under the Apache License, Version 2.0.
+---
+# Remove MongoDB server
+
+- name: remove MongoDB
+  docker_container:
+    name: mongodb
+    state: absent
+    keep_volumes: False
+
+- name: remove MongoDB data volume
+  docker_volume:
+    name: "{{ db.mongodb.data_volume }}"
+    state: absent
+
+- name: remove MongoDB log directory
+  file:
+    path: "{{ whisk_logs_dir }}/mongodb"
+    state: absent
+  become: "{{ logs.dir.become }}"
+
+- name: remove MongoDB conf directory
+  file:
+    path: "{{ db.confdir }}"
+    state: absent