remove deprecated default zone (#62)

Author: rvalle

.gitignore

@@ -0,0 +1,2 @@
+.idea
+tests/output

changelogs/fragments/62-deprecate-default-zone.yml

@@ -0,0 +1,2 @@
+breaking_changes:
+  - default zone deprecation - The `zone` param default value, across multiple modules, has been deprecated due to unreliable API (https://github.com/ngine-io/ansible-collection-cloudstack/pull/62).

plugins/module_utils/cloudstack.py

@@ -476,16 +476,12 @@ def get_zone(self, key=None):
         if not zones:
             self.fail_json(msg="No zones available. Please create a zone first")
 
-        # use the first zone if no zone param given
+        # this check is theoretically not required, as module argument specification should take care of it
+        # however, due to deprecated default zone is left behind just in case non obvious callers.
+        # Some modules benefit form the check anyway like those where zone if effectively optional like
+        # template registration (local/cross zone) or configuration (zone or global)
         if not zone:
-            self.module.deprecate(
-                msg="Using first zone as default is deprecated because of unreliable API, zone needs to be defined.",
-                version="2.0.0",
-                collection_name="ngine_io.cloudstack"
-            )
-            self.zone = zones['zone'][0]
-            self.result['zone'] = self.zone['name']
-            return self._get_by_key(key, self.zone)
+            self.fail_json(msg="Zone is required due to unreliable API.")
 
         if zones:
             for z in zones['zone']:

plugins/modules/cs_cluster.py

@@ -25,8 +25,8 @@
   zone:
     description:
       - Name of the zone in which the cluster belongs to.
-      - If not set, default zone is used.
     type: str
+    required: true
   pod:
     description:
       - Name of the pod in which the cluster belongs to.
@@ -332,7 +332,7 @@ def main():
     argument_spec = cs_argument_spec()
     argument_spec.update(dict(
         name=dict(required=True),
-        zone=dict(),
+        zone=dict(required=True),
         pod=dict(),
         cluster_type=dict(choices=['CloudManaged', 'ExternalManaged']),
         hypervisor=dict(),

plugins/modules/cs_configuration.py

@@ -165,7 +165,7 @@ def _get_common_configuration_args(self):
         return args
 
     def get_zone(self, key=None):
-        # make sure we do net use the default zone
+        # zone is optional as it means that the configuration is aimed at a global setting.
         zone = self.module.params.get('zone')
         if zone:
             return super(AnsibleCloudStackConfiguration, self).get_zone(key=key)

plugins/modules/cs_firewall.py

@@ -90,8 +90,8 @@
   zone:
     description:
       - Name of the zone in which the virtual machine is in.
-      - If not set, default zone is used.
     type: str
+    required: true
   poll_async:
     description:
       - Poll async jobs until job has finished.
@@ -112,12 +112,14 @@
 - name: Allow inbound port 80/tcp from 1.2.3.4 to 4.3.2.1
   ngine_io.cloudstack.cs_firewall:
     ip_address: 4.3.2.1
+    zone: zone01
     port: 80
     cidr: 1.2.3.4/32
 
 - name: Allow inbound tcp/udp port 53 to 4.3.2.1
   ngine_io.cloudstack.cs_firewall:
     ip_address: 4.3.2.1
+    zone: zone01
     port: 53
     protocol: '{{ item }}'
   with_items:
@@ -127,6 +129,7 @@
 - name: Ensure firewall rule is removed
   ngine_io.cloudstack.cs_firewall:
     ip_address: 4.3.2.1
+    zone: zone01
     start_port: 8000
     end_port: 8888
     cidr: 17.0.0.0/8
@@ -135,12 +138,14 @@
 - name: Allow all outbound traffic
   ngine_io.cloudstack.cs_firewall:
     network: my_network
+    zone: zone01
     type: egress
     protocol: all
 
 - name: Allow only HTTP outbound traffic for an IP
   ngine_io.cloudstack.cs_firewall:
     network: my_network
+    zone: zone01
     type: egress
     port: 80
     cidr: 10.101.1.20
@@ -395,7 +400,7 @@ def main():
         start_port=dict(type='int', aliases=['port']),
         end_port=dict(type='int'),
         state=dict(choices=['present', 'absent'], default='present'),
-        zone=dict(),
+        zone=dict(required=True),
         domain=dict(),
         account=dict(),
         project=dict(),

plugins/modules/cs_host.py

@@ -74,8 +74,8 @@
   zone:
     description:
       - Name of the zone in which the host should be deployed.
-      - If not set, default zone is used.
     type: str
+    required: true
 extends_documentation_fragment:
 - ngine_io.cloudstack.cloudstack
 '''
@@ -580,7 +580,7 @@ def main():
         pod=dict(),
         cluster=dict(),
         host_tags=dict(type='list', elements='str', aliases=['host_tag']),
-        zone=dict(),
+        zone=dict(required=True),
         state=dict(choices=['present', 'absent'], default='present'),
     ))
 

plugins/modules/cs_instance.py

@@ -150,8 +150,8 @@
   zone:
     description:
       - Name of the zone in which the instance should be deployed.
-      - If not set, default zone is used.
     type: str
+    required: true
   ssh_key:
     description:
       - Name of the SSH key to be deployed on the new instance.
@@ -218,6 +218,7 @@
 - name: for changing a running instance, use the 'force' parameter
   ngine_io.cloudstack.cs_instance:
     name: web-vm-1
+    zone: zone01
     display_name: web-vm-01.example.com
     iso: Linux Debian 7 64-bit
     service_offering: 2cpu_2gb
@@ -227,6 +228,7 @@
 - name: create or update a instance on Exoscale's public cloud using display_name.
   ngine_io.cloudstack.cs_instance:
     display_name: web-vm-1
+    zone: zone01
     template: Linux Debian 7 64-bit
     service_offering: Tiny
     ssh_key: [email protected]
@@ -243,6 +245,7 @@
 - name: create an instance with multiple interfaces specifying the IP addresses
   ngine_io.cloudstack.cs_instance:
     name: web-vm-1
+    zone: zone01
     template: Linux Debian 7 64-bit
     service_offering: Tiny
     ip_to_networks:
@@ -254,16 +257,19 @@
 - name: ensure an instance is stopped
   ngine_io.cloudstack.cs_instance:
     name: web-vm-1
+    zone: zone01
     state: stopped
 
 - name: ensure an instance is running
   ngine_io.cloudstack.cs_instance:
     name: web-vm-1
+    zone: zone01
     state: started
 
 - name: remove an instance
   ngine_io.cloudstack.cs_instance:
     name: web-vm-1
+    zone: zone01
     state: absent
 '''
 
@@ -1035,7 +1041,7 @@ def main():
         account=dict(),
         project=dict(),
         user_data=dict(),
-        zone=dict(),
+        zone=dict(required=True),
         ssh_key=dict(),
         force=dict(type='bool', default=False),
         tags=dict(type='list', elements='dict', aliases=['tag']),

plugins/modules/cs_instance_nic.py

@@ -54,8 +54,8 @@
   zone:
     description:
       - Name of the zone in which the instance is deployed in.
-      - If not set, default zone is used.
     type: str
+    required: true
   state:
     description:
       - State of the nic.
@@ -76,18 +76,21 @@
   ngine_io.cloudstack.cs_instance_nic:
     vm: privnet
     network: privNetForBasicZone
+    zone: zone01
 
 - name: Ensure IP address on a nic
   ngine_io.cloudstack.cs_instance_nic:
     vm: privnet
     ip_address: 10.10.11.32
     network: privNetForBasicZone
+    zone: zone01
 
 - name: Remove a secondary nic
   ngine_io.cloudstack.cs_instance_nic:
     vm: privnet
     state: absent
     network: privNetForBasicZone
+    zone: zone01
 '''
 
 RETURN = '''
@@ -258,7 +261,7 @@ def main():
         domain=dict(),
         account=dict(),
         project=dict(),
-        zone=dict(),
+        zone=dict(required=True),
         poll_async=dict(type='bool', default=True),
     ))
 

plugins/modules/cs_instance_nic_secondaryip.py

@@ -53,8 +53,8 @@
   zone:
     description:
       - Name of the zone in which the instance is deployed in.
-      - If not set, default zone is used.
     type: str
+    required: true
   state:
     description:
       - State of the ipaddress.
@@ -75,16 +75,19 @@
 - name: Assign a specific IP to the default NIC of the VM
   ngine_io.cloudstack.cs_instance_nic_secondaryip:
     vm: customer_xy
+    zone: zone01
     vm_guest_ip: 10.10.10.10
 
 # Note: If vm_guest_ip is not set, you will get a new IP address on every run.
 - name: Assign an IP to the default NIC of the VM
   ngine_io.cloudstack.cs_instance_nic_secondaryip:
     vm: customer_xy
+    zone: zone01
 
 - name: Remove a specific IP from the default NIC
   ngine_io.cloudstack.cs_instance_nic_secondaryip:
     vm: customer_xy
+    zone: zone01
     vm_guest_ip: 10.10.10.10
     state: absent
 '''
@@ -238,7 +241,7 @@ def main():
         domain=dict(),
         account=dict(),
         project=dict(),
-        zone=dict(),
+        zone=dict(required=True),
         poll_async=dict(type='bool', default=True),
     ))