docs: add TOC to setup.md
Add Table of Content to setup.md
Minor adjustments
Add CRI-O logo (Thanks to Tom Sweeney)
-# Build and install CRI-O from source
+![CRI-O logo](../logo/crio-logo.svg)
-This guide will walk you through the installation of [CRI-O](https://github.com/cri-o/cri-o), an Open Container Initiative-based implementation of [Kubernetes Container Runtime Interface](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/node/container-runtime-interface-v1.md).
+# Build and install CRI-O from source
-It is assumed you are running a Linux machine.
+This guide will walk you through the installation of [CRI-O](https://github.com/cri-o/cri-o), an Open Container Initiative-based implementation of [Kubernetes Container Runtime Interface](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/node/container-runtime-interface-v1.md). It is assumed you are running a Linux machine.
+
+**Table of Content**:
+
+- [Build and install CRI-O from source](#build-and-install-cri-o-from-source)
+ * [Runtime dependencies](#runtime-dependencies)
+ * [Build and Run Dependencies](#build-and-run-dependencies)
+ + [Fedora - RHEL 7 - CentOS](#fedora---rhel-7---centos)
+ + [RHEL 8](#rhel-8)
+ + [Debian - Raspbian - Ubuntu](#debian---raspbian---ubuntu)
+ * [Get Source Code](#get-source-code)
+ * [Build](#build)
+ + [Build Tags](#build-tags)
+ * [Static builds](#static-builds)
+ + [Creating a release archive](#creating-a-release-archive)
+ * [Download conmon](#download-conmon)
+ * [Setup CNI networking](#setup-cni-networking)
+ * [CRI-O configuration](#cri-o-configuration)
+ + [Validate registries in registries.conf](#validate-registries-in-registriesconf)
+ + [Recommended - Use systemd cgroups.](#recommended---use-systemd-cgroups)
+ + [Optional - Modify verbosity of logs](#optional---modify-verbosity-of-logs)
+ + [Optional - Modify capabilities and sysctls](#optional---modify-capabilities-and-sysctls)
+ * [Starting CRI-O](#starting-cri-o)
+ * [Using CRI-O](#using-cri-o)
## Runtime dependencies
@@ -15,6 +38,8 @@ Latest version of `runc` is expected to be installed on the system. It is picked
## Build and Run Dependencies
+
+### Fedora - RHEL 7 - CentOS
**Required**
Fedora, RHEL<=7, CentOS and related distributions:
@@ -45,6 +70,7 @@ yum install -y \
btrfs-progs-devel
```
+### RHEL 8
RHEL 8 distributions:\
Make sure you are subscribed to the following repositories: \
BaseOS/x86_64 \
@@ -99,12 +125,11 @@ The following dependencies:
pkgconf-pkg-config \
```
+### Debian - Raspbian - Ubuntu
On Debian, Raspbian and Ubuntu distributions, [enable the Kubic project
repositories](../README.md#installing-crio) and install the following packages:
```bash
-# Add containers-common and cri-o-runc
-
apt-get update -qq && apt-get install -y \
btrfs-tools \
containers-common \
@@ -327,7 +352,7 @@ By default, CRI-O uses cgroupfs as a cgroup manager. However, we recommend using
cgroup_manager = "systemd"
```
-### Optional - Modify verbosity of logs in /etc/crio/crio.conf
+### Optional - Modify verbosity of logs
Users can modify the `log_level` field in `/etc/crio/crio.conf` to change the verbosity of
the logs.
