Fix docs and comments according to PR reveiw

gardener · Oct 16, 2024 · ef3a664 · ef3a664
1 parent aedc679
commit ef3a664
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 18 deletions.
diff --git a/docs/usage/registry-cache/configuration.md b/docs/usage/registry-cache/configuration.md
@@ -96,14 +96,11 @@ The `providerConfig.caches[].secretReferenceName` is the name of the reference f
 > [!NOTE]
 > It is only possible to provide one set of credentials for one private upstream registry.
 
-The `providerConfig.caches[].proxy.httpProxy` field contains settings for a proxy which is used by the registry cache.
-The registry-cache extension sets this value as `HTTP_PROXY` ENV in the StatefulSet.
+The `providerConfig.caches[].proxy.httpProxy` field represents the proxy server for HTTP connections which is used by the registry cache. It must include an `https://` or `http://` scheme.
 
-The `providerConfig.caches[].proxy.httpsProxy` field contains settings for a proxy which is used by the registry cache.
-The registry-cache extension sets this value as `HTTPS_PROXY` ENV in the StatefulSet.
+The `providerConfig.caches[].proxy.httpsProxy` field represents the proxy server for HTTPS connections which is used by the registry cache. It must include an `https://` or `http://` scheme.
 
-The `providerConfig.caches[].proxy.noProxy` field contains settings for a proxy which is used by the registry cache.
-The registry-cache extension sets this value as `NO_PROXY` ENV in the StatefulSet.
+The `providerConfig.caches[].proxy.noProxy` field can be set to a comma separated list of IPs which should not connect over the specified proxy server. It can be only set of `httpProxy` and/or `httpsProxy` is set.
 
 ## Garbage Collection
 

diff --git a/hack/api-reference/registry.md b/hack/api-reference/registry.md
@@ -70,7 +70,7 @@ string
 </td>
 <td>
 <em>(Optional)</em>
-<p>HTTPProxy is used as HTTP_PROXY env in the StatefulSet.</p>
+<p>HTTPProxy field represents the proxy server for HTTP connections which is used by the registry cache.</p>
 </td>
 </tr>
 <tr>
@@ -82,7 +82,7 @@ string
 </td>
 <td>
 <em>(Optional)</em>
-<p>HTTPSProxy is used as HTTPS_PROXY env in the StatefulSet.</p>
+<p>HTTPSProxy field represents the proxy server for HTTPS connections which is used by the registry cache.</p>
 </td>
 </tr>
 <tr>
@@ -94,7 +94,7 @@ string
 </td>
 <td>
 <em>(Optional)</em>
-<p>NoProxy is used as NO_PROXY env in the StatefulSet.</p>
+<p>NoProxy field can be set to a comma separated list of IPs which should not connect over the specified proxy server.</p>
 </td>
 </tr>
 </tbody>

diff --git a/pkg/apis/registry/types.go b/pkg/apis/registry/types.go
@@ -62,11 +62,11 @@ type GarbageCollection struct {
 
 // Proxy contains settings for a proxy used in the registry cache.
 type Proxy struct {
-	// HTTPProxy is used as HTTP_PROXY env in the StatefulSet.
+	// HTTPProxy field represents the proxy server for HTTP connections which is used by the registry cache.
 	HTTPProxy *string
-	// HTTPSProxy is used as HTTPS_PROXY env in the StatefulSet.
+	// HTTPSProxy field represents the proxy server for HTTPS connections which is used by the registry cache.
 	HTTPSProxy *string
-	// NoProxy is used as NO_PROXY env in the StatefulSet.
+	// NoProxy field can be set to a comma separated list of IPs which should not connect over the specified proxy server.
 	NoProxy *string
 }
 

diff --git a/pkg/apis/registry/v1alpha3/types.go b/pkg/apis/registry/v1alpha3/types.go
@@ -71,15 +71,15 @@ type GarbageCollection struct {
 
 // Proxy contains settings for a proxy used in the registry cache.
 type Proxy struct {
-	// HTTPProxy is used as HTTP_PROXY env in the StatefulSet.
+	// HTTPProxy field represents the proxy server for HTTP connections which is used by the registry cache.
 	// +optional
-	HTTPProxy *string `json:"httpProxy"`
-	// HTTPSProxy is used as HTTPS_PROXY env in the StatefulSet.
+	HTTPProxy *string `json:"httpProxy,omitempty"`
+	// HTTPSProxy field represents the proxy server for HTTPS connections which is used by the registry cache.
 	// +optional
-	HTTPSProxy *string `json:"httpsProxy"`
-	// NoProxy is used as NO_PROXY env in the StatefulSet.
+	HTTPSProxy *string `json:"httpsProxy,omitempty"`
+	// NoProxy field can be set to a comma separated list of IPs which should not connect over the specified proxy server.
 	// +optional
-	NoProxy *string `json:"noProxy"`
+	NoProxy *string `json:"noProxy,omitempty"`
 }
 
 var (