From cd8c5974d41c92263e635c2ecdbf3687e94c684b Mon Sep 17 00:00:00 2001 From: jans23 Date: Mon, 22 Jul 2024 08:39:13 +0200 Subject: [PATCH] Update administration.rst --- nethsm/administration.rst | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/nethsm/administration.rst b/nethsm/administration.rst index 305e4110a8..95483b3c2b 100644 --- a/nethsm/administration.rst +++ b/nethsm/administration.rst @@ -2,7 +2,7 @@ Administration ============== This chapter describes administrative tasks for users with the *Administrator* role. -Please refer to chapter `Roles `__ to learn more about the role. +Please refer to chapter `Roles `__ to learn more about the role. .. important:: Please make sure you read the information in the beginning of `this document `__ before starting to work. @@ -142,7 +142,7 @@ The current state of the NetHSM can be retrieved as follows. Information about the `/health/state` endpoint can be found in the `API documentation `__. A new NetHSM has an *Unprovisioned* state and after provisioning enters the *Operational* state. -The provisioning of a NetHSM is described in the chapter `Provisioning `__. +The provisioning of a NetHSM is described in the chapter `Provisioning `__. A NetHSM in *Operational* state can be locked again to protect it as follows. @@ -496,9 +496,9 @@ The NetHSM logs metrics of system parameters. .. note:: This command requires the authentication of a user with the *Metrics* role. - Please refer to chapter `Roles `__ to learn more about the role. + Please refer to chapter `Roles `__ to learn more about the role. -Please refer to `Metrics `__ to learn more about each metric. +Please refer to `Metrics `__ to learn more about each metric. The metrics can be retrieved as follows. @@ -651,7 +651,7 @@ namely *Configuration Store*, *Authentication Store*, *Domain Key Store* and *Ke .. important:: A NetHSM system software in *Unattended Boot* mode will require the *Unlock Passphrase* if restored on a different NetHSM hardware. - Please refer to chapter `Unlock Passphrase `__ to learn more. + Please refer to chapter `Unlock Passphrase `__ to learn more. .. important:: A NetHSM in *Unattended Boot* mode will be in the same mode after a restore. @@ -700,7 +700,7 @@ The backup passphrase can be set as follows. .. note:: This command requires the authentication of a user with the *Backup* role. - Please refer to chapter `Roles `__ to learn more. + Please refer to chapter `Roles `__ to learn more. The backup can be executed as follows. @@ -936,7 +936,7 @@ Each user account configured on the NetHSM has one of the following *Roles* assi | | required to initiate a system backup only. | +-----------------+-------------------------------------------------------------+ -See `Namespaces `__ and `Tags `__ for more fine-grained access restricions. +See `Namespaces `__ and `Tags `__ for more fine-grained access restricions. .. note:: In a future release, additional *Roles* may be introduced. @@ -946,10 +946,9 @@ Add User Add a user account to the NetHSM. Each user account has a *Role*, which needs to be specified. -Please refer to chapter `Roles `__ to learn more about *Roles*. +Please refer to chapter `Roles `__ to learn more about *Roles*. -Optionally, a user can be assigned to a *Namespace*. -See the chapter `Namespaces `__ for more information. +Optionally, a user can be assigned to a `*Namespace* `__. .. note:: The NetHSM assigns a random user ID if none is specified. @@ -1111,12 +1110,12 @@ Namespaces *Namespaces* were introduced in software version 1.1. When migrating from an earlier version of the software, all existing users and keys will be without a Namespace. -*Namespaces* group keys and users on a NetHSM into subsets. +Similarly to the concept of partitions, NetHSM supports the more flexible *Namespaces* which group keys and users on a NetHSM into subsets. Users can only see and use keys in the same Namespace and can only see users in the same Namespace. It is not possible to see users and to see and use keys of other Namespaces. When a new user is created, it inherits the Namespace of the user that created it. -Users with the *Administrator* `Role `__ are also referred to as *R-Administrator* if they are not in a Namespace, or *N-Administrator* if they are in a Namespace. +Users with the *Administrator* `Role `__ are also referred to as *R-Administrator* if they are not in a Namespace, or *N-Administrator* if they are in a Namespace. Special rules apply to *R-Administrator* users: They can set the Namespace for new users, list all users and query the Namespace of a user. @@ -1224,7 +1223,7 @@ Tags for Users *Tags* can be used to set fine-grained access restrictions on keys, and are an optional feature. One or more *Tags* can be assigned to user accounts with the *Operator* role only. The *Operators* can see all keys, but only use those with at least one corresponding *Tag*. A key can not be modified by an *Operator* user. -To learn about how to use *Tags* on keys, please refer to `Tags for Keys `__. +To learn about how to use *Tags* on keys, please refer to `Tags for Keys `__. A *Tag* can be added as follows.