Skip to content
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

Updated the README #336

Merged
merged 1 commit into from
Jan 7, 2024
Merged

Updated the README #336

Show file tree
Hide file tree
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
4 changes: 4 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ fmt:
isort plugins/module_utils/*.py
isort tools/module_generator.py

yamlfmt .

fmt_tools:
# ignore if file not found
-autoflake tools/generated_modules/*.py
Expand All @@ -35,6 +37,8 @@ line_length:
grep -l '.\{159,\}' -R plugins --include='*.py'

lint:
yamllint .
echo "\n\n\n\n\n\n\n\n\n\n"
ansible-lint

test_sanity: galaxy_importer install
Expand Down
22 changes: 16 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> ⚠️ Note:
> The earlier `citrix.adc` ansible collection is replaced with the new `netscaler.adc` ansible collection.

> The `citrix.adc` ansible collection is backed up by a seperate branch [citrix.adc](https://github.com/netscaler/ansible-collection-netscaleradc/tree/citrix.adc)
> The `citrix.adc` ansible collection is backed up by a se branch [citrix.adc](https://github.com/netscaler/ansible-collection-netscaleradc/tree/citrix.adc)


## Vision
Expand Down Expand Up @@ -63,7 +63,7 @@ netscaler.adc 2.0.x

<https://netscaler.github.io/ansible-collection-netscaleradc/>

> Click on the desired module name in the [supported_modules_matrix.md](supported_modules_matrix.md) file to go to the specific module documentation
> You can also click on the desired module name in the [supported_modules_matrix.md](supported_modules_matrix.md) file to go to the specific module documentation

## Examples

Expand All @@ -79,7 +79,19 @@ Every module in the collection requires the user to authenticate to the NetScale

Refer to the [playbook_anatomy.md](playbook_anatomy.md) and [examples](examples) directory for the sample playbooks.

### Authenticate to NetScaler via token (passwordless)
### Authenticate to NetScaler

#### Password based authentication

Every task in the collection requires the user to authenticate to the NetScaler ADC appliance. The authentication can be done using the `nsip`, `nitro_user` and `nitro_pass` parameters. These parameters can also be passed as environment variables `NETSCALER_NSIP`, `NETSCALER_NITRO_USER` and `NETSCALER_NITRO_PASS`.

#### Using `netscaler.adc.module_defaults` group

To avoid having to specify common parameters for all the modules in every task, you can use the `netscaler.adc.module_defaults` [module defaults](https://docs.ansible.com/ansible/devel/playbook_guide/playbooks_module_defaults.html#module-defaults-groups) group:

> Refer [examples/module_default_args_action_group.yaml](./examples/module_default_args_action_group.yaml) for an example playbook.

#### Passwordless via `nitro_auth_token` parameter (SESSIONID based authentication)

The collection also supports authentication to NetScaler ADC appliance via token. The token can be generated using the `login` module. The token can be passed to other modules using the `nitro_auth_token` parameter. The `nitro_token` parameter can also be passed as environment variable `NETSCALER_NITRO_AUTH_TOKEN`.

Expand All @@ -102,7 +114,7 @@ echo $NETSCALER_NITRO_AUTH_TOKEN

## Supported Ansible Versions

This collection supports Ansible version 2.14 and above.
This collection is tested for Ansible version 2.14 and above.

> Please raise issues at <https://github.com/netscaler/ansible-collection-netscaleradc/issues> if you face any issues with the collection.

Expand Down Expand Up @@ -132,11 +144,9 @@ Refer to the [supported_modules_matrix.md](supported_modules_matrix.md) file for
- [ ] migration tool to convert `citrix.adc` playbooks (including generic `citrix.adc.nitro_request` and `citrix.adc.nitro_resource` modules) to `netscaler.adc` modules
- [ ] Add more examples
- [ ] Write a python script which converts examples/playbook.yaml to module's EXAMPLE documentation
- [ ] SSH Connection module
- [ ] Test modules against all NetScaler ADC versions.
- [x] Test modules againsts ansible versions 2.9+
- [x] Configure GitHub Actions to automate the collection build and release process.
- [ ] Configure GitHub Actions to automate the collection documentation build and release process.
- [ ] Configure GitHub Actions to automate the collection testing process.
- [x] Configure GitHub Actions to automate the collection linting process.
- [x] Collect NetScaler info (version, etc) and store it in the `facts` dictionary
1 change: 1 addition & 0 deletions galaxy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ build_ignore:
- tools
- issues
- "**/netscaler-adc-*.tar.gz"
- Makefile

# A dict controlling use of manifest directives used in building the collection artifact. The key 'directives' is a
# list of MANIFEST.in style
Expand Down
Loading