Remade docker example to be more generic

Author: olofhagsand

docker/README.md

@@ -2,8 +2,8 @@
 
 This directory contains sub-directories with examples of Clixon docker images:
 
-  * [example](example/README.md)   Clixon main example image 
+  * [example](example/README.md)        Clixon main example / generic YANG
   * [clixon-dev](clixon-dev/README.md)  Clixon development image
-  * [test](test/README.md)  Test scripts used in upstream CI
+  * [test](test/README.md)              Test scripts used in upstream CI
 
 

docker/example/Dockerfile

@@ -1,6 +1,6 @@
 #
 # ***** BEGIN LICENSE BLOCK *****
-# 
+#
 # Copyright (C) 2017-2019 Olof Hagsand
 # Copyright (C) 2020-2022 Olof Hagsand and Rubicon Communications, LLC(Netgate)
 #
@@ -23,7 +23,7 @@
 # in which case the provisions of the GPL are applicable instead
 # of those above. If you wish to allow use of your version of this file only
 # under the terms of the GPL, and not to allow others to
-# use your version of this file under the terms of Apache License version 2, 
+# use your version of this file under the terms of Apache License version 2,
 # indicate your decision by deleting the provisions above and replace them with
 # the notice and other provisions required by the GPL. If you do not delete
 # the provisions above, a recipient may use your version of this file under
@@ -79,14 +79,18 @@ RUN make DESTDIR=/clixon/build install-include
 WORKDIR /clixon/clixon/example/main
 RUN make
 RUN make DESTDIR=/clixon/build install
-RUN mkdir -p /clixon/build/etc
-RUN install example.xml /clixon/build/etc/clixon.xml
+RUN mkdir -p /clixon/build/usr/local/etc/clixon
+RUN mkdir -p /clixon/build/usr/local/etc/clixon/example
+RUN install example.xml /clixon/build/usr/local/etc/clixon/example.xml
 
 # Copy startscript
 WORKDIR /clixon
-COPY startsystem.sh startsystem.sh 
+COPY startsystem.sh startsystem.sh
 RUN install startsystem.sh /clixon/build/usr/local/bin/
 
+WORKDIR /clixon/build/usr/local/share/clixon
+COPY yang/ example/
+
 #
 # Stage 2
 # The second step skips the development environment and builds a runtime system
@@ -135,9 +139,8 @@ RUN echo -n 'admin:admin' | chpasswd
 COPY --from=0 /clixon/build/ /
 
 # Overwrite config file since install dirs are wrong
-COPY example.xml /usr/local/etc/clixon/example.xml
 # Create symlink so you can run clixon without -f arg
-RUN ln -s /usr/local/etc/clixon/example.xml /usr/local/etc/clixon.xml 
+RUN ln -s /usr/local/etc/clixon/example.xml /etc/clixon.xml
 
 # Start daemons
 CMD /usr/local/bin/startsystem.sh

docker/example/Makefile.in

@@ -39,6 +39,8 @@ CFLAGS  	= @CFLAGS@
 LDFLAGS 	= @LDFLAGS@
 LIBS    	= @LIBS@
 
+#DOCKERFLAGS="--no-cache"
+
 # docker.hub image. CHANGE THIS IF YOU PUSH YOUR OWN
 IMG   = clixon/clixon-example
 
@@ -78,4 +80,3 @@ install-include:
 install:
 
 uninstall:
-

docker/example/README.md

@@ -53,9 +53,18 @@ You may also do `make push` if you want to push the image, but you may then cons
 
 (You may have to login for push with sudo docker login -u <username>)
 
-## Other YANGs
+## Modification
+
+You can modify the example container with your own YANGs, keys, config-file and startup-db
+
+Yangs: Create a dir yang/ in this dir and add your yang files to it
+
+Key: Start the container with SSHKEY=<your pubkey> ./start.sh
+
+exmaple.xml: Place a file called "example.xml" in this dir.
+
+Startup: Place a file called "startup_db" in this dir.
 
-You can add other YANGs for experimentation by:
 ```
   $ sudo docker cp myyangs.tgz clixon-example:/usr/local/share/clixon/example
 ```

docker/example/start.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # ***** BEGIN LICENSE BLOCK *****
-# 
+#
 # Copyright (C) 2017-2019 Olof Hagsand
 # Copyright (C) 2020-2022 Olof Hagsand and Rubicon Communications, LLC(Netgate)
 #
@@ -23,7 +23,7 @@
 # in which case the provisions of the GPL are applicable instead
 # of those above. If you wish to allow use of your version of this file only
 # under the terms of the GPL, and not to allow others to
-# use your version of this file under the terms of Apache License version 2, 
+# use your version of this file under the terms of Apache License version 2,
 # indicate your decision by deleting the provisions above and replace them with
 # the notice and other provisions required by the GPL. If you do not delete
 # the provisions above, a recipient may use your version of this file under
@@ -45,16 +45,30 @@ set -eux
 
 sudo docker kill $NAME || true 2> /dev/null # ignore errors
 
+
 # Start clixon-example backend
 sudo docker run --name ${NAME} --rm -td clixon/clixon-example #|| err "Error starting clixon-example"
 
-# Copy rsa pubkey 
+# Copy user rsa pubkey
 if [ -n "$SSHKEY" ]; then
-    # install user pub key 
+    # install user pub key
     sudo docker exec -it $NAME mkdir -m 700 /root/.ssh
     sudo docker cp $SSHKEY $NAME:/root/.ssh/authorized_keys
     sudo docker exec -it $NAME chown root /root/.ssh/authorized_keys
     sudo docker exec -it $NAME chgrp root /root/.ssh/authorized_keys
 fi
 
+#if [ -d yang ]; then
+#    for f in $(ls yang/*.yang); do
+#        sudo docker cp $f $NAME:/usr/local/share/clixon/example/
+#    done
+#fi
+if [ -f startup_db ]; then
+    sudo docker cp startup_db $NAME:/usr/local/var/example/
+fi
+if [ -f example.xml ]; then
+    sudo docker cp example.xml $NAME:/usr/local/etc/clixon/
+fi
+
+
 >&2 echo "$NAME started"

docker/example/startsystem.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 # ***** BEGIN LICENSE BLOCK *****
-# 
+#
 # Copyright (C) 2017-2019 Olof Hagsand
 # Copyright (C) 2020-2022 Olof Hagsand and Rubicon Communications, LLC(Netgate)
 #
@@ -23,7 +23,7 @@
 # in which case the provisions of the GPL are applicable instead
 # of those above. If you wish to allow use of your version of this file only
 # under the terms of the GPL, and not to allow others to
-# use your version of this file under the terms of Apache License version 2, 
+# use your version of this file under the terms of Apache License version 2,
 # indicate your decision by deleting the provisions above and replace them with
 # the notice and other provisions required by the GPL. If you do not delete
 # the provisions above, a recipient may use your version of this file under
@@ -54,8 +54,8 @@ touch /run/openrc/softlevel
 #/usr/local/bin/clixon_restconf -l f/var/log/restconf.log -D $DBG &
 #>&2 echo "clixon_restconf started"
 
-# Start clixon backend 
-/usr/local/sbin/clixon_backend -D $DBG -s running -l e -f /usr/local/etc/clixon/example.xml 
+# Start clixon backend
+/usr/local/sbin/clixon_backend -D $DBG -s startup -l e -f /usr/local/etc/clixon/example.xml
 >&2 echo "clixon_backend started"
 
 # Alt: let backend be in foreground, but test scripts may

docker/example/yang/README

@@ -0,0 +1 @@
+Place extra YANGs here