Skip to content

Commit

Permalink
Update README with variables information
Browse files Browse the repository at this point in the history
  • Loading branch information
vladgh committed Oct 8, 2023
1 parent 94985d8 commit 679968d
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ More info: <https://access.redhat.com/security/cve/cve-2017-7494>

## Using this collection

### Installing the Collection from Ansible Galaxy
### Install collection

Install it with the Ansible Galaxy CLI:

Expand All @@ -45,7 +45,16 @@ collections:
- name: vladgh.samba
```
Using the GitHub repository and specific branch or release:
Optionally, You can specify a version number:
```yaml
---
collections:
- name: vladgh.samba
version: ">=3.1.1"
```
You can also refer to a branch or to a git commit-ish object (commit, tag, branch or release)
```yaml
collections:
Expand All @@ -54,11 +63,19 @@ collections:
type: git
```
### Import Roles
For more information, see [Ansible using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html)
### Load role
After the collection is installed you can include the `server` role.
You can define variables in a variety of places, such as in inventory, in playbooks, in reusable files, in roles, and at the command line. Ansible loads every possible variable it finds, then chooses the variable to apply based on [variable precedence rules](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_variables.html#ansible-variable-precedence).
A complete overview of server role variables follows below.

For more information, see [Using variables](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_variables.html#where-to-set-variables).

```yaml
---
- name: Common
- name: Samba Server
hosts: all
become: true
tasks:
Expand All @@ -67,16 +84,16 @@ collections:
name: vladgh.samba.server
```

### Import Playbooks
### Import playbook

Alternatively, you can directly import the existing playbook:

```yaml
---
- name: Samba Server
ansible.builtin.import_playbook: vladgh.samba.server
```

See [Ansible using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
## Server Role Variables

| Variable | Default | Comments |
Expand Down

0 comments on commit 679968d

Please sign in to comment.