From 1b5ce95df9dbe528c7cd257c11fd838f25f9190a Mon Sep 17 00:00:00 2001
From: przsus <101723670+przsus@users.noreply.github.com>
Date: Mon, 16 Dec 2024 11:00:47 +0100
Subject: [PATCH] READMEs

---
 roles/aws_device_params/README.md   | 56 ++++++++++++++++++++++++++++-
 roles/azure_device_params/README.md | 54 +++++++++++++++++++++++++++-
 2 files changed, 108 insertions(+), 2 deletions(-)

diff --git a/roles/aws_device_params/README.md b/roles/aws_device_params/README.md
index 30404ce..a775725 100644
--- a/roles/aws_device_params/README.md
+++ b/roles/aws_device_params/README.md
@@ -1 +1,55 @@
-TODO
\ No newline at end of file
+# Ansible Role: aws_device_params
+
+The `aws_device_params` Ansible role reads params from cEdge devices deployed on AWS, so that they can be used through other roles.
+
+## Role Description
+
+The `aws_device_params` role generates deployment facts for already deployed cEdge devices. For each cEdge deployment facts contain information about its:
+- `hostname`
+- `admin_username`
+- `admin_password`
+- `mgmt_public_ip`
+- `transport_public_ip`
+- `service_interfaces`
+Additionally the role sets the `manager_authentication` variable, which can be used for logging to vManage in other roles.
+
+## Requirements
+
+- The `cisco.sdwan_deployment` collection installed.
+- Ansible 2.16 or higher.
+- Ansible AWS modules (`amazon.aws` collection) installed.
+- AWS CLI configured with the appropriate permissions to create and manage AWS resources.
+
+## Dependencies
+
+There are no external role dependencies. Only `cisco.sdwan_deployment` collection is required.
+
+### Required Variables
+
+- `aws_tag_creator`: Tag for identifying the creator of AWS resources.
+- `aws_region`: AWS region to host the resources.
+- `admin_password`: The admin password for virtual machine access.
+
+## Example Playbook
+
+Including an example of how to use your role (for instance, with variables passed in as parameters):
+
+```yaml
+- name: Read deployed cEdge parameters
+  hosts: localhost
+  gather_facts: false
+  vars:
+    aws_region: "us-east-1"
+    aws_tag_creator: "tag-creator"
+    admin_password: "password"  # pragma: allowlist secret
+  roles:
+    - cisco.sdwan_deployment.aws_device_params
+```
+
+## License
+
+"GPL-3.0-only"
+
+## Author Information
+
+This role was created by Przemyslaw Susko <sprzemys@cisco.com>
diff --git a/roles/azure_device_params/README.md b/roles/azure_device_params/README.md
index 1333ed7..2abb6f5 100644
--- a/roles/azure_device_params/README.md
+++ b/roles/azure_device_params/README.md
@@ -1 +1,53 @@
-TODO
+_# Ansible Role: azure_device_params
+
+The `azure_device_params` Ansible role reads params from cEdge devices deployed on Azure, so that they can be used through other roles.
+
+## Role Description
+
+The `azure_device_params` role generates deployment facts for already deployed cEdge devices. For each cEdge deployment facts contain information about its:
+- `hostname`
+- `admin_username`
+- `admin_password`
+- `mgmt_public_ip`
+- `transport_public_ip`
+- `service_interfaces`
+Additionally the role sets the `manager_authentication` variable, which can be used for logging to vManage in other roles.
+
+## Requirements
+
+- The `cisco.sdwan_deployment` collection installed.
+- Ansible 2.16 or higher.
+- Ansible Azure modules (`azure.azcollection` collection) installed.
+- Azure CLI configured with the necessary permissions to manage Azure resources.
+
+## Dependencies
+
+There are no external role dependencies. Only `cisco.sdwan_deployment` collection is required.
+
+### Required Variables
+
+- `admin_password`: The admin password for virtual machine access.
+- `az_resource_group`: The name of the Azure resource group for the deployment.
+
+## Example Playbook
+
+Including an example of how to use your role (for instance, with variables passed in as parameters):
+
+```yaml
+- name: Read deployed cEdge parameters
+  hosts: localhost
+  gather_facts: false
+  vars:
+    az_resource_group: "resource-group"
+    admin_password: "password"  # pragma: allowlist secret
+  roles:
+    - cisco.sdwan_deployment.azure_device_params
+```
+
+## License
+
+"GPL-3.0-only"
+
+## Author Information
+
+This role was created by Przemyslaw Susko <sprzemys@cisco.com>_