api_resources

Creates, updates, deletes, gets or lists an api_resources resource.

Overview

Name	api_resources
Type	Resource
Id	k8s.flowcontrol.api_resources

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	name is the plural name of the resource. (default: )
singular_name	string	singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface. (default: ) (wire: singularName)
categories	array	categories is a list of the grouped resources this resource belongs to (e.g. 'all') (x-kubernetes-list-type: atomic)
group	string	group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
kind	string	kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') (default: )
namespaced	boolean	namespaced indicates if a resource is namespaced or not.
short_names	array	shortNames is a list of suggested short names of the resource. (x-kubernetes-list-type: atomic) (wire: shortNames)
storage_version_hash	string	The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates. (wire: storageVersionHash)
verbs	array	verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
version	string	version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	protocol, cluster_addr		get available resources

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_addr	string	(default: localhost, x-stackQL-envVar: KUBE_HOST)
protocol	string	(default: https, enum: [https, http], x-stackQL-envVar: KUBE_PROTOCOL)

SELECT examples

list

get available resources

SELECT
name,
singular_name,
categories,
group,
kind,
namespaced,
short_names,
storage_version_hash,
verbs,
version
FROM k8s.flowcontrol.api_resources
WHERE protocol = '{{ protocol }}' -- required
AND cluster_addr = '{{ cluster_addr }}' -- required
;