wcm.io DevOps

conga-aem:package-install

Full name:

io.wcm.devops.conga.plugins:conga-aem-maven-plugin:2.19.5-SNAPSHOT:package-install

Description:

Installs all AEM content packages and OSGi bundles to AEM which are referenced in a model.yaml generated by CONGA for a node.

Attributes:

  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<nodeDirectory> File - Directory with the generated CONGA configuration containing the model.yaml.
User property is: conga.nodeDirectory.
<serviceURL> String -

The URL of the HTTP service API of the CRX package manager.

See CRX HTTP service Interface for details on this interface.


Default value is: http://localhost:4502/crx/packmgr/service.
User property is: vault.serviceURL.
<slingPluginVersion> String - Version of Sling plugin
Default value is: 2.4.2.
User property is: sling.plugin.version.

Optional Parameters

Name Type Since Description
<bundleStatusBlacklistBundleNames> String[] - Patterns for symbolic names of bundles that are expected to be not present in bundle list. If any of these bundles are found in the bundle list, this system is assumed as not ready for installing further packages because a previous installation (e.g. of AEM service pack) is still in progress.
Default value is: ^updater\.aem.*$.
User property is: vault.bundleStatusBlacklistBundleNames.
<bundleStatusURL> String -

Bundle status JSON URL. If an URL is configured the activation status of all bundles in the system is checked before it is tried to upload and install a new package and after each upload.

If not all bundles are activated the upload is delayed up to bundleStatusWaitLimit seconds, every 5 seconds the activation status is checked anew.

Expected is an URL like: http://localhost:4502/system/console/bundles/.json

If the URL is not set it is derived from serviceURL. If set to "-" the status check is disabled.


User property is: vault.bundleStatusURL.
<bundleStatusWaitLimit> int - Number of seconds to wait as maximum for a positive bundle status check. If this limit is reached and the bundle status is still not positive the install of the package proceeds anyway.
Default value is: 360.
User property is: vault.bundleStatusWaitLimit.
<bundleStatusWhitelistBundleNames> String[] - Patterns for symbolic names of bundles that are ignored in bundle list. The state of these bundles has no effect on the bundle status check.
Default value is: ^com\.day\.crx\.crxde-support$,^com\.adobe\.granite\.crx-explorer$,^com\.adobe\.granite\.crxde-lite$,^org\.apache\.sling\.jcr\.webdav$,^org\.apache\.sling\.jcr\.davex$.
User property is: vault.bundleStatusWhitelistBundleNames.
<consoleOauth2AccessToken> String - OAuth 2 access token to authenticate against the remote CRX system (Felix console). If this is configured, username and password are ignored. Defaults to value from authenticationBearerToken.
User property is: console.consoleOauth2AccessToken.
<consolePassword> String - The password to authenticate against the remote CRX system (Felix console). Defaults to the value from password.
User property is: console.password.
<consoleUserId> String - The user name to authenticate as against the remote CRX system (Felix console). Defaults to the value from userId.
User property is: console.userId.
<delayAfterInstallSec> Integer - Delay further steps after package installation by this amount of seconds
User property is: vault.delayAfterInstallSec.
<force> Boolean - Force upload and install of content package. If set to:
  • true: Package is always installed, even if it was already uploaded before.
  • false: Package is only installed if it was not already uploade before.
  • nothing (default): Force is applied to packages with the string "-SNAPSHOT" in it's filename.

User property is: vault.force.
<httpConnectTimeoutSec> int - HTTP connection timeout (in seconds).
Default value is: 10.
User property is: vault.httpConnectTimeoutSec.
<httpSocketTimeout> int - HTTP socket timeout (in seconds).
Default value is: 60.
User property is: vault.httpSocketTimeoutSec.
<install> boolean - Whether to install (unpack) the uploaded package automatically or not.
Default value is: true.
User property is: vault.install.
<oauth2AccessToken> String - OAuth 2 access token to authenticate against the remote CRX system (package manager). If this is configured, username and password are ignored.
User property is: vault.oauth2AccessToken.
<packageManagerInstallStatusURL> String -

Package Manager install status JSON URL. If an URL is configured the installation status of packages and embedded packages is checked before it is tried to upload and install a new package and after each upload.

If not all packages are installed the upload is delayed up to packageManagerInstallStatusWaitLimit seconds, every 5 seconds the installation status is checked anew.

Expected is an URL like: http://localhost:4502/crx/packmgr/installstatus.jsp

If the URL is not set it is derived from serviceURL. If set to "-" the status check is disabled.


User property is: vault.packageManagerInstallStatusURL.
<packageManagerInstallStatusWaitLimit> int - Number of seconds to wait as maximum for a positive package manager install status check. If this limit is reached and the package manager status is still not positive the install of the package proceeds anyway.
Default value is: 360.
User property is: vault.packageManagerInstallStatusWaitLimit.
<packageManagerOutputLogLevel> String - Log level to be used to log responses from package manager (which may get huge for large packages). Possible values are INFO (default) or DEBUG.
Default value is: INFO.
User property is: vault.packageManagerOutputLogLevel.
<password> String - The password to authenticate against the remote CRX system (package manager).
Default value is: admin.
User property is: vault.password.
<recursive> boolean - If set to true nested packages get installed as well.
Default value is: true.
User property is: vault.recursive.
<relaxedSSLCheck> boolean - If set to true also self-signed certificates are accepted.
Default value is: false.
User property is: vault.relaxedSSLCheck.
<replicate> boolean - Replicate package(s) to publish instance after upload.
User property is: vault.replicatePackage.
<retryCount> int - Number of times to retry upload and install via CRX HTTP interface if it fails.
Default value is: 24.
User property is: vault.retryCount.
<retryDelay> int - Number of seconds between retry attempts.
Default value is: 5.
User property is: vault.retryDelay.
<skip> boolean - Set this to "true" to skip installing packages to CRX although configured in the POM.
Default value is: false.
User property is: vault.skip.
<userId> String - The user name to authenticate as against the remote CRX system (package manager).
Default value is: admin.
User property is: vault.userId.

Parameter Details

<bundleStatusBlacklistBundleNames>

Patterns for symbolic names of bundles that are expected to be not present in bundle list. If any of these bundles are found in the bundle list, this system is assumed as not ready for installing further packages because a previous installation (e.g. of AEM service pack) is still in progress.
  • Type: java.lang.String[]
  • Required: No
  • User Property: vault.bundleStatusBlacklistBundleNames
  • Default: ^updater\.aem.*$

<bundleStatusURL>

Bundle status JSON URL. If an URL is configured the activation status of all bundles in the system is checked before it is tried to upload and install a new package and after each upload.

If not all bundles are activated the upload is delayed up to bundleStatusWaitLimit seconds, every 5 seconds the activation status is checked anew.

Expected is an URL like: http://localhost:4502/system/console/bundles/.json

If the URL is not set it is derived from serviceURL. If set to "-" the status check is disabled.

  • Type: java.lang.String
  • Required: No
  • User Property: vault.bundleStatusURL

<bundleStatusWaitLimit>

Number of seconds to wait as maximum for a positive bundle status check. If this limit is reached and the bundle status is still not positive the install of the package proceeds anyway.
  • Type: int
  • Required: No
  • User Property: vault.bundleStatusWaitLimit
  • Default: 360

<bundleStatusWhitelistBundleNames>

Patterns for symbolic names of bundles that are ignored in bundle list. The state of these bundles has no effect on the bundle status check.
  • Type: java.lang.String[]
  • Required: No
  • User Property: vault.bundleStatusWhitelistBundleNames
  • Default: ^com\.day\.crx\.crxde-support$,^com\.adobe\.granite\.crx-explorer$,^com\.adobe\.granite\.crxde-lite$,^org\.apache\.sling\.jcr\.webdav$,^org\.apache\.sling\.jcr\.davex$

<consoleOauth2AccessToken>

OAuth 2 access token to authenticate against the remote CRX system (Felix console). If this is configured, username and password are ignored. Defaults to value from authenticationBearerToken.
  • Type: java.lang.String
  • Required: No
  • User Property: console.consoleOauth2AccessToken

<consolePassword>

The password to authenticate against the remote CRX system (Felix console). Defaults to the value from password.
  • Type: java.lang.String
  • Required: No
  • User Property: console.password

<consoleUserId>

The user name to authenticate as against the remote CRX system (Felix console). Defaults to the value from userId.
  • Type: java.lang.String
  • Required: No
  • User Property: console.userId

<delayAfterInstallSec>

Delay further steps after package installation by this amount of seconds
  • Type: java.lang.Integer
  • Required: No
  • User Property: vault.delayAfterInstallSec

<force>

Force upload and install of content package. If set to:
  • true: Package is always installed, even if it was already uploaded before.
  • false: Package is only installed if it was not already uploade before.
  • nothing (default): Force is applied to packages with the string "-SNAPSHOT" in it's filename.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: vault.force

<httpConnectTimeoutSec>

HTTP connection timeout (in seconds).
  • Type: int
  • Required: No
  • User Property: vault.httpConnectTimeoutSec
  • Default: 10

<httpSocketTimeout>

HTTP socket timeout (in seconds).
  • Type: int
  • Required: No
  • User Property: vault.httpSocketTimeoutSec
  • Default: 60

<install>

Whether to install (unpack) the uploaded package automatically or not.
  • Type: boolean
  • Required: No
  • User Property: vault.install
  • Default: true

<nodeDirectory>

Directory with the generated CONGA configuration containing the model.yaml.
  • Type: java.io.File
  • Required: Yes
  • User Property: conga.nodeDirectory

<oauth2AccessToken>

OAuth 2 access token to authenticate against the remote CRX system (package manager). If this is configured, username and password are ignored.
  • Type: java.lang.String
  • Required: No
  • User Property: vault.oauth2AccessToken

<packageManagerInstallStatusURL>

Package Manager install status JSON URL. If an URL is configured the installation status of packages and embedded packages is checked before it is tried to upload and install a new package and after each upload.

If not all packages are installed the upload is delayed up to packageManagerInstallStatusWaitLimit seconds, every 5 seconds the installation status is checked anew.

Expected is an URL like: http://localhost:4502/crx/packmgr/installstatus.jsp

If the URL is not set it is derived from serviceURL. If set to "-" the status check is disabled.

  • Type: java.lang.String
  • Required: No
  • User Property: vault.packageManagerInstallStatusURL

<packageManagerInstallStatusWaitLimit>

Number of seconds to wait as maximum for a positive package manager install status check. If this limit is reached and the package manager status is still not positive the install of the package proceeds anyway.
  • Type: int
  • Required: No
  • User Property: vault.packageManagerInstallStatusWaitLimit
  • Default: 360

<packageManagerOutputLogLevel>

Log level to be used to log responses from package manager (which may get huge for large packages). Possible values are INFO (default) or DEBUG.
  • Type: java.lang.String
  • Required: No
  • User Property: vault.packageManagerOutputLogLevel
  • Default: INFO

<password>

The password to authenticate against the remote CRX system (package manager).
  • Type: java.lang.String
  • Required: No
  • User Property: vault.password
  • Default: admin

<recursive>

If set to true nested packages get installed as well.
  • Type: boolean
  • Required: No
  • User Property: vault.recursive
  • Default: true

<relaxedSSLCheck>

If set to true also self-signed certificates are accepted.
  • Type: boolean
  • Required: No
  • User Property: vault.relaxedSSLCheck
  • Default: false

<replicate>

Replicate package(s) to publish instance after upload.
  • Type: boolean
  • Required: No
  • User Property: vault.replicatePackage

<retryCount>

Number of times to retry upload and install via CRX HTTP interface if it fails.
  • Type: int
  • Required: No
  • User Property: vault.retryCount
  • Default: 24

<retryDelay>

Number of seconds between retry attempts.
  • Type: int
  • Required: No
  • User Property: vault.retryDelay
  • Default: 5

<serviceURL>

The URL of the HTTP service API of the CRX package manager.

See CRX HTTP service Interface for details on this interface.

  • Type: java.lang.String
  • Required: Yes
  • User Property: vault.serviceURL
  • Default: http://localhost:4502/crx/packmgr/service

<skip>

Set this to "true" to skip installing packages to CRX although configured in the POM.
  • Type: boolean
  • Required: No
  • User Property: vault.skip
  • Default: false

<slingPluginVersion>

Version of Sling plugin
  • Type: java.lang.String
  • Required: Yes
  • User Property: sling.plugin.version
  • Default: 2.4.2

<userId>

The user name to authenticate as against the remote CRX system (package manager).
  • Type: java.lang.String
  • Required: No
  • User Property: vault.userId
  • Default: admin

Back to top

Copyright ©2015-2023 wcm.io DevOps. All Rights Reserved.

Version: 2.19.5-SNAPSHOT. Last Published: 2023-04-24.