Skip to content

Commit cff0c0f

Browse files
author
Walter Huf
committed
Adds documentation about the custom radosgw lwrp
1 parent 7f68405 commit cff0c0f

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,27 @@ The ceph\_cephfs LWRP provides an easy way to mount CephFS. It will automaticall
121121
- :use\_fuse - whether to use ceph-fuse or the kernel client to mount the filesystem. ceph-fuse is updated more often, but the kernel client allows for subdirectory mounting. Defaults to true
122122
- :cephfs\_subdir - which CephFS subdirectory to mount. Defaults to '/'. An exception will be thrown if this option is set to anything other than '/' if use\_fuse is also true
123123

124+
### ceph\_radosgw
125+
126+
The ceph\_radosgw LWRP provides an easy way to setup customized radosgw servers. The LWRP itself just adds a node attribute, and then the radosgw recipe does all the setup. Due to the way Chef processes the runlist, this resource has to be explicitly converged before compiling the radosgw recipe. Any recipe that calls this LWRP has to say `.run_action(:add)` after the do..end block. Alternatively, the node attributes can be set with a wrapper cookbook.
127+
128+
#### Actions
129+
130+
- :add - Adds the given information as a custom radosgw configuration.
131+
132+
#### Parameters
133+
134+
- :name - name attribute, not used
135+
- :region - what region should be set in the ceph.conf for this radosgw
136+
- :region\_root\_pool - what rados pool should be used to load region information
137+
- :zone - what zone should be set in the ceph.conf for this radosgw
138+
- :zone\_root\_pool - what rados pool should be used to load zone information
139+
- :keyname - what name to use when generating the cephx key for this radosgw. Defaults to client.radosgw.#{zone}.#{hostname}
140+
- :dns\_name - what dns name to use in ceph.conf and Apache
141+
- :dns\_aliases - an optional array of other hostnames to handle requests for in Apache
142+
- :socket\_path - the path to the socket that radosgw will use for fastcgi communications. Defaults to /var/run/ceph/ceph-radosgw.#{zone}.#{hostname}
143+
- :print\_continue - whether to set the `print continue` option in ceph.conf. Defaults to nil, which doesn't set the option, true or false sets the option to the given setting.
144+
124145
## LICENSE AND AUTHORS
125146

126147
* Author: Kyle Bader <[email protected]>

0 commit comments

Comments
 (0)