From a7aebf770a9c3f033f97bb050bc761690cd87c8f Mon Sep 17 00:00:00 2001 From: Thomas Schoebel-Theuer Date: Tue, 10 Sep 2019 16:42:24 +0200 Subject: [PATCH] doc: factor out common introduction --- docu/common-front-matter.lyx | 73 ++----------------- docu/common-introduction.lyx | 136 +++++++++++++++++++++++++++++++++++ docu/mars-user-manual.lyx | 35 ++------- 3 files changed, 146 insertions(+), 98 deletions(-) create mode 100644 docu/common-introduction.lyx diff --git a/docu/common-front-matter.lyx b/docu/common-front-matter.lyx index db6c5cc8..580ce512 100644 --- a/docu/common-front-matter.lyx +++ b/docu/common-front-matter.lyx @@ -196,80 +196,17 @@ sloppy \end_inset - MARS -\family default - is a block-level storage replication system for long distances / flaky - networks under GPL. - It runs as a Linux kernel module. - The sysadmin interface is similar to DRBD -\begin_inset Foot -status open - -\begin_layout Plain Layout -Registered trademarks are the property of their respective owner. -\end_layout - -\end_inset - -, but its internal engine is completely different from DRBD: it works with -\series bold -transaction logging -\series default -, similar to some database systems. -\end_layout +\family default -\begin_layout Abstract -Therefore, MARS can provide stronger -\series bold -consistency guarantees -\series default -. - Even in case of network bottlenecks / problems / failures, the secondaries - may become outdated (reflect an elder state), but never become inconsistent. - In contrast to DRBD, MARS preserves the -\series bold -order of write operations -\series default - even when the network is flaky ( -\series bold -Anytime Consistency -\series default -). -\end_layout +\begin_inset CommandInset include +LatexCommand input +preview true +filename "common-introduction.lyx" -\begin_layout Abstract -The current version of MARS supports -\begin_inset Formula $k>2$ \end_inset - replicas and works -\series bold -asynchronously -\series default -. - Therefore, application performance is completely decoupled from any network - problems. - Future versions are planned to also support synchronous or near-synchronous - modes. -\end_layout -\begin_layout Abstract -MARS supports a new method for building Cloud Storage / Software Defined - Storage, called -\series bold -LV Football -\series default -. -\end_layout - -\begin_layout Abstract -It comes with some automation scripts, leading to a similar functionality - than Kubernetes, but devoted to stateful LVs over -\series bold -virtual LVM pools -\series default - in the petabytes range. \end_layout \begin_layout Abstract diff --git a/docu/common-introduction.lyx b/docu/common-introduction.lyx new file mode 100644 index 00000000..a303ad93 --- /dev/null +++ b/docu/common-introduction.lyx @@ -0,0 +1,136 @@ +#LyX 2.3 created this file. For more info see http://www.lyx.org/ +\lyxformat 544 +\begin_document +\begin_header +\save_transient_properties true +\origin unavailable +\textclass scrreprt +\begin_preamble +\usepackage{listings} +\end_preamble +\options abstracton,dvipsnames +\use_default_options true +\begin_modules +customHeadersFooters +enumitem +fixltx2e +\end_modules +\maintain_unincluded_children false +\language english +\language_package default +\inputencoding auto +\fontencoding global +\font_roman "default" "default" +\font_sans "default" "default" +\font_typewriter "default" "default" +\font_math "auto" "auto" +\font_default_family rmdefault +\use_non_tex_fonts false +\font_sc false +\font_osf false +\font_sf_scale 100 100 +\font_tt_scale 100 100 +\use_microtype false +\use_dash_ligatures false +\graphics default +\default_output_format default +\output_sync 0 +\bibtex_command default +\index_command default +\paperfontsize 10 +\spacing single +\use_hyperref true +\pdf_title "MARS Manual" +\pdf_author "Thomas Schöbel-Theuer" +\pdf_bookmarks true +\pdf_bookmarksnumbered false +\pdf_bookmarksopen false +\pdf_bookmarksopenlevel 1 +\pdf_breaklinks true +\pdf_pdfborder true +\pdf_colorlinks true +\pdf_backref false +\pdf_pdfusetitle true +\papersize a4paper +\use_geometry true +\use_package amsmath 1 +\use_package amssymb 1 +\use_package cancel 1 +\use_package esint 1 +\use_package mathdots 1 +\use_package mathtools 1 +\use_package mhchem 1 +\use_package stackrel 1 +\use_package stmaryrd 1 +\use_package undertilde 1 +\cite_engine basic +\cite_engine_type default +\biblio_style plain +\use_bibtopic false +\use_indices false +\paperorientation portrait +\suppress_date false +\justification true +\use_refstyle 1 +\use_minted 0 +\index Index +\shortcut idx +\color #008000 +\end_index +\leftmargin 3.7cm +\topmargin 2.7cm +\rightmargin 2.8cm +\bottommargin 2.3cm +\secnumdepth 3 +\tocdepth 3 +\paragraph_separation indent +\paragraph_indentation default +\is_math_indent 0 +\math_numbering_side default +\quotes_style english +\dynamic_quotes 0 +\papercolumns 1 +\papersides 2 +\paperpagestyle headings +\tracking_changes false +\output_changes false +\html_math_output 0 +\html_css_as_file 0 +\html_be_strict false +\end_header + +\begin_body + +\begin_layout Chapter +GNU Free Documentation License +\begin_inset CommandInset label +LatexCommand label +name "chap:GNU-FDL" + +\end_inset + + +\end_layout + +\begin_layout Standard +\noindent + +\family typewriter +\size footnotesize +\begin_inset ERT +status open + +\begin_layout Plain Layout + + +\backslash +lstinputlisting{fdl.txt} +\end_layout + +\end_inset + + +\end_layout + +\end_body +\end_document diff --git a/docu/mars-user-manual.lyx b/docu/mars-user-manual.lyx index bad8db93..19984ce8 100644 --- a/docu/mars-user-manual.lyx +++ b/docu/mars-user-manual.lyx @@ -137,39 +137,14 @@ Introduction \end_layout \begin_layout Standard -MARS is a block-level storage replication system for long distances / flaky - networks under GPL. -\end_layout +\begin_inset CommandInset include +LatexCommand input +preview true +filename "common-introduction.lyx" -\begin_layout Standard -It runs as a Linux kernel module. - The sysadmin interface is similar to DRBD8, but its internal engine is - completely different from DRBD: it works with transaction logging, similar - to some database systems. -\end_layout +\end_inset -\begin_layout Standard -Therefore, MARS can provide stronger consistency guarantees. - Even in case of network bottlenecks / problems / failures, the secondaries - may become outdated (reflect an elder state), but never become inconsistent. - In contrast to DRBD, MARS preserves the order of write operations even - when the network is flaky (Anytime Consistency). -\end_layout -\begin_layout Standard -The current version of MARS supports k > 2 replicas and works asynchronously. - Therefore, application performance is completely decoupled from any network - problems. - Future versions are planned to also support synchronous or near-synchronous - modes. -\end_layout - -\begin_layout Standard -MARS supports a new method for building Cloud Storage / Software Defined - Storage, called LV Football. - It comes with some automation scripts, leading to a similar functionality - than Kubernetes, but devoted to stateful LVs over virtual LVM pools in - the petabytes range. \end_layout \begin_layout Section*