An open API service indexing awesome lists of open source software.

https://github.com/andif888/ansible-role-docker-container-stirlingpdf

Role to run stirling-pdf in a docker container
https://github.com/andif888/ansible-role-docker-container-stirlingpdf

ansible-role docker-container stirling-pdf

Last synced: about 1 month ago
JSON representation

Role to run stirling-pdf in a docker container

Awesome Lists containing this project

README

          

# ansible-role-docker-container-stirlingpdf

Role to run stirlingpdf in a docker container

## Table of content

- [Requirements](#requirements)
- [Default Variables](#default-variables)
- [docker_container_stirlingpdf_comparisons](#docker_container_stirlingpdf_comparisons)
- [docker_container_stirlingpdf_env](#docker_container_stirlingpdf_env)
- [docker_container_stirlingpdf_image](#docker_container_stirlingpdf_image)
- [docker_container_stirlingpdf_labels](#docker_container_stirlingpdf_labels)
- [docker_container_stirlingpdf_name](#docker_container_stirlingpdf_name)
- [docker_container_stirlingpdf_networks](#docker_container_stirlingpdf_networks)
- [docker_container_stirlingpdf_ports](#docker_container_stirlingpdf_ports)
- [docker_container_stirlingpdf_restic_enable](#docker_container_stirlingpdf_restic_enable)
- [docker_container_stirlingpdf_restic_retention](#docker_container_stirlingpdf_restic_retention)
- [docker_container_stirlingpdf_restic_s3_bucket_name](#docker_container_stirlingpdf_restic_s3_bucket_name)
- [docker_container_stirlingpdf_restic_s3_endpoint](#docker_container_stirlingpdf_restic_s3_endpoint)
- [docker_container_stirlingpdf_restic_s3_repo](#docker_container_stirlingpdf_restic_s3_repo)
- [docker_container_stirlingpdf_restic_s3_repo_access_key](#docker_container_stirlingpdf_restic_s3_repo_access_key)
- [docker_container_stirlingpdf_restic_s3_repo_password](#docker_container_stirlingpdf_restic_s3_repo_password)
- [docker_container_stirlingpdf_restic_s3_repo_secret_key](#docker_container_stirlingpdf_restic_s3_repo_secret_key)
- [docker_container_stirlingpdf_restic_stop_during_backup](#docker_container_stirlingpdf_restic_stop_during_backup)
- [docker_container_stirlingpdf_restic_tag](#docker_container_stirlingpdf_restic_tag)
- [docker_container_stirlingpdf_volume_dir](#docker_container_stirlingpdf_volume_dir)
- [docker_container_stirlingpdf_volumes](#docker_container_stirlingpdf_volumes)
- [docker_image_stirlingpdf_name](#docker_image_stirlingpdf_name)
- [docker_image_stirlingpdf_pull](#docker_image_stirlingpdf_pull)
- [docker_network_stirlingpdf_name](#docker_network_stirlingpdf_name)
- [Discovered Tags](#discovered-tags)
- [Dependencies](#dependencies)
- [License](#license)
- [Author](#author)

---

## Requirements

- Minimum Ansible version: `2.1`

## Default Variables

### docker_container_stirlingpdf_comparisons

Allows to specify how properties of existing containers are compared with module options
to decide whether the container should be recreated / updated or not.

#### Default value

```YAML
docker_container_stirlingpdf_comparisons:
image: strict
env: strict
volumes: strict
```

### docker_container_stirlingpdf_env

Dictionery of key,value pairs for docker
environment variables to configure stirlingpdf.

Example:

```yaml

docker_container_stirlingpdf_env:

stirlingpdf__mailer__ENABLED: "false"

```

#### Default value

```YAML
docker_container_stirlingpdf_env:
DOCKER_ENABLE_SECURITY: 'false'
SECURITY_ENABLELOGIN: 'false'
INSTALL_BOOK_AND_ADVANCED_HTML_OPS: 'false'
LANGS: en_GB
```

### docker_container_stirlingpdf_image

Repository path and tag used to create the container.
If an image is not found or pull is true, the image will be pulled from the registry.
If no tag is included, latest will be used.

#### Default value

```YAML
docker_container_stirlingpdf_image: '{{ docker_image_stirlingpdf_name }}'
```

### docker_container_stirlingpdf_labels

Dictionary of key value pairs for container labels.

Example:

```yaml

docker_container_stirlingpdf_labels:

traefik.enable: "true"

```

#### Default value

```YAML
docker_container_stirlingpdf_labels: {}
```

### docker_container_stirlingpdf_name

Name for the container

#### Default value

```YAML
docker_container_stirlingpdf_name: stirlingpdf
```

### docker_container_stirlingpdf_networks

List of networks the container belongs to.

#### Default value

```YAML
docker_container_stirlingpdf_networks:
- name: '{{ docker_network_stirlingpdf_name }}'
```

### docker_container_stirlingpdf_ports

List of ports to publish from the container to the host.

#### Default value

```YAML
docker_container_stirlingpdf_ports:
- 8080:8080
```

### docker_container_stirlingpdf_restic_enable

Enable restic backup for the container's mounted volumes.

#### Default value

```YAML
docker_container_stirlingpdf_restic_enable: false
```

### docker_container_stirlingpdf_restic_retention

Retention settions for `restic forget` after the `restic backup`.

#### Default value

```YAML
docker_container_stirlingpdf_restic_retention:
keep_last: 1
keep_daily: 7
keep_weekly: 4
```

### docker_container_stirlingpdf_restic_s3_bucket_name

Minio S3 bucket name for restic backup storage.

#### Default value

```YAML
docker_container_stirlingpdf_restic_s3_bucket_name: restic-{{ docker_container_stirlingpdf_name
}}
```

### docker_container_stirlingpdf_restic_s3_endpoint

Minio S3 endpoint for restic backup storage.

Example:

```yaml

docker_container__base__restic_s3_endpoint: "https://minio.{{ dns_domain }}"

docker_container_stirlingpdf_restic_s3_endpoint: "{{ docker_container__base__restic_s3_endpoint }}"

```

#### Default value

```YAML
docker_container_stirlingpdf_restic_s3_endpoint: '{{ docker_container__base__restic_s3_endpoint
}}'
```

### docker_container_stirlingpdf_restic_s3_repo

Minio S3 repo URL for restic backup storage.

#### Default value

```YAML
docker_container_stirlingpdf_restic_s3_repo: s3:{{ docker_container_stirlingpdf_restic_s3_endpoint
}}/{{ docker_container_stirlingpdf_restic_s3_bucket_name }}
```

### docker_container_stirlingpdf_restic_s3_repo_access_key

Minio S3 repo access key for restic backup storage.

#### Default value

```YAML
docker_container_stirlingpdf_restic_s3_repo_access_key: '{{ docker_container__base__restic_s3_repo_access_key
}}'
```

### docker_container_stirlingpdf_restic_s3_repo_password

Minio S3 repo password for restic backup storage.

#### Default value

```YAML
docker_container_stirlingpdf_restic_s3_repo_password: '{{ docker_container__base__restic_s3_repo_password
}}'
```

### docker_container_stirlingpdf_restic_s3_repo_secret_key

Minio S3 repo secret key for restic backup storage.

#### Default value

```YAML
docker_container_stirlingpdf_restic_s3_repo_secret_key: '{{ docker_container__base__restic_s3_repo_secret_key
}}'
```

### docker_container_stirlingpdf_restic_stop_during_backup

Stop and restart container during backup operation.

#### Default value

```YAML
docker_container_stirlingpdf_restic_stop_during_backup: false
```

### docker_container_stirlingpdf_restic_tag

Tag for the `restic backup` command

#### Default value

```YAML
docker_container_stirlingpdf_restic_tag: '{{ docker_container_stirlingpdf_name }}'
```

### docker_container_stirlingpdf_volume_dir

Volume mount host directory, where Treafik config files are stored.

#### Default value

```YAML
docker_container_stirlingpdf_volume_dir: '{{ docker_container__base__volume_dir }}/{{
docker_container_stirlingpdf_name }}'
```

### docker_container_stirlingpdf_volumes

List of volumes to mount within the container.

#### Default value

```YAML
docker_container_stirlingpdf_volumes:
- '{{ docker_container_stirlingpdf_volume_dir }}/tessdata:/usr/share/tessdata'
- '{{ docker_container_stirlingpdf_volume_dir }}/configs:/configs'
```

### docker_image_stirlingpdf_name

Repository path and tag for the container image.

#### Default value

```YAML
docker_image_stirlingpdf_name: stirlingtools/stirling-pdf:latest
```

### docker_image_stirlingpdf_pull

Indicate to always pull the docker image.

#### Default value

```YAML
docker_image_stirlingpdf_pull: false
```

### docker_network_stirlingpdf_name

Name of the docker network created for stirlingpdf.

#### Default value

```YAML
docker_network_stirlingpdf_name: '{{ docker_container_stirlingpdf_name }}_backend'
```

## Discovered Tags

**_docker-container-backup-all_**\
 Backup all containers' volume mounts.

**_docker-container-backup-init-all_**\
 Run init backup task for all container.

**_docker-container-backup-init-stirlingpdf_**\
 Run init backup task for stirlingpdf if restic is enabled.

**_docker-container-backup-list-all_**\
 List all containers' backups.

**_docker-container-backup-list-stirlingpdf_**\
 List stirlingpdf backups.

**_docker-container-backup-stirlingpdf_**\
 Backup stirlingpdf volume mounts.

**_docker-container-prereq-all_**\
 Ensure all pre-requisites are installed

**_docker-container-prereq-stirlingpdf_**\
 Ensure all pre-requisites for stirlingpdf are installed

**_docker-container-purge-all_**\
 Remove all containers and delete volume mounts.

**_docker-container-purge-stirlingpdf_**\
 Remove stirlingpdf and delete volume mounts.

**_docker-container-remove-all_**\
 Remove all containers.

**_docker-container-remove-stirlingpdf_**\
 Remove stirlingpdf.

**_docker-container-restore-all_**\
 Run restic restore for all restic enabled containers.

**_docker-container-restore-stirlingpdf_**\
 Run restic restore for stirlingpdf if restic is enabled.

**_docker-container-setup-all_**\
 Run setup task for all containers.

**_docker-container-setup-stirlingpdf_**\
 Run setup task for stirlingpdf.

**_never_**

## Dependencies

None.

## License

license (GPL-2.0-or-later, MIT, etc)

## Author

andif888