This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is the RESTful API definition of **Onepanel** component of Onedata data management system [onedata.org](http://www.onedata.org).
This is the RESTful API definition of **Onepanel** component of Onedata data
management system [onedata.org](http://www.onedata.org).
> This API is defined using [Swagger](http://swagger.io/), the JSON specification can be used to automatically generate client libraries - [swagger.json](../../../swagger/onepanel/swagger.json).
> This API is defined using [Swagger](http://swagger.io/), the JSON
specification can be used to automatically generate client libraries -
This API allows control and configuration of local Onedata deployment, in particular full control over the **Onezone** and **Oneprovider** services and their distribution and monitoring on the local resources.
This API allows control and configuration of local Onedata deployment, in
particular full control over the **Onezone** and **Oneprovider** services and
their distribution and monitoring on the local resources.
Each of these components is composed of the following services:
***Worker services** - these are available under `/zone/workers` and `/provider/workers` paths,
***Databases services** - each Onedata component stores it's metadata in a Couchbase backend, which can be distributed on any number of nodes, these are available under `/zone/databases` and `/provider/databases` paths,
***Cluster manager services** - this is a service which controls other deployed processes in one site, these are availables under these are available under `/zone/managers` and `/provider/managers` paths.
**Onezone** and **Oneprovider** components are composed of 3 types of services: **managers**, **databases** and **workers**.
Using this API each of these components can be deployed, configured, started and stopped on a specified host in the local site, in the context of either **Onezone** or **Oneprovider** service.
The API is group into 3 categories of operations:
***Onepanel** - for common operations
***Oneprovider** - for Oneprovider specific administrative operations
***Onezone** - for Onezone specific administrative operations
All paths listed in this documentation are relative to the base Onepanel REST API which is `/api/v3/onepanel`, so complete URL for a request to Onepanel service is:
Each of these components is composed of the following services:
***Worker services** - these are available under `/zone/workers` and
`/provider/workers` paths,
***Databases services** - each Onedata component stores it's metadata in a
Couchbase backend, which can be distributed on any number of nodes, these
are available under `/zone/databases` and `/provider/databases` paths,
***Cluster manager services** - this is a service which controls other
deployed processes in one site, these are availables under these are
available under `/zone/managers` and `/provider/managers` paths.
**Onezone** and **Oneprovider** components are composed of 3 types of
services: **managers**, **databases** and **workers**.
Using this API each of these components can be deployed, configured,
started and stopped on a specified host in the local site, in the context
of either **Onezone** or **Oneprovider** service.
All paths listed in this documentation are relative to the base Onepanel
REST API which is `/api/v3/onepanel`, so complete URL for a request to
Onepanel service is:
```
http://HOSTNAME:PORT/api/v3/onepanel/...
```
##Authentication
Onepanel supports only HTTP basic authentication, i.e. using `username` and `password`, which were set when creating users.
Onepanel supports only HTTP basic authentication, i.e. using `username` and
`password`, which were set when creating users.
Onepanel users can have 2 roles:
***admin** - Onepanel administrator, there can be multiple administrators and all have equal rights in terms of Onedata deployment management,
***regular** - this role allows manual creation of user accounts, using which users can login to Onezone service using HTTP Basic authentication without OpenID. This role makes sense only on Onepanel which manages Onezone deployment.
***admin** - Onepanel administrator, there can be multiple administrators
and all have equal rights in terms of Onedata deployment management,
***regular** - this role allows manual creation of user accounts, using
which users can login to Onezone service using HTTP Basic authentication
without OpenID. This role makes sense only on Onepanel which manages
Onezone deployment.
The first user account which is created in Onepanel is always an `admin` account.
The first user account which is created in Onepanel is always an `admin`
account.
##API structure
The Onepanel API is structured to reflect that it can either be used to control **Onezone** or **Oneprovider** deployment, each Onedata component deployment has a separate Onepanel instance. In order to make the API calls explicit, **Onezone** or **Oneprovider** specific requests have different paths, i.e.:
The Onepanel API is structured to reflect that it can either be used to
control **Onezone** or **Oneprovider** deployment, each Onedata component
deployment has a separate Onepanel instance. In order to make the API calls
explicit, **Onezone** or **Oneprovider** specific requests have different
paths, i.e.:
* Onezone specific operations start with `/api/v3/onepanel/zone/`
* Oneprovider specific operations start with `/api/v3/onepanel/provider/`
* Common operations paths include `/api/v3/onepanel/users`, `/api/v3/onepanel/hosts` and `/api/v3/onepanel/tasks`
* Common operations paths include `/api/v3/onepanel/users`,
`/api/v3/onepanel/hosts` and `/api/v3/onepanel/tasks`
The overall configuration of each component can be controlled by updating `/api/v3/onepanel/zone/configuration` and `/api/v3/onepanel/provider/configuration` resources.
The overall configuration of each component can be controlled by updating
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters