From 9ed114be3d6af2f367ca09e1876a12a2f995353d Mon Sep 17 00:00:00 2001 From: Sumanth Lingappa Date: Sun, 7 Jan 2024 20:55:45 +0530 Subject: [PATCH] Updated the README Signed-off-by: Sumanth Lingappa --- Makefile | 4 ++++ README.md | 22 ++++++++++++++++------ galaxy.yml | 1 + 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 9d7244cab..05284e3f7 100644 --- a/Makefile +++ b/Makefile @@ -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 @@ -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 diff --git a/README.md b/README.md index d2c2b6ae5..bfcb15314 100644 --- a/README.md +++ b/README.md @@ -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 @@ -63,7 +63,7 @@ netscaler.adc 2.0.x -> 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 @@ -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`. @@ -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 if you face any issues with the collection. @@ -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 diff --git a/galaxy.yml b/galaxy.yml index fa1c5e723..500f40782 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -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