Juju Charms Collection
landscape-client package

Merge lp:~jose/charms/precise/landscape-client/readme-to-markdown into lp:charms/landscape-client

  1. Precise Pangolin (12.04)
  2. readme-to-markdown
  3. Merge into trunk
Proposed by José Antonio Rey
Status: Merged
Approved by: Chris Glass
Approved revision: 39
Merged at revision: 39
Proposed branch: lp:~jose/charms/precise/landscape-client/readme-to-markdown
Merge into: lp:charms/landscape-client
Diff against target: 206 lines (+93/-104)
2 files modified
README (+0/-104)
README.md (+93/-0)
To merge this branch: bzr merge lp:~jose/charms/precise/landscape-client/readme-to-markdown
Reviewer Review Type Date Requested Status
Chris Glass Approve
David Britton Approve
Review via email: mp+228347@code.launchpad.net

Description of the change

Converted README file to README.md (Markdown), fixing bug #1239576.

To post a comment you must log in.
Revision history for this message
David Britton (dpb) wrote :

+1, thanks for the contribution!

review: Approve
Revision history for this message
Chris Glass (tribaal) wrote :

Nice! Thanks a lot!
+1

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== removed file 'README'
--- README 2013-10-15 19:11:10 +0000
+++ README 1970-01-01 00:00:00 +0000
@@ -1,104 +0,0 @@
1Overview
2========
3
4Landscape client is the agent for the Landscape administration system.
5
6Usage
7=====
8
9This subordinate charm is intended to be used to register a machine
10against a running Landscape server. Configuration needs to be supplied
11or it won't do anything. Here is a simple config.yaml to register
12against the hosted version of Landscape:
13
14landscape-client:
15 account-name: <account_name_here>
16 registration-key: <registration_key_here>
17 tags: <csv_tag_list>
18
19The following is a version if you need to customize the communication URL
20in case you are running against a dedicated version of Landscape (LDS), This
21version also sets Script exection, and allows landscape to become any user
22(even root), to execute scripts:
23
24landscape-client:
25 account-name: standalone
26 registration-key: 128-qosk-7382
27 tags: laptop,precise,developer
28 ping-url: http://landscape.example.com/ping
29 url: https://landscape.example.com/message-system
30 script-users: ALL
31 include-manager-plugins: ScriptExecution
32
33Configuration
34=============
35
36Landscape client has a number of configuration options available allowing
37customizability into a variety of environments where resources may be
38scarce or security may be a concern. The most useful and common options are
39documented below.
40
41To get more detail on options, these correlate directly to configuration
42settings on landscape-client itself. (landscape-client(1),
43landscape-client --help)
44
45account-name:
46 Name of the account to register against in the hosted version
47 of Landscape. In the dedicated version of Landscape (LDS), this will
48 always be "standalone"
49
50registration-key:
51 The account registration key, found in the Landscape account GUI.
52
53tags:
54 Comma separated list of tags to apply to the computer once it is
55 registered.
56
57url:
58 The server url to connect to, will usually be https and end with
59 /message-system
60
61ping-url:
62 If the server url is specified, ping-url should also be specified.
63 Will usually be http and end with /ping
64
65include-manager-plugins:
66 This option is primarily used to enable the ScriptExecution plugin, which
67 allows arbitrary scripts to be executed on the registered computer.
68
69script-users:
70 Comma-separated list of users that the landscape client can become to
71 execute scripts. Keyword "ALL" can be used to include all users on the
72 system.
73
74ssl-public-key:
75 If needed, use this to give the client the CA certificate it should use to
76 verify the server certificate it is connecting to.
77
78
79When registering the client against a server with a custom or not well known
80CA, you will need to use the ssl-public-key option. To insert the certificate
81contents into the charm config directly, just encode it in base64.
82
83For example, let's assume ca.pem is a file with the CA certificate the client
84needs to use to verify the server:
85
86$ cat ca.pem | openssl base64 -e > ca.encoded
87
88Now insert the ca.encoded contents into the charm config, like this:
89
90landscape-client:
91 url: ....
92 ping-url: ....
93 ssl-public-key: |
94 base64:<insert-here-
95 contents-of-ca.encoded>...
96 ...
97 ...
98
99Contact Information
100===================
101
102Author: Landscape Team <landscape-team@canonical.com>,
103Report bugs at: http://bugs.launchpad.net/charms/+source/landscape-client/+filebug
104Location: http://jujucharms.com/charms/landscape-client
1050
=== added file 'README.md'
--- README.md 1970-01-01 00:00:00 +0000
+++ README.md 2014-07-25 16:43:37 +0000
@@ -0,0 +1,93 @@
1# Overview
2
3Landscape client is the agent for the Landscape administration system.
4
5# Usage
6
7This subordinate charm is intended to be used to register a machine against a
8running Landscape server. Configuration needs to be supplied or it won't do
9anything. Here is a simple config.yaml to register against the hosted version of
10Landscape:
11
12 landscape-client:
13 account-name: <account_name_here>
14 registration-key: <registration_key_here>
15 tags: <csv_tag_list>
16
17The following is a version if you need to customize the communication URL in
18case you are running against a dedicated version of Landscape (LDS). This
19version also sets Script exection, and allows landscape to become any user
20(even root), to execute scripts:
21
22 landscape-client:
23 account-name: standalone
24 registration-key: 128-qosk-7382
25 tags: laptop,precise,developer
26 ping-url: http://landscape.example.com/ping
27 url: https://landscape.example.com/message-system
28 script-users: ALL
29 include-manager-plugins: ScriptExecution
30
31# Configuration
32
33Landscape client has a number of configuration options available allowing
34customizability into a variety of environments where resources may be scarce
35or security may be a concern. The most useful and common options are documented
36below.
37
38To get more detail on options, these correlate directly to configuration
39settings on landscape-client itself. (landscape-client(1),
40landscape-client --help)
41
42`account-name`: Name of the account to register against in the hosted version
43of Landscape. In the dedicated version of Landscape (LDS), this will always be
44"standalone"
45
46`registration-key`: The account registration key, found in the Landscape account
47GUI.
48
49`tags`:Comma separated list of tags to apply to the computer once it is
50registered.
51
52`url`: The server url to connect to, will usually be https and end with
53/message-system
54
55`ping-url`: If the server url is specified, ping-url should also be specified.
56Will usually be http and end with /ping
57
58`include-manager-plugins`: This option is primarily used to enable the
59ScriptExecution plugin, which allows arbitrary scripts to be executed on the
60registered computer.
61
62`script-users`: Comma-separated list of users that the landscape client can
63become to execute scripts. Keyword "ALL" can be used to include all users on the
64system.
65
66`ssl-public-key`: If needed, use this to give the client the CA certificate it
67should use to verify the server certificate it is connecting to.
68
69When registering the client against a server with a custom or not well known
70CA, you will need to use the ssl-public-key option. To insert the certificate
71contents into the charm config directly, just encode it in base64.
72
73For example, let's assume ca.pem is a file with the CA certificate the client
74needs to use to verify the server:
75
76 cat ca.pem | openssl base64 -e > ca.encoded
77
78Now insert the ca.encoded contents into the charm config, like this:
79
80 landscape-client:
81 url: ....
82 ping-url: ....
83 ssl-public-key: |
84 base64:<insert-here-
85 contents-of-ca.encoded>...
86 ...
87 ...
88
89# Contact Information
90
91Author: Landscape Team <landscape-team@canonical.com>
92Report bugs at: http://bugs.launchpad.net/charms/+source/landscape-client/+filebug
93Location: http://jujucharms.com/charms/landscape-client

Subscribers

People subscribed via source and target branches