Initial commit for multi-tenant-configuration

multi-tenant-configuration/README.md

@@ -0,0 +1 @@
+# Multi-tenants User configuration scripts for Opencast

multi-tenant-configuration/config.py

@@ -0,0 +1,19 @@
+# Configuration
+
+#Set this to your global admin node
+url = "http://tenant1:8080"
+#If you have multiple tenants use something like
+#url_pattern = "https://{}.example.org"
+#otherwise, url_pattern should be the same as the url variable above
+url_pattern = "http://{}:8080"
+
+# digest user
+digest_user = "opencast_system_account"
+digest_pw = "CHANGE_ME"
+
+# path to environment configuration file
+env_path = "environment/staging/opencast-organizations.yml"
+
+# workflow_definitions = ["import", "fast"]
+# exclude_tenants = []
+# export_dir = "."

multi-tenant-configuration/configurations/group_configuration.json

@@ -0,0 +1,113 @@
+{
+  "groups" : [
+    {
+      "name": "System Administrators",
+      "description": "System Administrators",
+      "tenants": "all",
+      "type": "closed",
+      "members": [
+        {
+          "name": "Guy 1",
+          "email": "[email protected]",
+          "reason": "Operations partner",
+          "uid": "guy-1",
+          "tenants": "all"
+         },
+         {
+           "name": "Guy 2",
+           "email": "[email protected]",
+           "reason": "Operations partner",
+           "uid": "guy-2",
+           "tenants": "tenant1"
+         }
+      ],
+      "inactive_members": [ ],
+      "permissions": [
+        {
+          "tenants": "all",
+          "roles": ["ROLE_ADMIN", "ROLE_SUDO"]
+        }
+      ]
+    },
+    {
+      "name": "Organization Administrators",
+      "description": "Organization administrators have full access to all content of ${name}",
+      "tenants": "all",
+      "type": "open",
+      "members": [],
+      "inactive_members": [],
+      "permissions": [
+        {
+          "tenants": "all",
+          "roles": [
+            "ROLE_ADMIN_UI",
+            "ROLE_ORG_ADMIN"
+          ]
+        },
+        {
+          "tenants" : "tenant2",
+          "roles": {
+            "add": [
+              "ROLE_UI_EVENTS_DETAILS_ACL_VIEW",
+              "ROLE_UI_EVENTS_DETAILS_ACL_EDIT"
+            ],
+            "remove": []
+          }
+        }
+      ]
+    },
+    {
+      "name": "Producers",
+      "description": "Producers have limited access to content and functionality",
+      "tenants": "all",
+      "type": "open",
+      "members": [],
+      "inactive_members": [],
+      "permissions": [
+        {
+          "tenants": "all",
+          "roles": [
+            "ROLE_ADMIN_UI",
+	    "ROLE_UI_EVENTS_CREATE"
+          ]
+        },
+        {
+          "tenants" : "tenant1",
+          "roles": {
+            "add": [
+              "ROLE_UI_EVENTS_COUNTERS_VIEW"
+            ],
+            "remove": [
+              "ROLE_UI_EVENTS_CREATE"
+            ]
+          }
+	},
+        {
+          "tenants" : "tenant2",
+          "roles": {
+            "add": [
+              "ROLE_ORG_ADMIN"
+            ],
+            "remove": []
+          }
+        }
+      ]
+    },
+    {
+      "name": "Tenant2 Producers",
+      "description": "Tenant2 Producers have limited access to content and functionality",
+      "tenants": "tenant2",
+      "type": "open",
+      "members": [],
+      "inactive_members": [],
+      "permissions": [
+        {
+          "tenants": "all",
+          "roles": [
+            "ROLE_ADMIN_UI"
+          ]
+        }
+      ]
+    }
+  ]
+}

multi-tenant-configuration/environment/staging/opencast-organizations.yml

@@ -0,0 +1,74 @@
+---
+
+opencast_organizations:
+  - id: dummy
+    name: Dummy Tenant
+    aai_org: switch.ch
+    stream_sec_key: 5387689
+    acl_default_template: organization
+    acl_default_download: False
+    acl_default_annotate: False
+
+  # Global External API user passwords
+    opencast_system_account:
+      username: opencast_system_account
+      password: CHANGE_ME
+    switchcast_system_accounts:
+      - username: player
+        name: Player System User
+        email: [email protected]
+        password: 34dchG6nbhmhnG
+        roles: [ROLE_ADMIN, ROLE_SUDO]
+      - username: annotate
+        name: Annotate System User
+        email: [email protected]
+        password: jhvhuJH7utghfgfgJH
+        roles: [ROLE_ADMIN, ROLE_SUDO]
+      - username: cast
+        name: Cast System User
+        email: [email protected]
+        password: jhvhuJH7utghfgfgJH
+        roles: [ROLE_ADMIN, ROLE_SUDO]
+    capture_agent_accounts: []
+
+  - id: tenant1
+    name: Tenant1
+    aai_org: tenant1.ch
+    stream_sec_key: tu7uzgjjhghjf
+    capture_agent_accounts:
+      - username: ca-tenant1-ch
+        password: jvblkajklvjhaklehr
+    external_api_accounts:
+      - username: moodle-tenant1-ch
+        password: hghghjghdghdjd76
+        name: Moodle System User
+        email: [email protected]
+        roles: [ROLE_EXTERNAL_APPLICATION]
+      - username: guy1
+        password: abc
+        name: Guy 1
+        email: [email protected]
+        roles: [ROLE_ADMIN]
+      - username: guy2
+        password: abc
+        name: Guy 2
+        email: [email protected]
+        roles: [ROLE_ADMIN, ROLE_SUDO]
+  - id: tenant2
+    name: Tenant2
+    aai_org: tenant2.ch
+    stream_sec_key: tu7uzgjjhghjf
+    capture_agent_accounts:
+      - username: ca-tenant2-ch
+        password: hjfkhfzuruzf76
+    external_api_accounts:
+      - username: moodle-tenant2-ch
+        password: 67rdghn
+        name: Moodle System User
+        email: [email protected]
+        roles: [ROLE_EXTERNAL_APPLICATION]
+      - username: guy-1
+        password: abc
+        name: Guy 1
+        email: [email protected]
+        roles: [ROLE_ADMIN, ROLE_SUDO]

multi-tenant-configuration/main.py

@@ -0,0 +1,82 @@
+import os
+import sys
+import yaml
+
+sys.path.append(os.path.join(os.path.abspath('..'), "lib"))
+
+# import datetime
+import config
+import io
+# from collections import defaultdict
+from rest_requests.request_error import RequestError
+from args.digest_login import DigestLogin
+from rest_requests.request import get_request, post_request
+# from pathlib import Path
+
+
+# ToDo
+# add logger
+# add interaction question
+# add parameter to python command
+
+def main():
+    """
+    configure Groups and Users
+    """
+
+    digest_login = DigestLogin(user=config.digest_user, password=config.digest_pw)
+    # read config file
+    opencast_organizations = read_configuration_file(config.env_path)['opencast_organizations']
+    tenants = [tenant['id'] for tenant in opencast_organizations]
+    external_api_accounts = opencast_organizations[1]['external_api_accounts']
+
+    # create users for tenant 1
+    for account in external_api_accounts:
+        tenant = tenants[1]
+        create_user(tenant, account, digest_login)
+
+
+def read_configuration_file(path):
+    with open(path, 'r') as f:
+        conf = yaml.load(f, Loader=yaml.FullLoader)
+
+    return conf
+
+# # example get request
+# response = get_request("http://tenant1:8080/users/users.json", digest_login, "users/users.json")
+# json_content = get_json_content(response)
+# print(response)
+
+def get_roles_as_Json_array(account):
+    roles = [{'name': role, 'type': 'INTERNAL'} for role in account['roles']]
+
+    return roles
+
+def create_user(tenantid, account, digest_login):
+    """ sends a POST request to the admin UI to create a User
+
+    :param tenantid:    str     tenant id to form correct url   (e.g. 'tenant1')
+    :param account:     dict    user account to be created      (e.g. {'username': 'Peter', 'password': '123'}
+    :param digest_login: digest login
+    :return:
+    """
+    url = '{}/admin-ng/users/'.format(config.url_pattern.format(tenantid))
+    data = {
+        'username': account['username'],
+        'password': account['password'],
+        'name': account['name'],
+        'email': account['email'],
+        'roles': str(get_roles_as_Json_array(account))
+    }
+    # ToDo error handling
+    response = post_request(url, digest_login, '/admin-ng/users/', data=data)
+
+    return response
+
+
+if __name__ == '__main__':
+    try:
+        main()
+    except KeyboardInterrupt:
+        print("\nAborting process.")
+        sys.exit(0)

multi-tenant-configuration/requirements.txt

@@ -0,0 +1,8 @@
+certifi==2020.11.8
+chardet==3.0.4
+idna==2.10
+requests==2.25.0
+requests-toolbelt==0.9.1
+urllib3==1.26.2
+
+pyyaml