Skip to content

Commit

Permalink
Drop bugzilla references on developer guide
Browse files Browse the repository at this point in the history 
Bugzilla oVirt classification is not accepting new tickets as the
project migrated to GitHub issues tracking system.

Signed-off-by: Sandro Bonazzola <[email protected]>
  • Loading branch information
@sandrobonazzola
sandrobonazzola committed Oct 24, 2023
1 parent e97ac76 commit a5a8011
Show file tree
Hide file tree
Showing 8 changed files with 146 additions and 176 deletions.
13 changes: 13 additions & 0 deletions .markdownlint.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"MD033": {
"allowed_elements": [
"section"
]
},
"MD013": {
"line_length": 200
},
"MD025": {
"front_matter_title": ""
}
}
4 changes: 2 additions & 2 deletions source/community/about/contact.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ authors:
# Communication

There are a number of ways to communicate with the oVirt Community.
[Mailing lists](/community/about/mailing-lists.html), [IRC](#irc), our [bug tracker](https://bugzilla.redhat.com/enter_bug.cgi?classification=oVirt) and [oVirt GitHub](https://github.com/oVirt).
[Mailing lists](/community/about/mailing-lists.html), [IRC](#irc) and [oVirt GitHub](https://github.com/oVirt).

## IRC

We are on **irc.oftc.net** server on **#ovirt** channel.

## Bug tracker and code review

You can report bugs, or discuss possible solutions to issues, on [Bugzilla](https://bugzilla.redhat.com/enter_bug.cgi?classification=oVirt) and [oVirt GitHub](https://github.com/oVirt).
You can report bugs, or discuss possible solutions to issues, on [oVirt GitHub](https://github.com/oVirt).

We use GitHub to review patches.
If you are not familiar with the process, you can read about
Expand Down
42 changes: 25 additions & 17 deletions source/community/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Community
title: Get involved
authors:
- bproffitt
- dneary
Expand All @@ -14,26 +14,30 @@ hide_metadata: true
---

<section class="community_head">
# Get involved!

# Get involved

oVirt is a community-driven virtualization project and people just like you are making it happen.

</section>

<section class="container">

# Getting involved

The oVirt community is a group of multidisciplinary individuals who are contributing code, writing documentation, reporting bugs, contributing UX and design expertise, and engaging with the community.
The oVirt community is a group of multidisciplinary individuals who are contributing code, writing documentation, reporting issues,
contributing UX and design expertise, and engaging with the community.

Before getting started, we recommend that you:

- Sign up for the [[email protected] mailing list](/community/users-list.html) and send us an email saying how you would like to contribute. Visit our [mailing lists](/community/about/mailing-lists.html) page for other oVirt mailing lists to sign up for.
- Sign up for the [[email protected] mailing list](/community/users-list.html) and send us an email saying how you would like to contribute.
Visit our [mailing lists](/community/about/mailing-lists.html) page for other oVirt mailing lists to sign up for.
- For fluent, real time communication, [join us on IRC](/community/about/contact.html#irc)
- Please read our [community etiquette guidelines](/community/about/community-guidelines.html). (Quick summary: Be nice!)

# Community

oVirt is a community project, and we welcome contributions from everyone! If you'd like to write code, report bugs, contribute designs, or enhance the documentation, we would love your help!
oVirt is a community project, and we welcome contributions from everyone! If you'd like to write code, report issues, contribute designs, or enhance the documentation, we would love your help!

There are a few ways to engage with the oVirt Community:

Expand Down Expand Up @@ -67,33 +71,36 @@ To contribute translations, please follow our [How-To](/develop/localization.htm

## Documentation

oVirt needs concise, user-friendly, up-to-date installation and usage documentation. To contribute, visit the [documentation repository](https://github.com/oVirt/ovirt-site/tree/main/source/documentation) and the [documentation issues tracker](https://github.com/oVirt/ovirt-site/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation). You can also report any documentation issues you find by clicking "Report an issue with this page" at the bottom of the documentation.
oVirt needs concise, user-friendly, up-to-date installation and usage documentation.
To contribute, visit the [documentation repository](https://github.com/oVirt/ovirt-site/tree/main/source/documentation)
and the [documentation issues tracker](https://github.com/oVirt/ovirt-site/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation).
You can also report any documentation issues you find by clicking "Report an issue with this page" at the bottom of the documentation.

## Report Bugs and New Feature Requests (RFEs)
## Report Issues and New Feature Requests (RFEs)

Reporting bugs is one of the most valuable ways you can contribute! Ideas for new features are also very welcome. Report bugs and RFEs using the following issue trackers:
Reporting issues is one of the most valuable ways you can contribute! Ideas for new features are also very welcome. Report issues and RFEs using the following issue trackers:

- [How to report a bug](/community/report-a-bug.html)
- [VM Portal GitHub - bugs and RFEs in VM Portal](https://github.com/oVirt/ovirt-web-ui/issues)
- [oVirt Documentation GitHub - Documentation issues](https://github.com/oVirt/ovirt-site/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation)
- [How to report an issue](/community/report-a-bug.html)
- [oVirt Documentation issues](https://github.com/oVirt/ovirt-site/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation)
- Security issues follow a [special reporting procedure](/community/security.html).

## Monitor security reports for oVirt Node

oVirt Node contains hundreds of packages: some of them may be affected by vulnerabilities which may have critical impact.
You can help keeping oVirt Node secure by monitoring [security reports](https://bugzilla.redhat.com/buglist.cgi?quicksearch=product%3A%22security%20response%22)
and open oVirt Node trackers using [Bug 2074469](https://bugzilla.redhat.com/show_bug.cgi?id=2074469) as template.
You can help keeping oVirt Node secure by monitoring [security reports](https://access.redhat.com/security/security-updates/cve)
and open [oVirt Node issue trackers](https://github.com/oVirt/ovirt-node-ng-image/issues).

Once the tracker is open you can help monitoring progress of the security fix.
Look at [existing security reports in oVirt Node](https://bugzilla.redhat.com/buglist.cgi?quicksearch=product%3Aovirt-node%20keyword%3Asecurity)
and check corresponding package on [CentOS Stream 8 Koji](https://koji.mbox.centos.org/koji/packages).
If a fix for the CVE is available, update Bugzilla accordingly. As an example you can see [Bug 2074469 handling](https://bugzilla.redhat.com/show_bug.cgi?id=2074469#c1)
Look at [existing security reports in oVirt Node](https://github.com/oVirt/ovirt-node-ng-image/issues?q=is%3Aissue+is%3Aopen+label%3Asecurity)
and check corresponding package on [CentOS Stream 8 Koji](https://koji.mbox.centos.org/koji/packages) and [CentOS Stream 9 Koji](https://kojihub.stream.centos.org/koji/packages).
If a fix for the CVE is available, update the traker issue accordingly.

## Participate in the oVirt infrastructure

Our project infrastructure can always benefit from extra people, hardware and network bandwidth.
First of all, consider [hosting a public mirror](/community/get-involved/repository-mirrors.html) of oVirt repositories.
You can also [become an infra team member](/community/becoming-an-infrastructure-team-member.html) or [donate GitHub runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) to the project to improve our capacity and redundancy.
You can also [become an infra team member](/community/becoming-an-infrastructure-team-member.html) or
[donate GitHub runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) to the project to improve our capacity and redundancy.

## Supporters, Sponsors, and Providers

Expand All @@ -117,4 +124,5 @@ You can find some of them listed here:
- [oVirt Simple Backup](https://github.com/zipurman/oVIRT_Simple_Backup)
- [oVirt Desktop Client](https://github.com/nkovacne/ovirt-desktop-client)
- [oVirt filesystem in userspace](https://github.com/yuvalturg/ovirtfs)

</section>
13 changes: 7 additions & 6 deletions source/develop/developer-guide/readme_template.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ In order to welcome contributors be sure to direct them to the right places.

Here you can find a template (be sure to replace links and names accordingly).


```markdown
# oVirt PROJECTNAME

Expand All @@ -16,15 +15,17 @@ All contributions are welcome - patches, bug reports, and documentation issues.

### Submitting patches

Please submit patches to [GitHub:PROJECTNAME](https://github.com/oVirt/PROJECTNAME). If you are not familiar with the process, you can read about [collaborating with pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests) on the GitHub website.
Please submit patches to [GitHub:PROJECTNAME](https://github.com/oVirt/PROJECTNAME). If you are not familiar with the process, you can read about
[collaborating with pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests)
on the GitHub website.

### Found a bug or documentation issue?
### Found a project or documentation issue?

To submit a bug or suggest an enhancement for oVirt PROJECTNAME please use [oVirt Bugzilla](https://bugzilla.redhat.com/enter_bug.cgi?product=PROJECTNAME).
To submit a bug or suggest an enhancement for oVirt PROJECTNAME please use [oVirt PROJECTNAME issue tracker](https://github.com/oVirt/PROJECTNAME/issues).

If you don't have a Bugzilla account, you can still report [issues](https://github.com/oVirt/PROJECTNAME/issues). If you find a documentation issue on the oVirt website, please navigate to the page footer and click "Report an issue on GitHub".
If you find a documentation issue on the oVirt website, please navigate to the page footer and click "Report an issue on GitHub".

## Still need help?

If you have any other questions or suggestions, you can join and contact us on the [oVirt Users forum / mailing list](https://lists.ovirt.org/admin/lists/users.ovirt.org/).
```
```
109 changes: 38 additions & 71 deletions source/develop/developer-guide/vdsm/todo.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,108 +22,75 @@ We intend to move this TODO into this [Trello board](https://trello.com/b/U3lsbV

#### infra

* `` pylint -E `git ls-files | grep '.py$'` `` makes me cry. A lot of it is "only" about bad style, but we should clear it up and add it to our `make check-local`. We should grow up and pass `pychecker` too.
* ``pylint -E `git ls-files | grep '.py$'` `` makes me cry.
A lot of it is "only" about bad style, but we should clear it up and add it to our `make check-local`.
We should grow up and pass `pychecker` too.

<!-- -->
* Add git submodules for pyflakes and pep8 to vdsm. Control the specific version of each tool to use from within the vdsm build itself.
This way we can make sure everyone is using the same version of the tools regardless of where vdsm is being built.
* See <https://github.com/jcrocholl/pep8> and <https://github.com/pyflakes/pyflakes/>

* Add git submodules for pyflakes and pep8 to vdsm. Control the specific version of each tool to use from within the vdsm build itself. This way we can make sure everyone is using the same version of the tools regardless of where vdsm is being built.
- See <https://github.com/jcrocholl/pep8> and <https://github.com/pyflakes/pyflakes/>

<!-- -->

* BindingXML's wrapApiMethod is incredibly fragile when deciding what not to log. Logging should be done as a decorator per called function, after password entries are converted to ProtectedPassword.
* BindingXML's wrapApiMethod is incredibly fragile when deciding what not to log. Logging should be done as a decorator per called function, after password entries are converted to ProtectedPassword.

### Testing

* Add `` `make distcheck` `` to Jenkins's jobs.

<!-- -->

* Wrap all tests and fail a test that leaves an open file descriptor behind.

<!-- -->

* add a unit test for qemuimg.rebase.
* Add `` `make distcheck` `` to GitHub actions.

<!-- -->
* Wrap all tests and fail a test that leaves an open file descriptor behind.

* make @permutations nestable
* add a unit test for `qemuimg.rebase`.

<!-- -->
* make `@permutations` nestable

* test fileSD.scanDomains()
* test `fileSD.scanDomains()`

<!-- -->
* add migration tests

* add migration tests

<!-- -->

* test cannonizeHostPort
* test `cannonizeHostPort`

### Features

* Support striping for disk images.

<!-- -->
* Support striping for disk images.

* let Vdsm install and run on hosts with no iscsid (report that iscsi is missing to Engine?)
* let Vdsm install and run on hosts with no iscsid (report that iscsi is missing to Engine?)

<!-- -->

* start Vdsm only when it receives a request (integrate with systemd)
* start Vdsm only when it receives a request (integrate with systemd)

#### Networking

* Modify vdsm-tool restore-nets so that the management network (or the network with the default IPv4 route) is the last to be taken down and the first to be taken up to minimize the connectivity loss (very useful when accessing the machine remotely). Minimize vdsm-restore-net-config downtime for the default route network.

<!-- -->
* Modify vdsm-tool restore-nets so that the management network (or the network with the default IPv4 route) is the last
to be taken down and the first to be taken up to minimize the connectivity loss (very useful when accessing the machine remotely).
Minimize vdsm-restore-net-config downtime for the default route network.

* ~~Split off the network restoration from vdsm startup so that it is performed in a different init service. This vdsm-network-restoration service should be oneshot and happen before network.service. <http://gerrit.ovirt.org/#/c/29441/>~~
* ~~Split off the network restoration from vdsm startup so that it is performed in a different init service.
This vdsm-network-restoration service should be oneshot and happen before network.service. <http://gerrit.ovirt.org/#/c/29441/>~~

<!-- -->
* Fine-grained control on network-specific routes.

* Fine-grained control on network-specific routes.
* Allow multiple setting IPv4 and IPv6 addresses per network device. (API change is needed; we report multiple ipv6 addresses).

<!-- -->
* models: support multiple IPv4 and/or IPv6 addresses

* Allow multiple setting IPv4 and IPv6 addresses per network device. (API change is needed; we report multiple ipv6 addresses).
* get a single dump of all libvirt networks (no libvirt API for it yet...)

<!-- -->
* IPv4 routing table Id hash mechanism
* change the 'network' argument in routes to 'link scope route'

* - models: support multiple IPv4 and/or IPv6 addresses
* move source routing info to route.py (which uses netlink instead of using the default configurator). this will also simplify StaticSourceRoute

<!-- -->
* Move vdsm-store-net-config logic to netconfbackpersistence.py

* get a single dump of all libvirt networks (no libvirt API for it yet...)


<!-- -->

* IPv4 routing table Id hash mechanism
- change the 'network' argument in routes to 'link scope route'

<!-- -->

* move source routing info to route.py (which uses netlink instead of using the default configurator). this will also simplify StaticSourceRoute

<!-- -->

* Move vdsm-store-net-config logic to netconfbackpersistence.py

<!-- -->

* Add configureIp to the configurators API so that Layer 3 can be configured in parallel after Layer 2 (and it gives much better modelling). Obviously, this isn't really possible in ifcfg without doing a two step write which is an ugly hack.
* Add configureIp to the configurators API so that Layer 3 can be configured in parallel after Layer 2 (and it gives much better modelling).
Obviously, this isn't really possible in ifcfg without doing a two step write which is an ugly hack.

### refactoring

* In vm.py, libvirtvm.py, clientIF.py there is a mess of prepare\*Path functions (end their respective teardowns), which is too complex to fathom. We have to convert all drive specifications (PDIV,GUID,path) into Drive object at the API entry.

<!-- -->

* lvm.PV.guid is devicemapper-owned piece of information; lvm has nothing to do with it, and jumps through [hoops](http://gerrit.ovirt.org/2940) to produce it. Instead, it should be produced by devicemapper and consumed directly by blockSD.
* In vm.py, libvirtvm.py, clientIF.py there is a mess of prepare\*Path functions (end their respective teardowns), which is too complex to fathom.
We have to convert all drive specifications (PDIV,GUID,path) into Drive object at the API entry.

### Bugzilla
* lvm.PV.guid is devicemapper-owned piece of information; lvm has nothing to do with it, and jumps through [hoops](http://gerrit.ovirt.org/2940) to produce it.
Instead, it should be produced by devicemapper and consumed directly by blockSD.

* pick one of the [<https://bugzilla.redhat.com/buglist.cgi?action=wrap&bug_file_loc>=&bug_file_loc_type=allwordssubstr&bug_id=&bug_id_type=anyexact&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=vdsm&deadlinefrom=&deadlineto=&email1=&email2=&emailtype1=substring&emailtype2=substring&field0-0-0=flagtypes.name&keywords=&keywords_type=allwords&longdesc=&longdesc_type=allwordssubstr&short_desc=&short_desc_type=allwordssubstr&status_whiteboard=&status_whiteboard_type=allwordssubstr&type0-0-0=notsubstring&value0-0-0=rhel-6.2.0&votes=&=&bug_status=NEW NEW bugs], post a patch to [gerrit](http://gerrit.ovirt.org), and make the bug yours.
### Issues

* pick one of the [open issues](https://github.com/oVirt/vdsm/issues), post a pull request to [GitHub](https://github.com/oVirt/vdsm/pulls), and make the issue yours.
Loading

0 comments on commit a5a8011

Please sign in to comment.