Skip to content

updated readme #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Nick-Andreano wants to merge 1 commit into from
Closed

updated readme #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 73 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,88 @@ community and are fully community supported.

This collection provides plugins that can be used in Ansible.

### Inventory
## Building the collection

To build the collection from the source code, use the following command
```bash
ansible-galaxy collection build <path to collection source code> --output-path <path to tarball>
```

## Installing the collection

The collection can be installed using either the Itential Automation Gateway UI
or the Ansible Galaxy CLI directly or defined as part of a `requirements.yaml`
file.

To install the collection on a server running Itential Automation Gateway,
simply click the "Install a collection" from the main page toolbar.

See the [Itential documentation](https//docs.itential.com) for more details about installing a collection
on an Itential Automation Gateway server.

Alternatively, the Ansible Galaxy CLI can be used to install the collection.
To use the Galaxy CLI, run the following command in your development
environment or on the Itential Automation Gateway server.

```bash
ansible-galaxy collection install itential.plugins
```

The collection can also be installed by adding it to an Ansible Galaxy
`requirements.yaml` file as shown below.

```yaml
---
collections:
- name: itential.plugins
```

Once installed, the collection is available for use.
## Inventory

| Name | Description |
|-------------------------------|------------------------------------|
| `itential.plugins.solarwinds` | Pull inventory from Solarwinds NCM. See the example configuration file [here](docs/solarwinds.example.yaml) |

### Lookup
## Lookup

| Name | Description |
|--------------------------------|------------------------------------|
| `itential.plugins.cyberark_ccp` | Retrieve secrets from CyberArk CCP |


## Contributing

Contributions to this collection are welcomed. This includes new features,
enhancements, bug fixes as well as updates to the documentation. If you
encounter any problems using this collection, please open an issue
[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).

For additional details please consult the Itential Community Guide found
[here](CONTRIBUTING.md)


## Code of Conduct

This project is managed by the Itential community and sponsored by Itential and
governed by a Code of Conduct. Please familiarize yourself with our Code of
Conduct available [here](CODE_OF_CONDUCT.md)

## Release Notes

The release notes provide a quick glance with regards to new and/or changed
features and bug fixes available in each release. The release notes are
updated for each release and can be found [here](CHANGELOG.md)


## More Information

Additional information about Itential Automation Gateway can be found at
http://itential.com.


# License

This project is licensed unser the GPLv3 open source license. See
[LICENSE](LICENSE)
GNU General Public License v3.0 or later.

See [LICENSE](LICENSE) to see the full text.