Containerized Services
last updated on: Sep 30, 2024
Introduction
Each of Access Anywhere's containerized services consists of one or more Docker containers. Services are defined and managed using Docker Compose. Docker With Docker Compose, each service can be started and stopped as a unit. Compose takes care of starting and stopping the containers that make up the service.
Containerized Service Configuration
Each Access Anywhere containerized service is described in a configuration file called <service_name>.yaml. These configuration files are stored in directories in:
/var/www/smestorage/containers/<service_name>
There is a directory for each service. Depending on the service, there may also be additional configuration files in the service's directory.
Available Containerized Services
(Note that some services require enablement in Access Anywhere's license key.)
| Access Anywhere service | Docker Compose service name | Access Anywhere volume |
|---|---|---|
| CIFS Locking | cifs-locker | |
| Content Extraction and Transcoding | content-extraction | /tmp |
| Document Previewer | document-previewer | |
| Keycloak (deprecated) | keycloak | |
| Redis | redis | /var/redis (as of 2402) |
| Content Indexing | solr | /var/solr |
| Content Indexing Replication | solr-replicas | |
| PDF Burner | pdfburner | |
| CloudFTP | cloudftp | |
| Memcache | memcached |
As of July 2022 containerized Memcache is available for manual installation as described here.
Checking Status of Containerized Services
To check the status of a containerized service, become root and cd to the service's configuration directory. Then use:
docker-compose ps
Starting and Stopping Containerized Services
To stop a containerized service, become root and cd to the service's configuration directory. Then use:
docker-compose down
For example:
root@appliance:/var/www/smestorage/containers/redis # docker-compose down Removing redis_redis_1 ... done Removing network redis_default root@appliance:/var/www/smestorage/containers/redis #
To start a containerized service, become root and cd to the service's configuration directory. Then use:
docker-compose up -d
For example:
root@appliance:/var/www/smestorage/containers/redis # docker-compose up -d Creating network "redis_default" with the default driver Creating redis_redis_1 ... done root@appliance:/var/www/smestorage/containers/redis #
Accessing Logs for Containerized Services
Each containerized service consists of one or more containers. Logs are accessed at the container level, not the service level.
To see the containers that make up a containerized service, first run “docker -ps” as root from the service's directory. The container names are listed in the leftmost column, for example:
To tail the log for a container, run this command:
docker logs -f <container_name>
substituting the name of the container for <container_name>.