From defb6cd8a7a40b386f1855378bffef4d4dc466f6 Mon Sep 17 00:00:00 2001 From: Max Illfelder Date: Thu, 9 Jun 2016 14:27:58 -0700 Subject: Add a Table of Contents to the README. --- README.md | 34 +++++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5376587..c083805 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,26 @@ This repository stores the collection of packages installed on Google supported Compute Engine [images](https://cloud.google.com/compute/docs/images). +**Table of Contents** + +* [Background](#background) +* [Guest Overview](#guest-overview) +* [Common Libraries](#common-libraries) + * [Metadata Watcher](#metadata-watcher) + * [Logging](#logging) + * [Configuration Management](#configuration-management) + * [File Management](#file-management) +* [Daemons](#daemons) + * [Accounts](#accounts) + * [Clock Skew](#clock-skew) + * [IP Forwarding](#ip-forwarding) +* [Instance Setup](#instance-setup) +* [Metadata Scripts](#metadata-scripts) +* [Configuration](#configuration) +* [Packaging](#packaging) +* [Contributing](#contributing) +* [License](#license) + ## Background The Linux guest environment denotes the Google provided configuration and @@ -40,7 +60,7 @@ are detailed in the sections below. The Python libraries are shared with each of the daemons and the instance setup tools. -### Metadata Watcher +#### Metadata Watcher The guest environment relies upon retrieving content from the metadata server to configure the VM environment. A metadata watching library handles all @@ -65,7 +85,7 @@ unavailability; by default, any request has one minute to complete before the request is cancelled. In case of a brief network outage where the metadata server is unavailable, there is a short delay between retries. -### Logging +#### Logging The Google added daemons and scripts write to the serial port for added transparency. A common logging library is a thin wrapper around the Python @@ -73,7 +93,7 @@ logging module. The library configures appropriate SysLog handlers, sets the logging formatter, and provides a debug options for added logging and console output. -### Configuration Management +#### Configuration Management A configuration file allows users to disable daemons and modify instance setup behaviors from a single location. Guest environment daemons and scripts need a @@ -92,7 +112,7 @@ The library exposes the following functions: responsible for locking the file, preventing concurrent writes, and writing a file header if one is provided. -### File Management +#### File Management Guest environment daemons and scripts use a common library for file management. The library provides the following functions: @@ -112,7 +132,7 @@ above. Each daemon reads the configuration file before execution. This allows a user to easily disable undesired functionality. Additional daemon behaviors are detailed below. -### Accounts +#### Accounts The accounts daemon is responsible for provisioning and deprovisioning user accounts. The daemon grants permissions to user accounts, and updates the list @@ -132,13 +152,13 @@ The accounts management daemon has the following behaviors. keys for the user are removed from metadata. * User accounts not managed by Google are not modified by the accounts daemon. -### Clock Skew +#### Clock Skew The clock skew daemon is responsible for syncing the software clock with the hypervisor clock after a stop/start event or after a migration. Preventing clock skew may result in `system time has changed` messages in VM logs. -### IP Forwarding +#### IP Forwarding The IP forwarding daemon uses IP forwarding metadata to setup or remove IP routes in the guest. -- cgit v1.2.1