Chapter 10. Kubernetes custom actions in Red Hat Developer Hub

Prerequisites

• You have installed Red Hat Developer Hub with the Helm chart.

• In your Helm chart, add a package with the Kubernetes custom action plugin name and update the disabled field. For example:

  global:
    dynamic:
      includes:
        - dynamic-plugins.default.yaml
      plugins:
        - package: ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-kubernetes-dynamic
          disabled: false

  Copy to Clipboard Toggle word wrap
  Note

  The default configuration for a plugin is extracted from the dynamic-plugins.default.yaml file, however, you can use a pluginConfig entry to override the default configuration.

Procedure

• To use a Kubernetes custom action in your custom template, add the following Kubernetes actions to your template:

  action: kubernetes:create-namespace
  id: create-kubernetes-namespace
  name: Create kubernetes namespace
  input:
    namespace: my-rhdh-project
    clusterRef: bar
    token: TOKEN
    skipTLSVerify: false
    caData: Zm9v
    labels: app.io/type=ns; app.io/managed-by=org;

  Copy to Clipboard Toggle word wrap

Procedure

• To create a template, define a Template object as a YAML file.

  The Template object describes the template and its metadata. It also contains required input variables and a list of actions that are executed by the scaffolding service.

  apiVersion: scaffolder.backstage.io/v1beta3
  kind: Template
  metadata:
    name: create-kubernetes-namespace
    title: Create a kubernetes namespace
    description: Create a kubernetes namespace
  spec:
    type: service
    parameters:
      - title: Information
        required: [namespace, token]
        properties:
          namespace:
            title: Namespace name
            type: string
            description: Name of the namespace to be created
          clusterRef:
            title: Cluster reference
            type: string
            description: Cluster resource entity reference from the catalog
            ui:field: EntityPicker
            ui:options:
              catalogFilter:
                kind: Resource
          url:
            title: Url
            type: string
            description: Url of the kubernetes API, will be used if clusterRef is not provided
          token:
            title: Token
            type: string
            ui:field: Secret
            description: Bearer token to authenticate with
          skipTLSVerify:
            title: Skip TLS verification
            type: boolean
            description: Skip TLS certificate verification, not recommended to use in production environment, default to false
          caData:
            title: CA data
            type: string
            ui:field: Secret
            description: Certificate Authority base64 encoded certificate
          labels:
            title: Labels
            type: string
            description: Labels to be applied to the namespace
            ui:widget: textarea
            ui:options:
              rows: 3
            ui:help: 'Hint: Separate multiple labels with a semicolon!'
            ui:placeholder: 'kubernetes.io/type=namespace; app.io/managed-by=org'
    steps:
      - id: create-kubernetes-namespace
        name: Create kubernetes namespace
        action: kubernetes:create-namespace
        input:
          namespace: ${{ parameters.namespace }}
          clusterRef: ${{ parameters.clusterRef }}
          url: ${{ parameters.url }}
          token: ${{ secrets.token }}
          skipTLSVerify: ${{ parameters.skipTLSVerify }}
          caData: ${{ secrets.caData }}
          labels: ${{ parameters.labels }}

  Copy to Clipboard Toggle word wrap