Skip to content

Commit

Permalink
Add permissions documentation (hyperledger-iroha#1395)
Browse files Browse the repository at this point in the history
Signed-off-by: Igor Egorov <[email protected]>

Add a list of permissions with their descriptions.
Permissions are also linked with corresponding commands or queries.

There is a tool that performs automatic page generation from the csv source of
https://docs.google.com/spreadsheets/d/1aKUXLrtbD5tzJV9fSZfagFcRC_PJVrPc2EkskA1VkFU/edit?usp=sharing (visible to Soramitsu employees) - 
https://repl.it/@igor_egorov/PermissionsGoogleSheetRst
  • Loading branch information
igor-egorov authored May 31, 2018
1 parent 2b27c83 commit 7446905
Show file tree
Hide file tree
Showing 4 changed files with 488 additions and 5 deletions.
10 changes: 9 additions & 1 deletion docs/source/core_concepts/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,14 @@ A request to Iroha that does **not** change the `state <#world-state-view>`__.
By performing a query, a client can get request data from the state,
for example a balance of his account, a history of transactions, etc.

Quorum
======

In the context of transactions signing, quorum number is a minimum amount
of signatures required to consider a transaction signed.
The default value is 1.
Each account can link additional public keys and increase own quorum number.

Synchronizer
============

Expand Down Expand Up @@ -243,4 +251,4 @@ For example, WSV holds information about an amount of `assets <#asset>`__
that an `account <#account>`__ has at the moment but does not contain any info
history of `transaction <#transaction>`__ flow.

.. [#f1] https://en.bitcoin.it/wiki/Block
.. [#f1] https://en.bitcoin.it/wiki/Block
6 changes: 6 additions & 0 deletions docs/source/maintenance/ansible.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*******
Ansible
*******

.. Attention:: Contents are missing for now.
Please check deploy/ansible folder and README.md file in it.
10 changes: 6 additions & 4 deletions docs/source/maintenance/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ Maintenance

Hardware requirements, deployment process in details, aspects related to security, configuration files — all of the listed is explained in this separate section, helpful for DevOps engineers or those who are digging deeper in the system capabilities.

Ansible
-------
.. toctree::
:maxdepth: 3
:caption: Table of contents

permissions.rst
ansible.rst

.. Attention:: Contents are missing for now.
Please check deploy/ansible folder and README.md file in it.
Loading

0 comments on commit 7446905

Please sign in to comment.