Skip to content

Commit 2cccaf0

Browse files
updated readme (#6)
1 parent 10ec3b8 commit 2cccaf0

1 file changed

Lines changed: 73 additions & 4 deletions

File tree

README.md

Lines changed: 73 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,88 @@ community and are fully community supported.
1010

1111
This collection provides plugins that can be used in Ansible.
1212

13-
### Inventory
13+
## Building the collection
14+
15+
To build the collection from the source code, use the following command
16+
```bash
17+
ansible-galaxy collection build <path to collection source code> --output-path <path to tarball>
18+
```
19+
20+
## Installing the collection
21+
22+
The collection can be installed using either the Itential Automation Gateway UI
23+
or the Ansible Galaxy CLI directly or defined as part of a `requirements.yaml`
24+
file.
25+
26+
To install the collection on a server running Itential Automation Gateway,
27+
simply click the "Install a collection" from the main page toolbar.
28+
29+
See the [Itential documentation](https//docs.itential.com) for more details about installing a collection
30+
on an Itential Automation Gateway server.
31+
32+
Alternatively, the Ansible Galaxy CLI can be used to install the collection.
33+
To use the Galaxy CLI, run the following command in your development
34+
environment or on the Itential Automation Gateway server.
35+
36+
```bash
37+
ansible-galaxy collection install itential.plugins
38+
```
39+
40+
The collection can also be installed by adding it to an Ansible Galaxy
41+
`requirements.yaml` file as shown below.
42+
43+
```yaml
44+
---
45+
collections:
46+
- name: itential.plugins
47+
```
48+
49+
Once installed, the collection is available for use.
50+
## Inventory
1451
1552
| Name | Description |
1653
|-------------------------------|------------------------------------|
1754
| `itential.plugins.solarwinds` | Pull inventory from Solarwinds NCM. See the example configuration file [here](docs/solarwinds.example.yaml) |
1855

19-
### Lookup
56+
## Lookup
2057

2158
| Name | Description |
2259
|--------------------------------|------------------------------------|
2360
| `itential.plugins.cyberark_ccp` | Retrieve secrets from CyberArk CCP |
2461

62+
63+
## Contributing
64+
65+
Contributions to this collection are welcomed. This includes new features,
66+
enhancements, bug fixes as well as updates to the documentation. If you
67+
encounter any problems using this collection, please open an issue
68+
[here](https://github.com/itential/itential.plugins/issues) or open a pull request with your proposed changes [here](https://github.com/itential/itential.plugins/pulls).
69+
70+
For additional details please consult the Itential Community Guide found
71+
[here](CONTRIBUTING.md)
72+
73+
74+
## Code of Conduct
75+
76+
This project is managed by the Itential community and sponsored by Itential and
77+
governed by a Code of Conduct. Please familiarize yourself with our Code of
78+
Conduct available [here](CODE_OF_CONDUCT.md)
79+
80+
## Release Notes
81+
82+
The release notes provide a quick glance with regards to new and/or changed
83+
features and bug fixes available in each release. The release notes are
84+
updated for each release and can be found [here](CHANGELOG.md)
85+
86+
87+
## More Information
88+
89+
Additional information about Itential Automation Gateway can be found at
90+
http://itential.com.
91+
92+
2593
# License
2694

27-
This project is licensed unser the GPLv3 open source license. See
28-
[LICENSE](LICENSE)
95+
GNU General Public License v3.0 or later.
96+
97+
See [LICENSE](LICENSE) to see the full text.

0 commit comments

Comments
 (0)