https://github.com/borisskert/ansible_minecraftserver
Ansible role to install a minecraft server
https://github.com/borisskert/ansible_minecraftserver
ansible ansible-role docker docker-compose minecraft minecraft-server minecraftserver systemd systemd-service systemd-unit
Last synced: 7 months ago
JSON representation
Ansible role to install a minecraft server
- Host: GitHub
- URL: https://github.com/borisskert/ansible_minecraftserver
- Owner: borisskert
- License: mit
- Created: 2021-05-01T13:19:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-19T16:23:39.000Z (10 months ago)
- Last Synced: 2024-12-19T17:25:48.697Z (10 months ago)
- Topics: ansible, ansible-role, docker, docker-compose, minecraft, minecraft-server, minecraftserver, systemd, systemd-service, systemd-unit
- Language: Jinja
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ansible_minecraftserver
This is an [ansible role](https://docs.ansible.com/) to install a [minecraft server](https://www.minecraft.net/de-de/download/server) as
[docker container](https://www.docker.com/) controlled by [systemd](https://systemd.io/).
I'm using [itzg's docker image](https://github.com/itzg/docker-minecraft-server). Thanks for your great work!
## System requirements
* Docker
* docker-compose
* Systemd
## Role requirements
* (none, so far)
## Tasks
* Template docker-compose file environment
* Create data volume directory for docker container
* Setup systemd unit file
* Start/Restart systemd service
## Role parameters
| Variable | Type | Mandatory? | Default | Description |
|---------------------------------------|---------------|------------|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| minecraftserver_state | text | no | `'present'` | If `absent` removes the docker configuration and systemd service |
| minecraftserver_image_version | text | no | `'latest'` | itzg's Docker image version |
| minecraftserver_version | text | no | `''` | Minecraft Server version (e.g. `1.16.5`, default: latest version will be downloaded) |
| minecraftserver_interface | text | no | `0.0.0.0` | Mapped network interface |
| minecraftserver_port | text | no | `25565` | Mapped network port |
| minecraftserver_data_volume_directory | text | no | `/srv/minecraftserver/minecraft-data` | Location of your data volume directory |
| minecraftserver_environment | key-value map | no | `{}` | Specifies the environment for the docker image (See [itzg's documentation](https://github.com/itzg/docker-minecraft-server)) |
| minecraftserver_force_remove | boolean | no | `false` | Only for state `absent`: Specifies if your data volume directory will be deleted on when uninstalling |
## Example Playbook
### Add to `requirements.yml`:
```yaml
- name: install-minecraftserver
src: https://github.com/borisskert/ansible_minecraftserver.git
scm: git
```
### Example `playbook.yml`:
```yaml
- hosts: servers
roles:
- role: install-minecraftserver
minecraftserver_state: present
minecraftserver_image_version: latest
minecraftserver_version: '1.16.5'
minecraftserver_interface: 0.0.0.0
minecraftserver_port: 25565
minecraftserver_data_volume_directory: /srv/minecraftserver/minecraft-data
minecraftserver_environment:
SEED: 1785852800490497919
VIEW_DISTANCE: 10
MODE: creative
MOTD: My super cool MC server
```
### Example `playbook.yml` for uninstall:
```yaml
- hosts: servers
roles:
- role: install-minecraftserver
minecraftserver_state: absent
minecraftserver_force_remove: true
```
## Testing
Requirements:
* [Vagrant](https://www.vagrantup.com/)
* [Qemu](https://www.qemu.org/libvirt) and [libvirt](https://libvirt.org/)
* [Ansible](https://docs.ansible.com/)
* [Molecule](https://molecule.readthedocs.io/en/latest/index.html)
* [yamllint](https://yamllint.readthedocs.io/en/stable/#)
* [ansible-lint](https://docs.ansible.com/ansible-lint/)
* [Docker](https://docs.docker.com/)
### Run within docker
```shell script
molecule test && molecule test --scenario-name all-parameters && molecule test --scenario-name state-absent && molecule test --scenario-name with-environment && molecule test --scenario-name state-absent-force-remove-persistent-data
```
### Run within Vagrant
```shell script
molecule test -s vagrant-default && molecule test -s vagrant-all-parameters && molecule test --scenario-name vagrant-state-absent && molecule test --scenario-name vagrant-with-environment && molecule test --scenario-name vagrant-state-absent-force-remove-persistent-data
```
I recommend to use [pyenv](https://github.com/pyenv/pyenv) for local testing.
Within the GitHub Actions pipeline I use [my own molecule action](https://github.com/borisskert/molecule-action).
## License
MIT
## Author Information
* [borisskert](https://github.com/borisskert)
## Further links
* [itzg/docker-minecraft-server (Github)](https://github.com/itzg/docker-minecraft-server)