OSSHelp / deploy-functions

Library and script for customization of LXC containers during deployment

deploy-functions

About

This library is used for customization in the deploying process. It is used with default-setup script. And default-setup is run by cloud-init.

Supported software:

• Netdata
• Monit
• Postfix
• Ssmtp
• Nginx
• PHP-FPM
• Apache
• Cron
• SSH
• MySQL
• Consul
• Promtail

How to use it

The library must be included in the default-setup script. How to use the library:

1. Place deploy-functions.sh library in the /usr/local/include/osshelp/ folder
2. Place default-setup script in the /usr/local/osshelp/ folder with default-setup.local (if you need an additional customization)
3. Install yq and jq binaries
4. Add necessary profiles to container yaml config which is used by lxhelper
5. Deploy container with lxhelper and make sure that the default-setup works as you expected

In the examples directory you can find a template of default-setup.local and available profiles usage examples.

There’re install/update scripts in the repository. Command for installation (deploy-function.sh, default-setup, yq and jq):

curl -s https://oss.help/scripts/backup/backup-functions/install.sh | bash

Or you can use this Ansible role to install it.

Useful

As a library, deploy-functions is often used with LXHelper, but it's still possible to use it without LXHelper.

FAQ

Log

You can find log in /var/log/default-setup.log.

Debug mode

If you want to run default-setup in debug mode, you need to:

• Export INSTANCE_ID variable in the container
• Run default-setup with bash -x command

Example:

export INSTANCE_ID=container_name
bash -x /usr/local/osshelp/default-setup server_name

Author

OSSHelp Team, see https://oss.help