GetKubernetesResource

GetKubernetesResource — retrieves a resource from a Kubernetes cluster.

Request example

group: managed-services.deckhouse.io
version: v1alpha1
resource_type: postgres
resource_name: example-postgres
namespace: default
ignore_not_found: true

Request specification

Response

On success, the action returns the found flag and the object in the resource field. If the object is not found and ignore_not_found is not enabled, the action fails with an error. With ignore_not_found: true, the action succeeds with found: false and without the resource field.

Determining the required Group and Version

Each resource type has its own API group (Group) and version (Version). A complete list of API resources, groups, and versions is available in the Kubernetes documentation.

If you do not know which API groups and versions are required, you can look up the current values. There are several ways to determine them:

Using the d8 k utility

The d8 k explain command shows the apiVersion for a resource.

Example:

d8 k explain deployment

Example output:

GROUP:      apps
KIND:       Deployment
VERSION:    v1

DESCRIPTION:
    Deployment enables declarative updates for Pods and ReplicaSets.
    
FIELDS:
...

Using the documentation

1. Find the resource you need (for example, Deployment).

2. Find the API group and version in the header. For example, for Deployment:

   apiVersion: apps/v1

   Here:

   • API Group is apps;
   • Version is v1.