feat(indy): replace ansible roles readme with inline code comments

This PR enhances the readability and understanding of our roles by adding comment messages throughout the code. Changes: - Added clear and concise comment messages in ansible roles. - Maintained proper code indentation for increased code reliability. - Removed the roles' Readme.md if it existed. fixes #2326 Signed-off-by: saurabhkumarkardam <[email protected]>
hyperledger-bevel · Nov 2, 2023 · a08fdd7 · a08fdd7
1 parent 2ee9a1e
commit a08fdd7
Show file tree

Hide file tree

Showing 57 changed files with 145 additions and 2,006 deletions.
diff --git a/platforms/hyperledger-indy/configuration/README.md b/platforms/hyperledger-indy/configuration/README.md
diff --git a/platforms/hyperledger-indy/configuration/cleanup.yaml b/platforms/hyperledger-indy/configuration/cleanup.yaml
@@ -7,12 +7,11 @@
 ##################################################
 # Playbook to cleanup platform specific resources
 ##################################################
+
 - hosts: ansible_provisioners
   gather_facts: no
   no_log: "{{ no_ansible_log | default(false) }}"
   tasks:
-  # ----------------------------------------------------------------------
-
   # Cleanup all organizations' vault indy crypto
   - name: Cleanup Vault indy crypto
     include_role:

diff --git a/platforms/hyperledger-indy/configuration/deploy-network.yaml b/platforms/hyperledger-indy/configuration/deploy-network.yaml
@@ -227,11 +227,12 @@
     - (organizationItem.type == 'peer')
     - (organizationItem.org_status is not defined or organizationItem.org_status == 'new')
     - (not add_new_org|bool or (add_new_org|bool and add_new_org_new_nyms_on_ledger_present|bool))
-
-  vars: #These variables can be overriden from the command line
-    install_os: "linux"                 #Default to linux OS
-    install_arch:  "amd64"              #Default to amd64 architecture
-    bin_install_dir:  "~/bin"            #Default to /bin install directory for binaries
-    add_new_org: false
-    add_new_org_network_trustee_present: true
-    add_new_org_new_nyms_on_ledger_present: true
+
+  # These variables can be overriden from the command line
+  vars: 
+    install_os: "linux"                           # Default to linux OS
+    install_arch:  "amd64"                        # Default to amd64 architecture
+    bin_install_dir:  "~/bin"                     # Default to /bin install directory for binaries
+    add_new_org: false                            # Default to false when not defined.
+    add_new_org_network_trustee_present: true     # Default to true when not defined.
+    add_new_org_new_nyms_on_ledger_present: true  # Default to true when not defined.
diff --git a/platforms/hyperledger-indy/configuration/roles/check/crypto/README.md b/platforms/hyperledger-indy/configuration/roles/check/crypto/README.md
diff --git a/platforms/hyperledger-indy/configuration/roles/check/crypto/tasks/main.yaml b/platforms/hyperledger-indy/configuration/roles/check/crypto/tasks/main.yaml
@@ -8,8 +8,7 @@
 # This role check trustee and stewards crypto in Vault
 ##############################################################################################
 
-##############################################################################################
-
+# Set a variable
 - name: "Set component_name to a temporary variable for later use"
   set_fact: 
     temp_component_name: "{{ component_name }}"
@@ -27,7 +26,6 @@
     loop_var: trusteeItem
   when: services.trustees is defined
 
-##############################################################################################
 # Check if Indy Key management pod for stewards is completed
 - name: Check if Indy Key management pod for stewards is completed
   include_role:
@@ -41,7 +39,6 @@
     loop_var: stewardItem
   when: services.stewards is defined
 
-##############################################################################################
 # Check if Indy Key management pod for endorser is completed
 - name: Check if Indy Key management pod for endorser is completed
   include_role: 
@@ -55,7 +52,6 @@
     loop_var: endorserItem
   when: services.endorsers is defined
 
-##############################################################################################
 # Check trustee in vault
 - name: "Check trustee in vault"
   environment:
@@ -69,7 +65,6 @@
     loop_var: trusteeItem
   when: services.trustees is defined
 
-##############################################################################################
 # Check stewards in vault
 - name: "Check stewards in vault"
   environment:
@@ -83,7 +78,6 @@
     loop_var: stewardItem
   when: services.stewards is defined
 
-##############################################################################################
 # Check endorser in vault
 - name: "Check endorser in vault"
   environment:

diff --git a/platforms/hyperledger-indy/configuration/roles/check/k8_component/README.md b/platforms/hyperledger-indy/configuration/roles/check/k8_component/README.md
diff --git a/platforms/hyperledger-indy/configuration/roles/check/k8_component/tasks/main.yaml b/platforms/hyperledger-indy/configuration/roles/check/k8_component/tasks/main.yaml
@@ -34,6 +34,7 @@
   register: token_output
   when: component_type == "GetServiceAccount"
 
+# Store token
 - name: "Store token"
   set_fact:
     ac_vault_tokens: "{{ ac_vault_tokens | default({}) | combine( {organization: token_output.stdout} ) }}"