Merge pull request #476 from chaosi-zju/dev

Add API Documents

Author: karmada-bot

docs/reference/karmada-api/auto-scaling-resources/cron-federated-hpa-v1alpha1.md

@@ -0,0 +1,62 @@
+---
+api_metadata:
+  apiVersion: ""
+  import: "k8s.io/apimachinery/pkg/apis/meta/v1"
+  kind: "DeleteOptions"
+content_type: "api_reference"
+description: "DeleteOptions may be provided when deleting an API object."
+title: "DeleteOptions"
+weight: 1
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
+
+DeleteOptions may be provided when deleting an API object.
+
+<hr/>
+
+- **apiVersion** (string)
+
+  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+
+- **dryRun** ([]string)
+
+  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
+
+- **gracePeriodSeconds** (int64)
+
+  The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+- **kind** (string)
+
+  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+
+- **orphanDependents** (boolean)
+
+  Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+- **preconditions** (Preconditions)
+
+  Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
+
+  <a name="Preconditions"></a>
+
+  *Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.*
+
+  - **preconditions.resourceVersion** (string)
+
+    Specifies the target ResourceVersion
+
+  - **preconditions.uid** (string)
+
+    Specifies the target UID.
+
+- **propagationPolicy** (string)
+
+  Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

docs/reference/karmada-api/auto-scaling-resources/federated-hpa-v1alpha1.md

@@ -0,0 +1,48 @@
+---
+api_metadata:
+  apiVersion: ""
+  import: "k8s.io/apimachinery/pkg/apis/meta/v1"
+  kind: "LabelSelector"
+content_type: "api_reference"
+description: "A label selector is a label query over a set of resources."
+title: "LabelSelector"
+weight: 2
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
+
+A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
+
+<hr/>
+
+- **matchExpressions** ([]LabelSelectorRequirement)
+
+  matchExpressions is a list of label selector requirements. The requirements are ANDed.
+
+  <a name="LabelSelectorRequirement"></a>
+
+  *A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.*
+
+  - **matchExpressions.key** (string), required
+
+    *Patch strategy: merge on key `key`*
+    
+    key is the label key that the selector applies to.
+
+  - **matchExpressions.operator** (string), required
+
+    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+
+  - **matchExpressions.values** ([]string)
+
+    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
+
+- **matchLabels** (map[string]string)
+
+  matchLabels is a map of [key,value] pairs. A single [key,value] in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
+

docs/reference/karmada-api/cluster-resources/cluster-v1alpha1.md

@@ -0,0 +1,38 @@
+---
+api_metadata:
+  apiVersion: ""
+  import: "k8s.io/apimachinery/pkg/apis/meta/v1"
+  kind: "ListMeta"
+content_type: "api_reference"
+description: "ListMeta describes metadata that synthetic resources must have, including lists and various status objects."
+title: "ListMeta"
+weight: 3
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
+
+ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of [ObjectMeta, ListMeta].
+
+<hr/>
+
+- **continue** (string)
+
+  continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
+
+- **remainingItemCount** (int64)
+
+  remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
+
+- **resourceVersion** (string)
+
+  String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+
+- **selfLink** (string)
+
+  Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
+

docs/reference/karmada-api/common-definitions/delete-options.md

@@ -0,0 +1,42 @@
+---
+api_metadata:
+  apiVersion: ""
+  import: "k8s.io/api/core/v1"
+  kind: "NodeSelectorRequirement"
+content_type: "api_reference"
+description: "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values."
+title: "NodeSelectorRequirement"
+weight: 4
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/api/core/v1"`
+
+A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+
+<hr/>
+
+- **key** (string), required
+
+  The label key that the selector applies to.
+
+- **operator** (string), required
+
+  Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+  
+  Possible enum values:
+   - `"DoesNotExist"`
+   - `"Exists"`
+   - `"Gt"`
+   - `"In"`
+   - `"Lt"`
+   - `"NotIn"`
+
+- **values** ([]string)
+
+  An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
+