IntenseWebs/pgadmin4
3
0
Fork 0
mirror of https://github.com/pgadmin-org/pgadmin4.git synced 2025-02-25 18:55:31 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doc updates for resource groups and roles.

Browse Source
This commit is contained in:
Susan Douglas 2017-11-30 12:22:22 +00:00 committed by Dave Page
parent f3256aef71
commit 54389595da
2 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/en_US/resource_group_dialog.rst
View File

@ -8,19 +8,19 @@ Use the *Resource Group* dialog to create a resource group and set values for it
http://www.enterprisedb.com/
The *Resource Group* dialog organizes the development of a resource group through the *General* dialog tab. The *SQL* tab displays the SQL code generated by dialog selections.
Fields used to create a resource group are located on the *General* tab. The *SQL* tab displays the SQL code generated by your selections on the *Resource Group* dialog.
.. image:: images/resource_group_general.png
Use the fields in the *General* tab to specify resource group parameters:
Use the fields on the *General* tab to specify resource group attributes:
* Use the *Group Name* field to add a descriptive name for the resource group. This name will be displayed in the *pgAdmin* tree control.
* Use the *CPU Rate Limit (%)* field to set the value of the CPU rate limit resource type assigned to the resource group. The valid range for a CPU rate limit is from 0 to 1.67772e+07. The default value is 0.
* Use the *Dirty Rate Limit (KB)* field to set the value of the dirty rate limit resource type assigned to the resource group. The valid range for a dirty rate limit is from 0 to 1.67772e+07. The default value is 0.
* Use the *Name* field to add a descriptive name for the resource group. This name will be displayed in the tree control.
* Use the *CPU rate limit (%)* field to set the value of the CPU rate limit resource type assigned to the resource group. The valid range for a CPU rate limit is from 0 to 1.67772e+07. The default value is 0.
* Use the *Dirty rate limit (KB)* field to set the value of the dirty rate limit resource type assigned to the resource group. The valid range for a dirty rate limit is from 0 to 1.67772e+07. The default value is 0.
Click the *SQL* tab to continue.
Your entries in the *Resource Group* dialog generate a SQL command (see an example below). Use the *SQL* tab for review; revisit the *General* tab to make any changes to the SQL command.
Your entries in the *Resource Group* dialog generate a SQL command. Use the *SQL* tab for review; revisit the *General* tab to make any changes to the SQL command.
**Example**
@ -30,7 +30,8 @@ The following is an example of the sql command generated by selections made in t
The example creates a resource group named *acctg* that sets *cpu_rate_limit* to *2*, and *dirty_rate_limit* to *6144*.
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
* Click the Info button (*i*) to access online SQL syntax reference material.
* Click the Help button (*?*) to access online documentation about Resource Groups.
* Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters.

32
docs/en_US/role_dialog.rst
View File

@ -6,13 +6,13 @@ The Login/Group Role Dialog
Use the *Login/Group Role* dialog to define a role. A role may be an individual user (with or without login privileges) or a group of users. Note that roles defined at the cluster level are shared by all databases in the cluster.
The dialog *Login/Group Role* organizes the creation of roles through the following dialog tabs: *General*, *Definition*, *Role Privileges*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
The *Login/Group Role* dialog organizes the creation and management of roles through the following dialog tabs: *General*, *Definition*, *Privileges*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/role_general.png
Use the fields in the *General* tab to identify the role.
Use the fields on the *General* tab to identify the role.
* Use the *Name* field to provide the name of the role. The name will be displayed in the *pgAdmin* tree control.
* Use the *Name* field to provide the name of the role. The name will be displayed in the tree control.
* Provide a note about the role in the *Comments* field.
Click the *Definition* tab to continue.
@ -22,14 +22,14 @@ Click the *Definition* tab to continue.
Use the *Definition* tab to set a password and configure connection rules:
* Provide a password that will be associated with the role in the *Password* field.
* Provide an expiration date for the password in the *Account Expires* field (the role does not expire). Provide the date in a mm/dd/yyyy format. The expiration date is not enforced when a user logs in with a non-password-based authentication method.
* Provide an expiration date for the password in the *Account Expires* field (the role does not expire). The expiration date is not enforced when a user logs in with a non-password-based authentication method.
* If the role is a login role, specify how many concurrent connections the role can make in the *Connection Limit* field. The default value (*-1*) allows unlimited connections.
Click the *Role Privileges* tab to continue.
Click the *Privileges* tab to continue.
.. image:: images/role_privileges.png
Use the *Role Privileges* tab to grant privileges to the role.
Use the *Privileges* tab to grant privileges to the role.
* Move the *Can login?* switch to the *Yes* position if the role has login privileges. The default value is *No*.
* Move the *Superuser* switch to the *Yes* position if the role is a superuser within the database. The default value is *No*.
@ -38,19 +38,22 @@ Use the *Role Privileges* tab to grant privileges to the role.
* The *Update catalog?* switch is disabled until the role is given superuser privileges. Move the *Update catalogs?* switch to the *No* position to control whether a role can update catalogs. The default value is *Yes* when the *Superuser* switch is in the *Yes* position.
* Move the *Inherit rights from the parent roles?* switch to the *No* position if a role does not inherit privileges. The default value is *Yes*.
* Move the *Can initiate streaming replication and backups?* switch to the *Yes* position to control whether a role can initiate streaming replication or put the system in and out of backup mode. The default value is *No*.
* Specify members of the role in the *Role Membership* field. Click inside the *Role Membership* field to select role names from a drop down list. Confirm each selection by checking the checkbox to the right of the role name; delete a selection by clicking the *x* to the left of the role name. Membership conveys the privileges granted to a role to each of its members.
.. image:: images/role_membership.png
* Specify members of the role in the *Role Membership* field. Click inside the *Roles* field to select role names from a drop down list. Confirm each selection by checking the checkbox to the right of the role name; delete a selection by clicking the *x* to the left of the role name. Membership conveys the privileges granted to the specified role to each of its members.
Click the *Parameters* tab to continue.
.. image:: images/role_parameters.png
Use the fields on the *Parameters* tab to set session defaults for a selected configuration parameter when the role is connected to a specified database. This tab invokes the ALTER ROLE... SET configuration_parameter syntax. Click the *Add* icon (+) to create a parameter.
Use the fields on the *Parameters* tab to set session defaults for a selected configuration parameter when the role is connected to a specified database. This tab invokes the ALTER ROLE... SET configuration_parameter syntax. Click the *Add* icon (+) to assign a value for a parameter.
* Use the drop-down listbox in the *Name* field to select a parameter.
* Use the *Value* field to specify a value for the parameter.
* Use the drop-down listbox in the *Database* field to select a database.
Click the *Add* icon (+) to specify each additional parameter; to discard a parameter, click the trash icon to the left of the row and confirm deletion in the *Delete Row* popup.
Click the *Add* icon (+) to specify each additional parameter; to discard a parameter, click the trash icon to the left of the row and confirm the deletion in the *Delete Row* popup.
Click the *Security* tab to continue.
@ -61,7 +64,7 @@ Use the *Security* tab to define security labels applied to the role. Click the
* Specify a security label provider in the *Provider* field. The named provider must be loaded and must consent to the proposed labeling operation.
* Specify a a security label in the *Security Label* field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them.
To discard a security label, click the trash icon to the left of the row and confirm deletion in the *Delete Row* popup.
To discard a security label, click the trash icon to the left of the row and confirm the deletion in the *Delete Row* popup.
Click the *SQL* tab to continue.
@ -73,14 +76,11 @@ The following is an example of the sql command generated by user selections in t
.. image:: images/role_sql.png
The example creates a login role named *alice* with *CREATE ROLE* privileges; the role is limited to 3 connections to the server at any given time.
The example creates a login role named *alice* with *pem_user* privileges; the role can make unlimited connections to the server at any given time.
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
* Click the Info button (*i*) to access online SQL help.
* Click the Help button (*?*) to access the documentation for the dialog.
* Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters.