Merge pull request #1444 from mboersma/add-godot-linter

Add godot linter

Author: k8s-ci-robot

.golangci.yml

@@ -13,6 +13,7 @@ linters:
     - errorlint
     - goconst
     - gocyclo
+    - godot
     - gofmt
     - goimports
     - golint

api/v1alpha3/azurecluster_types.go

@@ -27,11 +27,11 @@ const (
 	// removing it from the apiserver.
 	ClusterFinalizer = "azurecluster.infrastructure.cluster.x-k8s.io"
 
-	// ClusterLabelNamespace indicates the namespace of the cluster
+	// ClusterLabelNamespace indicates the namespace of the cluster.
 	ClusterLabelNamespace = "azurecluster.infrastructure.cluster.x-k8s.io/cluster-namespace"
 )
 
-// AzureClusterSpec defines the desired state of AzureCluster
+// AzureClusterSpec defines the desired state of AzureCluster.
 type AzureClusterSpec struct {
 	// NetworkSpec encapsulates all things related to Azure network.
 	NetworkSpec NetworkSpec `json:"networkSpec,omitempty"`
@@ -58,7 +58,7 @@ type AzureClusterSpec struct {
 	IdentityRef *corev1.ObjectReference `json:"identityRef,omitempty"`
 }
 
-// AzureClusterStatus defines the observed state of AzureCluster
+// AzureClusterStatus defines the observed state of AzureCluster.
 type AzureClusterStatus struct {
 	// FailureDomains specifies the list of unique failure domains for the location/region of the cluster.
 	// A FailureDomain maps to Availability Zone with an Azure Region (if the region support them). An
@@ -87,7 +87,7 @@ type AzureClusterStatus struct {
 // +kubebuilder:resource:path=azureclusters,scope=Namespaced,categories=cluster-api
 // +kubebuilder:subresource:status
 
-// AzureCluster is the Schema for the azureclusters API
+// AzureCluster is the Schema for the azureclusters API.
 type AzureCluster struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -98,7 +98,7 @@ type AzureCluster struct {
 
 // +kubebuilder:object:root=true
 
-// AzureClusterList contains a list of AzureCluster
+// AzureClusterList contains a list of AzureClusters.
 type AzureClusterList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
@@ -110,7 +110,7 @@ func (c *AzureCluster) GetConditions() clusterv1.Conditions {
 	return c.Status.Conditions
 }
 
-// SetConditions will set the given conditions on an AzureCluster object
+// SetConditions will set the given conditions on an AzureCluster object.
 func (c *AzureCluster) SetConditions(conditions clusterv1.Conditions) {
 	c.Status.Conditions = conditions
 }

api/v1alpha3/azureclusteridentity_types.go

@@ -22,7 +22,7 @@ import (
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1alpha3"
 )
 
-// AzureClusterIdentitySpec defines the parameters that are used to create an AzureIdentity
+// AzureClusterIdentitySpec defines the parameters that are used to create an AzureIdentity.
 type AzureClusterIdentitySpec struct {
 	// UserAssignedMSI or Service Principal
 	Type IdentityType `json:"type"`
@@ -46,7 +46,7 @@ type AzureClusterIdentitySpec struct {
 	AllowedNamespaces []string `json:"allowedNamespaces"`
 }
 
-// AzureClusterIdentityStatus defines the observed state of AzureClusterIdentity
+// AzureClusterIdentityStatus defines the observed state of AzureClusterIdentity.
 type AzureClusterIdentityStatus struct {
 	// Conditions defines current service state of the AzureClusterIdentity.
 	// +optional
@@ -57,7 +57,7 @@ type AzureClusterIdentityStatus struct {
 // +kubebuilder:resource:path=azureclusteridentities,scope=Namespaced,categories=cluster-api
 // +kubebuilder:subresource:status
 
-// AzureClusterIdentity is the Schema for the azureclustersidentities API
+// AzureClusterIdentity is the Schema for the azureclustersidentities API.
 type AzureClusterIdentity struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -68,7 +68,7 @@ type AzureClusterIdentity struct {
 
 // +kubebuilder:object:root=true
 
-// AzureClusterIdentityList contains a list of AzureClusterIdentity
+// AzureClusterIdentityList contains a list of AzureClusterIdentities.
 type AzureClusterIdentityList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
@@ -80,12 +80,12 @@ func (c *AzureClusterIdentity) GetConditions() clusterv1.Conditions {
 	return c.Status.Conditions
 }
 
-// SetConditions will set the given conditions on an AzureClusterIdentity object
+// SetConditions will set the given conditions on an AzureClusterIdentity object.
 func (c *AzureClusterIdentity) SetConditions(conditions clusterv1.Conditions) {
 	c.Status.Conditions = conditions
 }
 
-// ClusterNamespaceAllowed indicates if the cluster namespace is allowed
+// ClusterNamespaceAllowed indicates if the cluster namespace is allowed.
 func (c *AzureClusterIdentity) ClusterNamespaceAllowed(namespace string) bool {
 	if len(c.Spec.AllowedNamespaces) == 0 {
 		return true

api/v1alpha3/azuremachine_types.go

@@ -30,7 +30,7 @@ const (
 	MachineFinalizer = "azuremachine.infrastructure.cluster.x-k8s.io"
 )
 
-// AzureMachineSpec defines the desired state of AzureMachine
+// AzureMachineSpec defines the desired state of AzureMachine.
 type AzureMachineSpec struct {
 	// ProviderID is the unique identifier as specified by the cloud provider.
 	// +optional
@@ -107,7 +107,7 @@ type AzureMachineSpec struct {
 	// +optional
 	AcceleratedNetworking *bool `json:"acceleratedNetworking,omitempty"`
 
-	// SpotVMOptions allows the ability to specify the Machine should use a Spot VM
+	// SpotVMOptions allows the ability to specify the Machine should use a Spot VM.
 	// +optional
 	SpotVMOptions *SpotVMOptions `json:"spotVMOptions,omitempty"`
 
@@ -116,14 +116,14 @@ type AzureMachineSpec struct {
 	SecurityProfile *SecurityProfile `json:"securityProfile,omitempty"`
 }
 
-// SpotVMOptions defines the options relevant to running the Machine on Spot VMs
+// SpotVMOptions defines the options relevant to running the Machine on Spot VMs.
 type SpotVMOptions struct {
 	// MaxPrice defines the maximum price the user is willing to pay for Spot VM instances
 	// +optional
 	MaxPrice *resource.Quantity `json:"maxPrice,omitempty"`
 }
 
-// AzureMachineStatus defines the observed state of AzureMachine
+// AzureMachineStatus defines the observed state of AzureMachine.
 type AzureMachineStatus struct {
 	// Ready is true when the provider resource is ready.
 	// +optional
@@ -189,7 +189,7 @@ type AzureMachineStatus struct {
 // +kubebuilder:resource:path=azuremachines,scope=Namespaced,categories=cluster-api
 // +kubebuilder:subresource:status
 
-// AzureMachine is the Schema for the azuremachines API
+// AzureMachine is the Schema for the azuremachines API.
 type AzureMachine struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -200,7 +200,7 @@ type AzureMachine struct {
 
 // +kubebuilder:object:root=true
 
-// AzureMachineList contains a list of AzureMachine
+// AzureMachineList contains a list of AzureMachines.
 type AzureMachineList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
@@ -212,7 +212,7 @@ func (m *AzureMachine) GetConditions() clusterv1.Conditions {
 	return m.Status.Conditions
 }
 
-// SetConditions will set the given conditions on an AzureMachine object
+// SetConditions will set the given conditions on an AzureMachine object.
 func (m *AzureMachine) SetConditions(conditions clusterv1.Conditions) {
 	m.Status.Conditions = conditions
 }

api/v1alpha3/azuremachinetemplate_types.go

@@ -20,15 +20,15 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// AzureMachineTemplateSpec defines the desired state of AzureMachineTemplate
+// AzureMachineTemplateSpec defines the desired state of AzureMachineTemplate.
 type AzureMachineTemplateSpec struct {
 	Template AzureMachineTemplateResource `json:"template"`
 }
 
 // +kubebuilder:object:root=true
 // +kubebuilder:resource:path=azuremachinetemplates,scope=Namespaced,categories=cluster-api
 
-// AzureMachineTemplate is the Schema for the azuremachinetemplates API
+// AzureMachineTemplate is the Schema for the azuremachinetemplates API.
 type AzureMachineTemplate struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -38,7 +38,7 @@ type AzureMachineTemplate struct {
 
 // +kubebuilder:object:root=true
 
-// AzureMachineTemplateList contains a list of AzureMachineTemplate
+// AzureMachineTemplateList contains a list of AzureMachineTemplate.
 type AzureMachineTemplateList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
@@ -49,7 +49,7 @@ func init() {
 	SchemeBuilder.Register(&AzureMachineTemplate{}, &AzureMachineTemplateList{})
 }
 
-// AzureMachineTemplateResource describes the data needed to create an AzureMachine from a template
+// AzureMachineTemplateResource describes the data needed to create an AzureMachine from a template.
 type AzureMachineTemplateResource struct {
 	// Spec is the specification of the desired behavior of the machine.
 	Spec AzureMachineSpec `json:"spec"`

api/v1alpha3/conditions_consts.go

@@ -18,19 +18,19 @@ package v1alpha3
 
 import clusterv1 "sigs.k8s.io/cluster-api/api/v1alpha3"
 
-// AzureCluster Conditions and Reasons
+// AzureCluster Conditions and Reasons.
 const (
-	// NetworkInfrastructureReadyCondition reports of current status of cluster infrastructure
+	// NetworkInfrastructureReadyCondition reports of current status of cluster infrastructure.
 	NetworkInfrastructureReadyCondition = "NetworkInfrastructureReady"
-	// LoadBalancerProvisioningReason API Server endpoint for the loadbalancer
+	// LoadBalancerProvisioningReason API Server endpoint for the loadbalancer.
 	LoadBalancerProvisioningReason = "LoadBalancerProvisioning"
 	// LoadBalancerProvisioningFailedReason used for failure during provisioning of loadbalancer.
 	LoadBalancerProvisioningFailedReason = "LoadBalancerProvisioningFailed"
-	// NamespaceNotAllowedByIdentity used to indicate cluster in a namespace not allowed by identity
+	// NamespaceNotAllowedByIdentity used to indicate cluster in a namespace not allowed by identity.
 	NamespaceNotAllowedByIdentity = "NamespaceNotAllowedByIdentity"
 )
 
-// AzureMachine Conditions and Reasons
+// AzureMachine Conditions and Reasons.
 const (
 	// VMRunningCondition reports on current status of the Azure VM.
 	VMRunningCondition clusterv1.ConditionType = "VMRunning"

api/v1alpha3/groupversion_info.go

@@ -25,10 +25,10 @@ import (
 )
 
 var (
-	// GroupVersion is group version used to register these objects
+	// GroupVersion is group version used to register these objects.
 	GroupVersion = schema.GroupVersion{Group: "infrastructure.cluster.x-k8s.io", Version: "v1alpha3"}
 
-	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
 	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
 
 	// AddToScheme adds the types in this group-version to the given scheme.

api/v1alpha3/tags.go

@@ -47,7 +47,7 @@ func (t Tags) HasAzureCloudProviderOwned(cluster string) bool {
 	return ok && ResourceLifecycle(value) == ResourceLifecycleOwned
 }
 
-// GetRole returns the Cluster API role for the tagged resource
+// GetRole returns the Cluster API role for the tagged resource.
 func (t Tags) GetRole() string {
 	return t[NameAzureClusterAPIRole]
 }
@@ -74,13 +74,13 @@ func (t Tags) Merge(other Tags) {
 	}
 }
 
-// AddSpecVersionHashTag adds a spec version hash to the Azure resource tags to determine if state has changed quickly
+// AddSpecVersionHashTag adds a spec version hash to the Azure resource tags to determine if state has changed quickly.
 func (t Tags) AddSpecVersionHashTag(hash string) Tags {
 	t[SpecVersionHashTagKey()] = hash
 	return t
 }
 
-// ResourceLifecycle configures the lifecycle of a resource
+// ResourceLifecycle configures the lifecycle of a resource.
 type ResourceLifecycle string
 
 const (
@@ -99,36 +99,36 @@ const (
 	// to be permissive about state changes.
 	// logically independent clusters running in the same AZ.
 	// The tag key = NameKubernetesAzureCloudProviderPrefix + clusterID
-	// The tag value is an ownership value
+	// The tag value is an ownership value.
 	NameKubernetesAzureCloudProviderPrefix = "kubernetes.io_cluster_"
 
 	// NameAzureProviderPrefix is the tag prefix we use to differentiate
 	// cluster-api-provider-azure owned components from other tooling that
-	// uses NameKubernetesClusterPrefix
+	// uses NameKubernetesClusterPrefix.
 	NameAzureProviderPrefix = "sigs.k8s.io_cluster-api-provider-azure_"
 
 	// NameAzureProviderOwned is the tag name we use to differentiate
 	// cluster-api-provider-azure owned components from other tooling that
-	// uses NameKubernetesClusterPrefix
+	// uses NameKubernetesClusterPrefix.
 	NameAzureProviderOwned = NameAzureProviderPrefix + "cluster_"
 
 	// NameAzureClusterAPIRole is the tag name we use to mark roles for resources
 	// dedicated to this cluster api provider implementation.
 	NameAzureClusterAPIRole = NameAzureProviderPrefix + "role"
 
-	// APIServerRole describes the value for the apiserver role
+	// APIServerRole describes the value for the apiserver role.
 	APIServerRole = "apiserver"
 
-	// NodeOutboundRole describes the value for the node outbound LB role
+	// NodeOutboundRole describes the value for the node outbound LB role.
 	NodeOutboundRole = "nodeOutbound"
 
-	// ControlPlaneOutboundRole describes the value for the control plane outbound LB role
+	// ControlPlaneOutboundRole describes the value for the control plane outbound LB role.
 	ControlPlaneOutboundRole = "controlPlaneOutbound"
 
-	// BastionRole describes the value for the bastion role
+	// BastionRole describes the value for the bastion role.
 	BastionRole = "bastion"
 
-	// CommonRole describes the value for the common role
+	// CommonRole describes the value for the common role.
 	CommonRole = "common"
 
 	// VMTagsLastAppliedAnnotation is the key for the machine object annotation
@@ -138,7 +138,7 @@ const (
 	VMTagsLastAppliedAnnotation = "sigs.k8s.io/cluster-api-provider-azure-last-applied-tags-vm"
 )
 
-// SpecVersionHashTagKey is the key for the spec version hash used to enable quick spec difference comparison
+// SpecVersionHashTagKey is the key for the spec version hash used to enable quick spec difference comparison.
 func SpecVersionHashTagKey() string {
 	return fmt.Sprintf("%s%s", NameAzureProviderPrefix, "spec-version-hash")
 }