MozillaWiki

User:Bhearsum/Balrog/Administration: Difference between revisions

User page Discussion

User:Bhearsum/Balrog/Administration (view source)

Revision as of 19:31, 29 February 2012

8,570 bytes added ,  29 February 2012
m
moved User:Bhearsum/AUS3/Administration to User:Bhearsum/Balrog/Administration
 
(19 intermediate revisions by the same user not shown)
Line 31: Line 31:
* Add, modify, or delete a custom rule
* Add, modify, or delete a custom rule
* Add, modify, or delete a release
* Add, modify, or delete a release
* Add, modify, or delete a permission for a known or unknown user
* View history of changes to rules, releases or permissions
* Rollback to previous versions of a rule, release or permission.


=== UI ===
=== UI ===
TBD
==== Permissions ====
===== permissions.html =====
permissions.html is the entry point for managing user permissions. It...
* Contains a list of all known users (which is to say, all unique usernames in the permissions table), with links to user_permissions.html for each of them.
* Has a form that a new username can be entered into, which redirects to user_permissions.html for the new user upon submission.
 
Because AUS doesn't perform authentication, no details besides username are needed when "creating" a new username.
 
===== user_permissions.html =====
user_permissions.html allows for creation, editing, and deletion of permissions for a specific user. It...
* Lists existing permissions, and allows for deletion or editing of their options.
** Only known options for the permission are listed.
* Allows new permissions to be given to the user
** Only known permissions are listed


= Logging & Rollback =
= Logging & Rollback =
TBD
<p>Logging and rollback of will be handled by a shadow tables with two additional fields: username and timestamp. All rows in this table must have a username and timestamp logged. This schema will end up using more space than strictly necessary, but the simplistic nature makes implementation easy. Rules are small enough pieces of data that their shadow table's size should still be negligible. Releases are a big bigger, but we can reduce the size of shadow entries by only storing differences or changes in their JSON blobs, which should be of trivial size. Additionally, it should be a rare case that releases need updating, so their shadow table will not have many rows in it.</p>
 
<p>When an INSERT to the a table is requested a new row will be inserted into the shadow table containing the rule_id (update_paths) or release name (releases). All other fields (besides username & timestamp) will be NULL. When an UPDATE or DELETE is requested, a new row will be created in the shadow table with identical information to the row being updated.</p>
 
<p>With the schema being so simplistic there's a lot of onus on the client to present the history in a clear and concise way. I envision a few possible views to make this easy:</p>
* Simple undo ("Revert the last change to the rules")
* Rollback by day/time ("Revert the rules table to the state it was in at noon on August 1st")
* List of recent changes, allowing the user to select the ones they want to revert
** When the details link is clicked, the differences between the current state of the rule and the state before the change is shown. (similar for releases)
[ ] Push 6.0 to the release channel (details)
[ ] Push 6.0 to the beta channel (details)
[ ] Push 3.6.20 to the beta channel (details)
[ ] Push 6.0b5 to the beta channel (details)
[ ] Push 6.0b5 to the test channels (details)
[ ] Push 3.6.20 to the test channels (details)
[SUBMIT]
* Wiki-history-like form that lets you compare/revert to arbitrary states.
 
The above is by no means a final list or must-have, just some ideas.
 
Open questions:
* How are updates to shadow table done? Through triggers or by the application?
* Should the application have write access to this table? If so, how do we prevent accidental (or intentional) removal of history?
* How long should we keep shadow table entries for? A month? A year? Forever? This largely depends on whether we care about having long term history or just the ability to roll back quickly.
 
= Authentication/Accounts =
<p>Authentication through LDAP will be handled by the web server and passed onto AUS3. AUS3 will maintain a database of usernames and permissions. Permissions will be granted through ACLs. There will be one entry in the ACL for every URL in the API that supports PUT, POST, or DELETE, as well as an entry to allow/disallow user management.</p>
 
<p>Most humans who use AUS3 will likely have permissions for everything except user management.</p>
 
<p>Build machines will also have an account they must use, and will only be allowed to make changes to a limited set of things:</p>
* /releases/[name]
** For creating new nightly or release builds
* /releases/[name]/builds/[platform]/[locale] PUT
** For adding details of builds and repacks
** This method can implicitly create required intermediaries, should we grant those too, for clarity?
* /rules/[id] POST
** For updating test channel rules during a release.


= API =
= API =
Both the build machine client and the web administration API will make use of the REST interface described below. A 500 response is possible for any method, so not listed for all of them. Error responses (4xx and 5xx) will have an 'errmsg' entity in their response.
Both the build machine client and the web administration API will make use of the REST interface described below. A 500 response is possible for any method, so not listed for all of them. Most error responses (4xx and 5xx) will have an 'errmsg' entity in their response. The body of all responses will be a JSON object as described for each resource below.
{| class="wikitable"
{| class="wikitable"
|-
|-
Line 45: Line 99:
! Method
! Method
! Arguments
! Arguments
! width=40% | Description
! width=30% | Description
! Status codes
! Response status
! Response body
|-
|-
| rowspan=2 | /releases
| rowspan=2 | /releases
Line 53: Line 108:
| rowspan=2 | Retrieves all release names
| rowspan=2 | Retrieves all release names
| 200 - Releases returned
| 200 - Releases returned
| JSON object whose keys are names of releases and values are an object with the following data: product, version and release data
|-
|-
| 204 - No releases
| 204 - No releases
|
|-
|-
| rowspan=2 | /releases/[name]
| rowspan=2 | /releases/[name]
Line 61: Line 118:
| rowspan=2 | Retrieve the release identified by "name"
| rowspan=2 | Retrieve the release identified by "name"
| 200 - Release returned
| 200 - Release returned
| JSON object with the following data: product, version, release data
|-
|-
| 404 - Release doesn't exist
| 404 - Release doesn't exist
|
|-
|-
| rowspan=3 | /releases/[name]
| rowspan=3 | /releases/[name]
Line 69: Line 128:
| rowspan=3 | Update the release with the supplied JSON data. If non-existent, it is created. Be careful when using this for existing releases that already have builds added to them -- the JSON blob given here overrides all data for the release, not just platform independent data.
| rowspan=3 | Update the release with the supplied JSON data. If non-existent, it is created. Be careful when using this for existing releases that already have builds added to them -- the JSON blob given here overrides all data for the release, not just platform independent data.
| 200 - Release modified
| 200 - Release modified
|
|-
|-
| 201 - Release created
| 201 - Release created
|
|-
|-
| 400 - The details value is malformed or NULL
| 400 - The details value is malformed or NULL
| errmsg
|-
|-
| rowspan=2 | /releases/[name]
| rowspan=2 | /releases/[name]
Line 79: Line 141:
| rowspan=2 | Delete the release
| rowspan=2 | Delete the release
| 200 - Release deleted
| 200 - Release deleted
|
|-
|-
| 404 - Release does not exist
| 404 - Release does not exist
| errmsg
|-
| rowspan=2 | /releases/[name]/rollback
| rowspan=2 | PUT
| rowspan=2 | releases_log_id - Id of an entry in the releases shadow table. Must be an entry with a matching release name.
| rowspan=2 | Rollback the release to the specified log entry
| 200 - Rule modified
|
|-
| 400 - releases_log_id doesn't exist or release name doesn't match
| errmsg
|-
|-
| rowspan=3 | /releases/[name]/builds
| rowspan=3 | /releases/[name]/builds
Line 87: Line 161:
| rowspan=3 | Retrieve all builds from a release
| rowspan=3 | Retrieve all builds from a release
| 200 - Builds returned
| 200 - Builds returned
| JSON object with build data - top-level keys are platforms
|-
|-
| 204 - No builds
| 204 - No builds
|
|-
|-
| 404 - Release does not exist
| 404 - Release does not exist
| errmsg
|-
|-
| rowspan=2 | /releases/[name]/builds/[platform]/[locale]
| rowspan=2 | /releases/[name]/builds/[platform]/[locale]
Line 97: Line 174:
| rowspan=2 | Retrieve a specific build from a release
| rowspan=2 | Retrieve a specific build from a release
| 200 - Build returned
| 200 - Build returned
| JSON object with build data
|-
|-
| 404 - Release, platform, or locale doesn't exist
| 404 - Release, platform, or locale doesn't exist
| errmsg
|-
|-
| rowspan=3 |/releases/[name]/builds/[platform]/[locale]
| rowspan=3 |/releases/[name]/builds/[platform]/[locale]
| rowspan=3 | PUT
| rowspan=3 | PUT
| rowspan=3 | details - the JSON blob associated with this build
| details - the JSON blob associated with this build
| rowspan=3 | Update the build with the supplied JSON data. If any of the named release, platform, or locale don't exist, they will be created. If the specific build already exists, it will be overwritten with the supplied information.
| rowspan=3 | Update the build with the supplied JSON data. If any of the named release, platform, or locale don't exist, they will be created. If the specific build already exists, it will be overwritten with the supplied information.
| 200 - Build modified
| 200 - Build modified
|
|-
|-
| product
| 201 - Build created
| 201 - Build created
|
|-
|-
| version
| 400 - The details value is malformed or NULL.
| 400 - The details value is malformed or NULL.
| errmsg
|-
|-
| rowspan=2 | /releases/[name]/builds/[platform]/[locale]
| rowspan=2 | /releases/[name]/builds/[platform]/[locale]
Line 115: Line 199:
| rowspan=2 | Delete the build
| rowspan=2 | Delete the build
| 200 - Release deleted
| 200 - Release deleted
|
|-  
|-  
| 404 - Build doesn't exist
| 404 - Build doesn't exist
|
|-
| rowspan=5 | /releases/log
| rowspan=5 | GET
| name - Only retrieve log entries for a release with this name
| rowspan=5 | Retrieve history of changes to rules
| rowspan=2 | 200 - Log entries returned
| rowspan=2 | JSON object whose keys are releases_log_id's and values are an object with the following data: release name/version/product/data, username and timestamp
|-
| product - Only retrieve log entries for a release whose product is this
|-
| version - Only retrieve log entries for a release whose version is this
| rowspan=3 | 204 - No log entries
| rowspan=3 |
|-
| startdate - Only retrieve rules newer than this date/time
|-
| enddate - Only retrieve rules older than this date/time
|-
|-
| rowspan=15 | /rules
| rowspan=15 | /rules
Line 123: Line 226:
| rowspan=15 | Create a new rule with the supplied arguments.
| rowspan=15 | Create a new rule with the supplied arguments.
| rowspan=7 | 201 - Rule created
| rowspan=7 | 201 - Rule created
| rowspan=7 |
|-
|-
| mapping
| mapping
Line 138: Line 242:
| buildTarget
| buildTarget
| rowspan=8 | 400 - One or more of the arguments is invalid
| rowspan=8 | 400 - One or more of the arguments is invalid
| rowspan=8 | errmsg
|-
|-
| buildID
| buildID
Line 158: Line 263:
| rowspan=2 | Retrieve all of the rules that match the specified arguments. Any missing arguments are regarded as wildcards, therefore a request with no parameters returns all rules.
| rowspan=2 | Retrieve all of the rules that match the specified arguments. Any missing arguments are regarded as wildcards, therefore a request with no parameters returns all rules.
| 200 - Rules returned
| 200 - Rules returned
| JSON object whose keys are rule_id's and values are the same as the arguments described above
|-
|-
| 204 - No rules
| 204 - No rules
|
|-
| rowspan=2 | /rules/[id]
| rowspan=2 | GET
| rowspan=2 |
| rowspan=2 | Retrieve the rule
| 200 - Rule returned
| Same as a single entry in /rules GET.
|-
| 404 - Rule does not exist
|
|-
|-
| rowspan=2 | /rules/[id]
| rowspan=2 | /rules/[id]
Line 166: Line 283:
| rowspan=2 | Update the rule with the supplied arguments. Any missing arguments will be considered NULL.
| rowspan=2 | Update the rule with the supplied arguments. Any missing arguments will be considered NULL.
| 200 - Rule modified
| 200 - Rule modified
|
|-
|-
| 400 - One or more of the arguments is invalid
| 400 - One or more of the arguments is invalid
| errmsg
|-
|-
| rowspan=2 | /rules/[id]
| rowspan=3 | /rules/[id]
| rowspan=2 | POST
| rowspan=3 | POST
| rowspan=2 | Same as /rules POST
| rowspan=3 | Same as /rules POST
| rowspan=2 | Update the rule with any arguments passed. Any missing arguments will not be changed.
| rowspan=3 | Update the rule with any arguments passed. Any missing arguments will not be changed.
| 200 - Rule modified
| 200 - Rule modified
|
|-
|-
| 400 - One or more of the arguments is invalid
| 400 - One or more of the arguments is invalid
| errmsg
|-
| 404 - Rule does not exist
|
|-
|-
| rowspan=2 | /rules/[id]
| rowspan=2 | /rules/[id]
Line 182: Line 306:
| rowspan=2 | Delete the rule
| rowspan=2 | Delete the rule
| 200 - Rule deleted
| 200 - Rule deleted
|
|-
|-
| 404 - Rule does not exist
| 404 - Rule does not exist
|
|-
| rowspan=2 | /rules/[id]/rollback
| rowspan=2 | PUT
| rowspan=2 | rules_log_id - Id of an entry in the rules shadow table. Must be an entry with a matching rule id.
| rowspan=2 | Rollback the rule to the specified log entry
| 200 - Rule modified
|
|-
| 400 - rules_log_id doesn't exist or rule_id doesn't match
| errmsg
|-
| rowspan=3 | /rules/log
| rowspan=3 | GET
| All arguments to /rules POST are valid here
| rowspan=3 | Retrieve history of changes to rules
| 200 - Log entries returned
| JSON object whose keys are rules_log_id's and values are an object with all rule data, username, and timestamp.
|-
| startdate - Only retrieve rules newer than this date/time
| rowspan=2 | 204 - No log entries
| rowspan=2 |
|-
| enddate - Only retrieve rules older than this date/time
|-
| rowspan=2 | /users
| rowspan=2 | GET
| rowspan=2 |
| rowspan=2 | Retrieve all users referenced in the Permissions table
| 200 - Usernames returned
| List of usernames in the permission table, in JSON format
|-
| 204 - No usernames found
|
|-
| rowspan=2 | /users/[username]/permissions
| rowspan=2 | GET
| rowspan=2 |
| rowspan=2 | Retrieve all permissions that the named user has.
| 200 - Permissions returned
| List of permissions for the named user, in JSON format.
|-
| 204 - No permissions found
|
|-
| rowspan=2 | /users/[username]/permissions/[permission]
| rowspan=2 | GET
| rowspan=2 |
| rowspan=2 | Retrieve the options for a specific perimssion
| 200 - Options returned
| JSON object whose keys are option names and values are option values.
|-
| 404 - Permission does not exist
|
|-
| rowspan=3 | /users/[username]/permissions/[permission]
| rowspan=3 | PUT
| rowspan=3 | options - a JSON object whose keys are option names and values are option values
| rowspan=3 | Update the permission with the supplied arguments. If it does not exist, it will be created
| 200 - Permission modified
|
|-
| 201 - Permission created
|
|-
| 400 - Options argument is invalid
| errmsg
|-
| rowspan=2 | /users/[username]/permissions/[permission]
| rowspan=2 | DELETE
| rowspan=2 |
| rowspan=2 | Delete the permission
| 200 - Permission deleted
|
|-
| 404 - Permission does not exist
|
|}
|}


= Footnotes =
= Footnotes =
<span id="note1">1. $product-$channel-latest only works in a world where no channel names overlap, which we should be in once 1.9.2 is dead. Doing it this way ensures that we nightly updates work after version bumps happen *and* we don't need to maintain a branch name <-> version mapping a la existing AUS.</span>
<span id="note1">1. $product-$channel-latest only works in a world where no channel names overlap, which we should be in once 1.9.2 is dead. Doing it this way ensures that we nightly updates work after version bumps happen *and* we don't need to maintain a branch name <-> version mapping a la existing AUS.</span>
Bhearsum
canmove, Confirmed users
6,441

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/336735...402581"