Update API Reference multi-pages for v1.24

2022-04-09 09:47:23 +02:00
parent 5860eebf19
commit 363eea4e22
29 changed files with 1213 additions and 662 deletions
@@ -66,11 +66,6 @@ LimitRangeSpec defines a min/max usage limit for resources that match on kind.
  - **limits.type** (string), required

    Type of resource that this limit applies to.
-    
-    Possible enum values:
-     - `"Container"` Limit that applies to all containers in a namespace
-     - `"PersistentVolumeClaim"` Limit that applies to all persistent volume claims in a namespace
-     - `"Pod"` Limit that applies to all pods in a namespace

  - **limits.default** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)

@@ -46,6 +46,10 @@ NetworkPolicy describes what network traffic is allowed for a set of Pods

  Specification of the desired behavior for this NetworkPolicy.

+- **status** (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicyStatus" >}}">NetworkPolicyStatus</a>)
+
+  Status is the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
+



@@ -194,6 +198,54 @@ NetworkPolicySpec provides the specification of a NetworkPolicy



+## NetworkPolicyStatus {#NetworkPolicyStatus}
+
+NetworkPolicyStatus describe the current state of the NetworkPolicy.
+
+<hr>
+
+- **conditions** ([]Condition)
+
+  *Patch strategy: merge on key `type`*
+  
+  *Map: unique values on key type will be kept during a merge*
+  
+  Conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state
+
+  <a name="Condition"></a>
+  *Condition contains details for one aspect of the current state of this API Resource.*
+
+  - **conditions.lastTransitionTime** (Time), required
+
+    lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
+
+    <a name="Time"></a>
+    *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.*
+
+  - **conditions.message** (string), required
+
+    message is a human readable message indicating details about the transition. This may be an empty string.
+
+  - **conditions.reason** (string), required
+
+    reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
+
+  - **conditions.status** (string), required
+
+    status of the condition, one of True, False, Unknown.
+
+  - **conditions.type** (string), required
+
+    type of condition in CamelCase or in foo.example.com/CamelCase.
+
+  - **conditions.observedGeneration** (int64)
+
+    observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
+
+
+
+
+
 ## NetworkPolicyList {#NetworkPolicyList}

 NetworkPolicyList is a list of NetworkPolicy objects.
@@ -254,6 +306,39 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}



+#### Response
+
+
+200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
+
+401: Unauthorized
+
+
+### `get` read status of the specified NetworkPolicy
+
+#### HTTP Request
+
+GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}/status
+
+#### Parameters
+
+
+- **name** (*in path*): string, required
+
+  name of the NetworkPolicy
+
+
+- **namespace** (*in path*): string, required
+
+  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
+
+
+- **pretty** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
+
+
+
 #### Response


@@ -479,6 +564,61 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
  


+- **dryRun** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
+
+
+- **fieldManager** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
+
+
+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
+- **pretty** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
+
+
+
+#### Response
+
+
+200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
+
+201 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): Created
+
+401: Unauthorized
+
+
+### `update` replace status of the specified NetworkPolicy
+
+#### HTTP Request
+
+PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}/status
+
+#### Parameters
+
+
+- **name** (*in path*): string, required
+
+  name of the NetworkPolicy
+
+
+- **namespace** (*in path*): string, required
+
+  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
+
+
+- **body**: <a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>, required
+
+  
+
+
 - **dryRun** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
@@ -534,6 +674,66 @@ PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
  


+- **dryRun** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
+
+
+- **fieldManager** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
+
+
+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
+- **force** (*in query*): boolean
+
+  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
+
+
+- **pretty** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
+
+
+
+#### Response
+
+
+200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
+
+201 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): Created
+
+401: Unauthorized
+
+
+### `patch` partially update status of the specified NetworkPolicy
+
+#### HTTP Request
+
+PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}/status
+
+#### Parameters
+
+
+- **name** (*in path*): string, required
+
+  name of the NetworkPolicy
+
+
+- **namespace** (*in path*): string, required
+
+  <a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
+
+
+- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
+
+  
+
+
 - **dryRun** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
@@ -82,23 +82,13 @@ ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

      Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
      
-      Possible enum values:
-       - `"DoesNotExist"`
-       - `"Exists"`
-       - `"In"`
-       - `"NotIn"`
+      

    - **scopeSelector.matchExpressions.scopeName** (string), required

      The name of the scope that the selector applies to.
      
-      Possible enum values:
-       - `"BestEffort"` Match all pod objects that have best effort quality of service
-       - `"CrossNamespacePodAffinity"` Match all pod objects that have cross-namespace pod (anti)affinity mentioned. This is a beta feature enabled by the PodAffinityNamespaceSelector feature flag.
-       - `"NotBestEffort"` Match all pod objects that do not have best effort quality of service
-       - `"NotTerminating"` Match all pod objects where spec.activeDeadlineSeconds is nil
-       - `"PriorityClass"` Match all pod objects that have priority class mentioned
-       - `"Terminating"` Match all pod objects where spec.activeDeadlineSeconds >=0
+      

    - **scopeSelector.matchExpressions.values** ([]string)