fix automatic dns record registration based on vm and nic lifecycle

Author: sudo87

api/src/main/java/org/apache/cloudstack/dns/DnsProviderManager.java

@@ -75,7 +75,6 @@ public interface DnsProviderManager extends Manager, PluggableService {
 
     boolean disassociateZoneFromNetwork(DisassociateDnsZoneFromNetworkCmd cmd);
 
-    void addDnsRecordForVM(VirtualMachine instance, Network network, Nic nic);
     void deleteDnsRecordForVM(VirtualMachine instance, Network network, Nic nic);
 
     void checkDnsServerPermission(Account caller, DnsServer dnsServer);

engine/schema/src/main/resources/META-INF/cloudstack/core/spring-engine-schema-core-daos-context.xml

@@ -317,5 +317,6 @@
   <bean id="dnsZoneNetworkMapDao" class="org.apache.cloudstack.dns.dao.DnsZoneNetworkMapDaoImpl" />
   <bean id="dnsServerJoinDao" class="org.apache.cloudstack.dns.dao.DnsServerJoinDaoImpl" />
   <bean id="dnsZoneJoinDao" class="org.apache.cloudstack.dns.dao.DnsZoneJoinDaoImpl" />
+  <bean id="dnsNicJoinDao" class="org.apache.cloudstack.dns.dao.DnsNicJoinDaoImpl" />
 
 </beans>

engine/schema/src/main/resources/META-INF/db/schema-42210to42300.sql

@@ -124,7 +124,7 @@ CALL `cloud`.`IDEMPOTENT_ADD_COLUMN`('cloud.nics','enabled', 'TINYINT(1) NOT NUL
 -- ======================================================================
 
 -- DNS Server Table (Stores DNS Server Configurations)
-CREATE TABLE `cloud`.`dns_server` (
+CREATE TABLE IF NOT EXISTS `cloud`.`dns_server` (
     `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT 'id of the dns server',
     `uuid` varchar(40) COMMENT 'uuid of the dns server',
     `name` varchar(255) NOT NULL COMMENT 'display name of the dns server',
@@ -148,7 +148,7 @@ CREATE TABLE `cloud`.`dns_server` (
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
 
 -- DNS Zone Table (Stores DNS Zone Metadata)
-CREATE TABLE `cloud`.`dns_zone` (
+CREATE TABLE IF NOT EXISTS `cloud`.`dns_zone` (
     `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT 'id of the dns zone',
     `uuid` varchar(40) COMMENT 'uuid of the dns zone',
     `name` varchar(255) NOT NULL COMMENT 'dns zone name (e.g. example.com)',
@@ -171,7 +171,7 @@ CREATE TABLE `cloud`.`dns_zone` (
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
 
 -- DNS Zone Network Map (One-to-Many Link)
-CREATE TABLE `cloud`.`dns_zone_network_map` (
+CREATE TABLE IF NOT EXISTS `cloud`.`dns_zone_network_map` (
   `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT 'id of the dns zone to network mapping',
   `uuid` varchar(40),
   `dns_zone_id` bigint(20) unsigned NOT NULL,

engine/schema/src/main/resources/META-INF/db/views/cloud.dns_nic_view.sql

@@ -0,0 +1,40 @@
+-- Licensed to the Apache Software Foundation (ASF) under one
+-- or more contributor license agreements.  See the NOTICE file
+-- distributed with this work for additional information
+-- regarding copyright ownership.  The ASF licenses this file
+-- to you 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.
+
+-- VIEW `cloud`.`dns_nic_view`;
+
+DROP VIEW IF EXISTS `cloud`.`dns_nic_view`;
+CREATE VIEW `cloud`.`dns_nic_view` AS
+SELECT
+    n.id AS id,
+    n.uuid AS uuid,
+    n.instance_id AS instance_id,
+    n.network_id AS network_id,
+    n.ip4_address AS ip4_address,
+    n.ip6_address AS ip6_address,
+    n.removed AS removed,
+    nd.value AS nic_dns_url,
+    map.dns_zone_id AS dns_zone_id,
+    map.sub_domain AS sub_domain
+FROM
+    `cloud`.`nics` n
+        INNER JOIN
+    `cloud`.`dns_zone_network_map` map ON n.network_id = map.network_id
+        LEFT JOIN
+    `cloud`.`nic_details` nd ON n.id = nd.nic_id AND nd.name = 'nicdnsrecord'
+WHERE
+    map.removed IS NULL;

server/src/main/java/org/apache/cloudstack/dns/DnsProviderManagerImpl.java

@@ -0,0 +1,58 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you 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 org.apache.cloudstack.dns.dao;
+
+import java.util.List;
+
+import org.apache.cloudstack.dns.vo.DnsNicJoinVO;
+
+import com.cloud.utils.db.GenericDao;
+
+public interface DnsNicJoinDao extends GenericDao<DnsNicJoinVO, Long> {
+
+    /**
+     * Used for Collision Checks.
+     * @param dnsRecordUrl
+     * @param dnsZoneId
+     * @return active records to see who currently owns the dnsRecordUrl.
+     */
+    DnsNicJoinVO findActiveByDnsRecordAndZone(String dnsRecordUrl, long dnsZoneId);
+
+    /**
+     * Used to sync DNS record url based on available ips for vmId in the dnsZone
+     * @param vmId
+     * @param dnsZoneId
+     * @param dnsRecordUrl
+     * @return list of active nics using the dnsRecordUrl, supports null vmId for dnsZone wide query
+     */
+    List<DnsNicJoinVO> listActiveByVmIdZoneAndDnsRecord(Long vmId, long dnsZoneId, String dnsRecordUrl);
+
+    /**
+     * Used for VM Start/Running
+     * @param vmId
+     * @return records associated to vmId
+     */
+    List<DnsNicJoinVO> listActiveByVmId(long vmId);
+
+    /**
+     * Used by Instance Destroy/Stop or NIC delete
+     * @param vmId
+     * @return records with soft-delete
+     */
+    List<DnsNicJoinVO> listIncludingRemovedByVmId(long vmId);
+}

server/src/main/java/org/apache/cloudstack/dns/dao/DnsNicJoinDao.java

@@ -0,0 +1,91 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you 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 org.apache.cloudstack.dns.dao;
+
+import java.util.List;
+
+import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.dns.vo.DnsNicJoinVO;
+
+import com.cloud.utils.db.GenericDaoBase;
+import com.cloud.utils.db.SearchBuilder;
+import com.cloud.utils.db.SearchCriteria;
+
+public class DnsNicJoinDaoImpl extends GenericDaoBase<DnsNicJoinVO, Long> implements DnsNicJoinDao {
+    private final SearchBuilder<DnsNicJoinVO> activeDnsRecordZoneSearch;
+    private final SearchBuilder<DnsNicJoinVO> activeVmZoneDnsRecordSearch; // Route for null vmId
+    private final SearchBuilder<DnsNicJoinVO> activeVmSearch;
+
+    public DnsNicJoinDaoImpl() {
+
+        activeDnsRecordZoneSearch = createSearchBuilder();
+        activeDnsRecordZoneSearch.and(ApiConstants.NIC_DNS_RECORD, activeDnsRecordZoneSearch.entity().getNicDnsUrl(), SearchCriteria.Op.EQ);
+        activeDnsRecordZoneSearch.and(ApiConstants.DNS_ZONE_ID, activeDnsRecordZoneSearch.entity().getDnsZoneId(), SearchCriteria.Op.EQ);
+        activeDnsRecordZoneSearch.and(ApiConstants.REMOVED, activeDnsRecordZoneSearch.entity().getRemoved(), SearchCriteria.Op.NULL);
+        activeDnsRecordZoneSearch.done();
+
+        activeVmZoneDnsRecordSearch = createSearchBuilder();
+        activeVmZoneDnsRecordSearch.and(ApiConstants.INSTANCE_ID, activeVmZoneDnsRecordSearch.entity().getInstanceId(), SearchCriteria.Op.EQ);
+        activeVmZoneDnsRecordSearch.and(ApiConstants.NIC_DNS_RECORD, activeVmZoneDnsRecordSearch.entity().getNicDnsUrl(), SearchCriteria.Op.EQ);
+        activeVmZoneDnsRecordSearch.and(ApiConstants.DNS_ZONE_ID, activeVmZoneDnsRecordSearch.entity().getDnsZoneId(), SearchCriteria.Op.EQ);
+        activeVmZoneDnsRecordSearch.and(ApiConstants.REMOVED, activeVmZoneDnsRecordSearch.entity().getRemoved(), SearchCriteria.Op.NULL);
+        activeVmZoneDnsRecordSearch.done();
+
+        activeVmSearch = createSearchBuilder();
+        activeVmSearch.and(ApiConstants.INSTANCE_ID, activeVmSearch.entity().getInstanceId(), SearchCriteria.Op.EQ);
+        activeVmSearch.done();
+    }
+
+    @Override
+    public DnsNicJoinVO findActiveByDnsRecordAndZone(String dnsRecordUrl, long dnsZoneId) {
+        SearchCriteria<DnsNicJoinVO> sc = activeDnsRecordZoneSearch.create();
+        sc.setParameters(ApiConstants.NIC_DNS_RECORD, dnsRecordUrl);
+        sc.setParameters(ApiConstants.DNS_ZONE_ID, dnsZoneId);
+        return findOneBy(sc);
+    }
+
+    @Override
+    public List<DnsNicJoinVO> listActiveByVmIdZoneAndDnsRecord(Long vmId, long dnsZoneId, String dnsRecordUrl) {
+        if (vmId != null) {
+            SearchCriteria<DnsNicJoinVO> sc = activeDnsRecordZoneSearch.create();
+            sc.setParameters(ApiConstants.INSTANCE_ID, vmId);
+            sc.setParameters(ApiConstants.DNS_ZONE_ID, dnsZoneId);
+            sc.setParameters(ApiConstants.NIC_DNS_RECORD, dnsRecordUrl);
+            return listBy(sc);
+        } else {
+            SearchCriteria<DnsNicJoinVO> sc = activeDnsRecordZoneSearch.create();
+            sc.setParameters(ApiConstants.NIC_DNS_RECORD, dnsRecordUrl);
+            sc.setParameters(ApiConstants.DNS_ZONE_ID, dnsZoneId);
+            return listBy(sc);
+        }
+    }
+
+    @Override
+    public List<DnsNicJoinVO> listActiveByVmId(long vmId) {
+        SearchCriteria<DnsNicJoinVO> sc = activeVmSearch.create();
+        sc.setParameters(ApiConstants.INSTANCE_ID, vmId);
+        return listBy(sc);
+    }
+
+    @Override
+    public List<DnsNicJoinVO> listIncludingRemovedByVmId(long vmId) {
+        SearchCriteria<DnsNicJoinVO> sc = activeVmSearch.create();
+        sc.setParameters(ApiConstants.INSTANCE_ID, vmId);
+        return listIncludingRemovedBy(sc);
+    }
+}

server/src/main/java/org/apache/cloudstack/dns/dao/DnsNicJoinDaoImpl.java

@@ -0,0 +1,115 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.cloudstack.dns.vo;
+
+import java.util.Date;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.Table;
+
+import org.apache.cloudstack.api.Identity;
+import org.apache.cloudstack.api.InternalIdentity;
+
+import com.cloud.api.query.vo.BaseViewVO;
+
+@Entity
+@Table(name = "dns_nic_view")
+public class DnsNicJoinVO extends BaseViewVO implements InternalIdentity, Identity {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    @Column(name = "id")
+    private long id;
+
+    @Column(name = "uuid")
+    private String uuid;
+
+    @Column(name = "instance_id")
+    private long instanceId;
+
+    @Column(name = "network_id")
+    private long networkId;
+
+    @Column(name = "ip4_address")
+    private String ip4Address;
+
+    @Column(name = "ip6_address")
+    private String ip6Address;
+
+    @Column(name = "nic_dns_url")
+    private String nicDnsUrl;
+
+    @Column(name = "dns_zone_id")
+    private long dnsZoneId;
+
+    @Column(name = "sub_domain")
+    private String subDomain;
+
+    @Column(name = "removed")
+    private Date removed;
+
+    public DnsNicJoinVO() {
+    }
+
+    @Override
+    public long getId() {
+        return id;
+    }
+
+    @Override
+    public String getUuid() {
+        return uuid;
+    }
+
+    public long getInstanceId() {
+        return instanceId;
+    }
+
+    public long getNetworkId() {
+        return networkId;
+    }
+
+    public long getDnsZoneId() {
+        return dnsZoneId;
+    }
+
+    public String getSubDomain() {
+        return subDomain;
+    }
+
+    public String getNicDnsUrl() {
+        return nicDnsUrl;
+    }
+
+    public String getIp4Address() {
+        return ip4Address;
+    }
+
+    public String getIp6Address() {
+        return ip6Address;
+    }
+
+    public Date getRemoved() {
+        return removed;
+    }
+}