You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 28
Next »
Prerequistes
- Docker 20.10.X and up
- If using MacOS or Windows, install Docker Desktop
- Resources for MacOS/Windows Docker Desktop
- Docker Desktop → Preferences → Resources → Advanced
- A valid Aspire account and Aspire 5 License (see Aspire Registration and Licensing)
- Download aspire-quickstart.zip
Installation Process
- Unzip the aspire-quickstart.zip file
- (If MacOS or Windows) Install Docker Desktop from Official Site
- Set the resources for Docker Desktop as to at least 2 CPUs, 8 GB Memory, 1 GB Swap (at Preferences → Resources → Advanced)
- Enable file sharing on the unziped aspire-quickstart folder (at Preferences → Resources → File Sharing)
Open a command line terminal and Login to artifactory docker registry:
$ docker login docker.repository.sca.accenture.com
You will be prompted for your credentials (registered email and password)
If you can't remember the credentials write to [email protected], these would be shared with you when you request the Account and License. This step is required so Docker can download the official images of Aspire.- Copy your AspireLicense.lic to aspire-quickstart/config/
- Only Aspire 5 Licenses are valid
- Execute installation script from command line terminal:
- install-quickstart.sh if MacOS or Linux
- On Linux before executing the script, give it execution permissions: chmod +x install-quickstart.sh
- install-quickstart.bat if Windows
- Wait until all containers have started:
Now you should be able to access aspire at: https://localhost:50443/
Login with admin1 / 123456abC
Happy crawling with Aspire5!
Uninstall quickstart containers
- Execute uninstall-quickstart.sh if MacOS or Linux
- uninstall-quickstart.bat if Windows
What have been installed with these scripts?
The current quickstart guide installs the following containers:
- Elasticsearch / Kibana
- OpenLDAP
- Aspire5 (With HTTPS and authentication enabled)
Want to know more about the quickstart?
The current quickstart scripts execute the following steps in order:
- Creates docker volumes for persistent storage (elasticsearch indexes, ssl certificates, ldap directory) and network for all the containers to communicate to each other
- Generates self-signed certificates and CA for elasticsearch, kibana and aspire nodes (see generate-ssl.[sh/bat])
- Copies the certificates to the docker volumes previously created
- If you want to do this for an on-premise installation follow Enable HTTPS
- Starts elasticsearch and kibana
- The elasticsearch/docker-compose.yml contains a service that runs once to upload the Kibana Dashboard at elasticsearch/export.ndjson
- Uses the certificate docker volumes to obtain and configure the certificates
- Uploading of settings and AspireLicense to elasticsearch (see update-settings-license.[sh/bat]
- Uses the same aspire docker image to do it, the same env properties are provided for the elasticsearch authentication and SSL certificate trusting.
- Starts the LDAP service
- Copies the ldif folder with pre-loaded configuration into the ldap directory docker volume
- Starts the ldap/docker-compose.yml
- Starts aspire service using aspire/docker-compose.yml
All docker containers share the same environment variables at the .env file, this is not recommended for production deployments, but simplifies the management of variables for the quickstart scripts.