Merge lp:~jose/charms/precise/chef-server/add-icon-categories-fix-readme into lp:charms/chef-server

Proposed by José Antonio Rey
Status: Merged
Merged at revision: 6
Proposed branch: lp:~jose/charms/precise/chef-server/add-icon-categories-fix-readme
Merge into: lp:charms/chef-server
Diff against target: 318 lines (+143/-144)
4 files modified
README (+0/-144)
README.md (+140/-0)
config.yaml (+1/-0)
metadata.yaml (+2/-0)
To merge this branch: bzr merge lp:~jose/charms/precise/chef-server/add-icon-categories-fix-readme
Reviewer Review Type Date Requested Status
Charles Butler (community) Approve
Review via email: mp+212796@code.launchpad.net

Commit message

Added categories, reformatted README to Markdown

Description of the change

Added icon

Added categories

Changed README to Markdown, as it's now used by CharmWorld.

To post a comment you must log in.
7. By José Antonio Rey

Removed icon as it didn't comply with CS policies

8. By José Antonio Rey

Changed category to applications

Revision history for this message
Charles Butler (lazypower) wrote :

Thanks Jose!

LGTM. Merged

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== removed file 'README'
2--- README 2013-05-10 19:13:41 +0000
3+++ README 1970-01-01 00:00:00 +0000
4@@ -1,144 +0,0 @@
5-Overview
6-========
7-
8-Chef is a DevOps tool used for configuring cloud services or to streamline the
9-task of configuring a company's internal servers. Chef automatically sets up
10-and tweaks the operating systems and programs that run in massive data centers.
11-
12-Chef can run using a client/server model, or on a consolidated configuration
13-named "chef-solo". Chef can be integrated with Cloud-based platforms such as
14-Rackspace and Amazon EC2. Traditionally, Chef is used to manage Linux but later
15-versions support running on Windows as well.
16-
17-The user writes "recipes" that describe how a Chef manages server applications
18-(such as Apache, MySQL, or Hadoop) and how they are to be configured. These
19-recipes describe a series of resources that should be in a particular state -
20-packages that should be installed, services that should be running, or files
21-that should be written. Chef makes sure each resource is properly configured,
22-and automatically discovers data points of the system.
23-
24-Chef can be used to create clones of Quality Assurance environments,
25-pre-production environments, and partner preview environments. Once automated,
26-a blueprint is created for the infrastructure, enabling the user to build, or
27-rebuild, automatically in minutes or hours.
28-
29-
30-Configurable Options
31-====================
32-
33-The 'chef-server' charm allows for certain values to be configured using a
34-config.yaml file.
35-
36-Most default values used in the config.yaml file are taken from those used in a
37-standard installation e.g.
38-
39- chef-server:
40- chef-version: '0.10'
41- webui-port: '4040'
42- restapi-port: '4000'
43- solr-port: '8983'
44- webui-user: 'admin'
45- webui-pw: 'adminpass'
46- knife-user: 'ubuntu'
47-
48-If the 'knife-user' option is set, the value must correspond to an user that
49-exists on the install node. If not it is ignored. If it does exist, a knife
50-configuration profile will be generated for that user which can be used as a
51-template for managing a chef repository.
52-
53-Note that in order to change the username and password for the chef-server
54-webgui, you must do so through the UI itself. The username and password set on
55-install are just to seed the install. If a password is not provided, one will
56-be auto generated and saved in /var/cache/charms/chef-server/webui-pw.local.
57-Root permissions will be required to read this file.
58-
59-Deployment
60-==========
61-
62-Bootstrap the juju environment (required before any operation can be performed)
63-
64- juju bootstrap
65-
66-Check that the environment has been bootstrapped successfully.
67-
68- juju status
69-
70- machines:
71- 0:
72- agent-state: running
73- dns-name: <bootstrap-instance-ip-address>
74- instance-id: <bootstrap-instance-id>
75- instance-state: running
76-
77-Now deploy the service
78-
79- juju deploy -n 1 --config config.yaml chef-server
80-
81-Check the status. After a few minutes the service should be deployed and
82-running.
83-
84- juju status
85-
86- machines:
87- 0:
88- agent-state: running
89- dns-name: <bootstrap-instance-ip-address>
90- instance-id: <bootstrap-instance-id>
91- instance-state: running
92- 1:
93- agent-state: running
94- dns-name: <server-ip-address>
95- instance-id: <service-instance-id>
96- instance-state: running
97- services:
98- chef-server:
99- charm: local:precise/chef-server-0
100- exposed: false
101- relations: {}
102- units:
103- chef-server/0:
104- agent-state: started
105- machine: 1
106- public-address: <server-ip-address>
107-
108-And then expose the service so that it is accessible over the internet.
109-
110- juju expose chef-server
111-
112-And check status again to see that the requested ports have been exposed.
113-
114- juju status
115-
116- machines:
117- 0:
118- agent-state: running
119- dns-name: <bootstrap-instance-ip-address>
120- instance-id: <bootstrap-instance-id>
121- instance-state: running
122- 1:
123- agent-state: running
124- dns-name: <server-ip-address>
125- instance-id: <service-instance-id>
126- instance-state: running
127- services:
128- chef-server:
129- charm: local:precise/chef-server-0
130- exposed: true
131- relations: {}
132- units:
133- chef-server/0:
134- agent-state: started
135- machine: 1
136- open-ports:
137- - 4040/tcp
138- - 4000/tcp
139- public-address: <server-ip-address>
140-
141-
142-Contact Information
143-===================
144-
145-Author: Edward Hope-Morley <edward.hope-morley@canonical.com>
146-Report bugs at: http://bugs.launchpad.net/charms/+source/chef-server/+filebug
147-Location: http://jujucharms.com/charms/chef-server
148-
149
150=== added file 'README.md'
151--- README.md 1970-01-01 00:00:00 +0000
152+++ README.md 2014-04-16 03:00:44 +0000
153@@ -0,0 +1,140 @@
154+# Overview
155+
156+Chef is a DevOps tool used for configuring cloud services or to streamline the
157+task of configuring a company's internal servers. Chef automatically sets up
158+and tweaks the operating systems and programs that run in massive data centers.
159+
160+Chef can run using a client/server model, or on a consolidated configuration
161+named "chef-solo". Chef can be integrated with Cloud-based platforms such as
162+Rackspace and Amazon EC2. Traditionally, Chef is used to manage Linux but later
163+versions support running on Windows as well.
164+
165+The user writes "recipes" that describe how a Chef manages server applications
166+(such as Apache, MySQL, or Hadoop) and how they are to be configured. These
167+recipes describe a series of resources that should be in a particular state -
168+packages that should be installed, services that should be running, or files
169+that should be written. Chef makes sure each resource is properly configured,
170+and automatically discovers data points of the system.
171+
172+Chef can be used to create clones of Quality Assurance environments,
173+pre-production environments, and partner preview environments. Once automated,
174+a blueprint is created for the infrastructure, enabling the user to build, or
175+rebuild, automatically in minutes or hours.
176+
177+
178+# Configurable Options
179+
180+The 'chef-server' charm allows for certain values to be configured using a
181+config.yaml file.
182+
183+Most default values used in the config.yaml file are taken from those used in a
184+standard installation e.g.
185+
186+ chef-server:
187+ chef-version: '0.10'
188+ webui-port: '4040'
189+ restapi-port: '4000'
190+ solr-port: '8983'
191+ webui-user: 'admin'
192+ webui-pw: 'adminpass'
193+ knife-user: 'ubuntu'
194+
195+If the 'knife-user' option is set, the value must correspond to an user that
196+exists on the install node. If not it is ignored. If it does exist, a knife
197+configuration profile will be generated for that user which can be used as a
198+template for managing a chef repository.
199+
200+Note that in order to change the username and password for the chef-server
201+webgui, you must do so through the UI itself. The username and password set on
202+install are just to seed the install. If a password is not provided, one will
203+be auto generated and saved in /var/cache/charms/chef-server/webui-pw.local.
204+Root permissions will be required to read this file.
205+
206+# Deployment
207+
208+Bootstrap the juju environment (required before any operation can be performed)
209+
210+ juju bootstrap
211+
212+Check that the environment has been bootstrapped successfully.
213+
214+ juju status
215+
216+ machines:
217+ 0:
218+ agent-state: running
219+ dns-name: <bootstrap-instance-ip-address>
220+ instance-id: <bootstrap-instance-id>
221+ instance-state: running
222+
223+Now deploy the service
224+
225+ juju deploy -n 1 --config config.yaml chef-server
226+
227+Check the status. After a few minutes the service should be deployed and
228+running.
229+
230+ juju status
231+
232+ machines:
233+ 0:
234+ agent-state: running
235+ dns-name: <bootstrap-instance-ip-address>
236+ instance-id: <bootstrap-instance-id>
237+ instance-state: running
238+ 1:
239+ agent-state: running
240+ dns-name: <server-ip-address>
241+ instance-id: <service-instance-id>
242+ instance-state: running
243+ services:
244+ chef-server:
245+ charm: local:precise/chef-server-0
246+ exposed: false
247+ relations: {}
248+ units:
249+ chef-server/0:
250+ agent-state: started
251+ machine: 1
252+ public-address: <server-ip-address>
253+
254+And then expose the service so that it is accessible over the internet.
255+
256+ juju expose chef-server
257+
258+And check status again to see that the requested ports have been exposed.
259+
260+ juju status
261+
262+ machines:
263+ 0:
264+ agent-state: running
265+ dns-name: <bootstrap-instance-ip-address>
266+ instance-id: <bootstrap-instance-id>
267+ instance-state: running
268+ 1:
269+ agent-state: running
270+ dns-name: <server-ip-address>
271+ instance-id: <service-instance-id>
272+ instance-state: running
273+ services:
274+ chef-server:
275+ charm: local:precise/chef-server-0
276+ exposed: true
277+ relations: {}
278+ units:
279+ chef-server/0:
280+ agent-state: started
281+ machine: 1
282+ open-ports:
283+ - 4040/tcp
284+ - 4000/tcp
285+ public-address: <server-ip-address>
286+
287+
288+# Contact Information
289+
290+Author: Edward Hope-Morley <edward.hope-morley@canonical.com>
291+Report bugs at: http://bugs.launchpad.net/charms/+source/chef-server/+filebug
292+Location: http://jujucharms.com/charms/chef-server
293+
294
295=== modified file 'config.yaml'
296--- config.yaml 2013-05-10 19:13:41 +0000
297+++ config.yaml 2014-04-16 03:00:44 +0000
298@@ -25,6 +25,7 @@
299 description: Admin user for the chef-server web interface.
300 webui-pw:
301 type: string
302+ default: ""
303 description: Admin password for the chef-server web interface.
304 knife-user:
305 type: string
306
307=== modified file 'metadata.yaml'
308--- metadata.yaml 2013-05-10 19:13:41 +0000
309+++ metadata.yaml 2014-04-16 03:00:44 +0000
310@@ -4,6 +4,8 @@
311 description: |
312 Installs a Chef server (Opscode) which can then be used to deploy other
313 services.
314+categories:
315+ - applications
316 provides:
317 website:
318 interface: http

Subscribers

People subscribed via source and target branches

to all changes: