-
Notifications
You must be signed in to change notification settings - Fork 89
Bugs
All of the MidoNet projects maintain their bugs in JIRA:
Before reporting a bug, browse through JIRA to make sure it has not been submitted already.
To report a bug, create a new JIRA issue on the appropriate project. When you are not sure which project the bug applies to, file it against the highest layer in which the problematic behavior is known to occur. That project's maintainer will investigate and move the ticket to the appropriate project.
Choose the appropriate priority level based on the following guidelines:
- Critical: Requires immediate attention. Crashes, loss of data, severe memory leak.
- Major: Requires urgent attention (as soon as possible). Major loss of function.
- Minor: Best effort. Minor loss of function, or other problem where easy workaround is present. Cosmetic problem like misspelt words or misaligned text.
Each new issue should include the following information:
- Version(s) of the OpenStack integration in which the problem was observed
- Version(s) of MidoNet in which the problem was observed
- Description of the problem
- Description of the environment
- How to reproduce
- Zookeeper data snapshot: You can use the zkdump tool to generate this file:
$ zkdump -z <zk server ip:port> -p -o <output file name>
- Relevant information about the deployment (number of nodes, IP addresses of the nodes, number of VMs)
- Known workarounds
- Whether restarting the service fixed the problem
In addition to the list above, the following information would be useful for MidoNet agent:
- Dump of the flows
- Tcpdump
Due to differences in tools and size of our team/project, we use a simplified version of the OpenStack bug triage process as explained below.
The Bug Deputies are (usually volunteers) designated by the MidoNet PTL and change after every Bug Triage Meeting after they finished reporting. They also maintain the bug stats on the meeting page.
Bug deputies this sprint are: Miguel (Slack: @miguel), Joe (Slack: @joe) and Xavi (Slack: @xavileon).
- Anyone could do the following:
- Check for duplicates
- Check that all the fields are filled out (ask the reporter for more information if not)
- The Bug Deputy must do the following:
- Prioritize (see Priorization above)
- Label as 'low-hanging-fruit' if it can be handled by a new contributor
Not actual meetings themselves, but instead part of the regular MidoNet meetings instead. Here, the Bug Deputy should point out bugs that need further/special attention.
Browse through the JIRA issues and select any that does not have anyone assigned. Assign yourself to the ticket to claim it.
Bugs that are relatively fast and easy to fix can be found under the label low hanging fruit.
Follow the Developer's Guide to submit the fix. Make sure to mention the JIRA ticket ID in the commit message so that the commit appears in the JIRA ticket.
For example:
Fixes: MNA-100
TODO: Bug Status