DEV Community

Cover image for What is Kubernetes API?
Ruchita_Varma
Ruchita_Varma

Posted on

What is Kubernetes API?

Before discussing any further on Kubernetes API, let’s first understand what Kubernetes is. To put it simply, Kubernetes is a portable, open-source platform for the orchestration of containers. A container is an encapsulated bundle of software code and its related configuration files, libraries, and other related data packed into a small packet, capable of running independently in any infrastructure.

If we look into the State of Enterprise Report 2021, 85% agree that Kubernetes is the key to cloud-native application strategies.

While Kubernetes adoption is growing at a rapid pace, deploying it is a major challenge that enterprises have to face today. Know more about Kubernetes deployment challenges and the best practices to overcome these here, in this eBook!

The Ultimate Guide to Kubernetes Deployment!

Before I begin telling you about Kubernetes API, let’s make sure you know what API is. API, i.e., application programming interface, is an interface that manages, creates, and configures Kubernetes clusters.

Now, jumping right into the topic, Kubernetes API is the interface or the front end of Kubernetes through which users interact with their Kubernetes Cluster. There are two parts of the Kubernetes Cluster- one is the Control Plane, and the other is the Application Plane.

Good Read: An Introduction to Kubernetes Architecture!

The Kubernetes API is present in the Control Plane of the Kubernetes Cluster. That means the user interacts through the API with the application plane. Even end-users, the cluster itself, and other external components communicate through the Kubernetes API.

Diving deeper into the world of Kubernetes API, it is structurally a resource-based programmatic interface via HTTPS. The standard HTTP verbs (POST, PUT, PATCH, DELETE, GET) allow retrieving, creating, updating, and deleting primary resources.

Let’s get familiar with Kubernetes API Terminology.
-Resource Type: it is the name used in the URL (pods, namespaces, services).
-Kind: The concrete representation of all resource types
-Collection: A list of instances of a resource.
-Resource: The single instance of a resource type that usually represents an object.

Most Kubernetes API resource types are objects: they represent a concrete instance of a concept on the cluster, like a pod or namespace.

API Verbs

Kubernetes also uses its own verb forms. These are easily distinguishable from API verb forms, as they are often written in lowercase. In the case of Kubernetes:

The term list describes returning a collection of resources to distinguish from retrieving a single resource which is usually called a get.

Kubernetes internally classifies PUT requests as either create or update based on the state of the existing object.
An update is different from a patch; the HTTP verb for a patch is PATCH.

Image description

Detection of Changes through Kubernetes API!

-Clients can make an initial request for an object or a collection and then track changes since that initial request using a watch.
-Every Kubernetes object has a resourceVersion field. The client can use it to initiate a watch against the API server. The watch mechanism allows fetching the current state and implementing subsequent changes without losing any event. If the watch gets disconnected, the client can start a new watch from the last returned resourceVersion.
-To subscribe to collections, Kubernetes client libraries offer some form of a standard tool for this list-then-watch logic.

Kubernetes API Gateway

Kubernetes API Gateway is required to manage, secure, and present APIs. Being deployed as a software component, it acts as the single entry point into Virtual Machines within Kubernetes. In other words, the primary responsibility of a Kubernetes API gateway is that it enables multiple APIs, microservices, and backend systems to be accessed reliably and safely by users.
An API gateway deployed in Kubernetes faces two primary challenges:
-It should be able to scale 100s of services and the associated APIs, and
-The gateway should be able to support a broad range of microservice architectures, protocols, and configurations.

Kubernetes API Reference:

Kubernetes is a fully resource-centred system. This means Kubernetes maintains an internal state of resources. Users can fully control Kubernetes using these resources. Based on the current state of the resources, Kubernetes can find out what needs to be done. Because of this, the Kubernetes API reference is organised as a list of resource types with their associated operations.

The Kubernetes API reference helps in knowing about the different terminologies related to Kubernetes for better management of the Kubernetes cluster.

Understanding Kubernetes API, Kubernetes API gateway and Kubernetes API Reference is incomplete without knowing in detail about the Kubernetes architecture. You can refer to this blog on for a better understanding of Kubernetes architecture.

An Introduction to Kubernetes Architecture!

Top comments (0)