Add ArtifactStore implementation for MongoDB

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

Author: jiangpengcheng

ansible/README.md

@@ -102,6 +102,17 @@ db_host=
 db_port=
 ```
 
+or
+```bash
+[db_creds]
+db_username=
+db_password=
+db_host=
+db_port=
+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.
 
@@ -125,8 +136,12 @@ 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_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
@@ -191,6 +206,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> initMongoDB.yml
+ansible-playbook -i environments/<environment> wipeMongoDB.yml
+ansible-playbook -i environments/<environment> apigateway.yml
+ansible-playbook -i environments/<environment> openwhisk.yml -e database_backend=MongoDB
+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

@@ -13,6 +13,8 @@ db_password: couch_password
 db_host: "{{ groups['db'] | first }}"
 db_prefix: whisk_distributed_
 
+mongodb_database: whisks
+
 config_root_dir: /tmp/wskconf
 whisk_logs_dir: /tmp/wsklogs
 registry_storage_dir: "/"

ansible/group_vars/all

@@ -226,6 +226,8 @@ db:
   protocol: "{{ db_protocol | default(lookup('ini', 'db_protocol section=db_creds file={{ playbook_dir }}/db_local.ini')) }}"
   port: "{{ db_port | default(lookup('ini', 'db_port section=db_creds file={{ playbook_dir }}/db_local.ini')) }}"
   host: "{{ db_host | default(lookup('ini', 'db_host section=db_creds file={{ playbook_dir }}/db_local.ini')) }}"
+  backend: "{{ database_backend | default('CouchDB') }}"
+  confdir: "{{ config_root_dir }}/database"
   instances: "{{ groups['db'] | length }}"
   authkeys:
   - guest
@@ -244,6 +246,9 @@ db:
     invoker:
       user: "{{ db_invoker_user | default(lookup('ini', 'db_username section=invoker file={{ playbook_dir }}/db_local.ini')) }}"
       pass: "{{ db_invoker_pass | default(lookup('ini', 'db_password section=invoker file={{ playbook_dir }}/db_local.ini')) }}"
+  mongodb:
+    database: "{{ mongodb_database | default(lookup('ini', 'mongodb_database section=db_creds file={{ playbook_dir }}/db_local.ini')) }}"
+    data_volume: "{{ mongodb_data_volume | default('mongo-data') }}"
 
 apigateway:
   port:
@@ -262,6 +267,23 @@ linux:
 couchdb:
   version: 2.1
 
+mongodb:
+  version: 3.6.6
+  commonEnv:
+    CONFIG_whisk_mongodb_host: "{{ db.host }}"
+    CONFIG_whisk_mongodb_port: "{{ db.port }}"
+    CONFIG_whisk_mongodb_database: "{{ db.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_spi_ArtifactStoreProvider: "whisk.core.database.mongodb.MongoDBArtifactStoreProvider"
+  envForController:
+    CONFIG_whisk_mongodb_username: "{{ db.credentials.controller.user }}"
+    CONFIG_whisk_mongodb_password: "{{ db.credentials.controller.pass }}"
+  envForInvoker:
+    CONFIG_whisk_mongodb_username: "{{ db.credentials.invoker.user }}"
+    CONFIG_whisk_mongodb_password: "{{ db.credentials.invoker.pass }}"
+
 docker:
   # The user to install docker for. Defaults to the ansible user if not set. This will be the user who is able to run
   # docker commands on a machine setup with prereq_build.yml

ansible/initMongoDB.yml

@@ -0,0 +1,66 @@
+# 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 will initialize the immortal DBs in the database account.
+# This step is usually done only once per deployment.
+
+- hosts: ansible
+  tasks:
+  - name: "create user in {{ db.mongodb.database }}"
+    mongodb:
+      database: "{{ db.mongodb.database }}"
+      login_user: "{{ db.credentials.admin.user }}"
+      login_password: "{{ db.credentials.admin.pass }}"
+      login_host: "{{ db.host }}"
+      login_port: "{{ db.port }}"
+      login_database: "{{ db.mongodb.database }}"
+      user: "{{ item.user }}"
+      password: "{{ item.pass }}"
+      mode: "user"
+      roles: "readWrite"
+      force_update: True
+    with_items:
+      - "{{ db.credentials.controller }}"
+      - "{{ db.credentials.invoker }}"
+
+  - name: create necessary auth keys
+    mongodb:
+      database: "{{ db.mongodb.database }}"
+      login_user: "{{ db.credentials.admin.user }}"
+      login_password: "{{ db.credentials.admin.pass }}"
+      login_host: "{{ db.host }}"
+      login_port: "{{ db.port }}"
+      login_database: "{{ db.mongodb.database }}"
+      collection: "{{ db.whisk.auth }}"
+      doc:
+        _id: "{{ item }}"
+        subject: "{{ item }}"
+        namespaces:
+          - name: "{{ item }}"
+            uuid: "{{ key.split(':')[0] }}"
+            key: "{{ key.split(':')[1] }}"
+      mode: "doc"
+      force_update: True
+    vars:
+      key: "{{ lookup('file', 'files/auth.{{ item }}') }}"
+    with_items: "{{ db.authkeys }}"
+
+  - name: create necessary indexes on {{ db.whisk.auth }}
+    mongodb:
+      database: "{{ db.mongodb.database }}"
+      login_user: "{{ db.credentials.admin.user }}"
+      login_password: "{{ db.credentials.admin.pass }}"
+      login_host: "{{ db.host }}"
+      login_port: "{{ db.port }}"
+      login_database: "{{ db.mongodb.database }}"
+      collection: "{{ db.whisk.auth }}"
+      indexes:
+        - index:
+            - field: "namespaces.name"
+              direction: -1
+        - index:
+            - field: "namespaces.uuid"
+              direction: -1
+            - field: "namespaces.key"
+              direction: -1
+      mode: "index"