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

https://github.com/ansible-collections/community.beszel

Ansible content to automate the configuration of Beszel Hub and Agents.
https://github.com/ansible-collections/community.beszel

ansible beszel collection community

Last synced: 8 months ago
JSON representation

Ansible content to automate the configuration of Beszel Hub and Agents.

Awesome Lists containing this project

README

          

# Ansible Collection - `community.beszel`

[![CI](https://github.com/ansible-collections/community.beszel/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/ansible-collections/community.beszel/actions)
[![Ansible Lint](https://github.com/ansible-collections/community.beszel/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/ansible-collections/community.beszel/actions)
[![Molecule](https://github.com/ansible-collections/community.beszel/actions/workflows/ansible-molecule.yml/badge.svg)](https://github.com/ansible-collections/community.beszel/actions)
[![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.beszel)](https://codecov.io/gh/ansible-collections/community.beszel)

## Our mission

At `community.beszel`, our mission is to make automation against [Beszel](https://beszel.dev/) simple. We aim to provide Ansible content that you can use to automate the configuration of [Beszel Hub and Agents](https://beszel.dev/guide/what-is-beszel#architecture).

We welcome members from all skill levels to participate actively in our open, inclusive, and vibrant community.
Whether you are an expert or just beginning your journey with Ansible and `community.beszel`,
you are encouraged to contribute, share insights, and collaborate with fellow enthusiasts!

## Code of Conduct

We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project.

If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint.

## Communication

* Join the Ansible forum:
* [Get Help](https://forum.ansible.com/c/help/6): get help or help others. Please add appropriate tags if you start new discussions, for example the `beszel` tag.
* [Posts tagged with 'beszel'](https://forum.ansible.com/tag/beszel): subscribe to participate in collection/technology-related conversations.
* [The `community-beszel` collection group on the Ansible forum](https://forum.ansible.com/g/): by joining the team you will automatically get subscribed to the posts tagged with [beszel](https://forum.ansible.com/tags).
* [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.
* [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events. The [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn), which is used to announce releases and important changes, can also be found here.

For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).

## Contributing to this collection

The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software. Read the [CONTRIBUTING.md](CONTRIBUTING.md) file for steps on how to get started contributing to `community.beszel`.

We are actively accepting new contributors and all types of contributions are very welcome.

Don't know how to start? Refer to the [Ansible community guide](https://docs.ansible.com/ansible/devel/community/index.html)!

We also use the following guidelines:

* [Collection review checklist](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_reviewing.html)
* [Quick-start development guide](https://docs.ansible.com/ansible/devel/community/create_pr_quick_start.html)
* [Ansible development guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)
* [Ansible collection development guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections)

## Collection maintenance

The current maintainers are listed in the [MAINTAINERS](MAINTAINERS) file. If you have questions or need help, feel free to mention them in the proposals.

To learn how to maintain/become a maintainer of this collection, refer to the [Maintainer guidelines](https://docs.ansible.com/ansible/devel/community/maintainers.html).

It is necessary for maintainers of this collection to be subscribed to:

* The collection itself (the `Watch` button -> `All Activity` in the upper right corner of the repository's homepage).
* The [news-for-maintainers repository](https://github.com/ansible-collections/news-for-maintainers).

They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).

## Governance

The process of decision making in this collection is based on discussing and finding consensus among participants.

Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!

## Tested with Ansible

Ansible Core 2.17, 2.18 and 2.19.

## External requirements

To use the modules in this collection you will need:

- Python >= 3.9
- Pocketbase >= 0.15.0

## Using this collection

### Installing the Collection from Ansible Galaxy

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

```bash
ansible-galaxy collection install community.beszel
```

You can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format:

```yaml
---
collections:
- name: community.beszel
```

Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the `ansible` package. To upgrade the collection to the latest available version, run the following command:

```bash
ansible-galaxy collection install community.beszel --upgrade
```

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version `0.1.0`:

```bash
ansible-galaxy collection install community.beszel:==0.1.0
```

See [using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details.

## Release notes

See the [changelog](https://github.com/ansible-collections/community.beszel/tree/main/CHANGELOG.rst).

## Roadmap

## More information

- [Ansible user guide](https://docs.ansible.com/ansible/devel/user_guide/index.html)
- [Ansible developer guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)
- [Ansible collections requirements](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_requirements.html)
- [Ansible community Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html)
- [The Bullhorn (the Ansible contributor newsletter)](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn)
- [Important announcements for maintainers](https://github.com/ansible-collections/news-for-maintainers)

## Licensing

GNU General Public License v3.0 or later.

See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.