Merge pull request #596 from jichenjc/bug/543

Remove Tag creation for ports and add description for it

Author: k8s-ci-robot

api/v1alpha3/openstackcluster_types.go

@@ -99,9 +99,6 @@ type OpenStackClusterSpec struct {
 	// Tags for all resources in cluster
 	Tags []string `json:"tags,omitempty"`
 
-	// Default: True. In case of server tag errors, set to False
-	DisableServerTags bool `json:"disableServerTags,omitempty"`
-
 	// CAKeyPair is the key pair for ca certs.
 	CAKeyPair KeyPair `json:"caKeyPair,omitempty"`
 

config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclusters.yaml

@@ -127,10 +127,6 @@ spec:
                   network created for the Kubernetes cluster, which also disables
                   SecurityGroups
                 type: boolean
-              disableServerTags:
-                description: 'Default: True. In case of server tag errors, set to
-                  False'
-                type: boolean
               dnsNameservers:
                 description: DNSNameservers is the list of nameservers for OpenStack
                   Subnet being created. Set this value when you need create a new

docs/configuration.md

@@ -173,7 +173,7 @@ spec:
 
 ## Tagging
 
-By default, all resources will be tagged with the values: `clusterName` and `cluster-api-provider-openstack`. The minimum microversion of the nova api that you need to support server tagging is 2.52. If your cluster does not support this, then disable tagging servers by setting `disableServerTags: true` in `cluster.yaml`. By default, this value is false. If your cluster supports tagging servers, you have the ability to tag all resources created by the cluster in the `cluster.yaml` file. Here is an example how to configure tagging:
+If your cluster supports tagging servers, you have the ability to tag all resources created by the cluster in the `cluster.yaml` file. Here is an example how to configure tagging:
 
 ```yaml
 apiVersion: infrastructure.cluster.x-k8s.io/v1alpha3

pkg/cloud/services/compute/instance.go

@@ -78,11 +78,7 @@ func (s *Service) InstanceCreate(clusterName string, machine *clusterv1.Machine,
 		}
 	}
 
-	// Set default Tags
-	machineTags := []string{
-		"cluster-api-provider-openstack",
-		clusterName,
-	}
+	machineTags := []string{}
 
 	// Append machine specific tags
 	machineTags = append(machineTags, openStackMachine.Spec.Tags...)
@@ -150,19 +146,14 @@ func (s *Service) InstanceCreate(clusterName string, machine *clusterv1.Machine,
 		var port ports.Port
 		if len(portList) == 0 {
 			// create server port
-			port, err = createPort(s, openStackMachine.Name, net, &securityGroups)
+			port, err = createPort(s, clusterName, openStackMachine.Name, net, &securityGroups)
 			if err != nil {
 				return nil, fmt.Errorf("failed to create port err: %v", err)
 			}
 		} else {
 			port = portList[0]
 		}
 
-		_, err = attributestags.ReplaceAll(s.networkClient, "ports", port.ID, attributestags.ReplaceAllOpts{
-			Tags: machineTags}).Extract()
-		if err != nil {
-			return nil, fmt.Errorf("tagging port for server err: %v", err)
-		}
 		portsList = append(portsList, servers.Network{
 			Port: port.ID,
 		})
@@ -204,7 +195,7 @@ func (s *Service) InstanceCreate(clusterName string, machine *clusterv1.Machine,
 	}
 
 	var serverTags []string
-	if !openStackCluster.Spec.DisableServerTags {
+	if len(machineTags) > 0 {
 		serverTags = machineTags
 		// NOTE(flaper87): This is the minimum required version
 		// to use tags.
@@ -389,11 +380,12 @@ func isDuplicate(list []string, name string) bool {
 	return false
 }
 
-func createPort(is *Service, name string, net ServerNetwork, securityGroups *[]string) (ports.Port, error) {
+func createPort(is *Service, clusterName string, name string, net ServerNetwork, securityGroups *[]string) (ports.Port, error) {
 	portCreateOpts := ports.CreateOpts{
 		Name:           name,
 		NetworkID:      net.networkID,
 		SecurityGroups: securityGroups,
+		Description:    fmt.Sprintf("Created by cluster-api-provider-openstack cluster %s", clusterName),
 	}
 	if net.subnetID != "" {
 		portCreateOpts.FixedIPs = []ports.IP{{SubnetID: net.subnetID}}

pkg/cloud/services/networking/network.go

@@ -128,13 +128,12 @@ func (s *Service) ReconcileNetwork(clusterName string, openStackCluster *infrav1
 	}
 	record.Eventf(openStackCluster, "SuccessfulCreateNetwork", "Created network %s with id %s", networkName, network.ID)
 
-	_, err = attributestags.ReplaceAll(s.client, "networks", network.ID, attributestags.ReplaceAllOpts{
-		Tags: []string{
-			"cluster-api-provider-openstack",
-			clusterName,
-		}}).Extract()
-	if err != nil {
-		return err
+	if len(openStackCluster.Spec.Tags) > 0 {
+		_, err = attributestags.ReplaceAll(s.client, "networks", network.ID, attributestags.ReplaceAllOpts{
+			Tags: openStackCluster.Spec.Tags}).Extract()
+		if err != nil {
+			return err
+		}
 	}
 
 	openStackCluster.Status.Network = &infrav1.Network{
@@ -221,13 +220,12 @@ func (s *Service) ReconcileSubnet(clusterName string, openStackCluster *infrav1.
 		}
 	}
 
-	_, err = attributestags.ReplaceAll(s.client, "subnets", observedSubnet.ID, attributestags.ReplaceAllOpts{
-		Tags: []string{
-			"cluster-api-provider-openstack",
-			clusterName,
-		}}).Extract()
-	if err != nil {
-		return err
+	if len(openStackCluster.Spec.Tags) > 0 {
+		_, err = attributestags.ReplaceAll(s.client, "subnets", observedSubnet.ID, attributestags.ReplaceAllOpts{
+			Tags: openStackCluster.Spec.Tags}).Extract()
+		if err != nil {
+			return err
+		}
 	}
 
 	openStackCluster.Status.Network.Subnet = &observedSubnet

pkg/cloud/services/networking/router.go

@@ -153,13 +153,12 @@ INTERFACE_LOOP:
 		s.logger.V(4).Info("Created RouterInterface", "id", routerInterface.ID)
 	}
 
-	_, err = attributestags.ReplaceAll(s.client, "routers", observedRouter.ID, attributestags.ReplaceAllOpts{
-		Tags: []string{
-			"cluster-api-provider-openstack",
-			clusterName,
-		}}).Extract()
-	if err != nil {
-		return err
+	if len(openStackCluster.Spec.Tags) > 0 {
+		_, err = attributestags.ReplaceAll(s.client, "routers", observedRouter.ID, attributestags.ReplaceAllOpts{
+			Tags: openStackCluster.Spec.Tags}).Extract()
+		if err != nil {
+			return err
+		}
 	}
 
 	if observedRouter.ID != "" {

templates/cluster-template-without-lb.yaml

@@ -30,7 +30,6 @@ spec:
   dnsNameservers:
   - ${OPENSTACK_DNS_NAMESERVERS}
   disablePortSecurity: true
-  disableServerTags: true
   useOctavia: false
 ---
 kind: KubeadmControlPlane

templates/cluster-template.yaml

@@ -32,7 +32,6 @@ spec:
   dnsNameservers:
   - ${OPENSTACK_DNS_NAMESERVERS}
   disablePortSecurity: false
-  disableServerTags: true
   useOctavia: true
 ---
 kind: KubeadmControlPlane