From d10262761b66706f2e809eccc37748d4cc77b14e Mon Sep 17 00:00:00 2001
From: Jan Soukal <soukal@ics.muni.cz>
Date: Mon, 20 Feb 2012 16:36:57 +0100
Subject: [PATCH] dokoncena sekce G. Registration of Clients.
---
src/warden-server/doc/README | 50 +++++++++++++++++++++++++++++-------
1 file changed, 41 insertions(+), 9 deletions(-)
diff --git a/src/warden-server/doc/README b/src/warden-server/doc/README
index 802546f..2309909 100644
--- a/src/warden-server/doc/README
+++ b/src/warden-server/doc/README
@@ -189,7 +189,15 @@ F. Init Scripts
--------------------------------------------------------------------------------
G. Registration of Clients
- /*TODO*/Popsat registraci klientu
+ The Warden server administrator is responsible for registering new clients or
+ removing those already registered. Both registration or unregistreation scripts
+ are provided in the Warden server package. Those scripts should be run from
+ localhost (the same machine the Warden server is installed and running on).
+
+ Members of Warden community who would like to have their client registered must
+ contact the Warden server administrator with the requirement. This is usually
+ done via secured e-mail. Requestor should provide all important data to the
+ Warden server administrator so that the client can be successfully registered.
1. Register Sender
@@ -199,22 +207,46 @@ G. Registration of Clients
Following attributes must be provided in order to register new client
successfully:
- hostname - hostname of the client,
- requestor - organization or authorized person who demands new
- client registration,
- service - name of the service of a new registered client,
- description_tags - tags describing the nature of the service,
- ip_net_client - CIDR the client is only allowed to communicate from.
+ hostname - hostname of the client,
+ requestor - organization or authorized person who demands new
+ client registration,
+ service - name of the service of a new registered client,
+ description_tags - tags describing the nature of the service,
+ ip_net_client - CIDR the client is only allowed to communicate from.
One can always run registerSender.pl with -h argument to see a help.
2. Register Receiver
- /*TODO*/Doplnit...
+ New receiver clients are registered in Warden system via
+ warden-server/bin/registerReceiver.pl.
+
+ Following attributes must be provided in order to register new client
+ successfully:
+
+ hostname - hostname of the client,
+ requestor - organization or authorized person who demands new
+ client registration,
+ type - the type of events the client wish to receive (only
+ this and nothing else)
+ receive_own_events - boolean value describing if events originating from
+ the same CIDR will be sent to the client.
+ ip_net_client - CIDR the client is only allowed to communicate from.
+
+ One can always run registerReceiver.pl with -h argument to see a help.
+
3. Unregister Client
- /*TODO*/Doplnit...
+ In the Warden system, already register clients can be removed (unregistered)
+ via warden-server/bin/unregisterClient.pl.
+
+ Following attribute must be provided in order to unregister existing client
+ successfully:
+
+ client_id - ID of the client that should be removed (unregistered).
+
+ One can always run unregisterClient.pl with -h argument to see a help.
--------------------------------------------------------------------------------
H. Status Info
--
GitLab