Updates the documentation to add package/deploy

Author: ralt

README.md

@@ -17,7 +17,6 @@ An opinionated LXC wrapper.
 - [CLI Usage](#cli-usage)
 - [Requirements](#requirements)
 - [Limitations](#limitations)
-- [Roadmap](#roadmap)
 - [Development](#development)
 - [API](#api)
   - [Functions](#functions)
@@ -26,6 +25,8 @@ An opinionated LXC wrapper.
     - [`start`](#start)
     - [`stop`](#stop)
     - [`ls`](#ls)
+    - [`package`](#package)
+    - [`deploy`](#deploy)
   - [Variables](#variables)
     - [`*lxc-default-folder*`](#lxc-default-folder)
     - [`*lxc-rootfs*`](#lxc-rootfs)
@@ -38,6 +39,8 @@ An opinionated LXC wrapper.
     - [`*ip-regex*`](#ip-regex)
     - [`*lxc-interfaces-file*`](#lxc-interfaces-file)
     - [`*default-shell*`](#default-shell)
+    - [`*lxc-package-extension*`](#lxc-package-extension)
+    - [`*lxc-config*`](#lxc-config)
 - [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -153,33 +156,44 @@ Wrapper around lxc for an opinionated workflow.
 
 Commands:
 
- create NAME
-  creates a container named NAME
+        create NAME
+                creates a container named NAME
 
-  Options (must be BEFORE the command):
-   --base=BASE
-    clone BASE
-   --template=TEMPLATE
-    use the TEMPLATE lxc template
-   --lxc-default-folder, --lxc-rootfs, --lxc-folder, --lxc-extension, --lxc-gateway, --default-dns-nameserver, --hosts-file, --lxc-interfaces-file
+                Options (must be BEFORE the command):
+                        --base=BASE
+                                clone BASE
+                        --template=TEMPLATE
+                                use the TEMPLATE lxc template
+                        --lxc-default-folder, --lxc-rootfs, --lxc-folder, --lxc-extens
+ion, --lxc-gateway, --default-dns-nameserver, --hosts-file, --lxc-interfaces-file    
 
- start NAME
-  starts the container named NAME
+        start NAME
+                starts the container named NAME
 
- stop NAME
-  stops the container named NAME
+        stop NAME
+                stops the container named NAME
 
- ls
-  lists the containers
+        ls
+                lists the containers
 
- destroy NAME
-  destroys the container named NAME
+        destroy NAME
+                destroys the container named NAME
 
-  Options (must be BEFORE the command):
-   --lxc-folder, --lxc-host-extension, --hosts-file
+                Options (must be BEFORE the command):
+                        --lxc-folder, --lxc-host-extension, --hosts-file
 
- Options for all commands (must be BEFORE the command):
-  --default-shell
+        package NAME
+                packages the container named NAME
+
+                Options (must be BEFORE the command):
+                        --archive-path=PATH
+                                the path of the archive
+
+        deploy --archive ARCHIVE NAME
+                deploys the ARCHIVE in a container named NAME
+
+        Options for all commands (must be BEFORE the command):
+                --default-shell
 ```
 
 ## Requirements
@@ -200,12 +214,6 @@ Known limitations:
   containers **with lxc-wrapper** on one host.
 - Autostart management not supported yet.
 
-## Roadmap
-
-Ideas I want to eventually implement:
-
-- `package`: to create a template from an existing container.
-
 ## Development
 
 You need:
@@ -294,6 +302,26 @@ Stops an LXC. The argument can be a string or a symbol.
 
 Returns the fancy output of the list of LXCs.
 
+#### `package`
+
+```lisp
+(defcommand package (name)
+  "Packages an LXC"
+```
+
+Packages an LXC into an shareable archive file.
+
+#### `deploy`
+
+```lisp
+(defcommand deploy (name args)
+  "Deploys an archive created by lxc-wrapper"
+  (destructuring-bind (&key archive)
+    args
+```
+
+Deploys an archive created by `lxc-wrapper package`.
+
 ### Variables
 
 Variables are used throughout the code to be able to customize them
@@ -387,6 +415,22 @@ Default value: `/bin/bash`
 
 The shell used by the commands.
 
+#### `*lxc-package-extension*`
+
+Used by: `package`
+
+Default value: `.tar.gz`
+
+The extension to give to archives created by `package`.
+
+#### `*lxc-config*`
+
+Used by: `deploy`
+
+Default value: `#p"config"`
+
+The name of the configuration file of the containers.
+
 ## License
 
 MIT License.

src/cli.lisp

@@ -100,6 +100,16 @@ Commands:
 		Options (must be BEFORE the command):
 			--lxc-folder, --lxc-host-extension, --hosts-file
 
+	package NAME
+		packages the container named NAME
+
+		Options (must be BEFORE the command):
+			--archive-path=PATH
+				the path of the archive
+
+	deploy --archive ARCHIVE NAME
+		deploys the ARCHIVE in a container named NAME
+
 	Options for all commands (must be BEFORE the command):
 		--default-shell
 

src/lxc-wrapper.lisp

@@ -100,11 +100,11 @@
 
 (defcommand deploy (name args)
   "Deploys an archive created by lxc-wrapper"
-  (let* ((cli-name (adapt-arg name))
-	 (lxc-path (merge-pathnames (concatenate 'string cli-name "/")
-				    *lxc-default-folder*)))
-    (destructuring-bind (&key archive)
-	args
+  (destructuring-bind (&key archive)
+      args
+    (let* ((cli-name (adapt-arg name))
+	   (lxc-path (merge-pathnames (concatenate 'string cli-name "/")
+				      *lxc-default-folder*)))
       (run
 	"mkdir" "-p" lxc-path)
       (format t "Deploying ~A..." cli-name)
@@ -115,6 +115,7 @@
       (fix-lxc-config cli-name lxc-path *lxc-config*)
       (format t " done.~%")
       (init-lxc cli-name *hosts-file*))))
+
 (defun adapt-arg (name)
   "Adapts an argument to string"
   (when (symbolp name)