ClusterResourceSetBinding [addons.cluster.x-k8s.io/v1beta1] - Cluster APIs | API reference

Specification
API endpoints

Description: ClusterResourceSetBinding lists all matching ClusterResourceSets with the cluster it belongs to.
Type: object

Specification

Property Type Description

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`	ClusterResourceSetBindingSpec defines the desired state of ClusterResourceSetBinding.

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

ClusterResourceSetBindingSpec defines the desired state of ClusterResourceSetBinding.

.spec

Description: ClusterResourceSetBindingSpec defines the desired state of ClusterResourceSetBinding.
Type: object

Property Type Description

Property	Type	Description
`bindings`	`array`	Bindings is a list of ClusterResourceSets and their resources.
`bindings[]`	`object`	ResourceSetBinding keeps info on all of the resources in a ClusterResourceSet.
`clusterName`	`string`	ClusterName is the name of the Cluster this binding applies to. Note: this field mandatory in v1beta2.

bindings

array

Bindings is a list of ClusterResourceSets and their resources.

bindings[]

object

ResourceSetBinding keeps info on all of the resources in a ClusterResourceSet.

clusterName

string

ClusterName is the name of the Cluster this binding applies to. Note: this field mandatory in v1beta2.

.spec.bindings

Description: Bindings is a list of ClusterResourceSets and their resources.
Type: array

.spec.bindings[]

Description

ResourceSetBinding keeps info on all of the resources in a ClusterResourceSet.

Type

object

Required

clusterResourceSetName

Property Type Description

Property	Type	Description
`clusterResourceSetName`	`string`	ClusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding.
`resources`	`array`	Resources is a list of resources that the ClusterResourceSet has.
`resources[]`	`object`	ResourceBinding shows the status of a resource that belongs to a ClusterResourceSet matched by the owner cluster of the ClusterResourceSetBinding object.

clusterResourceSetName

string

ClusterResourceSetName is the name of the ClusterResourceSet that is applied to the owner cluster of the binding.

resources

array

Resources is a list of resources that the ClusterResourceSet has.

resources[]

object

ResourceBinding shows the status of a resource that belongs to a ClusterResourceSet matched by the owner cluster of the ClusterResourceSetBinding object.

.spec.bindings[].resources

Description: Resources is a list of resources that the ClusterResourceSet has.
Type: array

.spec.bindings[].resources[]

Description

ResourceBinding shows the status of a resource that belongs to a ClusterResourceSet matched by the owner cluster of the ClusterResourceSetBinding object.

Type

object

Required

applied
kind
name

Property Type Description

Property	Type	Description
`applied`	`boolean`	Applied is to track if a resource is applied to the cluster or not.
`hash`	`string`	Hash is the hash of a resource’s data. This can be used to decide if a resource is changed. For "ApplyOnce" ClusterResourceSet.spec.strategy, this is no-op as that strategy does not act on change.
`kind`	`string`	Kind of the resource. Supported kinds are: Secrets and ConfigMaps.
`lastAppliedTime`	`string`	LastAppliedTime identifies when this resource was last applied to the cluster.
`name`	`string`	Name of the resource that is in the same namespace with ClusterResourceSet object.

applied

boolean

Applied is to track if a resource is applied to the cluster or not.

hash

string

Hash is the hash of a resource’s data. This can be used to decide if a resource is changed. For "ApplyOnce" ClusterResourceSet.spec.strategy, this is no-op as that strategy does not act on change.

kind

string

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

lastAppliedTime

string

LastAppliedTime identifies when this resource was last applied to the cluster.

name

string

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

API endpoints

The following API endpoints are available:

/apis/addons.cluster.x-k8s.io/v1beta1/clusterresourcesetbindings
- GET: list objects of kind ClusterResourceSetBinding
/apis/addons.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusterresourcesetbindings
- DELETE: delete collection of ClusterResourceSetBinding
- GET: list objects of kind ClusterResourceSetBinding
- POST: create a ClusterResourceSetBinding
/apis/addons.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusterresourcesetbindings/{name}
- DELETE: delete a ClusterResourceSetBinding
- GET: read the specified ClusterResourceSetBinding
- PATCH: partially update the specified ClusterResourceSetBinding
- PUT: replace the specified ClusterResourceSetBinding
/apis/addons.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/clusterresourcesetbindings/{name}/status
- GET: read status of the specified ClusterResourceSetBinding
- PATCH: partially update status of the specified ClusterResourceSetBinding
- PUT: replace status of the specified ClusterResourceSetBinding

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

HTTP method: GET
Description: list objects of kind ClusterResourceSetBinding

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterResourceSetBindingList` schema
401 - Unauthorized	Empty

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

HTTP method: DELETE
Description: delete collection of ClusterResourceSetBinding

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind ClusterResourceSetBinding

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterResourceSetBindingList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a ClusterResourceSetBinding

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`	`ClusterResourceSetBinding` schema

Table 6. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterResourceSetBinding` schema
201 - Created	`ClusterResourceSetBinding` schema
202 - Accepted	`ClusterResourceSetBinding` schema
401 - Unauthorized	Empty

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

Table 7. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ClusterResourceSetBinding

HTTP method: DELETE
Description: delete a ClusterResourceSetBinding

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 ClusterResourceSetBinding

Table 10. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterResourceSetBinding` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ClusterResourceSetBinding

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	`ClusterResourceSetBinding` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ClusterResourceSetBinding

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`	`ClusterResourceSetBinding` schema

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterResourceSetBinding` schema
201 - Created	`ClusterResourceSetBinding` schema
401 - Unauthorized	Empty

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

Table 16. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ClusterResourceSetBinding

HTTP method: GET
Description: read status of the specified ClusterResourceSetBinding

Table 17. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterResourceSetBinding` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified ClusterResourceSetBinding

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	`ClusterResourceSetBinding` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified ClusterResourceSetBinding

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`	`ClusterResourceSetBinding` schema

Table 22. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterResourceSetBinding` schema
201 - Created	`ClusterResourceSetBinding` schema
401 - Unauthorized	Empty