×

Specification

Property Type Description

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

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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ClusterResourceSetSpec defines the desired state of ClusterResourceSet.

status

object

ClusterResourceSetStatus defines the observed state of ClusterResourceSet.

.spec

Description

ClusterResourceSetSpec defines the desired state of ClusterResourceSet.

Type

object

Required
  • clusterSelector

Property Type Description

clusterSelector

object

Label selector for Clusters. The Clusters that are selected by this will be the ones affected by this ClusterResourceSet. It must match the Cluster labels. This field is immutable. Label selector cannot be empty.

resources

array

Resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters.

resources[]

object

ResourceRef specifies a resource.

strategy

string

Strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable.

.spec.clusterSelector

Description

Label selector for Clusters. The Clusters that are selected by this will be the ones affected by this ClusterResourceSet. It must match the Cluster labels. This field is immutable. Label selector cannot be empty.

Type

object

Property Type Description

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (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.

.spec.clusterSelector.matchExpressions

Description

matchExpressions is a list of label selector requirements. The requirements are ANDed.

Type

array

.spec.clusterSelector.matchExpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required
  • key

  • operator

Property Type Description

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (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.

.spec.resources

Description

Resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters.

Type

array

.spec.resources[]

Description

ResourceRef specifies a resource.

Type

object

Required
  • kind

  • name

Property Type Description

kind

string

Kind of the resource. Supported kinds are: Secrets and ConfigMaps.

name

string

Name of the resource that is in the same namespace with ClusterResourceSet object.

.status

Description

ClusterResourceSetStatus defines the observed state of ClusterResourceSet.

Type

object

Property Type Description

conditions

array

Conditions defines current state of the ClusterResourceSet.

conditions[]

object

Condition defines an observation of a Cluster API resource operational state.

observedGeneration

integer

ObservedGeneration reflects the generation of the most recently observed ClusterResourceSet.

.status.conditions

Description

Conditions defines current state of the ClusterResourceSet.

Type

array

.status.conditions[]

Description

Condition defines an observation of a Cluster API resource operational state.

Type

object

Required
  • lastTransitionTime

  • status

  • type

Property Type Description

lastTransitionTime

string

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.

message

string

A human readable message indicating details about the transition. This field may be empty.

reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

status

string

Status of the condition, one of True, False, Unknown.

type

string

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

API endpoints

The following API endpoints are available:

  • /apis/addons.cluster.x-k8s.io/v1beta1/clusterresourcesets

    • GET: list objects of kind ClusterResourceSet

  • /apis/addons.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusterresourcesets

    • DELETE: delete collection of ClusterResourceSet

    • GET: list objects of kind ClusterResourceSet

    • POST: create a ClusterResourceSet

  • /apis/addons.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusterresourcesets/{name}

    • DELETE: delete a ClusterResourceSet

    • GET: read the specified ClusterResourceSet

    • PATCH: partially update the specified ClusterResourceSet

    • PUT: replace the specified ClusterResourceSet

  • /apis/addons.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusterresourcesets/{name}/status

    • GET: read status of the specified ClusterResourceSet

    • PATCH: partially update status of the specified ClusterResourceSet

    • PUT: replace status of the specified ClusterResourceSet

/apis/addons.cluster.x-k8s.io/v1beta1/clusterresourcesets

HTTP method

GET

Description

list objects of kind ClusterResourceSet

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

ClusterResourceSetList schema

401 - Unauthorized

Empty

/apis/addons.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusterresourcesets

HTTP method

DELETE

Description

delete collection of ClusterResourceSet

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list objects of kind ClusterResourceSet

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

ClusterResourceSetList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create a ClusterResourceSet

Table 4. Query parameters
Parameter Type Description

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 5. Body parameters
Parameter Type Description

body

ClusterResourceSet schema

Table 6. HTTP responses
HTTP code Reponse body

200 - OK

ClusterResourceSet schema

201 - Created

ClusterResourceSet schema

202 - Accepted

ClusterResourceSet schema

401 - Unauthorized

Empty

/apis/addons.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusterresourcesets/{name}

Table 7. Global path parameters
Parameter Type Description

name

string

name of the ClusterResourceSet

HTTP method

DELETE

Description

delete a ClusterResourceSet

Table 8. Query parameters
Parameter Type Description

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

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified ClusterResourceSet

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

ClusterResourceSet schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified ClusterResourceSet

Table 11. Query parameters
Parameter Type Description

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 12. HTTP responses
HTTP code Reponse body

200 - OK

ClusterResourceSet schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified ClusterResourceSet

Table 13. Query parameters
Parameter Type Description

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 14. Body parameters
Parameter Type Description

body

ClusterResourceSet schema

Table 15. HTTP responses
HTTP code Reponse body

200 - OK

ClusterResourceSet schema

201 - Created

ClusterResourceSet schema

401 - Unauthorized

Empty

/apis/addons.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusterresourcesets/{name}/status

Table 16. Global path parameters
Parameter Type Description

name

string

name of the ClusterResourceSet

HTTP method

GET

Description

read status of the specified ClusterResourceSet

Table 17. HTTP responses
HTTP code Reponse body

200 - OK

ClusterResourceSet schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update status of the specified ClusterResourceSet

Table 18. Query parameters
Parameter Type Description

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 19. HTTP responses
HTTP code Reponse body

200 - OK

ClusterResourceSet schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace status of the specified ClusterResourceSet

Table 20. Query parameters
Parameter Type Description

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 21. Body parameters
Parameter Type Description

body

ClusterResourceSet schema

Table 22. HTTP responses
HTTP code Reponse body

200 - OK

ClusterResourceSet schema

201 - Created

ClusterResourceSet schema

401 - Unauthorized

Empty