Custom Resources

    A resource is an endpoint in the Kubernetes API that stores a collection of of a certain kind. For example, the built-in pods resource contains a collection of Pod objects.

    A custom resource is an extension of the Kubernetes API that is not necessarily available in a default Kubernetes installation. It represents a customization of a particular Kubernetes installation. However, many core Kubernetes functions are now built using custom resources, making Kubernetes more modular.

    Custom resources can appear and disappear in a running cluster through dynamic registration, and cluster admins can update custom resources independently of the cluster itself. Once a custom resource is installed, users can create and access its objects using kubectl, just as they do for built-in resources like Pods.

    Custom controllers

    On their own, custom resources simply let you store and retrieve structured data. When you combine a custom resource with a custom controller, custom resources provide a true declarative API.

    A declarative API allows you to declare or specify the desired state of your resource and tries to keep the current state of Kubernetes objects in sync with the desired state. The controller interprets the structured data as a record of the user’s desired state, and continually maintains this state.

    You can deploy and update a custom controller on a running cluster, independently of the cluster’s lifecycle. Custom controllers can work with any kind of resource, but they are especially effective when combined with custom resources. The combines custom resources and custom controllers. You can use custom controllers to encode domain knowledge for specific applications into an extension of the Kubernetes API.

    Should I add a custom resource to my Kubernetes Cluster?

    When creating a new API, consider whether to or let your API stand alone.

    In a Declarative API, typically:

    • Your API consists of a relatively small number of relatively small objects (resources).
    • The objects define configuration of applications or infrastructure.
    • The objects are updated relatively infrequently.
    • Humans often need to read and write the objects.
    • The main operations on the objects are CRUD-y (creating, reading, updating and deleting).
    • Transactions across objects are not required: the API represents a desired state, not an exact state.

    Imperative APIs are not declarative. Signs that your API might not be declarative include:

    • The client says “do this”, and then gets a synchronous response back when it is done.
    • The client says “do this”, and then gets an operation ID back, and has to check a separate Operation object to determine completion of the request.
    • You talk about Remote Procedure Calls (RPCs).
    • Directly storing large amounts of data (e.g. > a few kB per object, or >1000s of objects).
    • High bandwidth access (10s of requests per second sustained) needed.
    • Store end-user data (such as images, PII, etc.) or other large-scale data processed by applications.
    • The natural operations on the objects are not CRUD-y.
    • The API is not easily modeled as objects.
    • You chose to represent pending operations with an operation ID or an operation object.

    Should I use a configMap or a custom resource?

    Use a ConfigMap if any of the following apply:

    • There is an existing, well-documented config file format, such as a mysql.cnf or pom.xml.
    • The main use of the config file is for a program running in a Pod on your cluster to consume the file to configure itself.
    • Consumers of the file prefer to consume via file in a Pod or environment variable in a pod, rather than the Kubernetes API.
    • You want to perform rolling updates via Deployment, etc., when the file is updated.

    Use a custom resource (CRD or Aggregated API) if most of the following apply:

    • You want to use Kubernetes client libraries and CLIs to create and update the new resource.
    • You want top-level support from kubectl (for example: kubectl get my-object object-name).
    • You want to build new automation that watches for updates on the new object, and then CRUD other objects, or vice versa.
    • You want to write automation that handles updates to the object.
    • You want to use Kubernetes API conventions like , .status, and .metadata.
    • You want the object to be an abstraction over a collection of controlled resources, or a summarization of other resources.

    Kubernetes provides two ways to add custom resources to your cluster:

    • CRDs are simple and can be created without any programming.
    • requires programming, but allows more control over API behaviors like how data is stored and conversion between API versions.

    Aggregated APIs are subordinate APIServers that sit behind the primary API server, which acts as a proxy. This arrangement is called API Aggregation (AA). To users, it simply appears that the Kubernetes API is extended.

    CRDs allow users to create new types of resources without adding another APIserver. You do not need to understand API Aggregation to use CRDs.

    Regardless of how they are installed, the new resources are referred to as Custom Resources to distinguish them from built-in Kubernetes resources (like pods).

    CustomResourceDefinitions

    The CustomResourceDefinition API resource allows you to define custom resources. Defining a CRD object creates a new custom resource with a name and schema that you specify. The Kubernetes API serves and handles the storage of your custom resource. The name of a CRD object must be a valid .

    This frees you from writing your own API server to handle the custom resource, but the generic nature of the implementation means you have less flexibility than with API server aggregation.

    Refer to the for an example of how to register a new custom resource, work with instances of your new resource type, and use a controller to handle events.

    API server aggregation

    Usually, each resource in the Kubernetes API requires code that handles REST requests and manages persistent storage of objects. The main Kubernetes API server handles built-in resources like pods and services, and can also generically handle custom resources through .

    The aggregation layer allows you to provide specialized implementations for your custom resources by writing and deploying your own standalone API server. The main API server delegates requests to you for the custom resources that you handle, making them available to all of its clients.

    Choosing a method for adding custom resources

    CRDs are easier to use. Aggregated APIs are more flexible. Choose the method that best meets your needs.

    Typically, CRDs are a good fit if:

    • You have a handful of fields
    • You are using the resource within your company, or as part of a small open-source project (as opposed to a commercial product)

    Comparing ease of use

    CRDs are easier to create than Aggregated APIs.

    Aggregated APIs offer more advanced API features and customization of other features, for example: the storage layer.

    Common Features

    When you create a custom resource, either via a CRDs or an AA, you get many features for your API, compared to implementing it outside the Kubernetes platform:

    While creating a CRD does not automatically add any new points of failure (for example, by causing third party code to run on your API server), packages (for example, Charts) or other installation bundles often include CRDs as well as a Deployment of third-party code that implements the business logic for a new custom resource.

    Installing an Aggregated APIserver always involves running a new Deployment.

    Storage

    Custom resources consume storage space in the same way that ConfigMaps do. Creating too many custom resources may overload your API server’s storage space.

    Aggregated API servers may use the same storage as the main API server, in which case the same warning applies.

    CRDs always use the same authentication, authorization, and audit logging as the built-in resources of your API Server.

    If you use RBAC for authorization, most RBAC roles will not grant access to the new resources (except the cluster-admin role or any role created with wildcard rules). You’ll need to explicitly grant access to the new resources. CRDs and Aggregated APIs often come bundled with new role definitions for the types they add.

    Aggregated API servers may or may not use the same authentication, authorization, and auditing as the primary API server.

    Accessing a custom resource

    Kubernetes client libraries can be used to access custom resources. Not all client libraries support custom resources. The go and python client libraries do.

    When you add a custom resource, you can access it using:

    • kubectl
    • The kubernetes dynamic client.
    • A REST client that you write.
    • A client generated using (generating one is an advanced undertaking, but some projects may provide a client along with the CRD or AA).

    What’s next

    • Learn how to .

    Feedback

    Was this page helpful?

    Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it on . Open an issue in the GitHub repo if you want to report a problem or .