# Entando Custom Resources for Kubernetes

Custom resources (CRs) extend the capabilities of the Kubernetes API to customize your Entando Application. The resources use Kubernetes API conventions, leveraging CRUD support, event subscriptions and RBAC out of the box.

A custom resource is introduced by registering a custom resource definition (CRD). This is a YAML or JSON resource that defines the structure with an OpenAPI JSON schema format. It is important to distinguish between CRDs and custom resources. CRDs are static definitions provided by Entando. CRDs are like class definitions for those familiar with programming languages, whereas custom resources are actual instances of those definitions.

The Entando core custom resource is required to run Entando whereas the other resources serve as metadata for Entando components such as the database service. Following are the descriptions of some of the main CRDs.

See Kubernetes custom resources (opens new window) for more details.

# Entando Core Custom Resources

A core set of resources are required for the basic installation of Entando in a Kubernetes cluster. The Entando Operator observes these resources in the namespace. If any of the core custom resources is created, updated or deleted, the operator will trigger a new run-to-completion pod that implements the state change in the cluster. Typically, this results in the deployment of Docker images, services, and sometimes an ingress. Docker images that implement these run-to-completion pods are referred to as Entando Kubernetes Controllers.

# General ResourceRequirements Specifications

All the custom resources that result in Kubernetes Deployments can be configured with specific resource requirements. These settings can be provided under the spec object of the custom resource. It supports the following attributes:

Spec Name Description
spec.resourceRequirements.cpuLimit The maximum CPU allocation for the deployment's primary container.
spec.resourceRequirements.cpuRequest The initial CPU allocation from the node the deployment's primary container is running on.
spec.resourceRequirements.fileUploadLimit The maximum upload file size supported by the deployment.
spec.resourceRequirements.memoryLimit The maximum memory the deployment's primary container will use. If it exceeds this amount, the container may be terminated by Kubernetes.
spec.resourceRequirements.memoryRequest The initial memory requested from the node the deployment's primary container is running on.
spec.resourceRequirements.storageLimit The maximum amount of storage required by the deployment.
spec.resourceRequirements.storageRequest The initial storage requested from the persistence provider. Resizable storage is not supported by all storage providers and this may be the final size of the allocation.
Units These specs require a number and a unit of measurement, e.g. "64Mi".

Consult the official Kubernetes documentation (opens new window) for more information on configuring these attributes.

# Other Custom Resources

# EntandoPlugin CR

An EntandoPlugin CR is a microservice that can be made available to one or more EntandoApp in the cluster. Follow the instructions for using the Entando Blueprint to build your own EntandoPlugin as an example. The deployment resulting from an EntandoPlugin is a single-container pod with the plugin Docker image specified.

The EntandoAppPluginLink custom resource is created when an AppBuilder user links an EntandoPlugin or a plugin is deployed to the current EntandoApp. The Entando Operator processes the resulting EntandoAppPluginLink and creates a path for the plugin on the ingress that exposes the EntandoApp in question. This path is determined by the spec.ingressPath property in the EntandoPlugin CRD. If the plugin resides in a namespace other than that of the EntandoApp, the operator creates a K8s service in the EntandoApp namespace to delegate the service in the plugin's namespace.

# Provided Capability CR

The ProvidedCapability custom resource is used to specify a requirement for a capability (e.g. DBMS, SSO) at a specific level or scope such as namespace, cluster, or labeled. This custom resource is used primarily to allow decoupling of the different controllers that the Entando Operator is made of.

# Learn More

← Databases →