Skip to main content
Version: 13.x (Current)

Create Custom Resources

How to use the Custom Resources​

A Custom Resource allows you to define custom objects that are not part of the standard Console supported resources.

For example, it is possible to:

  • configure Kubernetes Custom Resource that are managed by the cluster (e.g. the Traefik IngressRoute);
  • generate manifests for different runtimes using the External Configuration Generator.

How to manage a Custom Resource​

It is possible to manage the Custom Resource from inside the Design section of the Console.

Create a Custom Resource​

It is possible to create a new Custom Resource from Marketplace or from scratch.

Create a Custom Resource from Marketplace​

To create a resource from Marketplace, you need to select the Custom Resource you want to create.

At the moment, the only supported Custom Resources to create are the ones inside the internal Company marketplace.
To allow the user to create a Custom Resource from marketplace, you need to apply it using miactl (see here for details).

Create from Marketplace

Create a Custom Resource from Scratch​

To create a resource from scratch, you need to provide the following information:

  • name: the name of the Custom Resource. It will be used to generate the manifest, and cannot be changed during updates;
  • apiVersion: the apiVersion of the Custom Resource, it can be any string. If you are creating a Kubernetes Custom Resource, it must be the apiVersion of the Custom Resource Definition;
  • kind: the kind of the Custom Resource, it can be any string. If you are creating a Kubernetes Custom Resource, it must be the kind of the Custom Resource Definition.

In creation, you will see the preview of the generated manifest.

Create from scratch

Update a Custom Resource​

Once you have created a Custom Resource, it will be possible to update it. Click on the Custom Resource you want to update in the sidebar, and you will see a YAML editor.

The Custom Resource has some supported fields, other fields will be ignored. The supported fields are:

  • apiVersion (required): the apiVersion of the Custom Resource, it can be any string. If you are creating a Kubernetes Custom Resource, it must be the apiVersion of the Custom Resource Definition;
  • kind (required): the kind of the Custom Resource, it can be any string. If you are creating a Kubernetes Custom Resource, it must be the kind of the Custom Resource Definition.
  • metadata (required): the metadata of the Custom Resource, it can be any object;
    • name (required): the name of the Custom Resource. It will be used to generate the manifest, and cannot be changed during updates;
    • labels: the labels of the Custom Resource, it can be any key/value pair;
    • annotations: the annotations of the Custom Resource, it can be any key/value pair;
  • spec (required): the spec of the Custom Resource, it can be any object.

Update

Delete a Custom Resource​

To delete a Custom Resource, you have to click on the delete button in the detail page of the Custom Resource.

You need to insert the Custom Resource name and click on the delete button.

Delete Custom Resource

Publish a Custom Resource inside the Marketplace​

It is possible to add the Custom Resource inside the Company Marketplace using miactl.

For example, Custom Resources can be used to configure the Traefik IngressRoute. In order to add the Custom Resource Marketplace item that allows you to create a Traefik IngressRoute you can use the Mia-Platform Marketplace manifest below:

name: 'Traefik IngressRoute'
description: The configuration of the IngressRoute resource for Traefik
type: custom-resource
categoryId: kubernetes-custom-resource
documentation:
  type: externalLink
  url: 'https://docs.mia-platform.eu/docs/infrastructure/paas/tools/traefik#expose-an-endpoint'
resources:
  name: "default"
  meta:
    apiVersion: traefik.io/v1alpha1
    kind: IngressRoute
  labels:
    - name: app.kubernetes.io/instance
      value: "ingress-controller"
  spec:
    entryPoints:
      - "websecure"
    routes:
      - match: Host(`{{PROJECT_HOST}}`)
        kind: Rule
        services:
        - name: "api-gateway"
          port: 8080
itemId: traefik-ingressroute
imageUrl: <IMAGE_URL>
supportedByImageUrl: <SUPPORTED_BY_IMAGE_URL>
supportedBy: <YOUR_COMPANY_NAME>
tenantId: <YOUR_COMPANY_ID>
tip

Remember to change the file, replacing the placeholders with the correct values!

The placeholders in the file above are meant to be used with the following values:

  • <IMAGE_URL>: the URL of the image that represents the Custom Resource;
  • <SUPPORTED_BY_IMAGE_URL>: the URL of the image that represents the company that supports the Custom Resource;
  • <YOUR_COMPANY_NAME>: the name of the company that supports the Custom Resource;
  • <YOUR_COMPANY_ID>: the ID of the company that in which you are creating the Custom Resource.

Once the configuration are ready, you can use miactl to add the Custom Resource to the Company Marketplace (remember to set the correct company id):

miactl marketplace apply --file-path ./path-to-file-folder --company-id <YOUR_COMPANY_ID>

Future Improvements​

In the future, we plan to add more features to the Resources, such as:

  • the ability to add a custom template to be interpolated to generate the manifest;
  • see the Custom Resources runtime inside the Runtime Section of the Console;
  • manage Custom Resource with a specific dynamically generated UI.