Merge lp:~ahasenack/charms/precise/landscape-client/client-charm-doc into lp:charms/landscape-client

[Andreas Hasenack]

Explain in a bit more detail the ssl-public-key config option, and elaborate on the two url options we also have in there.

Explain in a bit more detail the ssl-public-key config option, and elaborate on the two url options we also have in there.

[Darryl Weaver (dweaver)]

The instructions look good to me. I have followed them and tested the landscape-client charm works with these options.

review: Approve

[James Page (james-page)]

review: Approve

=== modified file 'README'
--- README	2013-03-06 21:25:41 +0000
+++ README	2013-10-15 19:13:53 +0000
@@ -71,6 +71,30 @@
     execute scripts.  Keyword "ALL" can be used to include all users on the
     system.
 
+ssl-public-key:
+    If needed, use this to give the client the CA certificate it should use to
+    verify the server certificate it is connecting to.
+    
+
+When registering the client against a server with a custom or not well known
+CA, you will need to use the ssl-public-key option. To insert the certificate
+contents into the charm config directly, just encode it in base64.
+
+For example, let's assume ca.pem is a file with the CA certificate the client
+needs to use to verify the server:
+
+$ cat ca.pem | openssl base64 -e > ca.encoded
+
+Now insert the ca.encoded contents into the charm config, like this:
+
+landscape-client:
+    url: ....
+    ping-url: ....
+    ssl-public-key: |
+        base64:<insert-here-
+        contents-of-ca.encoded>...
+        ...
+        ...
 
 Contact Information
 ===================

=== modified file 'config.yaml'
--- config.yaml	2013-03-21 22:57:40 +0000
+++ config.yaml	2013-10-15 19:13:53 +0000
@@ -24,16 +24,20 @@
     type: string
   url:
     description: |
-      The server URL to connect to.
+      The message server URL to connect to. Normally
+      https://fqdn/message-system.
     type: string
   ping-url:
     description: |
-      The URL to perform lightweight exchange initiation with.
+      The ping server URL to perform lightweight exchange initiation with.
+      Normally http://fqdn/ping.
     type: string
   ssl-public-key:
     description: |
-      The public SSL key to verify the server. Only used if
-      the given URL is https.
+      The CA certificate to verify the server certificate with. This can be
+      a path to a file, or a base64 encoded entry of the certificate itself,
+      prefixed with "base64:". This config is only used if the message server
+      URL given above starts with https.
     type: string
   server-autodiscover:
     description: |