First attempt for keama new docs

5 files changed, 78 insertions, 15 deletions

diff --git a/README b/README
index d430b38a..2565d7e2 100644
--- a/README
+++ b/README
@@ -78,6 +78,9 @@ referred to for information about DHCP options.
 DHCP relay agent documentation is in the dhcrelay man page, the source
 for which is distributed in the relay/ subdirectory.
 
+KEA Migration Assistant documentation, including how to build, install
+and use it, is including in the keama directory.
+
 To read installed manual pages, use the man command.  Type "man page"
 where page is the name of the manual page.   This will only work if
 you have installed the ISC DHCP distribution using the ``make install''
diff --git a/RELNOTES b/RELNOTES
index 09dbcbd4..66a114f9 100644
--- a/RELNOTES
+++ b/RELNOTES
@@ -108,6 +108,11 @@ by Eric Young (eay@cryptsoft.com).
   to Jay Doran from Bluecat Networks for suggesting this feature.
   [Gitlab #10]
 
+- The KEA Migration Assistant, an experimental tool which helps to
+  translate ISC DHCP configurations to Kea, is now included in
+  the distribution.
+  (Gitlab #34)
+
 		Changes since 4.4.1 (Bug Fixes)
 
 - Corrected a misuse of the BIND9 DDNS API which caused DDNS updates to be
diff --git a/keama/ChangeLog b/keama/ChangeLog
deleted file mode 100644
index 41f29090..00000000
--- a/keama/ChangeLog
+++ /dev/null
@@ -1,15 +0,0 @@
-3.	[doc]		fdupont
-	New documentation including this file.
-	(Gitlab #34)
-
-2.	[bug]		fdupont
-	Fixed dhcp4 option 67 wrong name.
-	(Gitlab #22)
-
-1.	[func]		fdupont
-	Initial revision.
-
-LEGEND
-[bug]	Bug fix.
-[doc]	Update to documentation.
-[func]	New feature.
diff --git a/keama/ChangeLog.md b/keama/ChangeLog.md
new file mode 100644
index 00000000..fd386d9e
--- /dev/null
+++ b/keama/ChangeLog.md
@@ -0,0 +1,18 @@
+* 3 [doc] fdupont
+
+   New documentation including this file.
+   (Gitlab #34)
+
+* 2 [bug] fdupont
+
+   Fixed dhcp4 option 67 wrong name.
+   (Gitlab #22)
+
+* 1 [func] fdupont
+
+   Initial revision.
+
+LEGEND
+* [bug]   Bug fix.
+* [doc]   Update to documentation.
+* [func]  New feature.
diff --git a/keama/REAME,md b/keama/REAME,md
new file mode 100644
index 00000000..130c4e1f
--- /dev/null
+++ b/keama/REAME,md
@@ -0,0 +1,52 @@
+# KEA Migration Assistant Short Guide.
+
+The KEA Migration Assistant (aka _keama_) is an experimental tool
+which helps to translate ISC DHCP configurations to Kea.
+
+## How to get last sources
+
+From time to time the _keama_ is upgraded for bug fixes, support of
+new or not yet ISC DHCP features or more likely support of new KEA
+features.
+
+As now _keama_ is included in ISC DHCP the last code can be find with
+the last ISC DHCP code in the master branch of gitlab repository.
+
+## How to build and install
+
+After the ISC DHCP build go to the keama directory and type:
+```console
+make
+```
+To install it:
+```console
+make install
+```
+
+## Known limitations
+
+_keama_ uses a subset of the ISC DHCP configuration file parser with a lot
+of sanaity checks removed so it does not know how to handle an incorrect
+ISC DHCP configuration file and eventually can even crash on it.
+
+ISC DHCP and KEA have different models for many things, for instance
+ISC DHCP supports the failover protocol when KEA supports High Availability.
+In some cases _keama_ tries to cope with that, for instance for host
+reservations which are global in ISC DHCP and by default per subnet in KEA.
+
+## How to use
+
+The manual explains how parameters guide _keama_ choices for lifetimes,
+name literals, host reservation scope, etc. Directives were added to
+the ISC DHCP syntax (they are valid but ignored) for options.
+
+Each time _keama_ finds a feature it can't translate it emits a comment
+with a reference to the feature description in a kea (not isc dhcp) gitlab
+issue in the "ISC DHCP Migration" milestone. The number of reports is
+returned by _keama_ when it exits.
+
+## How to help
+
+We already collected a lot of ISC DHCP configurations used in production
+but you can supply new ones, in particular if they use a common
+paradigm which can be easily translated but not (yet) supported.