This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-site.git
The following commit(s) were added to refs/heads/master by this push:
new 8714f3c SLING-3747 document pause feature of JCR installer
8714f3c is described below
commit 8714f3ca1a385c5bf3a58676fcd2db458b6dfdd2
Author: Konrad Windszus <[email protected]>
AuthorDate: Thu Jun 4 17:45:40 2020 +0200
SLING-3747 document pause feature of JCR installer
---
.../content/documentation/bundles/jcr-installer-provider.md | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git
a/src/main/jbake/content/documentation/bundles/jcr-installer-provider.md
b/src/main/jbake/content/documentation/bundles/jcr-installer-provider.md
index 3ee9ccb..ae82646 100644
--- a/src/main/jbake/content/documentation/bundles/jcr-installer-provider.md
+++ b/src/main/jbake/content/documentation/bundles/jcr-installer-provider.md
@@ -16,17 +16,17 @@ In addition every node of type `sling:OsgiConfig` is
provided as a configuration
The JCR installer provider does not check or scan the artifacts itself, the
detection and installation is deferred to the OSGi installer.
-### Runmode Support
+## Run Mode Support
-The JCR installer supports run modes for installing artifacts. By default
folders named `install` are checked for artifacts. If Apache Sling is started
with one (or more run modes), all folders named `install.[RUNMODE]` are scanned
as well. To be precise, the folder name can be followed by any number of run
modes separated by dot (`.`). For example, if started with run modes `dev`,
`a1`, and `public`, folders like `install.dev`, `install.a1`, `install.public`
are searched as well as `ins [...]
+The JCR installer supports [run
modes](sling-settings-org-apache-sling-settings.html) for installing artifacts.
By default folders named `install` are checked for artifacts. If Apache Sling
is started with one (or more run modes), all folders named `install.[RUNMODE]`
are scanned as well. To be precise, the folder name can be followed by any
number of run modes separated by dot (`.`). For example, if started with run
modes `dev`, `a1`, and `public`, folders like `install.dev`, `install.a [...]
Artifacts from folders with a run mode get a higher priority. For example by
default, an `install` folder underneath `/libs` gets the priority `50`. For
each run mode in the folder name, this priority is increased by `1`, so
`install.dev` has `51` and `install.a1.dev` has `52`.
-### Start Level Support
+## Start Level Support
If the parent folder of a bundle has a name which is a number, this is used as
the start level (when installing the bundle for the first time, compare with
[SLING-2011](https://issues.apache.org/jira/browse/SLING-2011)). So e.g. a
bundle in the path `/libs/sling/install/15/somebundle.jar` is having the start
level `15`.
-# Write Back Support
+## Write Back Support
The JCR installer supports writing back of configurations which are changed by
some other ways, e.g by using the Apache Felix web console. If this is a new
configuration which was not originally stored in the repository, a new
configuration is stored under `/apps/sling/install`. The highest search path is
used together with a configurable folder (`sling/install` in this case).
If a configuration is changed which already exists in the repository, then it
depends where the original configuration is stored. If its under `/libs` a new
configuration at the same path under `/apps` is created. Otherwise the
configuration is directly modified.
@@ -34,6 +34,10 @@ As JCR properties do not support all Java primitive types
like Integer, the writ
Write back can be turned off by configuration.
+## Pausing the provider
+
+In version 3.1.8
([SLING-3747](https://issues.apache.org/jira/browse/SLING-3747)) a mechanism
has been added which pauses the scanning of artifacts. Whenever there is at
least one child node below `/system/sling/installer/jcr/pauseInstallation`
(path configurable), the provider will be paused i.e. not provide any artifacts
to the OSGi installer. This is reasonable to do while executing operations
which rely on certain services not being restarted. Every deployment of new
bundles and conf [...]
+
# Example
Here's a quick walkthrough of the JCR installer functionality.
