Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/sling-org-apache-sling-kickstart
Apache Sling Kickstart Launcher
https://github.com/apache/sling-org-apache-sling-kickstart
java maven sling
Last synced: 8 days ago
JSON representation
Apache Sling Kickstart Launcher
- Host: GitHub
- URL: https://github.com/apache/sling-org-apache-sling-kickstart
- Owner: apache
- License: apache-2.0
- Created: 2020-02-13T10:39:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T17:45:54.000Z (9 days ago)
- Last Synced: 2024-10-28T18:59:19.209Z (8 days ago)
- Topics: java, maven, sling
- Language: Java
- Homepage: https://sling.apache.org/
- Size: 77.4 MB
- Stars: 3
- Watchers: 27
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://sling.apache.org)
[](https://ci-builds.apache.org/job/Sling/job/modules/job/sling-org-apache-sling-kickstart/job/master/) [](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-kickstart) [](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-kickstart) [](https://www.javadoc.io/doc/org.apache.sling/org-apache-sling-kickstart) [](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.sling%22%20a%3A%22org.apache.sling.kickstart%22) [](https://www.apache.org/licenses/LICENSE-2.0)
# Sling Kickstart Launcher
This project is the Feature Model based version of the **sling-org-apache-sling-starter**
module and creates an executable JAR file (for now).
It is also a test case for the Sling Kickstart Maven Plugin as it uses it
to launch a Launchpad Ready Rule and Smoke tests.
The Kickstart is using an embedded Sling Feature Archive to launch Sling and so the
Kicstart can be started w/o having access to the internet.
## Build
This plugin depends on the **Sling Kickstart Maven Plugin** which is then used to run the IT tests:
1. Go to **sling-kickstart-maven-plugin** module
2. Build with: `mvn clean install`
3. Go back to **sling-org-apache-sling-kickstart**
4. Build and Launch it with: `mvn clean install`
5. Sling will come up and run the IT tests and then shut down. Sling can be
kept running after the end of the IT tests by providing the property
**block.sling.at.the.end** with the value **true**
## Update to the Latest Sling
This project contains a copy of the Sling Starter features models and uses the **oak-tar**
configuration for its internal Sling 12 Feature Archive.
To update you just need to copy all available feature models from the Sling Starter module
and place it into the **src/main/resources/features** folder.
## Usage
After the resulting jar file **org.apache.sling.kickstart--.jar**
can be executed with:
```
java -jar org.apache.sling.kickstart--.jar ...
```
### Running as a Service / Background
The kickstart can be started in the background as a service with the 'start'
command but the starter needs to be put into the background:
```
java -jar org.apache.sling.kickstart--.jar start &
```
The status of the service then can be retrieved by using the 'status' command:
```
java -jar org.apache.sling.kickstart--.jar status
```
To shutdown the service use the 'stop' command:
```
java -jar org.apache.sling.kickstart--.jar stop
```
### Providing Sling Run Modes
If you project requires Sling Run Modes for Configuration purposes then
you can provide them here with the Kickstart project by using the
**sling.run.modes** property. Call it this way:
```bash
java -jar .jar -Dsling.run.modes=mode1,mode2
```
### Parameters
The parameters of the Kickstarter is beside **-af, -s** are the same as
the for the Sling Starater. To checkout the usage of the parameters you
can use the **help** parameter when starting the kickstarter JAR file:
```
Usage: java -jar [-hmnSv] [-a=
]
[-c=] [-f=]
[-j=]
[-l=] [-p=]
[-r=]
[-s=]
[-af=]...
[-D=]...
[-O=]... [COMMAND]
Apache Sling Kickstart
[COMMAND] Optional Command for Server Instance Interaction, can be
one of: 'start', 'stop', 'status' or 'threads'
-a, --address= the interface to bind to (use 0.0.0.0 for any)
-af, --additionalFeature=
additional feature files
-c, --slingHome=
the sling context directory (default launcher)
-D, --define=
sets property n to value v. Make sure to use this option
*after* the jar filename. The JVM also has a -D option
which has a different meaning
-f, --logFile= the log file, "-" for stdout (default logs/error.log)
-h, --help Display the usage message.
-j, --control=
host and port to use for control connection in the
format '[host:]port' (default 127.0.0.1:0)
-l, --logLevel= the initial loglevel (0..4, FATAL, ERROR, WARN, INFO,
DEBUG)
-m, --nofar Do not use Sling FAR (if no Main Feature was provided)
and use FM instead
-n, --noShutdownHook don't install the shutdown hook
-O, --overrides=
Overrides in format =, type: C = artifact,
CC = config, V = variable
-p, --port= the port to listen to (default 8080)
-r, --context=
the root servlet context path for the http service
(default is /)
-s, --mainFeature=
main feature file (file path or URL) replacing the
provided Sling Feature File
-S, --nofm Do not use Sling Feature Archive or Model file
-v, --verbose the feature launcher is verbose on launch
Copyright(c) 2020 The Apache Software Foundation.
```
These are four additional parameters:
**-s**: this takes a path to a Feature Model (FM) that replaces the provided
Sling Feature Module. With it it is possible to provide your own Sling FM
which may or may not contain your own project FMs.
**-af**: each parameter will have a path to a Feature Model (FM) that is
added to the provided Sling FM (or its override). To add multiple FMs just
use multiple *-af* parameter lines.
**-m/--nofar**: do not use the embedded Sling Feature Archive and use the
plain Sling Feature Model. This will greatly increase the launch performance
if most of the dependencies are already in the local Maven repository.
**-S/--nofm**: do not use the embedded Sling Feature Archive or Model file.
If no other Feature Module file is provided this launch aborts.
### Composite Node Store
The Kickstart project also comes with the Feature Models and the scripts to run
a Sling Composite Node Store as well having the option to upgrade a Sling instance
afterwards.
**Note**: keep in mind that these feature model files are not based on the latest
Sling 12 feature models.
#### Feature Models
The Sling Feature Model of the Composite Node Store needs to have the Default Node
Store removed which is available here: **src/main/resources/feature-sling12-two-headed.json**.
Then we have to additional Feature Models:
* feature-two-headed-seed.json: The setup to seed the initial **Libs** node store
which will be later the **read-only** node store
* feature-two-headed-runtime.json: This will create the Sling Instance with the composite
node store
#### Scripts
There are two sets of two scripts available in the **bin** folder:
* create_seed_fm.sh: creates the Seed Sling instance
* run_composite_fm.sh: launches the Sling instance with a composite node store where **libs**
is read-only
* create_updated_seed_fm.sh: creates an update Seed Sling Instance
* run_updated_composite_fm.sh: launches the Sling Instance with a composite node store
which the updates available
**Note**: the first two scripts support optionally additional features. Just add the path to the
feature model file or feature archive as parameters to the script and they will be added when
launched. It is important that both scripts get the same arguments, though.
The last two scripts requires at least one additional feature as an update only makes sense
when there is something to be updated.
Example:
```
./bin/create_seed_fm.sh my-project-fm.json another-project.json
./bin/run_composite_fm.sh my-project-fm.json another-project.json
```