From eab84663d7ffebd9928a105eaff7363cdae3b987 Mon Sep 17 00:00:00 2001 From: "bugreport%peshkin.net" <> Date: Fri, 4 Apr 2008 11:47:11 +0000 Subject: Bug 178230 Update documentation for Entrprise Groups r=Jake,preed a=justdave --- docs/en/xml/administration.xml | 164 ++++++++++++++++++++++------------------- 1 file changed, 90 insertions(+), 74 deletions(-) (limited to 'docs/en/xml') diff --git a/docs/en/xml/administration.xml b/docs/en/xml/administration.xml index 1873ee025..b09de7666 100644 --- a/docs/en/xml/administration.xml +++ b/docs/en/xml/administration.xml @@ -38,27 +38,24 @@ - usebuggroups: - This dictates whether or not to implement group-based security for - Bugzilla. If set, Bugzilla bugs can have an associated 'group', - defining which users are allowed to see and edit the - bug. - - Set "usebuggroups" to "on" - only - if you may wish to restrict access to particular bugs to certain - groups of users. I suggest leaving - this parameter off - while initially testing your Bugzilla. + makeproductgroups: + This dictates whether or not to automatically create groups + when new products are created. + - usebuggroupsentry: - Bugzilla Products can have a group associated with them, so that - certain users can only see bugs in certain products. When this parameter - is set to on, this places all newly-created bugs in the - group for their product immediately. + useentrygroupdefault: + Bugzilla products can have a group associated with them, so that + certain users can only see bugs in certain products. When this + parameter is set to on, this + causes the initial group controls on newly created products + to place all newly-created bugs in the group + having the same name as the product immediately. + After a product is initially created, the group controls + can be further adjusted without interference by + this mechanism. @@ -69,8 +66,14 @@ write locking. What this means is that if someone needs to make a change to a bug, they will lock the entire table until the operation is complete. Locking for write also blocks reads until the write is - complete. The - shadowdb + complete. Note that more recent versions of mysql support row level + locking using different table types. These types are slower than the + standard type, and Bugzilla does not yet take advantage of features + such as transactions which would justify this speed decrease. The + Bugzilla team are, however, happy to hear about any experiences with + row level locking and Bugzilla + + The shadowdb parameter was designed to get around this limitation. While only a single user is allowed to write to a table at a time, reads can continue unimpeded on a read-only shadow copy of the database. @@ -85,23 +88,10 @@ Bugzilla bug changes and comments per day. The value of the parameter defines the name of the - shadow bug database. - Set "shadowdb" to e.g. "bug_shadowdb" if you will be running a - *very* large installation of Bugzilla. - - Enabling "shadowdb" can adversely affect the stability of - your installation of Bugzilla. You should regularly check that your - database is in sync. It is often advisable to force a shadow - database sync nightly via - cron. - - - - - If you use the "shadowdb" option, it is only natural that you - should turn the "queryagainstshadowdb" option on as well. Otherwise - you are replicating data into a shadow database for no reason! - + shadow bug database. You will need to set the host and port settings + from the params page, and set up replication in your database server + so that updates reach this readonly mirror. Consult your database + documentation for more detail. @@ -655,44 +645,83 @@ Groups allow the administrator to isolate bugs or products that should only be seen by certain people. - There are two types of group - Generic Groups, and Product-Based Groups. + The association between products and groups is controlled from + the product edit page under Edit Group Controls. + + + + If the makeproductgroups param is on, a new group will be automatically + created for every new product. - Product-Based Groups are matched with products, and allow you to restrict - access to bugs on a per-product basis. They are enabled using the - usebuggroups Param. Turning on the usebuggroupsentry - Param will mean bugs automatically get added to their product group when - filed. + On the product edit page, there is a page to edit the + Group Controls + for a product and determine which groups are applicable, default, + and mandatory for each product as well as controlling entry + for each product and being able to set bugs in a product to be + totally read-only unless some group restrictions are met. - Generic Groups have no special relationship to products; - you create them, and put bugs in them - as required. One example of the use of Generic Groups - is Mozilla's "Security" group, - into which security-sensitive bugs are placed until fixed. Only the - Mozilla Security Team are members of this group. + For each group, it is possible to specify if membership in that + group is... + + + + required for bug entry, + + + + + Not applicable to this product(NA), + a possible restriction for a member of the + group to place on a bug in this product(Shown), + a default restriction for a member of the + group to place on a bug in this product(Default), + or a mandatory restriction to be placed on bugs + in this product(Mandatory). + + + + + Not applicable by non-members to this product(NA), + a possible restriction for a non-member of the + group to place on a bug in this product(Shown), + a default restriction for a non-member of the + group to place on a bug in this product(Default), + or a mandatory restriction to be placed on bugs + in this product when entered by a non-member(Mandatory). + + + + + required in order to make any change + to bugs in this product including comments. + + + - To create Generic Groups: + To create Groups: - Select the "groups" + Select the groups link in the footer. - Take a moment to understand the instructions on the "Edit - Groups" screen, then select the "Add Group" link. + Take a moment to understand the instructions on the Edit + Groups screen, then select the Add Group link. - Fill out the "Group", "Description", and - "User RegExp" fields. "New User RegExp" allows you to automatically + Fill out the Group, Description, + and User RegExp fields. + User RegExp allows you to automatically place all users who fulfill the Regular Expression into the new group. - When you have finished, click "Add". + When you have finished, click Add. The User Regexp is a perl regexp and, if not anchored, will match any part of an address. So, if you do not want to grant access @@ -708,28 +737,15 @@ - To use Product-Based Groups: - - - - Turn on "usebuggroups" and "usebuggroupsentry" in the "Edit - Parameters" screen. - - - - - In future, when you create a Product, a matching group will be - automatically created. If you need to add a Product Group to - a Product which was created before you turned on usebuggroups, - then simply create a new group, as outlined above, with the - same name as the Product. - - - Note that group permissions are such that you need to be a member of all the groups a bug is in, for whatever - reason, to see that bug. + reason, to see that bug. Similarly, you must be a member + of all of the entry groups for a product + to add bugs to a product and you must be a member + of all of the canedit groups for a product + in order to make any change to bugs in that + product. -- cgit v1.2.3-24-g4f1b