Logo
Contact us

API Group

What is an API Group?

An API Group is a logical collection of related Kubernetes API resources. It organizes resources by function and API version. Kubernetes uses API groups to separate resource types within its API architecture. The core group contains basic resources such as Pods and Services. Named groups contain resources for areas such as workloads, networking, and batch processing.

How Does API Group Work?

API Group routing starts when a Kubernetes API calls on one particular resource. The API call includes the API group, API version and resource kind. These values are the API, which API end point and a resource definition, which the API is willing to call. The API call arrives at the API server.

For instance, /apis/apps/v1/deployments indicates a Deployment resource in the api group named apps and in the api version v1. The server checks a request against the resource specification, and carries out the operation for the resource, for example a create/read/update/delete operation. API core resources are stored under /api/v1, while named api groups are stored using paths such as /apis/apps/v1.

Key Characteristics of API Group

  • Logical organization: Groups related Kubernetes resources by their function.
  • Resource identification: Provides group information as part of a resource identity.
  • API versioning: Separates resource definitions across different API versions.
  • API separation: Distinguishes core resources from resources in named groups.
  • Extensibility: Provides a structure for custom resources and Kubernetes extensions.

Benefits of API Group

  • Provides API structure: Organizes the large set of Kubernetes resources into defined API areas.
  • Supports API changes: Provides separate versions for different stages of API development.
  • Improves resource discovery: Gives clients group and version information for locating API resources.
  • Supports custom resources: Provides separate API groups for Kubernetes extensions and custom resource definitions.
  • Supports compatibility: Versioned API interfaces provide stable access for clients, controllers, and management tools.

API Group in Cloud Computing

API groups are a critical aspect of cloud platforms built on top of Kubernetes. Cloud workloads depend on Kubernetes resources for deployment, scaling, networking, batch workloads etc. During resource operation Kubernetes clients, controllers, operators, and automation tools use API group information.

But still different API groups also spread out various parts of functionality in Kubernetes. The API group of apps specific to resources working with workloads, such as Deployments and StatefulSets. The batch API group specific to resources working with batch workloads. The networking.k8s.io API group specific to resources working with networking. These API groups provide cloud native tools and a unified API model across various types of resources.