From aaf5116bb4bcf984f61ae14d706fb49d2574f898 Mon Sep 17 00:00:00 2001 From: Olof hagsand Date: Sun, 28 Feb 2016 10:32:16 +0100 Subject: [PATCH] faq docker --- doc/FAQ.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/doc/FAQ.txt b/doc/FAQ.txt index bd0d04f4..80a90a2d 100644 --- a/doc/FAQ.txt +++ b/doc/FAQ.txt @@ -66,6 +66,19 @@ Q: How do you run the example? - Start a cli session: clicon_cli -f /usr/local/etc/routing.conf - Start a netconf session: clicon_netconf -f /usr/local/etc/routing.conf +Q: Can you run clicon as docker containers? +------------------------------------------- +Yes, the example works as docker containers as well. backend and cli needs a +common file-system so they need to run as a composed pair. + cd example/docker + make docker # Prepares /data as shared file-system mount + run.sh # Starts an example backend and a cli +Futhermore, you build the clicon docker containers as follows: + cd docker + make docker +You may also push the containers with 'make push' but you may then consider changing the image +name in the makefile. + Q: How do you change the example? --------------------------------- - routing.conf.local - Override default settings @@ -88,6 +101,17 @@ Example: Each line corresponds to a database entry (node in an XML tree). If the node is a leaf, the value appears as the second entry ('bgp' and 'eth0'). +Q: What is validate and commit? +------------------------------- +Clixon follows netconf in its validate and commit semantics. +In short, you edit a 'candidate' configuration, which is first +'validated' for consistency and then 'committed' to the 'running' +configuration. + +A clixon developer writes commit functions to incrementaly upgrade a +system state based on configuration changes. Writing commit callbacks +is the core functionality of a clixon system. + Q: How do you write a commit function? -------------------------------------- You write a commit function in routing_backend.c.