Merge pull request #16 from nutanixdev/1.3.1

1.3.1

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,49 @@
+name: Report an issue/bug
+description: Report an issue/bug.
+body:
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Description
+      description: >-
+        Provide a clear and concise description of what the problem is.
+  - type: markdown
+    attributes:
+      value: |
+        ## Platform / OS
+  - type: dropdown
+    validations:
+      required: true
+    attributes:
+      label: What Platform / OS are you running?
+      options:
+        - Linux
+        - Mac OS
+        - Windows
+        - Docker
+  - type: markdown
+    attributes:
+      value: |
+        ## Version
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: What version are you running?
+  - type: markdown
+    attributes:
+      value: |
+        # Additional Details
+  - type: textarea
+    attributes:
+      label: Anything in the logs or a references that might be useful?
+      description: For example, error message, or stack traces.
+      render: txt
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: >
+        If you have any additional information for us, use the field below.
+        Please note, you can attach screenshots or screen recordings here, by
+        dragging and dropping files in the field below.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,10 @@
+blank_issues_enabled: false
+contact_links:
+  - name: I have an issue with the Nutanix APIs
+    url: https://support.nutanix.com
+    about: Please report any Nutanix API issues to Nutanix Support.
+  - name: I have a question about ZTF
+    about: Please email solutions-automation@nutanix.com for help or to ask questions regarding ZTF.
+  - name: I have an issue with the documentation or would like to suggest content to be added
+    url: https://github.com/nutanixdev/zerotouch-framework/issues
+    about: Please use create an issue for documentation or website related issues.

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,17 @@
+name: Request a new feature
+description: Request a new feature or enhancement.
+body:
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Description
+      description: >-
+        Details of the feature and what should be added.
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: >
+        If you have any additional information for us, use the field below.
+        Please note, you can attach screenshots or screen recordings here, by
+        dragging and dropping files in the field below.

config/example-configs/pod-configs/pod-config.yml

@@ -148,9 +148,12 @@ pod:
           - name: objectstore01
             domain: eng.company.com
             cluster: cluster-01 # Cluster reference
-            # DHCP subnet
-            network: vlan110
-            # 4 statis IPs
+            # Storage Network
+            storage_network: vlan110
+            # Public Network
+            public_network: vlan10
+            # First 2 Static IPs should be storage network static IPs.
+            # Rest of the Static IPs will be assigned as Public static IPs.
             static_ip_list:
              - ip1
              - ip2

config/example-configs/pod-configs/pod-deploy.yml

@@ -53,13 +53,15 @@ pod:
               cvm_ram: 12 # cvm_ram is Gigabytes. Minimum 12, no maximum. Default set it to 12.
               node_details:
                 - node_serial: node-serial-1
-                  cvm_ip: valid-cvm-ip
-                  host_ip: valid-host-ip
-                  ipmi_ip: valid-ipmi-ip
+                  cvm_ip: valid-cvm-ip # Optional. New CVM IP
+                  host_ip: valid-host-ip # Optional. New Hypervisor Host IP
+                  ipmi_ip: valid-ipmi-ip # Optional. New IPMI IP
+                  hypervisor_hostname: hostname-01 # Optional. It is used to setup new hypervisor hostname. In-case of IPAM, hypervisor_hostname will be used to create hostrecord
                 - node_serial: node-serial-2
                   cvm_ip: valid-cvm-ip
                   host_ip: valid-host-ip
                 - node_serial: node-serial-3
+                  hypervisor_hostname: hostname-03
               redundancy_factor: 2 # Nutanix supports RF2, and also RF3 only if the cluster has 5+ nodes
             - cluster_name: site01-cluster-01
               cluster_size: 3 # Cluster size will be the number of nodes for deployment

config/example-configs/pod-configs/pod-management-config.yml

@@ -1,5 +1,5 @@
 ---
-# This configuration is used to facilitate Initial PC configurations includind enabling FC
+# This configuration is used to facilitate Initial PC configurations including enabling FC
 
 # Global variables, which can be inherited in blocks
 pc_creds: &pc_creds

config/example-configs/script-configs/authentication_pc.yml

@@ -58,7 +58,7 @@ pc_directory_services:
 #       type: list
 #       required: false
 #       dependencies:
-#       - directory_services.ad_name
+#       - ad_name
 #       schema:
 #         type: dict
 #         schema:
@@ -80,6 +80,8 @@ pc_directory_services:
 #           values:
 #             required: true
 #             type: list
+#             schema:
+#               type: string
 # 
 
 

config/example-configs/script-configs/authentication_pe.yml

@@ -85,7 +85,7 @@ clusters:
 #       type: list
 #       required: false
 #       dependencies:
-#       - directory_services.ad_name
+#       - ad_name
 #       schema:
 #         type: dict
 #         schema:
@@ -107,6 +107,8 @@ clusters:
 #           values:
 #             required: true
 #             type: list
+#             schema:
+#               type: string
 # 
 
 

config/example-configs/script-configs/objectstore_buckets.yml

@@ -8,8 +8,12 @@ objects:
     - name: objectstore01
       domain: eng.company.com
       cluster: cluster01
-      network: subnet01
-      # Specify 4 static IPs
+      # Storage Network
+      storage_network: subnet01
+      # Public Network
+      public_network: subnet02
+      # First 2 Static IPs should be storage network static IPs.
+      # Rest of the Static IPs will be assigned as Public static IPs.
       static_ip_list:
         - ip1
         - ip2
@@ -28,8 +32,12 @@ objects:
     - name: objectstore02
       domain: eng.company.com
       cluster: cluster01
-      network: subnet01
-      # Specify 4 static IPs
+      # Storage Network
+      storage_network: subnet01
+      # Public Network
+      public_network: subnet02
+      # First 2 Static IPs should be storage network static IPs.
+      # Rest of the Static IPs will be assigned as Public static IPs.
       static_ip_list:
         - ip1
         - ip2
@@ -68,12 +76,17 @@ objects:
 #           cluster:
 #             type: string
 #             required: true
-#           network:
+#           storage_network:
+#             type: string
+#             required: true
+#           public_network:
 #             type: string
 #             required: true
 #           static_ip_list:
 #             type: list
 #             required: true
+#             schema:
+#               type: string
 #           num_worker_nodes:
 #             type: integer
 #             required: true

config/example-configs/script-configs/saml_idp.yml

@@ -0,0 +1,79 @@
+pc_ip: valid-pc-ip
+# Specify a user with permission to make API calls.
+pc_credential: pc_user # credential reference from "vaults" in global.yml file
+
+#Create
+saml_idp_configs:
+  - name: IDP1
+    username_attr: "username_attribute" #Optional
+    email_attr: "email_attribute" #Optional
+    groups_attr: "groups_attribute" #Optional
+    groups_delim: "groups_delimiter" #Optional
+    # Either of metadata_url or metadata_path or idp_properties need to be specified
+    metadata_url: "IdentityProviderURL"
+    metadata_path: "path_where_idp_metadata_is_stored" # e.g. "config/idp.xml" if it is stored in config directory
+    idp_properties:
+      idp_url: "idp_url" # Required
+      login_url: "login_url" # Required
+      logout_url: "logout_url" # Required
+      error_url: "error_url" # Optional
+      certificate: "certificate" # copy the details here, don't specify the path
+  - name: IDP2
+    username_attr: "username_attribute" #Optional
+    email_attr: "email_attribute" #Optional
+    groups_attr: "groups_attribute" #Optional
+    groups_delim: "groups_delimiter" #Optional
+    # Either of metadata_url or metadata_path or idp_properties need to be specified
+    metadata_url: "IdentityProviderURL"
+    metadata_path: "path_where_idp_metadata_is_stored" # e.g. "config/idp.xml" if it is stored in config directory
+    idp_properties:
+      idp_url: "idp_url" # Required
+      login_url: "login_url" # Required
+      logout_url: "logout_url" # Required
+      error_url: "error_url" # Optional
+      certificate: "certificate" # copy the details here, don't specify the path
+
+######################################## SCHEMA DOCUMENTATION ########################################
+### 			---CREATE SCHEMA --- 			 ###
+
+# saml_idp_configs:
+#   type: list
+#   schema:
+#     type: dict
+#     schema:
+#       name:
+#         type: string
+#         required: true
+#         empty: false
+#       username_attr:
+#         type: string
+#       email_attr:
+#         type: string
+#       groups_attr:
+#         type: string
+#       groups_delim:
+#         type: string
+#       metadata_path:
+#         type: string
+#       metadata_url:
+#         type: string
+#       idp_properties:
+#         type: dict
+#         schema:
+#           idp_url:
+#             required: true
+#             type: string
+#           login_url:
+#             required: true
+#             type: string
+#           logout_url:
+#             required: true
+#             type: string
+#           error_url:
+#             type: string
+#           certificate:
+#             required: true
+#             type: string
+# 
+
+####################################################################################################

config/example-configs/script-configs/subnets_pc.yml

@@ -106,6 +106,8 @@ clusters:
 #             schema:
 #               domain_name_server_list:
 #                 type: list
+#                 schema:
+#                   type: string
 #               domain_search_list:
 #                 type: list
 #               domain_name:

config/example-configs/script-configs/subnets_pe.yml

@@ -101,6 +101,8 @@ clusters:
 #             schema:
 #               domain_name_server_list:
 #                 type: list
+#                 schema:
+#                   type: string
 #               domain_search_list:
 #                 type: list
 #               domain_name:

config/example-configs/script-configs/update_cvm_foundation.yml

@@ -0,0 +1,26 @@
+cvm_creds: &cvm_creds
+  # Specify a user with permission to make API calls.
+  cvm_credential: cvm_credential # credential reference from "vaults" in global.yml file
+foundation: &foundation
+  foundation_build_url: http://url-path-to-foundation-tar/ # url path to download the foundation tar file
+  foundation_version: "5.x" # Foundation version to be updated to in CVM
+nameserver: &nameserver
+  nameserver: valid-nameserver # Optional. Provide a nameserver, if nameserver needs to be added to /etc/resolv.conf to download the tar file from the webserver
+cvm_downgrade: &cvm_downgrade
+  downgrade: True # Optional, set to downgrade as True when the foundation version needs to be downgraded.
+
+cvms:
+  valid-cvm01-ip:
+    # Use global cvm creds
+    <<: *cvm_creds
+    # Use global nameserver
+    <<: *nameserver
+    # Use global foundation config
+    <<: *foundation
+  valid-cvm02-ip:
+    cvm_credential: cvm_credential # credential reference from "vaults" in global.yml file
+    nameserver: valid-nameserver # Optional. Provide a nameserver, if nameserver needs to be added to /etc/resolv.conf to download the tar file from the webserver
+    # Use global cvm_downgrade. This is optional, set to downgrade as True when the foundation version needs to be downgraded.
+    <<: *cvm_downgrade
+    foundation_build_url: http://url-path-to-foundation-tar/ # url path to download the foundation tar file
+    foundation_version: "5.x" # Foundation version to be updated to in CVM

config/example-configs/workflow-configs/cluster-config.yml

@@ -70,6 +70,15 @@ ntp_servers: &ntp_servers
     - 1.us.pool.ntp.org
     - 2.us.pool.ntp.org
 
+# Not supported for single node cluster
+ha_reservation: &ha_reservation
+  enable_failover: true
+  num_host_failure_to_tolerate: 1
+
+# Not supported for 1 and 2 node cluster
+rebuild_capacity_reservation: &rebuild_capacity_reservation
+  enable_rebuild_reservation: true
+
 # configure the below clusters
 clusters:
   valid-site01-cluster-01-ip:
@@ -92,6 +101,11 @@ clusters:
     # NTP, DNS servers
     <<: *ntp_servers
     <<: *name_servers
+    # Use global HA Reservation config
+    ha_reservation:
+      <<: *ha_reservation
+    # Use global Rebuild capacity Reservation config
+    <<: *rebuild_capacity_reservation
 
   valid-site02-cluster-02-ip:
     name: cluster-02 # Optional if name is already provided above
@@ -136,3 +150,7 @@ clusters:
             domain_name_server_list: [ 10.10.10.10 ]
             domain_search_list: [ eng.company.com ]
             domain_name: eng.company.com
+    ha_reservation:
+      enable_failover: true
+      num_host_failure_to_tolerate: 0
+    enable_rebuild_reservation: false