Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New kernelci.org #407

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
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
9 changes: 7 additions & 2 deletions kernelci.org/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ enable = true
# -- docsy parameters --

[params.ui]
sidebar_menu_compact = false
sidebar_menu_compact = true
breadcrumb_disable = false
sidebar_search_disable = false
navbar_logo = true
Expand Down Expand Up @@ -91,7 +91,12 @@ footer_about_disable = false
name = "Dashboard"
url = "https://linux.kernelci.org/job"

[[menu.main]]
identifier = "about"
name = "About"
url = "/about/"

[[menu.main]]
identifier = "blog"
name = "Blog"
url = "https://kernelci.org/blog/"
url = "/blog/"
135 changes: 114 additions & 21 deletions kernelci.org/content/en/_index.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,133 @@
---
title: "Documentation"
no_list: true
toc_hide: true

cascade:
- type: "blog"
toc_root: true
_target:
path: "/blog/**"
- type: "maestro"
toc_root: true
_target:
path: "/maestro/**"
- type: "legacy"
toc_root: true
_target:
path: "/legacy/**"
- type: "api_pipeline"
toc_root: true
_target:
path: "/api_pipeline/**"
- type: "docs"
_target:
path: "/**"
---
<style>

Welcome to the KernelCI documentation website. You'll find below a summary of
the overall architecture and pointers to the main sections.

## Overall Architecture
.card {
background-clip: border-box;
border: 0px solid #edf2f9;
border-radius: 0.375rem;
}

![architecture](/image/kernelci-architecture.png)
.card-footer {
padding: 1rem 1.25rem;
background-color: #fff;
border-top: 0px solid #edf2f9;
}
.card-span .card-span-img {
position: absolute;
left: 50%;
transform: translate3d(-50%, -50%, 0);
width: 5rem;
height: 5rem;
background-color: #fff;
box-shadow: 0 0.125rem 0.25rem rgba(0, 0, 0, 0.075);
border-radius: 50%;
display: flex;
justify-content: center;
align-items: center;
}

The first thing worth noting here is that there are two main parts of the
overall KernelCI architecture:
.card-span:hover, .card-span:focus {
transform: translateY(-0.2rem);
box-shadow: 0 1rem 4rem rgba(0, 0, 0, 0.175);
}

### [API & Pipeline](api_pipeline)
body {
background-color: #edf2f9;
}

The top half of this picture shows native services interacting directly with
the API: LAVA test labs, Kubernetes clusters, custom test environments and the
job scheduler. These are referred to as the KernelCI Pipeline in a loose
sense. Such services can be run pretty much anywhere, they are just API
clients with a particular purpose.
</style>

### [KCIDB](kcidb)
Ensuring the quality, stability and long-term maintenance of the Linux kernel
<br><br>
<div class="container">
<div class="row row-cols-9">
<div class="col p-3"><a href="https://www.cip-project.org/" target="_blank"><img height="64" width="64" src="/image/cip-stacked-color.svg" alt="Civil Infrastructure Platform" title="Civil Infrastructure Platform" /></a></div>
<div class="col p-3"><a href="https://www.collabora.com/" target="_blank"><img height="64" width="64" src="/image/collabora-stacked-color.svg" alt="Collabora" title="Collabora" /></a></div>
<div class="col p-3"><a href="https://www.google.com/" target="_blank"><img height="64" width="64" src="/image/google-color.svg" alt="Google" title="Google" /></a></div>
<div class="col p-3"><a href="https://www.microsoft.com/" target="_blank"><img height="64" width="64" src="/image/microsoft-color.svg" alt="Microsoft" title="Microsoft" /></a></div>
<div class="col p-3"><a href="https://www.redhat.com/" target="_blank"><img height="64" width="64" src="/image/redhat-color.svg" alt="Red Hat" title="Red Hat" /></a></div>
<div class="col p-3"><a href="https://ti.com/" target="_blank"><img height="64" width="64" src="/image/texas-instruments.svg" alt="Texas Instruments" title="Texas Instruments" /></a></div>
<div class="col p-3"><a href="https://www.baylibre.com/" target="_blank"><img height="64" width="64" src="/image/baylibre-horizontal-color.svg" alt="Baylibre" title="Baylibre" /></a></div>
</div>
</div>
<br><br>
<div class="card-deck">
<div class="card card-span">
<div class="card-span-img">
<i class="fas fa-bug fa-2x" align="center"></i>
</div>
<div class="card-body">
<br><h3 align=center><strong>Kernel Community</strong></h3>
<p class="card-text" align=center>The linux kernel is the focal point
of all our work. Learn how to use CI services to help improve the code.
</p>
</div>
<p class="card-footer" align=center><a href="community"><small>More information &raquo;</small></a></p>
</div>
<div class="card card-span">
<div class="card-span-img">
<i class="fas fa-flask fa-2x" align="center"></i>
</div>
<div class="card-body">
<br><h3 align=center><strong>Lab Owners</strong></h3>
<p class="card-text" align=center>Do you have hardware in a lab that you
would like to share with the community? The linux kernel needs hardware to
test on whether it is virtual or real. The more hardware that is available,
the more coverage that can be provided.
</p>
</div>
<p class="card-footer" align=center><a href="labs"><small>More information &raquo;</small></a></p>
</div>
<div class="card card-span">
<div class="card-span-img">
<i class="fas fa-users fa-2x" align="center"></i>
</div>
<div class="card-body">
<br><h3 align=center><strong>CI Service Providers</strong></h3>
<p class="card-text" align=center>Continuous Integration only works if
we have services that expand our ecosystem to include more testing,
hardware, regression tracking, etc. Do you have a CI service you would like
to plug in?
</p>
</div>
<p class="card-footer" align=center><a href="ci-services"><small>More information &raquo;</small></a></p>
</div>
<div class="card card-span">
<div class="card-span-img">
<i class="fas fa-bullhorn fa-2x" align="center"></i>
</div>
<div class="card-body">
<br><h3 align=center><strong>Contributing to KernelCI</strong></h3>
<p class="card-text" align=center>KernelCI is an architecture that
helps build out a connected ecosystem, gathers results, and documents standards.
</p>
</div>
<p class="card-footer" align=center><a href="kernelci"><small>More information &raquo;</small></a></p>
</div>
</div>

Other fully autonomous systems producing their own kernel builds and running
their own tests can submit results to
[KCIDB](kcidb), which is a
[BigQuery](https://cloud.google.com/bigquery) database to provide a unified
kernel test reporting mechanism. Please take a look at this blog post for a
comprehensive description: [Introducing Common
Reporting](https://kernelci.org/blog/2020/08/21/introducing-common-reporting/).
6 changes: 6 additions & 0 deletions kernelci.org/content/en/ci-services.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "CI Services"
---

Welcome to the CI Services section

6 changes: 6 additions & 0 deletions kernelci.org/content/en/community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Developers"
---

Welcome to the Developers section

6 changes: 6 additions & 0 deletions kernelci.org/content/en/kernelci.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "KernelCI Internal"
---

Welcome to the KernelCI Internal section

6 changes: 6 additions & 0 deletions kernelci.org/content/en/labs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Labs"
---

Welcome to the Labs section

11 changes: 11 additions & 0 deletions kernelci.org/content/en/maestro/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Maestro"
date: 2024-06-19
description: "Maestro CI Service"
weight: 1
aliases:
- "/docs/team/"
---

Talk about the Maestro CI service.

File renamed without changes.
2 changes: 1 addition & 1 deletion kernelci.org/themes/docsy
Submodule docsy updated 155 files