Dual-stack support (IPv6 mode) (#434)

* Documentation updated.

* google-api-services-compute upgraded.

* Dual-stack supported.

* Constants renamed.

* Network interface stack mode factorized.

* Compatibility with previous version managed.

Author: Artmorse

docs/Home.md

@@ -57,7 +57,7 @@ View Google Compute Engine on the plugin site for more information.
 ### Google Compute Engine configuration
 Each GCE configuration can point to a different GCP project. Follow the steps below to create one.
 
- 1. Go to Manage Jenkins, then Configure System
+ 1. Go to Manage Jenkins, then Nodes and Clouds, then CLouds in the left menu 
  2. At the bottom of the page there will be a button labeled Add a new cloud, click the 
     button then click Google Compute Engine.
  3. Enter a name for your cloud configuration and the Project ID that you will be using
@@ -134,6 +134,5 @@ If you want to turn off this Strategy globally then you can set a SystemProperty
 
 Follow the steps below to configure it:
 
- 1. Go to Manage Jenkins, then Configure System
- 2. At the bottom of the page there will be a Cloud Section
- 3. Select the cloud project and look for the `No delay provisioning` checkbox, and click on to enable it. 
+ 1. Go to Manage Jenkins, then Nodes and Clouds, then CLouds in the left menu
+ 2. Select the cloud project and look for the `No delay provisioning` checkbox, and click on to enable it. 

pom.xml

@@ -72,10 +72,10 @@
     <it.windows>false</it.windows>
     <powershell.version>1.3</powershell.version>
     <google.http.version>1.42.2</google.http.version>
-    <google.compute.api.version>1.25.0</google.compute.api.version>
+    <google.compute.api.version>1.32.1</google.compute.api.version>
     <com.google.oauth-client.version>1.34.1</com.google.oauth-client.version>
     <google.j2objc.version>1.3</google.j2objc.version>
-    <compute.revision>235</compute.revision>
+    <compute.revision>20220720</compute.revision>
     <gcp-plugin-core.version>0.3.0</gcp-plugin-core.version>
     <hpi.compatibleSinceVersion>4.1.0</hpi.compatibleSinceVersion>
     <concurrency>10</concurrency>

src/main/java/com/google/jenkins/plugins/computeengine/ComputeEngineComputerLauncher.java

@@ -343,17 +343,28 @@ protected Connection connectToSsh(ComputeEngineComputer computer, TaskListener l
                 if (this.useInternalAddress) {
                     host = nic.getNetworkIP();
                 } else {
-                    // Look for a public IP address
+                    // Look for a public IPv4 address
                     if (nic.getAccessConfigs() != null) {
                         for (AccessConfig ac : nic.getAccessConfigs()) {
-                            if (ac.getType().equals(InstanceConfiguration.NAT_TYPE)) {
+                            if (ac.getType().equals(NetworkInterfaceIpStackMode.NAT_TYPE)) {
                                 host = ac.getNatIP();
                             }
                         }
                     }
+                    // Look for a public IPv6 address
+                    // TODO: IPv6 address is preferred compared to IPv4, we could let the user select
+                    //  his preferences to prioritize them.
+                    if (nic.getIpv6AccessConfigs() != null) {
+                        for (AccessConfig ac : nic.getIpv6AccessConfigs()) {
+                            if (ac.getType().equals(NetworkInterfaceDualStack.IPV6_TYPE)) {
+                                host = ac.getExternalIpv6();
+                            }
+                        }
+                    }
                     // No public address found. Fall back to internal address
                     if (host.isEmpty()) {
                         host = nic.getNetworkIP();
+                        logInfo(computer, listener, "No public address found. Fall back to internal address.");
                     }
                 }
 

src/main/java/com/google/jenkins/plugins/computeengine/InstanceConfiguration.java

@@ -20,7 +20,6 @@
 import static com.google.jenkins.plugins.computeengine.ComputeEngineCloud.checkPermissions;
 
 import com.google.api.services.compute.model.AcceleratorConfig;
-import com.google.api.services.compute.model.AccessConfig;
 import com.google.api.services.compute.model.AttachedDisk;
 import com.google.api.services.compute.model.AttachedDiskInitializeParams;
 import com.google.api.services.compute.model.DiskType;
@@ -46,6 +45,7 @@
 import edu.umd.cs.findbugs.annotations.Nullable;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.Extension;
+import hudson.ExtensionList;
 import hudson.RelativePath;
 import hudson.Util;
 import hudson.model.Describable;
@@ -98,8 +98,6 @@ public class InstanceConfiguration implements Describable<InstanceConfiguration>
     public static final String DEFAULT_RUN_AS_USER = "jenkins";
     public static final String METADATA_LINUX_STARTUP_SCRIPT_KEY = "startup-script";
     public static final String METADATA_WINDOWS_STARTUP_SCRIPT_KEY = "windows-startup-script-ps1";
-    public static final String NAT_TYPE = "ONE_TO_ONE_NAT";
-    public static final String NAT_NAME = "External NAT";
     public static final List<String> KNOWN_IMAGE_PROJECTS = Collections.unmodifiableList(new ArrayList<String>() {
         {
             add("centos-cloud");
@@ -131,7 +129,11 @@ public class InstanceConfiguration implements Describable<InstanceConfiguration>
     private String bootDiskSourceImageName;
     private String bootDiskSourceImageProject;
     private NetworkConfiguration networkConfiguration;
+    private NetworkInterfaceIpStackMode networkInterfaceIpStackMode;
+
+    @Deprecated
     private boolean externalAddress;
+
     private boolean useInternalAddress;
     private boolean ignoreProxy;
     private String networkTags;
@@ -351,6 +353,7 @@ public ComputeEngineInstance provision() throws IOException {
     /** Initializes transient properties */
     protected Object readResolve() {
         labelSet = Label.parse(labels);
+        this.networkInterfaceIpStackMode = new NetworkInterfaceSingleStack(externalAddress);
         return this;
     }
 
@@ -521,18 +524,15 @@ && notNullOrEmpty(acceleratorConfiguration.getGpuType())) {
 
     private List<NetworkInterface> networkInterfaces() {
         List<NetworkInterface> networkInterfaces = new ArrayList<>();
-        List<AccessConfig> accessConfigs = new ArrayList<>();
-        if (externalAddress) {
-            accessConfigs.add(new AccessConfig().setType(NAT_TYPE).setName(NAT_NAME));
-        }
-        NetworkInterface nic = new NetworkInterface().setAccessConfigs(accessConfigs);
+
+        NetworkInterface networkInterface = networkInterfaceIpStackMode.getNetworkInterface();
 
         // Don't include subnetwork name if using default
         if (!networkConfiguration.getSubnetwork().equals("default")) {
-            nic.setSubnetwork(stripSelfLinkPrefix(networkConfiguration.getSubnetwork()));
+            networkInterface.setSubnetwork(stripSelfLinkPrefix(networkConfiguration.getSubnetwork()));
         }
 
-        networkInterfaces.add(nic);
+        networkInterfaces.add(networkInterface);
         return networkInterfaces;
     }
 
@@ -939,6 +939,10 @@ public FormValidation doCheckNumExecutorsStr(
             }
             return FormValidation.ok();
         }
+
+        public List<NetworkInterfaceIpStackMode.Descriptor> getNetworkInterfaceIpStackModeDescriptors() {
+            return ExtensionList.lookup(NetworkInterfaceIpStackMode.Descriptor.class);
+        }
     }
 
     public static class Builder {
@@ -962,7 +966,7 @@ public InstanceConfiguration build() {
             instanceConfiguration.setBootDiskSourceImageName(this.bootDiskSourceImageName);
             instanceConfiguration.setBootDiskSourceImageProject(this.bootDiskSourceImageProject);
             instanceConfiguration.setNetworkConfiguration(this.networkConfiguration);
-            instanceConfiguration.setExternalAddress(this.externalAddress);
+            instanceConfiguration.setNetworkInterfaceIpStackMode(this.networkInterfaceIpStackMode);
             instanceConfiguration.setUseInternalAddress(this.useInternalAddress);
             instanceConfiguration.setIgnoreProxy(this.ignoreProxy);
             instanceConfiguration.setNetworkTags(this.networkTags);

src/main/java/com/google/jenkins/plugins/computeengine/NetworkInterfaceDualStack.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2024 CloudBees, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.jenkins.plugins.computeengine;
+
+import com.google.api.services.compute.model.AccessConfig;
+import com.google.api.services.compute.model.NetworkInterface;
+import hudson.Extension;
+import java.util.ArrayList;
+import java.util.List;
+import org.jenkinsci.Symbol;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+
+public class NetworkInterfaceDualStack extends NetworkInterfaceIpStackMode {
+    public static final String PREMIUM_NETWORK_TIER = "PREMIUM";
+    public static final String IPV6_TYPE = "DIRECT_IPV6";
+    public static final String IPV6_NAME = "external-ipv6";
+
+    private boolean externalIPV4Address;
+    private static final boolean externalIPV6Address = true; // always true in dual-stack type
+
+    @DataBoundConstructor
+    public NetworkInterfaceDualStack() {}
+
+    public boolean getExternalIPV4Address() {
+        return externalIPV4Address;
+    }
+
+    public boolean getExternalIPV46ddress() {
+        return externalIPV6Address;
+    }
+
+    @DataBoundSetter
+    public void setExternalIPV4Address(boolean externalIPV4Address) {
+        this.externalIPV4Address = externalIPV4Address;
+    }
+
+    @Override
+    protected NetworkInterface getNetworkInterface() {
+        List<AccessConfig> accessConfigs = new ArrayList<>();
+        NetworkInterface networkInterface = new NetworkInterface().setStackType(DUAL_IP_STACK_TYPE);
+        if (externalIPV4Address) {
+            accessConfigs.add(new AccessConfig().setType(NAT_TYPE).setName(NAT_NAME));
+            networkInterface.setAccessConfigs(accessConfigs);
+        }
+        List<AccessConfig> ipv6AccessConfigs = new ArrayList<>();
+        if (externalIPV6Address) { // always true
+            ipv6AccessConfigs.add(
+                    new AccessConfig().setType(IPV6_TYPE).setName(IPV6_NAME).setNetworkTier(PREMIUM_NETWORK_TIER));
+            networkInterface.setIpv6AccessConfigs(ipv6AccessConfigs);
+        }
+
+        return networkInterface;
+    }
+
+    @Extension
+    @Symbol("dualStack")
+    public static class DescriptorImpl extends NetworkInterfaceIpStackMode.Descriptor {
+        @Override
+        public String getDisplayName() {
+            return DUAL_IP_STACK_TYPE + " (dual-stack)";
+        }
+    }
+}

src/main/java/com/google/jenkins/plugins/computeengine/NetworkInterfaceIpStackMode.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2024 CloudBees, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.jenkins.plugins.computeengine;
+
+import com.google.api.services.compute.model.NetworkInterface;
+import hudson.model.AbstractDescribableImpl;
+
+public abstract class NetworkInterfaceIpStackMode extends AbstractDescribableImpl<NetworkInterfaceIpStackMode> {
+    public static final String NAT_TYPE = "ONE_TO_ONE_NAT";
+    public static final String NAT_NAME = "External NAT";
+
+    public static final String SINGLE_IP_STACK_TYPE = "IPV4_ONLY";
+    public static final String DUAL_IP_STACK_TYPE = "IPV4_IPV6";
+
+    protected NetworkInterface getNetworkInterface() {
+        return null;
+    }
+
+    public static class Descriptor extends hudson.model.Descriptor<NetworkInterfaceIpStackMode> {}
+}

src/main/java/com/google/jenkins/plugins/computeengine/NetworkInterfaceSingleStack.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2024 CloudBees, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.jenkins.plugins.computeengine;
+
+import com.google.api.services.compute.model.AccessConfig;
+import com.google.api.services.compute.model.NetworkInterface;
+import hudson.Extension;
+import java.util.ArrayList;
+import java.util.List;
+import org.jenkinsci.Symbol;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+
+public class NetworkInterfaceSingleStack extends NetworkInterfaceIpStackMode {
+
+    private boolean externalIPV4Address;
+
+    @DataBoundConstructor
+    public NetworkInterfaceSingleStack() {}
+
+    public NetworkInterfaceSingleStack(boolean externalIPV4Address) {
+        this.externalIPV4Address = externalIPV4Address;
+    }
+
+    public boolean getExternalIPV4Address() {
+        return externalIPV4Address;
+    }
+
+    @DataBoundSetter
+    public void setExternalIPV4Address(boolean externalIPV4Address) {
+        this.externalIPV4Address = externalIPV4Address;
+    }
+
+    @Override
+    protected NetworkInterface getNetworkInterface() {
+        List<AccessConfig> accessConfigs = new ArrayList<>();
+        NetworkInterface networkInterface = new NetworkInterface().setStackType(SINGLE_IP_STACK_TYPE);
+        if (externalIPV4Address) {
+            accessConfigs.add(new AccessConfig().setType(NAT_TYPE).setName(NAT_NAME));
+            networkInterface.setAccessConfigs(accessConfigs);
+        }
+        return networkInterface;
+    }
+
+    @Extension
+    @Symbol("singleStack")
+    public static class DescriptorImpl extends NetworkInterfaceIpStackMode.Descriptor {
+        @Override
+        public String getDisplayName() {
+            return SINGLE_IP_STACK_TYPE + " (single-stack)";
+        }
+    }
+}

src/main/resources/com/google/jenkins/plugins/computeengine/InstanceConfiguration/config.jelly

@@ -109,8 +109,9 @@
                     <f:entry title="${%Network tags}" field="networkTags">
                         <f:textbox/>
                     </f:entry>
-                    <f:entry field="externalAddress" title="${%Attach External IP?}">
-                        <f:checkbox/>
+                    <f:entry title="Network Interface IP stack type">
+                        <f:hetero-radio field="networkInterfaceIpStackMode"
+                                        descriptors="${descriptor.networkInterfaceIpStackModeDescriptors}"/>
                     </f:entry>
                 </f:section>
 

src/main/resources/com/google/jenkins/plugins/computeengine/InstanceConfiguration/help-externalAddress.html

@@ -0,0 +1,20 @@
+<!--
+Copyright 2024 CloudBees, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<div>
+    The IP stack type to use for the instance network interface configuration.
+    Check that the configuration of your subnetwork match the selected stack type.
+</div>
+