address ahg comments around comments

kubernetes-sigs · Apr 16, 2024 · 23a0a39 · 23a0a39
1 parent 7d36541
commit 23a0a39
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 11 deletions.
diff --git a/api/jobset/v1alpha2/jobset_types.go b/api/jobset/v1alpha2/jobset_types.go
@@ -199,9 +199,8 @@ type Network struct {
 	// +optional
 	Subdomain string `json:"subdomain,omitempty"`
 
-	// PublishNotReadyAddresses indicates that any agent
-	// which deals with endpoints for this Service should disregard any indications of ready/not-ready.
-	// Defaults to true if not set
+	// Indicates if DNS records of pods should be published before the pods are ready.
+	// Defaults to True.
 	// +optional
 	PublishNotReadyAddresses *bool `json:"publishNotReadyAddresses,omitempty"`
 }

diff --git a/api/jobset/v1alpha2/openapi_generated.go b/api/jobset/v1alpha2/openapi_generated.go
diff --git a/config/components/crd/bases/jobset.x-k8s.io_jobsets.yaml b/config/components/crd/bases/jobset.x-k8s.io_jobsets.yaml
@@ -87,9 +87,8 @@ spec:
                     type: boolean
                   publishNotReadyAddresses:
                     description: |-
-                      PublishNotReadyAddresses indicates that any agent
-                      which deals with endpoints for this Service should disregard any indications of ready/not-ready.
-                      Defaults to true if not set
+                      Indicates if DNS records of pods should be published before the pods are ready.
+                      Defaults to True.
                     type: boolean
                   subdomain:
                     description: |-

diff --git a/hack/python-sdk/swagger.json b/hack/python-sdk/swagger.json
@@ -160,7 +160,7 @@
           "type": "boolean"
         },
         "publishNotReadyAddresses": {
-          "description": "PublishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. Defaults to true if not set",
+          "description": "Indicates if DNS records of pods should be published before the pods are ready. Defaults to True.",
           "type": "boolean"
         },
         "subdomain": {

diff --git a/sdk/python/docs/JobsetV1alpha2Network.md b/sdk/python/docs/JobsetV1alpha2Network.md
@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **enable_dns_hostnames** | **bool** | EnableDNSHostnames allows pods to be reached via their hostnames. Pods will be reachable using the fully qualified pod hostname: &lt;jobSet.name&gt;-&lt;spec.replicatedJob.name&gt;-&lt;job-index&gt;-&lt;pod-index&gt;.&lt;subdomain&gt; | [optional] 
-**publish_not_ready_addresses** | **bool** | PublishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. Defaults to true if not set | [optional] 
+**publish_not_ready_addresses** | **bool** | Indicates if DNS records of pods should be published before the pods are ready. Defaults to True. | [optional] 
 **subdomain** | **str** | Subdomain is an explicit choice for a network subdomain name When set, any replicated job in the set is added to this network. Defaults to &lt;jobSet.name&gt; if not set. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/sdk/python/jobset/models/jobset_v1alpha2_network.py b/sdk/python/jobset/models/jobset_v1alpha2_network.py
@@ -89,7 +89,7 @@ def enable_dns_hostnames(self, enable_dns_hostnames):
     def publish_not_ready_addresses(self):
         """Gets the publish_not_ready_addresses of this JobsetV1alpha2Network.  # noqa: E501
 
-        PublishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. Defaults to true if not set  # noqa: E501
+        Indicates if DNS records of pods should be published before the pods are ready. Defaults to True.  # noqa: E501
 
         :return: The publish_not_ready_addresses of this JobsetV1alpha2Network.  # noqa: E501
         :rtype: bool
@@ -100,7 +100,7 @@ def publish_not_ready_addresses(self):
     def publish_not_ready_addresses(self, publish_not_ready_addresses):
         """Sets the publish_not_ready_addresses of this JobsetV1alpha2Network.
 
-        PublishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. Defaults to true if not set  # noqa: E501
+        Indicates if DNS records of pods should be published before the pods are ready. Defaults to True.  # noqa: E501
 
         :param publish_not_ready_addresses: The publish_not_ready_addresses of this JobsetV1alpha2Network.  # noqa: E501
         :type: bool