Ubersmith Docs
Дерево страниц
Перейти к концу метаданных
Переход к началу метаданных

Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 9 Следующий »

 

Architecture

What technology is in use?

Ubersmith is using Docker to run our software. Everything from our database backend to our search engine is run inside Docker containers.

Filesystem Locations

Where is everything?

 The /usr/local/ubersmith directory has the following subdirectories:

  • /app/
    • /custom/
      The custom directory holds custom files, such as service, order, and device modules. Any file in this directory is copied to the webroot of the web container when the container starts or restarts. The subfolders include/{service,order,device}_modules, serve as a guide for the locations of custom module class files. The subfolder plugins is used for the storage of custom plugins.
  • /conf/
    • /cron/

This directory is empty by default. Any files in this directory override the contents of /etc/cron.d in the cron container. This is used for rare situations when the default Ubersmith cron tasks need to be overridden.

    • /httpd/

This directory includes the sites-enabled folder, which in turn includes the Apache virtual host configuration(s) for Ubersmith. If multiple brands need to be supported, additional virtual host definitions are created in this directory.

    • /mysql/

This directory contains ubersmith.cnf which  configures and/or overrides specific MySQL variables. Variables are updated when the db container restarts.

    • /ssl/

This directory contains .key and .pem files which should be replaced by the Apache key and certificate used for the Ubersmith instance. The the web and mail containers need to be restarted when these files are updated. These file names are important; services with unexpected file names will fail to start or will fail with TLS disabled. To include a CA bundle, first place the leaf certificate in the .pem file, then add the CA bundle. Restart the web and mail containers after modifying certificates.

  • /logs/

This directory contains the Apache Access and Error in the ubersmith directory. As of Ubersmith 4.1.6, logs for containers are redirected to syslog, and can be found in /var/log/ubersmith.

The Containers

When containers are running, they are prefixed with ubersmith_ and suffixed with _1. For example, the running web container is named 'ubersmith_web_1'.

Container Name
Function
Healthcheck
Listens On
mail

Runs the postfix MTA; handles incoming mail directed at the Support Manager and outgoing mail from Ubersmith.

postfix status

25/tcp
cron

Runs crond, and executes Ubersmith's polling cron task, and the daily invoicing task.

supervisorctl status cronNone
web

Runs Apache; serves the Ubersmith HTTP user interface.

curl https://localhost/version.ini80/tcp, 443/tcp
phpRuns php-fpm; renders PHP code into HTML for use by the web container.cgi-fcgi -bind -connect 127.0.0.1:90009000/tcp
db

Runs Percona Server (MySQL drop-in replacement).

pt-table-checksum
127.0.0.1:3306/tcp
solr

Runs Apache Solr.

Solr PING requestNone
backupExecutes Percona xtrabackup and stores a backup in the backups Docker volume.NoneNone
rwhoisRuns the Ubersmith RWhois server.nc localhost 43214321/tcp
redisRuns Redis; used for session handling and advisory locking.redis-cli -h localhost ping

6379/tcp

pmmRuns Percona Monitoring and Management. Disabled by default.None0.0.0.0:8443/tcp

Docker Compose

Ubersmith uses the Docker Compose utility to manage using many containers. There are two files in /usr/local/ubersmith,docker-compose.yml and docker-compose.override.yml. Any custom changes specific to your deployment should be made in the override file, as the main docker-compose.yml may be updated when Ubersmith is upgraded.

Starting Ubersmith with Docker Compose

 

 

# cd /usr/local/ubersmith
# docker-compose -p ubersmith up -d

 

Stopping Ubersmith with Docker Compose

 

 

# cd /usr/local/ubersmith
# docker-compose -p ubersmith stop

 

Restarting Individual Container(s) with Docker Compose

 

 

# cd /usr/local/ubersmith
# docker-compose -p ubersmith restart web mail

 

Checking Status with Docker Compose and Expected Output

Note: The backup container is only used to generate backups, and is not expect to have an Up status.

 

# docker-compose -p ubersmith ps

       Name                     Command                       State                            Ports                  

----------------------------------------------------------------------------------------------------------------------

ubersmith_cron_1     /usr/bin/supervisord -c /e ...   Up (healthy)                                                    

ubersmith_db_1       docker-entrypoint.sh mysqld      Up (healthy)            127.0.0.1:3306->3306/tcp                

ubersmith_mail_1     /entrypoint.sh                   Up (healthy)            0.0.0.0:25->8025/tcp                    

ubersmith_php_1      /usr/sbin/php-fpm5.6 -F          Up (healthy)            9000/tcp                                

ubersmith_redis_1    docker-entrypoint.sh redis ...   Up (healthy)            6379/tcp                                

ubersmith_rwhois_1   /usr/sbin/xinetd -pidfile  ...   Up (healthy)   0.0.0.0:4321->4321/tcp                  

ubersmith_solr_1     /bin/bash -c /opt/solr/bin ...   Up (healthy)            8983/tcp                                

ubersmith_web_1      /ubersmith.sh                    Up (healthy)            0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp

 

Making a Backup

Starting the backup container runs Percona xtrabackup and takes a live database snapshot. The output of the process is displayed to the terminal. The backup is stored uncompressed in the /usr/local/ubersmith/backup directory.

 

# cd /usr/local/ubersmith
# docker-compose -p ubersmith up backup

The database container is configured to listen on the loopback interface (127.0.0.1:3306) of the host machine by default. The database credentials can be retrieved from /usr/local/ubersmith/docker-compose.yml.

These access credentials can be used to make backups using other utilities (ex. mysqldump) or third party applications.

Troubleshooting

Troubleshooting Container Startup

If a container won't start, contact Ubersmith support for assistance. Also, the following are steps to troubleshoot the issue.

For example, if the web container isn't starting because of a problem in the Apache configuration in/usr/local/ubersmith/conf/httpd:

 

# cd /usr/local/ubersmith
# docker-compose -p ubersmith up web
(output follows, possibly with an error message indicating the issue)
(container exits)

 

Once the issue is resolved,  start the container normally using up -d:

 

# cd /usr/local/ubersmith
# docker-compose -p ubersmith up -d web

 

Note: The command above only brings up the web container; for this example it is assumed that everything else is running normally.

Restarting Docker

When all else fails, restarting Docker completely may resolve networking and/or firewall issues:

 

# service docker restart

 

The above recreates the firewall rules Docker needs for both outside world and inter-container communication. Ubersmith's containers are configured to start automatically when Docker does.

On this page:

On this page:

Related Topics 

Implementation Page

 

 

  • Нет меток