Commit 5869fcab authored by Karol Latecki's avatar Karol Latecki Committed by Tomasz Zawadzki
Browse files

docs: update ci_tools and distributions docs 



These are outdated, still referring to ci.spdk.io
and describing previous CI configuration. Align
with current state of the CI using Github Actions.

Change-Id: Ifbe5d01bd163ca98af5b111b0ca45cd02f6ddf77
Signed-off-by: default avatarKarol Latecki <karol.latecki@nutanix.com>
Reviewed-on: https://review.spdk.io/c/spdk/spdk/+/25744


Reviewed-by: default avatarTomasz Zawadzki <tomasz@tzawadzki.com>
Tested-by: default avatarSPDK Automated Test System <spdkbot@gmail.com>
Reviewed-by: default avatarMateusz Kozlowski <mateusz.kozlowski@solidigm.com>
Reviewed-by: default avatarMichal Berger <michal.berger@nutanix.com>
parent 414d8024

doc/ci_tools.md

+1 −1
Original line number Diff line number Diff line 
# CI Tools {#ci_tools}



Section describing tools used by CI to verify integrity of the submitted

patches ([status](https://ci.spdk.io)).

patches ([status](https://github.com/spdk/spdk-ci/actions)).



- @subpage shfmt

- @subpage distributions

doc/distributions.md

+29 −52
Original line number Diff line number Diff line
@@ -4,75 +4,52 @@ 


* @ref distros_overview

* @ref linux_list

* @ref freebsd_list



## Overview {#distros_overview}



CI pool uses different flavors of `Linux` and `FreeBSD` distributions which are

used as a base for all the tests run against submitted patches. Below is the

listing which covers all currently supported versions and the related CI

jobs (see [status](https://ci.spdk.io) as a reference).

CI pool uses Fedora Linux as primary OS distribution to run SPDK tests.

Below is the listing which covers all currently supported versions and the

related CI jobs.



See [spdk/spdk-ci](https://github.com/spdk/spdk-ci) for the most up-to-date

reference for SPDK CI configuration.



## Linux distributions {#linux_list}



### Fedora



Trying to follow new release as per the release cycle whenever possible.

## Fedora 40



```list

- autobuild-vg-autotest

- clang-vg-autotest

- iscsi*-vg-autotest

- nvme-vg-autotest

- nvmf*-vg-autotest

- scanbuild-vg-autotest

- unittest-vg-autotest

- vhost-initiator-vg-autotest

```



Jobs listed below are run on bare-metal systems where version of

Fedora may vary. In the future these will be aligned with the

`vg` jobs.

Fedora 40 is used to run virtualized and containerized tests in

Github Actions workflows.



Tests run using Fedora 40 in virtualized environment:

```list

- BlobFS-autotest

- crypto-autotest

- nvme-phy-autotest

- nvmf*-phy-autotest

- vhost-autotest

- bdev-vm-autotest

- ftl-vm-autotest

- nvme-vm-autotest

- nvmf-tcp-uring-vm-autotest

- nvmf-tcp-vm-autotest

- raid-vm-autotest

```



### Ubuntu



Last two LTS releases. Currently `20.04` and `22.04`.



Tests run using Fedora 40 in containerized environment:

```list

- ubuntu20-vg-autotest

- ubuntu22-vg-autotest

- build-files-container-autotest

- check-format-container-autotest

- check-so-deps-container-autotest

- doc-container-autotest

- release-build-gcc-container-autotest

- scan-build-container-autotest

- unittest-gcc-container-autotest

```



### CentOS



Maintained releases. Currently `7.9`.



```list

- centos7-vg-autotest

```



### Rocky Linux



Last release. Currently `8.6`. CentOS 8 replacement.



```list

- rocky8-vg-autotest

```



## FreeBSD distributions {#freebsd_list}



### FreeBSD

## Fedora 39



Production release. Currently `12.2`

Fedora 39 is used to run tests in virtualized environment, but

using actual, physical hardware passed into virtual machines.



Tests run using Fedora 39:

```list

- freebsd-vg-autotest

- hpe-nvmf-rdma

```