bosun.org@v0.0.0-20210513094433-e25bc3e69a1f/docs/admin.md (about)

     1  ---
     2  layout: default
     3  title: Administration
     4  ---
     5  
     6  <div class="row">
     7  <div class="col-sm-3" >
     8    <div class="sidebar" data-spy="affix" data-offset-top="0" data-offset-bottom="0" markdown="1">
     9   
    10   * Some TOC
    11   {:toc}
    12   
    13    </div>
    14  </div>
    15  
    16  <div class="doc-body col-sm-9" markdown="1">
    17  
    18  <p class="title h1">{{page.title}}</p>
    19  This part of the documentation covers various aspects of Bosun administration. 
    20  
    21  # Authentication
    22  Bosun currently supports two types of authentication when authentication is enabled:
    23  
    24   1. LDAP authentication
    25   2. Token Based access
    26  
    27  The two intended uses of these methods is user authentication and api authentication respectively. Authorization is a new feature in Bosun 0.6.0. Even when authorization is enabled, Bosun should still be run inside a trusted network.
    28  
    29  ## Setup
    30  The authentication feature gets enabled when you define the [AuthConf section of the system configuration](/system_configuration#authconf). Authentication tokens can be set up via the UI by setting [AuthDisabled](/system_configuration#authdisabled) before authentication is enabled. `AuthDisabled` makes it so the authentication *feature* is enabled but authentication itself is not enabled. With `AuthDisabled` set to true anonymous users can create auth tokens via Bosun's user interface.
    31  
    32  ## Auth Token UI
    33  When the authentication feature is enabled, you should see a <span class="docFromLabel">Manage Auth Tokens</span> menu item under your username in Bosun's UI in the upper right corner. You will be able to see this if `AuthDisabled` is true or if you have the `Manage Tokens` Permission set for your user.
    34  
    35  From there you can create new auth tokens in two steps as show in the following images. Note that once you retrieve a token from the second screen, you will *not* be able to view the token itself again. You will still be able to see the name, description, permissions set, and the last time it was used.
    36  
    37  First Screen:
    38  
    39  ![Create Token Image](/public/createToken.jpg)
    40  
    41  Second Screen:
    42  
    43  ![Token Created Image](/public/createdToken.png)
    44  
    45  ## Permissions and Roles
    46  Permissions provide the ability to certain things with both, and Roles are a collection of permissions for convenience. A user could have no role and an arbitrary collection of permissions.
    47  
    48  <table>
    49      <tr>
    50          <th>Permission</th>
    51          <th>Roles</th>
    52          <th>Description</th>
    53      </tr>
    54      <tr>
    55          <td>View Dashboard</td>
    56          <td>Admin, Writer, Reader</td>
    57          <td>Can view dashboard and alert state data, metrics, and graphs</td>
    58      </tr>
    59      <tr>
    60          <td>View Config</td>
    61          <td>Admin, Writer, Reader</td>
    62          <td>Can view bosun configuration page</td>
    63      </tr>
    64      <tr>
    65          <td>View Annotations</td>
    66          <td>Admin, Writer, Reader</td>
    67          <td>Can view annotations on graph page</td>
    68      </tr>
    69      <tr>
    70          <td>Put Data</td>
    71          <td>Admin, Writer</td>
    72          <td>Can put and index OpenTSDB data and metadata</td>
    73      </tr>
    74      <tr>
    75          <td>Actions</td>
    76          <td>Admin, Writer</td>
    77          <td>Can acknowledge and close alerts</td>
    78      </tr>
    79      <tr>
    80          <td>Run Tests</td>
    81          <td>Admin, Writer</td>
    82          <td>Can execute expressions, graphs, and rule tests</td>
    83      </tr>
    84      <tr>
    85          <td>Save Config</td>
    86          <td>Admin, Writer</td>
    87          <td>Can alter and save bosun rule config</td>
    88      </tr>
    89      <tr>
    90          <td>Silence</td>
    91          <td>Admin, Writer</td>
    92          <td>Can add and manage silences</td>
    93      </tr>
    94      <tr>
    95          <td>Manage Tokens</td>
    96          <td>Admin</td>
    97          <td>Can manage authorization tokens</td>
    98      </tr>
    99      <tr>
   100          <td>Set Username</td>
   101          <td>Admin</td>
   102          <td>Allows external services to set a different username in api requests</td>
   103      </tr>
   104  </table>
   105  
   106  ## Syncing Tokens
   107  
   108  </div>
   109  </div>