Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions docs/teams/rel_eng/bugs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
title: Reporting bugs and requests for enhancement (RFE)
author: Release Engineering
contributors: Steven Spencer
---

The Rocky Linux project has several ways of reporting issues or requesting enhancements, depending on what the issue is and who it pertains to. The aim of this resource is to guide you to the correct location.

## Rocky Linux (core distribution)

### Bugs

!!! note

The Bug Tracker is **not** meant for general support questions. A maintainer will close a bug immediately if it is found to be a general question rather than a bug report.

Bugs are an inevitable part of any Linux distribution. Users who find problems need a way to report the bug.

You should report all bugs in our [Bug Tracker](https://bugs.rockylinux.org).

### Bug Tracker guidelines

These guidelines are what you should expect using the Bug Tracker system.

**Mantis Bug Tracker** is a core component of the Rocky Linux distribution. If you are a bug reporter, a contributor, or even a member of the Release Engineering team, the Bug Tracker facilitates engagement for everyone. It helps resolve issues in the software available within the distribution.

As a reporter, you should follow these guidelines and expectations when reporting issues or bugs on the Bug Tracker. Following these helps to keep the queues clean, consistent, and readable. This helps the responsible party address the issue in a proper manner.

Guidelines:

* The Rocky Linux team enforces moderation - As is the case with Rocky Linux Mattermost chat, it is important to mind your language and word choice. Speak to others as you would want them to speak to you.
* The Bug Tracker is not a place for support - The Bug Tracker is for issues, bugs, and problems with the packages and software in Rocky Linux. The team closes tickets opened that are asking for support on the operating system or software. You should use our subreddit, Libera IRC channel (#rockylinux), Mattermost, or our forums, for such support.
* There is no support for custom compiled software and libraries, including those that either replace or live side-by-side with system packages. The team closes most such reports.

Expectations:

* Ensure your report goes to the correct project - There is a list of projects that accept bug reports or issues. The drop down is on the top right corner of the Bug Tracker. Choose the one most appropriate to your issue.
* Ensure that you provide relevant information - When submitting a report that might be a bug or issue, ensure that you provide relevant logs and output that can help the responsible parties to address your issue. This includes:
* Logs from `/var/log`
* `journalctl` logs
* Console output in your shell or session
* An archive created by `sosreport`
* Patch files or workarounds
* Do **NOT** attempt to submit arbitrary scripts. The team will reject these. This includes but is not limited to `sh`, `py`, `pl` files.
* Do not submit support questions - The Bug Tracker is not a support desk. The team will close tickets of this nature. Use our reddit, Libera IRC channel (#rockylinux), or our forum, for such issues.

!!! note

The team may ask you to reproduce the issue on Red Hat Enterprise Linux (RHEL). If the issue is reproducible on RHEL, they will encourage you to open a bug report at [Red Hat Jira](https://issues.redhat.com). The assignee on your bug report can do this for you if you wish.

#### Ticket types

While reporting bugs and issues are common with bug trackers, the tracker also accepts other reports. Such as:

* Account Removal - If you are requesting removing or disabling your account, You can do this in the Account Services section of the Bug Tracker.
* GitLab Request - There might be patch, repos missing or something else that involves a group or even a Special Interest Group (SIG).
* Rocky Services - This could be the Bug Tracker itself, the wiki, or other pieces of infrastructure.

### RFE (Request for enhancement)

Requests for enhancements to packages[^1] are typically handled in the [Bug Tracker](https://bugs.rockylinux.org). In some cases, this might not apply. A Special Interest Group (SIG) might ask that you submit an RFE elsewhere. See the SIGs section later on this page.

## Rocky Linux Infrastructure and Services

Rocky Linux Infrastructure have responsibility over several areas including:

* [Mirror Manager](https://mirrors.rockylinux.org)
* [Account Services](https://accounts.rockylinux.org)
* [RESF Git Service](https://git.resf.org)
* [Rocky Linux Git Service](https://git.rockylinux.org)
* [Mail List](https://lists.resf.org)
* General Special Interest Group requests (such as resources)

Infrastructure and Services encourages the submission of issues and requests go to their [Infrastructure Meta](https://git.resf.org/infrastructure/meta/issues) tracker.

## Special interest groups (SIGs)

Each Special Interest Group might do things differently from the next. In a majority of cases, a SIG will receive a group at the [RESF Git Service](https://git.resf.org) and a "meta" repository. However, a SIG can choose not to use this and might note on their documentation where to go instead.

Examples of SIGs that use "meta" are:

* [SIG/AltArch](https://git.resf.org/sig_altarch/meta/issues)
* [SIG/HPC](https://git.resf.org/sig_hpc/meta/issues)
* [SIG/Kernel](https://git.resf.org/sig_kernel/meta/issues)

## Other Resources

If you have reproduced a bug or an issue in RHEL or even CentOS Stream, or you want to request something for a future Enterprise Linux versions, you should submit a report to the [Red Hat Jira](https://issues.redhat.com). Below are some quick links for submitting such requests.

* [Red Hat Enterprise Linux](https://issues.redhat.com/projects/RHEL/issues/RHEL-2997?filter=allopenissues) - For RHEL bugs found in both Rocky Linux and RHEL
* [CentOS Stream](https://issues.redhat.com/projects/CS/issues/CS-1759?filter=allopenissues) - Bugs or RFE's for CentOS Stream

Depending on the package or feature, it might be something that you can request in a SIG, plus, or extras repositories. You can also request a package inclusion to EPEL at the [Red Hat Bugzilla](https://bugzilla.redhat.com).

[^1]: Packages might be for a core Rocky Linux package or a Special Interest Group package. Note that if the RFE is for a Rocky Linux core package, the team will likely reject it and might encourage you to request it upstream to CentOS Stream. If the RFE is to a package that contains `rocky-` in the name *or* it is a package that we actively patch, the team might consider it. The team encourages RFE's to prepare for upcoming features from Stream to RHEL.
63 changes: 63 additions & 0 deletions docs/teams/rel_eng/errata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Rocky Linux Errata
author: Release Engineering
contributors: Steven Spencer
---

This page goes over general information about the Rocky Linux errata and its backend system.

## Errata Resources

* [Errata Browser](https://errata.build.resf.org/)
* [Errata API Endpoint](https://apollo.build.resf.org/)
* [Errata API Endpoint OpenAPI Specs](https://gist.github.com/mstg/16dec9f3f63ce16bce79816575ab9791)
* [Errata RSS Endpoint](https://apollo.build.resf.org/v2/advisories:rss)

## General Errata Information

A system called "Apollo" together with the build system `peridot` generate errata. The Apollo system replaces the old errata system "secparse" and effectively generates the `updateinfo.xml` data that will appear in repositories. This provides information such as:

* Security advisories (RLSA)
* Bugfix advisories (RLBA)
* Enhancement advisories (RLEA)

This information generally attempts to match the advisories provided by Red Hat. You can find errata for your system by running `dnf updateinfo`.

```bash
# dnf updateinfo
Last metadata expiration check: 1:41:31 ago on Thu 22 Sep 2022 10:00:23 PM MST.
Updates Information Summary: available
1 New Package notice(s)
5 Security notice(s)
4 Important Security notice(s)
1 Moderate Security notice(s)
1 Bugfix notice(s)
1 Enhancement notice(s)
Security: kernel-core-4.18.0-372.19.1.el8_6.x86_64 is an installed security update
Security: kernel-core-4.18.0-372.9.1.el8.x86_64 is the currently running version
```

You can also run `dnf updateinfo list` to see the full list that applies to your system. If you use the EPEL (Extra Packages for Enterprise Linux), you might see `FEDORA-EPEL` advisories as well.

```bash
# dnf updateinfo list
RLSA-2022:6159 Moderate/Sec. curl-7.61.1-22.el8_6.4.x86_64
FEDORA-EPEL-2022-232803ed1b enhancement distribution-gpg-keys-1.77-1.el8.noarch
RLSA-2022:5564 Important/Sec. kernel-4.18.0-372.16.1.el8_6.x86_64
RLSA-2022:5819 Important/Sec. kernel-4.18.0-372.19.1.el8_6.x86_64
RLSA-2022:5564 Important/Sec. kernel-core-4.18.0-372.16.1.el8_6.x86_64
RLSA-2022:5819 Important/Sec. kernel-core-4.18.0-372.19.1.el8_6.x86_64
RLSA-2022:5564 Important/Sec. kernel-modules-4.18.0-372.16.1.el8_6.x86_64
RLSA-2022:5819 Important/Sec. kernel-modules-4.18.0-372.19.1.el8_6.x86_64
FEDORA-EPEL-2022-42c9410b12 bugfix koji-1.30.0-1.el8.noarch
RLSA-2022:6159 Moderate/Sec. libcurl-7.61.1-22.el8_6.4.x86_64
FEDORA-EPEL-2022-42c9410b12 bugfix python3-koji-1.30.0-1.el8.noarch
FEDORA-EPEL-2022-42c9410b12 bugfix python3-koji-cli-plugins-1.30.0-1.el8.noarch
FEDORA-EPEL-2019-6adf1e0ef3 newpackage python3-psutil-5.6.3-5.el8.x86_64
RLSA-2022:6180 Important/Sec. rsync-3.1.3-14.el8_6.3.x86_64
RLSA-2022:6206 Important/Sec. systemd-239-58.el8_6.4.x86_64
RLSA-2022:6206 Important/Sec. systemd-container-239-58.el8_6.4.x86_64
RLSA-2022:6206 Important/Sec. systemd-libs-239-58.el8_6.4.x86_64
RLSA-2022:6206 Important/Sec. systemd-pam-239-58.el8_6.4.x86_64
RLSA-2022:6206 Important/Sec. systemd-udev-239-58.el8_6.4.x86_64
```
149 changes: 149 additions & 0 deletions docs/teams/rel_eng/image.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
---
title: Rocky Linux ISOs and Images
author: Release Engineering
contributors: Steven Spencer
---

For a given Rocky Linux release, Release Engineering provides the generation of ISOs and images to the community. This process provides different methods of installing Rocky Linux, whether that is a full DVD iso, a boot iso, live desktop, or even cloud, images.

It is important to note that the images and what they provide may differ between major releases. This can include packages, installable or installed groups, and more.

## About ISO Images

| Version | boot | minimal | dvd | Architectures |
|---------------------------------------------------------------|------|---------|-----|------------------------------------------|
| [Rocky Linux 8](http://dl.rockylinux.org/pub/rocky/8/isos/) | Yes | Yes | Yes | x86_64, aarch64 |
| [Rocky Linux 9](http://dl.rockylinux.org/pub/rocky/9/isos/) | Yes | Yes | Yes | x86_64, aarch64, ppc64le, s390x |
| [Rocky Linux 10](http://dl.rockylinux.org/pub/rocky/10/isos/) | Yes | Yes | Yes | x86_64, aarch64, ppc64le, s390x, riscv64 |

Every Rocky Linux release gets a set of ISOs. These ISOs are made by the tooling used to make and finalize the distribution. For a given Rocky Linux release, they will live in an `isos` directory at the root of a Rocky Linux release.

There are three formats for the ISO's. See the notes below.

### Notes about multiple ISO images

There are multiple templated formats for each ISO you may see.

| Format | Type | Context |
|--------------------------|----------|---------------------------|
| Rocky-X.Y-ARCH-TYPE | ISO File | Day of release ISO |
| Rocky-X.Y-DATE-ARCH-TYPE | ISO File | Rebuilt ISO |
| Rocky-ARCH-TYPE | Symlink | Symlink to the latest ISO |

* X is the major version
* Y is the minor version
* ARCH is the architecture
* DATE will be the date the ISO was built (if applicable)
* TYPE will be the type of ISO (boot, dvd, minimal)

The first format is the most common and is the day-of-release ISO.

The second format is in the case of rebuilt ISOs, typically in the case of addressing a bug or providing updated images (in the case of a newer kernel, a new secure boot shim, and so on).

The third format is a symlink to the "latest" ISO, which is deprecated and will not appear in versions after Rocky Linux 9.

### Notes about what each ISO does

Each provided ISO has a specific purpose.

* The `boot` image, also known as the "net install" media, is used to perform Rocky Linux installations over the internet.
* The `minimal` image is typically used to install a minimal Rocky Linux environment without downloading the entire DVD image or using the `boot` ISO to do so.

* The equivalent dnf group or environment would be `Minimal Install`
* The equivalent dnf group or environment for a kickstart would be `@^minimal-environment` - This can also be used with dnf install as `@minimal-environment`
* The `dvd` image, or also known as the "everything" or "BaseOS" media, contains everything needed to do a custom installation of Rocky Linux without needing an internet connection.

### Notes about writing the ISO

There are many ways to write ISOs to a USB. Listed here are the recommended and not recommended methods.

#### Recommended

* Fedora Media Writer

* [Windows](https://getfedora.org/fmw/FedoraMediaWriter-win32-latest.exe)
* [MacOS](https://getfedora.org/fmw/FedoraMediaWriter-osx-latest.dmg)
* On Fedora: `dnf install mediawriter`
* [dd for windows](http://www.chrysocome.net/dd)
* [Rawrite32](https://www.netbsd.org/~martin/rawrite32/)

#### Not recommended (avoid)

Release Engineering lists the following tools as **do not use**. They might break isohybrid images or cause other inconsistencies:

* rufus
* unetbootin
* multibootusb
* universal usb installer

!!! warning

Rufus can **only** work for Rocky Linux images if you use "dd mode". Do **not** use ISO mode as it will result in a broken installer. Release Engineering recommends that you use a writer from the recommended section on this page.

## About Cloud Images

Every Rocky Linux release gets a set of cloud images that cloud infrastructure can use as they see fit. They live in an `images` directory at the root of a Rocky Linux release.

| Version | Generic Cloud | EC2 |
|-----------------------------------------------------------------|---------------------------------|-----------------------|
| [Rocky Linux 8](https://dl.rockylinux.org/pub/rocky/8/images/) | Yes (x86_64, aarch64) | Yes (x86_64, aarch64) |
| [Rocky Linux 9](https://dl.rockylinux.org/pub/rocky/9/images/) | Yes (x86_64, aarch64, others\*) | Yes (x86_64, aarch64) |
| [Rocky Linux 10](https://dl.rockylinux.org/pub/rocky/10/images/)| Yes (x86_64, aarch64, others\*) | Yes (x86_64, aarch64) |

There are two formats for the images:

| Format | Type | Context |
|-------------------------------------------|------------|-------------------------------------|
| Rocky-X-CLOUD{-TYPE}-X.Y-DATE-ARCH.FORMAT | Image File | Any given cloud image |
| Rocky-X-CLOUD{-TYPE}.latest.ARCH.FORMAT | Symlink | Symlink to the latest image |
| Rocky-X-CLOUD.latest.ARCH.FORMAT | Symlink | Symlink to the latest primary image |

* X is the major version
* Y is the minor version
* ARCH is the architecture
* DATE will be the date of when the image was produced (YYYYMMDD.X, X starts at 0)
* CLOUD will the type of cloud image (e.g., GenericCloud)
* TYPE will be the type of image such as Base or LVM, if applicable
* FORMAT will be `raw` or `qcow2`

The first format will always exist. Cloud images will appear in this format in majority of cases and there might be more than one at any given time. Updates can occur for newer kernels or to address issues in previous versions. This means the date will change frequently.

The second format is a symlink to the latest cloud image of that variant and type, if applicable.

The third format is a symlink to the latest available image. Users, mirrors, and service providers can script this download location if they want to always pull the latest available. This is typically the "Base" variant.

## About Live Images

Every Rocky Linux release provides a set of live images that a user can download, boot, use, and optionally install to their systems. The live images are desktop oriented images that are primarily for desktop use cases and try to closely match similarly to what Fedora provides for their releases.

| Version | GNOME / Workstation | KDE | XFCE | Architectures |
|----------------------------------------------------------------|---------------------|---------|------|-----------------|
| [Rocky Linux 8](https://dl.rockylinux.org/pub/rocky/8/live/) | Yes | No\* | Yes | x86_64 |
| [Rocky Linux 9](https://dl.rockylinux.org/pub/rocky/9/live/) | Yes | Yes | Yes | x86_64, aarch64 |
| [Rocky Linux 10](https://dl.rockylinux.org/pub/rocky/10/live/) | Yes | Yes | No | x86_64, aarch64 |

\* This image is not available either due to image/package issues or issues with the desktop environment in that version of Rocky Linux.

### Notes about missing architectures

There might be other live images for different architectures in the future. You can check availability by going to the Rocky Linux version link to see if another architecture exists.

### Notes about Kickstarts

You can find the kickstarts that help generate these live images at [https://git.resf.org/sig_core/kickstarts](https://git.resf.org/sig_core/kickstarts) and the mirror at [https://github.com/rocky-linux/kickstarts](https://github.com/rocky-linux/kickstarts).

## About Pi Images (maintained by SIG/AltArch)

The raspberry pi images are exactly what is labeled on the tin: images for the means of installing to an sd card to run Rocky Linux on a raspberry pi. SIG/AltArch community members support these images.

You can find these images in the [SIG](http://dl.rockylinux.org/pub/sig/) directories.

You can find the git repository that contains the kickstart and other related data for the creation of these images at [https://git.resf.org/sig_altarch/RockyRpi](https://git.resf.org/sig_altarch/RockyRpi).

For general quickstart information, checkout the readme for the images.

| Version | README (direct) |
|----------------------------------------------------------------------------------------------- |---------------------------------------------------------------------------------|
| [Rocky Linux 8 for Raspberry Pi](https://dl.rockylinux.org/pub/sig/8/altarch/aarch64/images/) | [README](https://dl.rockylinux.org/pub/sig/8/altarch/aarch64/images/README.txt) |
| [Rocky Linux 9 for Raspberry Pi](https://dl.rockylinux.org/pub/sig/9/altarch/aarch64/images/) | [README](https://dl.rockylinux.org/pub/sig/9/altarch/aarch64/images/README.txt) |
| [Rocky Linux 10 for Raspberry Pi](https://dl.rockylinux.org/pub/sig/10/altarch/aarch64/images/)| [README](https://dl.rockylinux.org/pub/sig/10/altarch/aarch64/images/README.txt)|
Loading
Loading