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.

Sign up for GitHub

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

update README with new OVERVIEW and DEMONSTRATION section #1

Merged
merged 1 commit into from
Feb 11, 2014
Merged

update README with new OVERVIEW and DEMONSTRATION section #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 21 additions & 1 deletion README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
README for kpatch
====================

OVERVIEW

kpatch is a tool for the generation and application of kernel
modules that patch a running Linux kernel while in operation,
without requiring a reboot. This is very valuable in cases
where critical workloads, which do not have high availability via
scale-out, run on a single machine and are very downtime
sensitive or require a heavyweight approval process and
notification of workload users in the event of downtime.

LICENSE

kpatch is under the GPLv2 license.
Expand Down Expand Up @@ -42,7 +52,7 @@ The specific commit is 88ad5ddb71bd1fa8ed043a840157ebf23c0057b3.

git://git.fedorahosted.org/git/elfutils.git

OVERVIEW
HOWTO

An example script for automating the hotfix module generation is in
scripts/kpatch-build. The script is written for Fedora but should
Expand All @@ -68,3 +78,13 @@ The primary steps in the hotfix module generation process are:
- Generate the hotfix kernel module
- Use tools/link-vmlinux-syms to hardcode non-exported kernel symbols
into the symbol table of the hotfix kernel module

DEMONSTRATION

A demonstration of kpatch is available on Youtube:

http://www.youtube.com/watch?v=WeSmG-XirC4

This demonstration completes each step in the HOWTO section in a manual
fashion. However, from a end-user perspective, most of these steps will
be hidden away in scripts (eventually).