Skip to content

Commit 0ec02e4

Browse files
committed
Adding documentation.
1 parent 159181f commit 0ec02e4

File tree

1 file changed

+58
-4
lines changed

1 file changed

+58
-4
lines changed

README.md

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,10 +129,34 @@ aem::instance { 'aem' :
129129
}
130130
~~~
131131

132+
#### Specify License Example
133+
134+
This is an example for defining an AEM instance, and a license.
135+
136+
~~~
137+
# Add Instance
138+
aem::instance { 'aem' :
139+
source => '/path/to/aem-quickstart.jar',
140+
sample_content => false,
141+
}
142+
# Add License
143+
aem::license { 'aem' :
144+
customer => 'Customer Name',
145+
home => '/opt/aem',
146+
license_key => 'enter-your-key-here',
147+
version => '6.1.0',
148+
}
149+
# Ensure Instance before License (home must exist)
150+
Aem::Instance['aem'] -> Aem::License['aem']
151+
152+
~~~
153+
154+
132155
## Reference
133156

134157
- [**Public Defines**](#public-defines)
135158
- [Define: aem::instance](#define-aeminstance)
159+
- [Define: aem::license](#define-aemlicense)
136160
- [**Private Defines**](#private-defines)
137161
- [Define: aem::package](#define-aempackage)
138162
- [Define: aem::config](#define-aemconfig)
@@ -147,7 +171,7 @@ This type enables you to manage AEM instances within Puppet. Declare one `aem::i
147171

148172
** Parametrs within `aem::instance`:**
149173

150-
#####`name`
174+
##### `name`
151175
Namevar. Required. Specifies the name of the AEM instance.
152176

153177
##### `ensure`
@@ -157,12 +181,12 @@ Optional. Changes the state of the AEM instance. Valid values are `present` or `
157181
Optional. Specifies the URL context root for the AEM application. [Sling documentation](https://sling.apache.org/documentation/the-sling-engine/the-sling-launchpad.html). Defaults to `/`.
158182

159183
##### `debug_port`
160-
Optional. Specifies the port on which to listen for remote debugging connections. Setting this will add the following JVM options: `-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=<<port>>` Valid options: any port number.
184+
Optional. Specifies the port on which to listen for remote debugging connections. Setting this will add the following JVM options: `-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=<<port>>` Valid options: any port number.
161185

162186
##### `group`
163187
Optional. Sets the group for installation. Valid options: any valid group. Default: `aem`.
164188

165-
#####`home`
189+
##### `home`
166190
Optional. Sets the directory in which AEM will be installed. Valid options: Any absolute system path. Default: `/opt/aem`.
167191

168192
##### `jvm_mem_opts`
@@ -202,11 +226,41 @@ Optional. Sets the timeout allowed for startup monitoring. If the installation d
202226
Optional. Specifies the AEM installation type. Valid options: `author` or `publish`. Default: `author`. [AEM documentation](https://docs.adobe.com/docs/en/aem/6-1/deploy/configuring/configure-runmodes.html#Installation Run Modes)
203227

204228
##### `user`
205-
Optional. Sets the user for installation. Valid options: any valid group. Default: `aem`.
229+
Optional. Sets the user for installation. Valid options: any valid user. Default: `aem`.
206230

207231
##### `version`
208232
Optional. Sets the version of AEM. Informational only, does not affect installation or resource management. Valid options: any semantic version.
209233

234+
#### Define: `aem::license`
235+
236+
This type enables you to manage AEM license. Declare one `aem::license` per managed AEM server.
237+
238+
** Parametrs within `aem::license`:**
239+
240+
##### `name`
241+
Namevar. Required. Specifies the name of the AEM license.
242+
243+
##### `ensure`
244+
Optional. Changes the state of the AEM license. Valid values are `present` or `absent`. Default: `present`.
245+
246+
##### `customer`
247+
Optional. Specifies the customer name for the license file.
248+
249+
##### `group`
250+
Optional. Sets the group for file ownership. Valid options: any valid group. Default: `aem`.
251+
252+
##### `home`
253+
Required. Sets the directory in which the license will be placed. Valid options: Any absolute system path.
254+
255+
##### `license_key`
256+
Required. Sets the license key for AEM. Valid options: any string.
257+
258+
##### `user`
259+
Optional. Sets the user for for file ownership. Valid options: any valid user. Default: `aem`.
260+
261+
##### `version`
262+
Optional. Sets the version of AEM for the license file contents. Valid options: any string.
263+
210264
### Private Defines
211265

212266
#### Define: `aem::package`

0 commit comments

Comments
 (0)