Changes between Version 2 and Version 3 of Bcfg2FS

Timestamp:

06/14/10 08:22:07 (13 years ago)

Author:

fabaff

Comment:

--

Bcfg2FS

@@ -5 +5 @@
 `bcfg2-admin bundle list-xml` and `bcfg2-admin bundle show` only provide a simple and limited interface to the content of XML bundle files. As mentioned in ticket #638 the usage of a Fuse filesystem may be more intuitive than `bcfg2-admin`/`bcfg2-info` for some cases.
 
-This page is the place for the documentation of the Bcfg2FS development.  Maybe this page will become a tutorial as well.
+This page is the place for the documentation of the Bcfg2FS development. Maybe this page will become a tutorial as well.
 
 == Requirements ==
@@ -12 +12 @@
  * a mount point (e.g. in `/tmp`)
 
+== Design ==
+
+The start will be with the bundles (perhaps the new part can be called `bcfg2-admin bundle browse`). Bundles are a bit different than the other XML files like client.xml or group.xml because every bundle has its own XML file.  
+
+All bundles are store in the `/var/lib/bcfg2/Bundler/` directory.
+
+ * XML files : `/var/lib/bcfg2/Bundler/*.xml`
+ * gensh files: `/var/lib/bcfg2/Bundler/*.genshi`
+
+A simple bundle file can look like this :
+{{{
+#!text/xml
+<Bundle name='motd' version='2.0'>
+  <ConfigFile name='/etc/motd' />
+</Bundle>
+}}}
+
+There are other [wiki:WritingSpecification#ConfigurationEntityTypes configuration entries] available. 
+
+== Implementation ==
+
+Basically a FUSE file system needs of have three functions.
+
+ * '''init''' - Starts the file system and grabs the file in the `Bundler/` directory
+ * '''getattr''' - Passes back the attributes of a file (at the moment not needed)
+ * '''readdir''' - Is needed to use `ls`
+
+== Usage ==
+
+You need to make a directory with `mkdir [mountpoint]` first.  
+
+{{{
+$ python bcfg2fs.py [mountpoint]
+}}}
+
+Now you can change to the FUSE file system.
+
+{{{
+$ cd [mountpoint]
+}}}
+
+Use `ls` to browse the directory.
+
+{{{
+$ ls
+}}}
+
+When you are done, unmount the FUSE directory.
+
+{{{
+fusemount -u [mountpoint]
+}}}
+
+
 == Status ==
 
  * 2010-06-14 - The first step is done. The creation of a directory structure of available bundles is working.
+
+== !ToDo ==
+
+ * Make the source available
+ * Implement all parts of `bcfg2-admin` 
+ * Start with documentation
 
 == More information ==