cluster.conf.adoc: new manual page

cluster.conf.5-opts.adoc

@@ -0,0 +1,24 @@
+`cid`: `<integer> (1 - N)` ::
+
+Cluster Node ID.
+
+`hostrsapubkey`: `<string>` ::
+
+Public SSH RSA key for the host.
+
+`ip`: `<string>` ::
+
+IP address.
+
+`maxcid`: `<integer> (1 - N)` ::
+
+Maximum used cluster node ID (used internally, do not modify).
+
+`name`: `<string>` ::
+
+Node name.
+
+`rootrsapubkey`: `<string>` ::
+
+Public SSH RSA key for the root user.
+

cluster.conf.adoc

@@ -0,0 +1,62 @@
+[[pmg_cluster_configuration_file]]
+ifdef::manvolnum[]
+cluster.conf(5)
+===============
+:pmg-toplevel:
+
+NAME
+----
+
+cluster.conf - Proxmox Mail Gateway Cluster Configuration
+
+
+SYNOPSIS
+--------
+
+`/etc/pmg/cluster.conf`
+
+
+DESCRIPTION
+-----------
+endif::manvolnum[]
+ifndef::manvolnum[]
+Cluster Configuration
+=====================
+endif::manvolnum[]
+ifdef::wiki[]
+:title: Manual: cluster.conf
+:pmg-toplevel:
+endif::wiki[]
+
+The file `/etc/pmg/cluster.conf` contains the cluster configuration.
+
+
+File Format
+-----------
+
+The file is divided into several section. There is one 'master' and
+several 'node' sections.
+
+----
+master: <cid>
+	 OPTION value
+	 ...
+
+node: <cid>
+	 OPTION value
+	 ...
+----
+
+Blank lines in the file separates sections, and lines starting with a `#`
+character are treated as comments and are also ignored.
+
+
+Options
+-------
+
+include::cluster.conf.5-opts.adoc[]
+
+
+ifdef::manvolnum[]
+include::pmg-copyright.adoc[]
+endif::manvolnum[]

gen-cluster.conf.5-opts.pl

@@ -0,0 +1,18 @@
+#!/usr/bin/perl
+
+use lib '.';
+use strict;
+use warnings;
+use PVE::RESTHandler;
+
+use Data::Dumper;
+
+use PMG::ClusterConfig;
+
+my $schema = PMG::ClusterConfig::Base->createSchema(1);
+my $properties = $schema->{properties};
+    
+    
+print PVE::RESTHandler::dump_properties($properties);
+ 
+exit(0);

pmg-admin-guide.adoc

@@ -143,6 +143,8 @@ Configuration Files
 
 include::pmg.conf.adoc[]
 
+include::cluster.conf.adoc[]
+
 :leveloffset: 0
 
 :leveloffset: 1