mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-10-21 11:58:41 +00:00
docs: Remove table of contents
Removed all TOCs now that GitHub auto-generates them. Also updated the documentation requirements doc removing the requirement to add a TOC. Fixes: #2022. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt
@@ -1,14 +1,5 @@
|
||||
# Agent Control tool
|
||||
|
||||
* [Overview](#overview)
|
||||
* [Audience and environment](#audience-and-environment)
|
||||
* [Full details](#full-details)
|
||||
* [Code summary](#code-summary)
|
||||
* [Running the tool](#running-the-tool)
|
||||
* [Prerequisites](#prerequisites)
|
||||
* [Connect to a real Kata Container](#connect-to-a-real-kata-container)
|
||||
* [Run the tool and the agent in the same environment](#run-the-tool-and-the-agent-in-the-same-environment)
|
||||
|
||||
## Overview
|
||||
|
||||
The Kata Containers agent control tool (`kata-agent-ctl`) is a low-level test
|
||||
|
||||
@@ -1,27 +1,5 @@
|
||||
# osbuilder
|
||||
|
||||
* [osbuilder](#osbuilder)
|
||||
* [Introduction](#introduction)
|
||||
* [Terms](#terms)
|
||||
* [Building](#building)
|
||||
* [Rootfs creation](#rootfs-creation)
|
||||
* [Rootfs with systemd as init](#rootfs-with-systemd-as-init)
|
||||
* [Rootfs with the agent as init](#rootfs-with-the-agent-as-init)
|
||||
* [dracut based rootfs](#dracut-based-rootfs)
|
||||
* [Image creation](#image-creation)
|
||||
* [Image with systemd as init](#image-with-systemd-as-init)
|
||||
* [Image with the agent as init](#image-with-the-agent-as-init)
|
||||
* [dracut based image](#dracut-based-image)
|
||||
* [Initrd creation](#initrd-creation)
|
||||
* [Rootfs based initrd](#rootfs-based-initrd)
|
||||
* [dracut based initrd](#dracut-based-initrd)
|
||||
* [dracut options](#dracut-options)
|
||||
* [Add kernel modules](#add-kernel-modules)
|
||||
* [Custom images](#custom-images)
|
||||
* [Intel® QuickAssist Technology (QAT) customized kernel and rootfs](#intel-quickassist-technology-qat-customized-kernel-and-rootfs)
|
||||
* [Testing](#testing)
|
||||
* [Platform-Distro Compatibility Matrix](#platform-distro-compatibility-matrix)
|
||||
|
||||
## Introduction
|
||||
|
||||
The Kata Containers runtime creates a virtual machine (VM) to isolate a set of
|
||||
|
||||
@@ -1,8 +1,3 @@
|
||||
|
||||
* [Introduction](#introduction)
|
||||
* [Building](#building)
|
||||
* [Options](#options)
|
||||
|
||||
## Introduction
|
||||
|
||||
The files in this directory can be used to build a modified Kata Containers rootfs
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
* [Creating a guest OS image](#creating-a-guest-os-image)
|
||||
* [Further information](#further-information)
|
||||
|
||||
# Kata Containers image generation
|
||||
|
||||
A Kata Containers disk image is generated using the `image_builder.sh` script.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
* [Creating a guest OS initrd image](#creating-a-guest-os-initrd-image)
|
||||
* [Further information](#further-information)
|
||||
|
||||
# Kata Containers initrd image generation
|
||||
|
||||
A Kata Containers initrd image is generated using the `initrd_builder.sh` script.
|
||||
|
||||
@@ -1,20 +1,3 @@
|
||||
* [Building a Guest OS rootfs for Kata Containers](#building-a-guest-os-rootfs-for-kata-containers)
|
||||
* [Supported base OSs](#supported-base-oss)
|
||||
* [Extra features](#extra-features)
|
||||
* [Supported distributions list](#supported-distributions-list)
|
||||
* [Generate Kata specific files](#generate-kata-specific-files)
|
||||
* [Rootfs requirements](#rootfs-requirements)
|
||||
* [Creating a rootfs](#creating-a-rootfs)
|
||||
* [Creating a rootfs with kernel modules](#creating-a-rootfs-with-kernel-modules)
|
||||
* [Build a rootfs using Docker](#build-a-rootfs-using-docker)
|
||||
* [Adding support for a new guest OS](#adding-support-for-a-new-guest-os)
|
||||
* [Create template files](#create-template-files)
|
||||
* [Modify template files](#modify-template-files)
|
||||
* [Expected rootfs directory content](#expected-rootfs-directory-content)
|
||||
* [Optional - Customize the rootfs](#optional---customize-the-rootfs)
|
||||
* [Adding extra packages](#adding-extra-packages)
|
||||
* [Arbitrary rootfs changes](#arbitrary-rootfs-changes)
|
||||
|
||||
# Building a Guest OS rootfs for Kata Containers
|
||||
|
||||
The Kata Containers rootfs is created using the `rootfs.sh` script.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
* [Run the osbuilder tests](#run-the-osbuilder-tests)
|
||||
* [Further information](#further-information)
|
||||
|
||||
## Run the osbuilder tests
|
||||
|
||||
osbuilder provides a test script that creates all rootfs disk images and
|
||||
|
||||
@@ -1,17 +1,5 @@
|
||||
# Kata Containers packaging
|
||||
|
||||
* [Introduction](#introduction)
|
||||
* [Build in a container](#build-in-a-container)
|
||||
* [Build a snap package](#build-a-snap-package)
|
||||
* [Build static binaries](#build-static-binaries)
|
||||
* [Build Kata Containers Kernel](#build-kata-containers-kernel)
|
||||
* [Build QEMU](#build-qemu)
|
||||
* [Test Kata using ccloudvm](#test-kata-using-ccloudvm)
|
||||
* [Create a Kata Containers release](#create-a-kata-containers-release)
|
||||
* [Jenkins files](#jenkins-files)
|
||||
* [Packaging scripts](#packaging-scripts)
|
||||
* [Credits](#credits)
|
||||
|
||||
## Introduction
|
||||
|
||||
Kata Containers currently supports packages for many distributions. Tooling to
|
||||
|
||||
@@ -1,10 +1,5 @@
|
||||
# Test Kata using ccloudvm
|
||||
|
||||
* [How to use Kata workloads for `ccloudvm`](#how-to-use-kata-workloads-for-ccloudvm)
|
||||
* [Create Docker\* and Kata Containers virtualized environment](#create-docker-and-kata-containers-virtualized-environment)
|
||||
|
||||
***
|
||||
|
||||
The [ccloudvm](https://github.com/intel/ccloudvm/) tool is a command
|
||||
to create development and demo environments. The tool sets up these development
|
||||
environments inside a virtual machine.
|
||||
|
||||
@@ -1,9 +1,5 @@
|
||||
# Kata OBS to Packagecloud sync tool
|
||||
|
||||
* [How it works](#how-it-works)
|
||||
* [Detailed behaviour](#detailed-behaviour)
|
||||
* [Install and Usage](#install-and-usage)
|
||||
|
||||
`kata-pkgsync` is a tool to synchronize Kata package from OBS to Packagecloud.
|
||||
|
||||
## How it works
|
||||
|
||||
@@ -1,15 +1,5 @@
|
||||
# `kata-deploy`
|
||||
|
||||
* [Kubernetes quick start](#kubernetes-quick-start)
|
||||
* [Install Kata on a running Kubernetes cluster](#install-kata-on-a-running-kubernetes-cluster)
|
||||
* [Run a sample workload](#run-a-sample-workload)
|
||||
* [Remove Kata from the Kubernetes cluster](#remove-kata-from-the-kubernetes-cluster)
|
||||
* [`kata-deploy` details](#kata-deploy-details)
|
||||
* [Dockerfile](#dockerfile)
|
||||
* [DaemonSets and RBAC](#daemonsets-and-rbac)
|
||||
* [Kata deploy](#kata-deploy)
|
||||
* [Kata cleanup](#kata-cleanup)
|
||||
|
||||
[`kata-deploy`](.) provides a Dockerfile, which contains all of the binaries
|
||||
and artifacts required to run Kata Containers, as well as reference DaemonSets, which can
|
||||
be utilized to install Kata Containers on a running Kubernetes cluster.
|
||||
|
||||
@@ -1,14 +1,5 @@
|
||||
# Build Kata Containers Kernel
|
||||
|
||||
* [Requirements](#requirements)
|
||||
* [Usage](#usage)
|
||||
* [Setup kernel source code](#setup-kernel-source-code)
|
||||
* [Build the kernel](#build-the-kernel)
|
||||
* [Install the Kernel in the default path for Kata](#install-the-kernel-in-the-default-path-for-kata)
|
||||
* [Submit Kernel Changes](#submit-kernel-changes)
|
||||
* [How is it tested](#how-is-it-tested)
|
||||
* [Contribute](#contribute)
|
||||
|
||||
This document explains the steps to build a kernel recommended for use with
|
||||
Kata Containers. To do this use `build-kernel.sh`, this script
|
||||
automates the process to build a kernel for Kata Containers.
|
||||
|
||||
@@ -1,8 +1,3 @@
|
||||
* [Kata Containers kernel config files](#kata-containers-kernel-config-files)
|
||||
* [Types of config files](#types-of-config-files)
|
||||
* [How to use config files](#how-to-use-config-files)
|
||||
* [How to modify config files](#how-to-modify-config-files)
|
||||
|
||||
# Kata Containers kernel config files
|
||||
|
||||
This directory contains Linux Kernel config files used to configure Kata
|
||||
|
||||
@@ -1,12 +1,5 @@
|
||||
# Release information
|
||||
|
||||
* [Introduction](#introduction)
|
||||
* [Create a Kata Containers release](#create-a-kata-containers-release)
|
||||
* [Release tools](#release-tools)
|
||||
- [`update-repository-version.sh`](#update-repository-versionsh)
|
||||
- [Update Kata projects to a new version](#update-kata-projects-to-a-new-version)
|
||||
- [`tag_repos.sh`](#tag_repossh)
|
||||
|
||||
## Introduction
|
||||
|
||||
This directory contains information of the process and
|
||||
|
||||
Reference in New Issue
Block a user