Note |
---|
The recommended way of deploying Aspire 5 is by containers. See Quickstart Guide with Docker or Kubernetes Deployments for more information. |
The current guide describes how to deploy Aspire 5 directly into a VM (Linux or Windows).
Table of Contents
Table of Contents |
---|
Follow the steps at Configuring Aspire Maven Repository using your registered credentials for maven to be able to download the Aspire artifacts.
The Aspire Distribution Maven Archetype allows for building aspire distributions consistently and easily.
Create the distribution archetype project with maven
Code Block | ||||
---|---|---|---|---|
| ||||
mvn archetype:generate -DarchetypeGroupId=com.accenture.aspire -DarchetypeArtifactId=aspire-distribution-archetype -DarchetypeVersion=5.0-SNAPSHOT -DrepositoryId=stPublic |
You will be prompted with the following parameters (sample configuration):
Code Block | ||
---|---|---|
| ||
Define value for property 'groupId': com.accenture.aspire Define value for property 'artifactId': aspire5 Define value for property 'version' 1.0-SNAPSHOT: : [use default just hit ENTER] [INFO] Using property: package = pom [INFO] Using property: aspire.bootloader = aspire-elasticsearch-bootloader [INFO] Using property: aspireAdminPort = 50505 Confirm properties configuration: groupId: com.accenture.aspire artifactId: aspire5 version: 1.0-SNAPSHOT package: pom aspire.bootloader: aspire-elasticsearch-bootloader aspireAdminPort: 50505 Y: : y |
You will see a folder with the name entered in the 'artifactId' parameter, change your current directory into it
Code Block | ||||
---|---|---|---|---|
| ||||
cd aspire5 |
Build the distribution
Code Block | ||||
---|---|---|---|---|
| ||||
mvn clean package |
This generates the distribution into the 'target' folder
Copy your distribution to where you want it to be installed
Code Block | ||||
---|---|---|---|---|
| ||||
cp -r target/aspire5 /your/installation/path |
If installing on Linux, give execution permissions to the bin/aspire.sh file:
Code Block | ||||
---|---|---|---|---|
| ||||
cd /your/installation/path/aspire5 chmod +x bin/aspire.sh |
Aspire 5 differs from previous versions of Aspire in its architecture which impacts the way it is deployed. See Aspire 5.0 Architecture for more information.
There are two types of nodes that can be deployed: manager and worker nodes. At a minimum there should be 1 manager and 1 worker node on any Aspire deployment.
The same aspire distribution can act as both manager and worker at the same time, which is usually ideal for installing POCs, as it is simpler to maintain only one distribution.
Note |
---|
For production deployments using the same distribution for manager and worker roles is not supported. There should be at least one distribution for the worker and one for the manager in different VMs. |
Follow the steps above to create distributions for the different nodes in your cluster.
Info |
---|
When starting multiple distributions on the same VM, make sure to change the HTTP or HTTPS port it uses to start (at config/felix.properties file), otherwise conflicts would arise. |