UserManagement

Agent Controller - User Management module

© Atos Spain S.A. 2017

The User Management module is a component of the European Project mF2C.

---

Description

Component architecture

Installation Guide

Usage Guide

Relation to other mF2C components

Resources managed by this component

LICENSE

---

Description

The User Management module is responsible for managing the user’s profile and the definition of the user’s device resources that will be shared in mF2C. It is also responsible for checking that the mF2C applications act according to these sharing model and user profile properties.

---

Component architecture

This module is part of the Agent Controller component:

This module is composed of three components:

• Profiling
• Sharing Model
• User Management Assessment

---

Installation Guide

1. Requirements

1. Install Docker

2. Install and Run

This component can be installed as a standalone component, or as part of mF2C. To install it as a standalone component you just need the following:

• Clone repository

      git clone https://github.com/mF2C/UserManagement.git
      cd UserManagement

• Build the docker image:

      sudo docker build -t usermanagement .

The docker image can also be downloaded from docker hub (this image includes the Lifecycle module):

      sudo docker pull mf2c lifecycle-usermngt:latest

To install it as part of mF2C see mF2C/mF2C repository

Finally, to run the component without Docker, you will need Python 3.4.

2.1. Launch the User Management

Run application and expose port 46300:

sudo docker run -p 46300:46300 usermanagement

Available environment variables:

• DEVICE_USER
• CIMI_URL

Example:

sudo docker run --env CIMI_URL=https://192.192.192.192 --env DEVICE_USER="testuser" --env -p 46300:46300 usermanagement

After installing the User Management module, the REST API services can be accessed at port 46300:

• List of services (json): https://192.192.192.192:46300/api/v2/um
• List of services (swagger ui): https://192.192.192.192:46300/api/v2/um.html

---

Usage Guide

Methods exposed by the REST API

• List of methods:
  • /api/v2
    • GET: get rest api service status
  • /api/v2/um/
    • GET: check initialization values
  • /api/v2/um/user-profile/
    • GET: get "current" profile
  • /api/v2/um/user-profile/string:user_profile_id
    • GET: get profile by profile ID
    • PUT: updates profile
    • DELETE: deletes profile
  • /api/v2/um/user-profile/user/string:user_id/device/string:device_id
    • GET: get user's profile by user ID and device ID
    • PUT: updates profile
    • DELETE: deletes profile
  • /api/v2/um/sharing-model
    • GET: get current sharing model
  • /api/v2/um/sharing-model/string:sharing_model_id
    • GET: get a sharing model
    • PUT: updates a sharing model
    • DELETE: deletes a sharing model
  • /api/v2/um/sharing-model/user/string:user_id/profile/string:device_id
    • GET: get user's sharing model
    • PUT: updates sharing model
    • DELETE: deletes sharing model
  • /api/v2/um/assesment
    • GET: gets the status of the current assessment in the device
    • PUT: start / stop assessment

See the user guide that can be found in https://github.com/mF2C/Documentation/blob/master/documentation/user_guide/api.rst (TO BE DONE !!)

---

Relation to other mF2C components

The User Management module is connected with the following mF2C components:

• Is called by the following modules / components:

  • Lifecycle Management: it needs information about the profiling and sharing model before 'launching' a service

• Makes calls to the following modules / components:

  • Lifecycle Management: it sends the Lifecycle warnings when mF2C uses more resources than defined by the user

---

Resources managed by this component

user_profile

{
  "device_id": string,
  "service_consumer": boolean,
  "resource_contributor": boolean
}

sharing_model

{
  "device_id": string,
  "GPS_allowed": boolean,
  "max_CPU_usage": integer,
  "max_memory_usage": integer,
  "max_storage_usage": integer,
  "max_bandwidth_usage": integer,
  "battery_limit": integer,
  "max_apps": integer
}

---

LICENSE

The User Management application is licensed under Apache License, version 2.