Standard installation¶
This topic provides guidance on installing Anaconda Server and verifying your installation.
Note
To successfully install Anaconda Server, you must have already prepared your environment according to the Standard environment preparation topic.
Installing Anaconda Server¶
Download your installer by running the command:
# Replace <INSTALLER_LOCATION> with the provided installer location curl -O <INSTALLER_LOCATION>Run the installation command.
Installing with root access¶
HTTP Installation
If you have root access, run this command to install Anaconda Server:
# Replace <INSTALLER> with the installer you just downloaded
# Replace <FQDN> with the fully qualified domain name of your Anaconda Server instance
bash <INSTALLER> --keep -- --domain <FQDN> --default-user anaconda 2>&1 | tee as.install.output
HTTPS Installation
If you are using TLS/SSL certificates, run this command to install Anaconda Server:
# Replace <INSTALLER> with the installer you just downloaded
# Replace <FQDN> with the fully qualified domain name of your Anaconda Server instance
# Replace <PATH_TO_CERT> with the path to your TLS/SSL cert
# Replace <PATH_TO_KEY> with the path to your TLS/SSL key
bash <INSTALLER> --keep -- --domain <FQDN> --tls-cert <PATH_TO_CERT> --tls-key <PATH_TO_KEY> --default-user anaconda 2>&1 | tee as.install.output
During installation, login credentials will be generated and displayed in the terminal for two separate roles:
- anaconda - for administration in Anaconda Server UI
- admin - for administration in Keycloak
Caution
You’ll need the user names and passwords shown to log in to your instance of Anaconda Server and Keycloak. Make sure you save them!
Example output:
User anaconda created, realm=dev, roles=admin
password: J86j193PwaH92tjIN5J78m67 # This will be your password for logging into Anaconda Server
User admin created, realm=master, roles=admin
password: 79g2X1Zx02iY9RKe729MP38Y # This will be your password for logging into your Keycloak instance
The installer file directory contains both the installation script (install.sh), and the docker-compose.yml file, which define how the Anaconda Server services are run.
By default, /opt/anaconda/repo is the default file path for the installation folder. You can either create the folder manually by assigning write access to the current user, or use the -b (--base-install-dir) parameter to specify the folder for your installation.
Installing without root access¶
If you do not have root access, you must add yourself to the docker group by running the following command before you install:
# Replace <USERNAME> with your Anaconda username usermod -a -G docker <USERNAME>
Installing with external Postgres and Redis¶
Before you begin installation, make sure you are using Postgres version 9.6 or later and Redis version 6.0 or later, then perform the following steps:
Download the installer.
# Replace <INSTALLER_LOCATION> with the provided installer location curl -O <INSTALLER_LOCATION>Modify the downloaded file to make it executable, then run the installation command:
# Replace <INSTALLER> with the installer file you just downloaded # Replace <FQDN> with the fully qualified domain name of your Anaconda Server instance # Replace <PATH_TO_CERT> with the path to your TLS/SSL cert # Replace <PATH_TO_KEY> with the path to your TLS/SSL key # Replace <EXTERNAL_PS/RD_INSTANCE_IP4> with your external instance IP4 address in both locations # Replace <ASSIGNED_PORT> with the port used for communication # Replace <POSTGRES_USERID> with your postgres user ID # Replace <POSTGRES_PASSWORD> with your postgres password chmod +x <INSTALLER> bash <INSTALLER> --keep -- --domain <FQDN> --tls-cert <PATH_TO_CERT> --tls-key <PATH_TO_KEY> -e redis://<EXTERNAL_PS/RD_INSTANCE_IP4> -h <EXTERNAL_PS/RD_INSTANCE_IP4> -p <ASSIGNED_PORT> -u <POSTGRES_USERID> -pw <POSTGRES_PASSWORD> --default-user anaconda -y 2>&1 | tee as.install.output
Verifying your installation¶
Services are one-to-one to containers. Therefore, verifying that all major containers are up and not restarting or failing is a good first step.
In a terminal, run:
docker ps
You should see output similar to the following:
It is important to note that each container appears in the output:
- <INSTALLER>_repo_api_1
- <INSTALLER>_nginx_proxy_1
- <INSTALLER>_repo_worker_1
- <INSTALLER>_repo_dispatcher_1
- <INSTALLER>_proxy_1
- <INSTALLER>_keycloak_1
- <INSTALLER>_postgres_1
- <INSTALLER>_redis_1
It is also important to make sure that the status of each container is Up, and not stuck in a restart loop.
Finally, you should be able to use a browser to navigate to the domain that you supplied when executing the installer. If you are able to successfully authenticate and use the product, it has installed correctly.
Next steps¶
After the installation has completed, open a browser and visit the domain you used during the product installation.
Warning
Never delete the install directory containing the docker-compose.yml and .env files.
Further installation options can be seen by running the following command:
# Replace <INSTALLER> with your installer file
./<INSTALLER>/install.sh --help
This will present you with the following list of possible arguments:
| Arguments (shorthand) | Arguments (longhand) | Description |
-r DOCKER_REGISTRY |
--registry DOCKER_REGISTRY |
Docker registry, url:port (default uses the system Docker daemon) |
-h POSTGRES_HOST |
--pg-host POSTGRES_HOST |
Postgresql host (default is on internal Postgres instance) |
-p POSTRES_PORT |
--pg-port POSTRES_PORT |
Postgresql port |
-u POSTGRES_USER |
--pg-user POSTGRES_USER |
Postgresql user |
-pw POSTGRES_PASSWORD |
--pg-password POSTGRES_PASSWORD |
Postgresql password (will set the internal Postgres instance password) |
-e REDIS_URL |
--redis REDIS_URL |
Redis URL (default is an internal Redis instance) |
-d DOMAIN |
--domain DOMAIN |
External domain (or IP) of host system |
-c TLS_CERTIFICATE |
--tls-cert |
Path to TLS certification file for optionally configuring HTTPS |
-k TLS_KEY |
--tls-key TLS_KEY |
Path to TLS key file for optionally configuring HTTPS |
--default-user DEFAULT_USER |
Default user name | |
--custom-ca-cert CA_CERTIFICATE |
Path to custom CA certification, which should be respected | |
--custom-cve-source CVE_DEFAULT_MIRROR |
For Airgaped environments provide a custom source for CVE data | |
--upgrade-from PREVIOUS_DIR |
Previous install folder | |
-l |
--no-image-load |
Don’t load Docker images |
-y |
--no-prompt |
Answer yes to all prompts |
-- help |
Print help text |