Fix forwarding rule fields and add Internal LB example (#236)

Signed-off-by: Modular Magician <magic-modules@google.com>

plugins/modules/gcp_compute_forwarding_rule.py

@@ -91,9 +91,8 @@ options:
     - ICMP
   backend_service:
     description:
-    - A reference to a BackendService to receive the matched traffic.
+    - A BackendService to receive the matched traffic. This is used only for INTERNAL
-    - This is used for internal load balancing.
+      load balancing.
-    - "(not used for external load balancing) ."
     - 'This field represents a link to a BackendService resource in GCP. It can be
       specified in two ways. First, you can place a dictionary with key ''selfLink''
       and value of your resource''s selfLink Alternatively, you can add `register:
@@ -102,8 +101,7 @@ options:
     required: false
   ip_version:
     description:
-    - The IP Version that will be used by this forwarding rule. Valid options are
+    - ipVersion is not a valid field for regional forwarding rules.
-      IPV4 or IPV6. This can only be specified for a global forwarding rule.
     required: false
     choices:
     - IPV4
@@ -133,7 +131,7 @@ options:
     - For internal load balancing, this field identifies the network that the load
       balanced IP should belong to for this Forwarding Rule. If this field is not
       specified, the default network will be used.
-    - This field is not used for external load balancing.
+    - This field is only used for INTERNAL load balancing.
     - 'This field represents a link to a Network resource in GCP. It can be specified
       in two ways. First, you can place a dictionary with key ''selfLink'' and value
       of your resource''s selfLink Alternatively, you can add `register: name-of-resource`
@@ -164,12 +162,10 @@ options:
     required: false
   subnetwork:
     description:
-    - A reference to a subnetwork.
+    - The subnetwork that the load balanced IP should belong to for this Forwarding
-    - For internal load balancing, this field identifies the subnetwork that the load
+      Rule. This field is only used for INTERNAL load balancing.
-      balanced IP should belong to for this Forwarding Rule.
     - If the network specified is in auto subnet mode, this field is optional. However,
       if the network is in custom subnet mode, a subnetwork must be specified.
-    - This field is not used for external load balancing.
     - 'This field represents a link to a Subnetwork resource in GCP. It can be specified
       in two ways. First, you can place a dictionary with key ''selfLink'' and value
       of your resource''s selfLink Alternatively, you can add `register: name-of-resource`
@@ -178,12 +174,10 @@ options:
     required: false
   target:
     description:
+    - This field is only used for EXTERNAL load balancing.
     - A reference to a TargetPool resource to receive the matched traffic.
-    - For regional forwarding rules, this target must live in the same region as the
+    - This target must live in the same region as the forwarding rule.
-      forwarding rule. For global forwarding rules, this target must be a global load
+    - The forwarded traffic must be of a type appropriate to the target object.
-      balancing resource. The forwarded traffic must be of a type appropriate to the
-      target object.
-    - This field is not used for internal load balancing.
     - 'This field represents a link to a TargetPool resource in GCP. It can be specified
       in two ways. First, you can place a dictionary with key ''selfLink'' and value
       of your resource''s selfLink Alternatively, you can add `register: name-of-resource`
@@ -193,9 +187,10 @@ options:
     version_added: 2.7
   all_ports:
     description:
-    - When the load balancing scheme is INTERNAL and protocol is TCP/UDP, omit `port`/`port_range`
+    - For internal TCP/UDP load balancing (i.e. load balancing scheme is INTERNAL
-      and specify this field as `true` to allow packets addressed to any ports to
+      and protocol is TCP/UDP), set this to true to allow packets addressed to any
-      be forwarded to the backends configured with this forwarding rule.
+      ports to be forwarded to the backends configured with this forwarding rule.
+      Used with backend service. Cannot be set if port or portRange are set.
     required: false
     type: bool
     version_added: 2.8
@@ -218,7 +213,7 @@ options:
       `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase
       letter, and all following characters must be a dash, lowercase letter, or digit,
       except the last character, which cannot be a dash.
-    - This field is only used for internal load balancing.
+    - This field is only used for INTERNAL load balancing.
     required: false
     version_added: 2.8
   region:
@@ -316,15 +311,13 @@ IPProtocol:
   type: str
 backendService:
   description:
-  - A reference to a BackendService to receive the matched traffic.
+  - A BackendService to receive the matched traffic. This is used only for INTERNAL
-  - This is used for internal load balancing.
+    load balancing.
-  - "(not used for external load balancing) ."
   returned: success
   type: dict
 ipVersion:
   description:
-  - The IP Version that will be used by this forwarding rule. Valid options are IPV4
+  - ipVersion is not a valid field for regional forwarding rules.
-    or IPV6. This can only be specified for a global forwarding rule.
   returned: success
   type: str
 loadBalancingScheme:
@@ -351,7 +344,7 @@ network:
   - For internal load balancing, this field identifies the network that the load balanced
     IP should belong to for this Forwarding Rule. If this field is not specified,
     the default network will be used.
-  - This field is not used for external load balancing.
+  - This field is only used for INTERNAL load balancing.
   returned: success
   type: dict
 portRange:
@@ -379,29 +372,26 @@ ports:
   type: list
 subnetwork:
   description:
-  - A reference to a subnetwork.
+  - The subnetwork that the load balanced IP should belong to for this Forwarding
-  - For internal load balancing, this field identifies the subnetwork that the load
+    Rule. This field is only used for INTERNAL load balancing.
-    balanced IP should belong to for this Forwarding Rule.
   - If the network specified is in auto subnet mode, this field is optional. However,
     if the network is in custom subnet mode, a subnetwork must be specified.
-  - This field is not used for external load balancing.
   returned: success
   type: dict
 target:
   description:
+  - This field is only used for EXTERNAL load balancing.
   - A reference to a TargetPool resource to receive the matched traffic.
-  - For regional forwarding rules, this target must live in the same region as the
+  - This target must live in the same region as the forwarding rule.
-    forwarding rule. For global forwarding rules, this target must be a global load
+  - The forwarded traffic must be of a type appropriate to the target object.
-    balancing resource. The forwarded traffic must be of a type appropriate to the
-    target object.
-  - This field is not used for internal load balancing.
   returned: success
   type: dict
 allPorts:
   description:
-  - When the load balancing scheme is INTERNAL and protocol is TCP/UDP, omit `port`/`port_range`
+  - For internal TCP/UDP load balancing (i.e. load balancing scheme is INTERNAL and
-    and specify this field as `true` to allow packets addressed to any ports to be
+    protocol is TCP/UDP), set this to true to allow packets addressed to any ports
-    forwarded to the backends configured with this forwarding rule.
+    to be forwarded to the backends configured with this forwarding rule. Used with
+    backend service. Cannot be set if port or portRange are set.
   returned: success
   type: bool
 networkTier:
@@ -420,13 +410,13 @@ serviceLabel:
     `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase
     letter, and all following characters must be a dash, lowercase letter, or digit,
     except the last character, which cannot be a dash.
-  - This field is only used for internal load balancing.
+  - This field is only used for INTERNAL load balancing.
   returned: success
   type: str
 serviceName:
   description:
   - The internal fully qualified service name for this Forwarding Rule.
-  - This field is only used for internal load balancing.
+  - This field is only used for INTERNAL load balancing.
   returned: success
   type: str
 region:

plugins/modules/gcp_compute_forwarding_rule_facts.py

@@ -119,15 +119,13 @@ items:
       type: str
     backendService:
       description:
-      - A reference to a BackendService to receive the matched traffic.
+      - A BackendService to receive the matched traffic. This is used only for INTERNAL
-      - This is used for internal load balancing.
+        load balancing.
-      - "(not used for external load balancing) ."
       returned: success
       type: dict
     ipVersion:
       description:
-      - The IP Version that will be used by this forwarding rule. Valid options are
+      - ipVersion is not a valid field for regional forwarding rules.
-        IPV4 or IPV6. This can only be specified for a global forwarding rule.
       returned: success
       type: str
     loadBalancingScheme:
@@ -154,7 +152,7 @@ items:
       - For internal load balancing, this field identifies the network that the load
         balanced IP should belong to for this Forwarding Rule. If this field is not
         specified, the default network will be used.
-      - This field is not used for external load balancing.
+      - This field is only used for INTERNAL load balancing.
       returned: success
       type: dict
     portRange:
@@ -184,29 +182,26 @@ items:
       type: list
     subnetwork:
       description:
-      - A reference to a subnetwork.
+      - The subnetwork that the load balanced IP should belong to for this Forwarding
-      - For internal load balancing, this field identifies the subnetwork that the
+        Rule. This field is only used for INTERNAL load balancing.
-        load balanced IP should belong to for this Forwarding Rule.
       - If the network specified is in auto subnet mode, this field is optional. However,
         if the network is in custom subnet mode, a subnetwork must be specified.
-      - This field is not used for external load balancing.
       returned: success
       type: dict
     target:
       description:
+      - This field is only used for EXTERNAL load balancing.
       - A reference to a TargetPool resource to receive the matched traffic.
-      - For regional forwarding rules, this target must live in the same region as
+      - This target must live in the same region as the forwarding rule.
-        the forwarding rule. For global forwarding rules, this target must be a global
+      - The forwarded traffic must be of a type appropriate to the target object.
-        load balancing resource. The forwarded traffic must be of a type appropriate
-        to the target object.
-      - This field is not used for internal load balancing.
       returned: success
       type: dict
     allPorts:
       description:
-      - When the load balancing scheme is INTERNAL and protocol is TCP/UDP, omit `port`/`port_range`
+      - For internal TCP/UDP load balancing (i.e. load balancing scheme is INTERNAL
-        and specify this field as `true` to allow packets addressed to any ports to
+        and protocol is TCP/UDP), set this to true to allow packets addressed to any
-        be forwarded to the backends configured with this forwarding rule.
+        ports to be forwarded to the backends configured with this forwarding rule.
+        Used with backend service. Cannot be set if port or portRange are set.
       returned: success
       type: bool
     networkTier:
@@ -225,13 +220,13 @@ items:
         expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must
         be a lowercase letter, and all following characters must be a dash, lowercase
         letter, or digit, except the last character, which cannot be a dash.
-      - This field is only used for internal load balancing.
+      - This field is only used for INTERNAL load balancing.
       returned: success
       type: str
     serviceName:
       description:
       - The internal fully qualified service name for this Forwarding Rule.
-      - This field is only used for internal load balancing.
+      - This field is only used for INTERNAL load balancing.
       returned: success
       type: str
     region: