Build and Publish a Simple Widget

Overview

This tutorial describes how to build and publish a single-component Entando Bundle consisting of a simple widget. Following the steps below will:

• Define the bundle component
• Push the bundle artifact to a Docker registry
• Apply the bundle custom resource to Kubernetes
• Install the bundle into an Entando Application

Prerequisites

• Verify dependencies with the Entando CLI: ent check-env develop
• Authenticated Docker credentials
• A running Entando instance

Bundles are generated using the ent bundle command and its convenience methods.

Create and Deploy a Simple Widget

1. Initialize a bundle project:

   ent bundle init YOUR-BUNDLE-NAME
   

   This generates the required bundle structure by scaffolding default files and folders.

2. Create a widget folder inside the platform folder of your bundle's root folder:

   mkdir -p platform/widgets
   

   Descriptor files are organized by component type, with all micro frontends, microservices and platform-specific components located under their respective parent folders. The parent folder platform and child folder widgets complete the path to widget descriptor files.

3. Create a widget descriptor file inside the widget directory:

   touch platform/widgets/example-widget.yaml
   

   A descriptor file name is a user-defined string of alphanumeric and special characters. The file must reside in its corresponding component folder, e.g. widgets/example-widget.yaml.

4. Add the following definition to the widget descriptor file:

   Note: Retain correct YAML indentation of 2 or 4 spaces. To avoid potential processing conflicts, the code field value must not contain the hyphen character.

   code: example_widget
   titles:
      en: Example Widget
      it: Widget d'esempio
   group: free
   customUi: <h2>Hi from Example Widget</h2>
   

5. Publish the bundle project