search

bird-house / birdhouse-deploy

Scripts and configurations to deploy the various birds and servers required for a full-fledged production platform
https://birdhouse-deploy.readthedocs.io/en/latest/
Apache License 2.0
4 stars 6 forks source link

:books: [Documentation]: Docs related to permissions #369

Closed huard closed 1 year ago

huard commented 1 year ago

Description

Docs currently found in pavics-sdi and probably best suited for here on permissions.

=========================
User and Group management
=========================

The following guide explains the management of users, groups, and permissions for the PAVICS deployment. Permissions and group settings for users both server-side and client-side and can be configured to unique deployment specifications.

As mentioned, PAVICS is built to work within POSIX and POSIX-like systems. As such, user/group management within servers running PAVICS is synonymous with conventions for user/group management in Linux and Unix systems.

.. warning::
    Are we clarifying both within-server permissions and permissions as set within the Birds?

Adding Users and Groups to PAVICS server
========================================

Users added to the PAVICS server for the purpose of adding data or administering Bird services may need unique access privileges. Once a user has been created with `useradd <https://linux.die.net/man/8/useradd>`_ and groups initiatialized with `groupadd <https://linux.die.net/man/8/groupadd>`_ group membership and privileges can be later specified with ``usermod`` and ``groupmod``.

Begin by tunneling into the server::

    ssh user@server

User and Group management for Bird services
===========================================

.. todo::

   How authorizations for services work (the concept)
   How to grant users access to data and services

Permissions and authorizations
------------------------------

Twitcher?
---------

Malleefowl?
-----------

References

Information Value
Server/Platform URL
Related issues/PR
Related documentation
tlvu commented 1 year ago

Magpie permission can be configured programmatically for each component, for example weaver https://github.com/bird-house/birdhouse-deploy/blob/93ed91b9223e2eb89c8b83109282d2f79e8218e7/birdhouse/components/weaver/config/magpie/config.yml.template

For more details, refer to Magpie documentation https://pavics-magpie.readthedocs.io/en/latest/usage.html