documentation: polish NB contract and add more comments

pkg/parser/utilities.go

@@ -16,7 +16,7 @@ func getBaseTemplate() *nbcontractv1.Configuration {
 			CustomKubeBinaryUrl:  "https://acs-mirror.azureedge.net/kubernetes/v1.26.0/binaries/kubernetes-node-linux-amd64.tar.gz",
 			PrivateKubeBinaryUrl: "",
 		},
-		KubeproxyUrl: "",
+		KubeProxyUrl: "",
 		EnableSsh:    true,
 	}
 }

pkg/proto/nbcontract/v1/apiserverconfig.proto

@@ -2,6 +2,9 @@ syntax = "proto3";
 package nbcontract.v1;
 
 message ApiServerConfig {
-    string api_server_public_key = 1;
-    string api_server_name = 2;
-  }
+  // The certificate public key of the API server.
+  string api_server_public_key = 1;
+
+  // The name or endpoint URI of the API server.
+  string api_server_name = 2;
+}

pkg/proto/nbcontract/v1/authconfig.proto

@@ -3,11 +3,24 @@ package nbcontract.v1;
 
 // Auth Config fields stored in azure.json used by cloud-provider-azure
 message AuthConfig {
-  string target_cloud = 1; // set to cloud, default to AzurePublicCloud
+  // Target cloud. Set to cloud. Default to AzurePublicCloud
+  string target_cloud = 1;
+
+  // Tenant ID
   string tenant_id = 2;
+
+  // Subscription ID
   string subscription_id = 3;
-  string service_principal_id = 4; // set to aadClientId
-  string service_principal_secret = 5; // set to aadClientSecret
-  string assigned_identity_id = 6;  //could be user or system assigned, depending on the type
-  bool use_managed_identity_extension = 7; // default to false
+
+  // Service Principal ID. set to aadClientId
+  string service_principal_id = 4;
+
+  // Service Principal Secret. set to aadClientSecret
+  string service_principal_secret = 5;
+
+  // Assigned identity id, could be user or system assigned, depending on the type.
+  string assigned_identity_id = 6;
+
+  // Specify if use managed identity extension, default to false
+  bool use_managed_identity_extension = 7;
 }

pkg/proto/nbcontract/v1/clusterconfig.proto

@@ -3,13 +3,28 @@ package nbcontract.v1;
 
 // Cluster Config fields stored in azure.json used by cloud-provider-azure
 message ClusterConfig {
+  // Rescource group name
   string resource_group = 1;
+
+  // Location
   string location = 2;
+
+  // VM type
   VM vm_type = 3; // default to standard for v1.27 and below versions and vmss for v1.28+ versions
+
+  // Primary availability set name
   string primary_availability_set = 4;
+
+  // Primary scale set name
   string primary_scale_set = 5;
+
+  // Cluster network config
   ClusterNetworkConfig virtual_network_config = 6;
+
+  // Specifiy if it uses instance metadata
   bool use_instance_metadata = 7; // default to false
+
+  // Load balancer config
   LoadBalancerConfig load_balancer_config = 8;
 
   enum VM {
@@ -20,18 +35,34 @@ message ClusterConfig {
 }
 
 message ClusterNetworkConfig {
+  // Virtual network name
   string vnet_name = 1;
+
+  // Virtual network resource group
   string vnet_resource_group = 2;
+
+  // Subnet name
   string subnet = 3;
+
+  // Network security group name
   string security_group_name = 4;
+
+  // Route table name
   string route_table = 5;
 }
 
 message LoadBalancerConfig {
-  LoadBalancerSku load_balancer_sku = 1; // default to basic
-  optional bool exclude_master_from_standard_load_balancer = 2; // default to true
-  optional int32 max_load_balancer_rule_count = 3; // default to 148
-  optional bool disable_outbound_snat = 4; // default to false
+  // Load balancer sku, default to basic
+  LoadBalancerSku load_balancer_sku = 1;
+
+  // Specify if master node should be excluded from standard load balancer, default to true 
+  optional bool exclude_master_from_standard_load_balancer = 2;
+
+  // Maximum number of load balancer rules, default to 148
+  optional int32 max_load_balancer_rule_count = 3;
+
+  // Disable outbound SNAT (Source Network Address Translation) for load balancer, default to false
+  optional bool disable_outbound_snat = 4;
 
   enum LoadBalancerSku {
     UNSPECIFIED = 0;