From c295a15330f9d8c3ba4055d92434987dbdd07a93 Mon Sep 17 00:00:00 2001 From: themr0c Date: Mon, 13 Jan 2025 18:23:14 +0000 Subject: [PATCH] deploy: 59bd00ecf5c188cdd04d227f3fc240357c97a824 --- main/about/index.html | 36 +- main/audit-log/index.html | 4 +- main/authentication/index.html | 4 +- main/authorization/index.html | 552 +++++++-------- main/configuring/index.html | 16 +- main/customizing/index.html | 34 +- main/install-rhdh-air-gapped/index.html | 4 +- main/install-rhdh-aks/index.html | 4 +- main/install-rhdh-eks/index.html | 4 +- main/install-rhdh-gke/index.html | 4 +- main/install-rhdh-ocp/index.html | 4 +- main/install-rhdh-osd-gcp/index.html | 4 +- main/monitoring-and-logging/index.html | 4 +- main/plugin-rhdh/index.html | 676 +++++++++---------- main/plugins-rhdh-about/index.html | 46 +- main/plugins-rhdh-configure/index.html | 566 ++++++++-------- main/plugins-rhdh-install/index.html | 4 +- main/plugins-rhdh-reference/index.html | 604 ++++++++--------- main/plugins-rhdh-troubleshooting/index.html | 4 +- main/plugins-rhdh-using/index.html | 4 +- main/rel-notes-rhdh/index.html | 4 +- main/telemetry/index.html | 4 +- main/upgrade-rhdh/index.html | 4 +- 23 files changed, 1295 insertions(+), 1295 deletions(-) diff --git a/main/about/index.html b/main/about/index.html index f16f46a3d..abf94f0a0 100644 --- a/main/about/index.html +++ b/main/about/index.html @@ -1,6 +1,6 @@ -About Red Hat Developer Hub
Red Hat Developer Hub 1.4

About Red Hat Developer Hub

Introduction to Red Hat Developer Hub

Red Hat Customer Content Services

Abstract

+About Red Hat Developer Hub
Red Hat Developer Hub 1.4

About Red Hat Developer Hub

Introduction to Red Hat Developer Hub

Red Hat Customer Content Services

Abstract

Red Hat Developer Hub is a developer platform designed to build developer portals. Use Red Hat Developer Hub to provide a streamlined development environment with a centralized software catalog to build high-quality software efficiently.

Red Hat Developer Hub (RHDH) is an enterprise-grade internal developer portal designed to simplify and streamline software development processes. Combined with Red Hat OpenShift Container Platform, RHDH empowers platform engineering teams to create customized portals that improve developer productivity, accelerate onboarding, and enable faster application delivery. By reducing friction and complexity, RHDH allows developers to focus on writing high-quality code while adhering to enterprise-class best practices. @@ -88,67 +88,67 @@ Google Kubernetes Engine

4. Sizing requirements for Red Hat Developer Hub

Scaling the Red Hat Developer Hub requires significant resource allocation. The following table lists the sizing requirements for installing and running Red Hat Developer Hub, including Developer Hub application, database components, and Operator. -

Table 1. Recommended sizing for running Red Hat Developer Hub

ComponentsRed Hat Developer Hub applicationRed Hat Developer Hub databaseRed Hat Developer Hub Operator
+

Table 1. Recommended sizing for running Red Hat Developer Hub

ComponentsRed Hat Developer Hub applicationRed Hat Developer Hub databaseRed Hat Developer Hub Operator

Central Processing Unit (CPU)

- 		+

4 vCPU

- 		+

2 vCPU

- 		+

1 vCPU

-
+

Memory

- 		+

16 GB

- 		+

8 GB

- 		+

1500 Mi

-
+

Storage size

- 		+

2 GB

- 		+

20 GB

- 		+

50 Mi

-
+

Replicas

- 		+

2 or more

- 		+

3 or more

- 		+

1 or more

@@ -158,7 +158,7 @@ To search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products.
  • To create a support case for Red Hat Global Support Services (GSS). For support case creation, select Red Hat Developer Hub as the product and select the appropriate product version. For detailed information about supported platforms, see Supported Platforms and the Red Hat Developer Hub Life Cycle. -

    • Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/audit-log/index.html b/main/audit-log/index.html index 7c74a7e29..dcecf18e8 100644 --- a/main/audit-log/index.html +++ b/main/audit-log/index.html @@ -1,6 +1,6 @@ -Audit log
    Red Hat Developer Hub 1.4

    Audit log

    Tracking user activities, system events, and data changes with Red Hat Developer Hub audit logs

    Red Hat Customer Content Services

    Abstract

    +Audit log
    Red Hat Developer Hub 1.4

    Audit log

    Tracking user activities, system events, and data changes with Red Hat Developer Hub audit logs

    Red Hat Customer Content Services

    Abstract

    As a Red Hat Developer Hub administrator, you can track user activities, system events, and data changes with Developer Hub audit logs.

    1. Audit logs in Red Hat Developer Hub

    Audit logs are a chronological set of records documenting the user activities, system events, and data changes that affect your Red Hat Developer Hub users, administrators, or components. Administrators can view Developer Hub audit logs in the OpenShift Container Platform web console to monitor scaffolder events, changes to the RBAC system, and changes to the Catalog database. Audit logs include the following information: @@ -308,7 +308,7 @@ Tracks GET requests to the /locations/:id endpoint, which returns a location matching the specified location ID

    QueriedCatalogEntityFetch
    Tracks GET requests to the /entities/by-query endpoint, which returns a list of entities matching the specified query -

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/authentication/index.html b/main/authentication/index.html index 4e9fcae47..fd9422351 100644 --- a/main/authentication/index.html +++ b/main/authentication/index.html @@ -1,6 +1,6 @@ -Authentication
    Red Hat Developer Hub 1.4

    Authentication

    Configuring authentication to external services in Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    +Authentication
    Red Hat Developer Hub 1.4

    Authentication

    Configuring authentication to external services in Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    As a Red Hat Developer Hub platform engineer, you can manage authentication of other users to meet the specific needs of your organization.

    Depending on your organization’s security policies, you might require to identify and authorize users before giving them access to resources, such as Red Hat Developer Hub. @@ -968,7 +968,7 @@ backend:start: {"class":"MicrosoftGraphOrgEntityProvider$1","level":"info","message":"Committed 1 msgraph users and 1 msgraph groups in 0.0 seconds.","plugin":"catalog","service":"backstage","taskId":"MicrosoftGraphOrgEntityProvider:default:refresh","taskInstanceId":"88a67ce1-c466-41a4-9760-825e16b946be","timestamp":"2024-06-26 12:23:42"}

  • Log in with a Microsoft Azure account. -

    • Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/authorization/index.html b/main/authorization/index.html index e46a2159e..e84d763d1 100644 --- a/main/authorization/index.html +++ b/main/authorization/index.html @@ -1,6 +1,6 @@ -Authorization
    Red Hat Developer Hub 1.4

    Authorization

    Configuring authorization by using role based access control (RBAC) in Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    +Authorization
    Red Hat Developer Hub 1.4

    Authorization

    Configuring authorization by using role based access control (RBAC) in Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    As a Red Hat Developer Hub platform engineer, you can manage authorizations of other users by using role based access control (RBAC) to meet the specific needs of your organization.

    In Authentication, you learnt how to authenticate users to Red Hat Developer Hub. Developer Hub knowns who the users are. @@ -407,19 +407,19 @@ ]

    [POST] /api/permission/roles/<kind>/<namespace>/<name>

    Creates a role in Developer Hub. -

    Table 1. Request parameters

    NameDescriptionTypePresence
    +

    Table 1. Request parameters

    NameDescriptionTypePresence

    body

    -     		+

    The memberReferences, group, namespace, and name the new role to be created.

    -     		+

    Request body

    -     		+

    Required

    @@ -436,19 +436,19 @@ Updates memberReferences, kind, namespace, or name for a role in Developer Hub.

    Request parameters

    The request body contains the oldRole and newRole objects: -

    NameDescriptionTypePresence
    +

    NameDescriptionTypePresence

    body

    -     		+

    The memberReferences, group, namespace, and name the new role to be created.

    -     		+

    Request body

    -     		+

    Required

    @@ -469,67 +469,67 @@ 
    200 OK

    [DELETE] /api/permission/roles/<kind>/<namespace>/<name>?memberReferences=<VALUE>

    Deletes the specified user or group from a role in Developer Hub. -

    Table 2. Request parameters

    NameDescriptionTypePresence
    +

    Table 2. Request parameters

    NameDescriptionTypePresence

    kind

    -     		+

    Kind of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    namespace

    -     		+

    Namespace of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    name

    -     		+

    Name of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    memberReferences

    -     		+

    Associated group information

    -     		+

    String

    -     		+

    Required

    @@ -538,51 +538,51 @@ 
    204

    [DELETE] /api/permission/roles/<kind>/<namespace>/<name>

    Deletes a specified role from Developer Hub. -

    Table 3. Request parameters

    NameDescriptionTypePresence
    +

    Table 3. Request parameters

    NameDescriptionTypePresence

    kind

    -     		+

    Kind of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    namespace

    -     		+

    Namespace of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    name

    -     		+

    Name of the entity

    -     		+

    String

    -     		+

    Required

    @@ -617,51 +617,51 @@ ]

    [GET] /api/permission/policies/<kind>/<namespace>/<name>

    Returns permission policies related to the specified entity reference. -

    Table 4. Request parameters

    NameDescriptionTypePresence
    +

    Table 4. Request parameters

    NameDescriptionTypePresence

    kind

    -     		+

    Kind of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    namespace

    -     		+

    Namespace of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    name

    -     		+

    Name related to the entity

    -     		+

    String

    -     		+

    Required

    @@ -689,67 +689,67 @@ ]

    [POST] /api/permission/policies

    Creates a permission policy for a specified entity. -

    Table 5. Request parameters

    NameDescriptionTypePresence
    +

    Table 5. Request parameters

    NameDescriptionTypePresence

    entityReference

    -     		+

    Reference values of an entity including kind, namespace, and name

    -     		+

    String

    -     		+

    Required

    -
    +

    permission

    -     		+

    Permission from a specific plugin, resource type, or name

    -     		+

    String

    -     		+

    Required

    -
    +

    policy

    -     		+

    Policy action for the permission, such as create, read, update, delete, or use

    -     		+

    String

    -     		+

    Required

    -
    +

    effect

    -     		+

    Indication of allowing or not allowing the policy

    -     		+

    String

    -     		+

    Required

    @@ -770,51 +770,51 @@ Updates a permission policy for a specified entity.

    Request parameters

    The request body contains the oldPolicy and newPolicy objects: -

    NameDescriptionTypePresence
    +

    NameDescriptionTypePresence

    permission

    -     		+

    Permission from a specific plugin, resource type, or name

    -     		+

    String

    -     		+

    Required

    -
    +

    policy

    -     		+

    Policy action for the permission, such as create, read, update, delete, or use

    -     		+

    String

    -     		+

    Required

    -
    +

    effect

    -     		+

    Indication of allowing or not allowing the policy

    -     		+

    String

    -     		+

    Required

    @@ -851,99 +851,99 @@ 
    200

    [DELETE] /api/permission/policies/<kind>/<namespace>/<name>?permission={value1}&policy={value2}&effect={value3}

    Deletes a permission policy added to the specified entity. -

    Table 6. Request parameters

    NameDescriptionTypePresence
    +

    Table 6. Request parameters

    NameDescriptionTypePresence

    kind

    -     		+

    Kind of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    namespace

    -     		+

    Namespace of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    name

    -     		+

    Name related to the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    permission

    -     		+

    Permission from a specific plugin, resource type, or name

    -     		+

    String

    -     		+

    Required

    -
    +

    policy

    -     		+

    Policy action for the permission, such as create, read, update, delete, or use

    -     		+

    String

    -     		+

    Required

    -
    +

    effect

    -     		+

    Indication of allowing or not allowing the policy

    -     		+

    String

    -     		+

    Required

    @@ -952,51 +952,51 @@ 
    204 No Content

    [DELETE] /api/permission/policies/<kind>/<namespace>/<name>

    Deletes all permission policies added to the specified entity. -

    Table 7. Request parameters

    NameDescriptionTypePresence
    +

    Table 7. Request parameters

    NameDescriptionTypePresence

    kind

    -     		+

    Kind of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    namespace

    -     		+

    Namespace of the entity

    -     		+

    String

    -     		+

    Required

    -
    +

    name

    -     		+

    Name related to the entity

    -     		+

    String

    -     		+

    Required

    @@ -1260,131 +1260,131 @@ ]

    [POST] /api/permission/roles/conditions

    Creates a conditional policy for the specified role. -

    Table 8. Request parameters

    NameDescriptionTypePresence
    +

    Table 8. Request parameters

    NameDescriptionTypePresence

    result

    -     		+

    Always has the value CONDITIONAL

    -     		+

    String

    -     		+

    Required

    -
    +

    roleEntityRef

    -     		+

    String entity reference to the RBAC role, such as role:default/dev

    -     		+

    String

    -     		+

    Required

    -
    +

    pluginId

    -     		+

    Corresponding plugin ID, such as catalog

    -     		+

    String

    -     		+

    Required

    -
    +

    permissionMapping

    -     		+

    Array permission action, such as ['read', 'update', 'delete']

    -     		+

    String array

    -     		+

    Required

    -
    +

    resourceType

    -     		+

    Resource type provided by the plugin, such as catalog-entity

    -     		+

    String

    -     		+

    Required

    -
    +

    conditions

    -     		+

    Condition JSON with parameters or array parameters joined by criteria

    -     		+

    JSON

    -     		+

    Required

    -
    +

    name

    -     		+

    Name of the role

    -     		+

    String

    -     		+

    Required

    -
    +

    metadata.description

    -     		+

    The description of the role

    -     		+

    String

    -     		+

    Optional

    @@ -1411,131 +1411,131 @@ }

    [PUT] /permission/roles/conditions/:id

    Updates a condition policy for a specified ID. -

    Table 9. Request parameters

    NameDescriptionTypePresence
    +

    Table 9. Request parameters

    NameDescriptionTypePresence

    result

    -     		+

    Always has the value CONDITIONAL

    -     		+

    String

    -     		+

    Required

    -
    +

    roleEntityRef

    -     		+

    String entity reference to the RBAC role, such as role:default/dev

    -     		+

    String

    -     		+

    Required

    -
    +

    pluginId

    -     		+

    Corresponding plugin ID, such as catalog

    -     		+

    String

    -     		+

    Required

    -
    +

    permissionMapping

    -     		+

    Array permission action, such as ['read', 'update', 'delete']

    -     		+

    String array

    -     		+

    Required

    -
    +

    resourceType

    -     		+

    Resource type provided by the plugin, such as catalog-entity

    -     		+

    String

    -     		+

    Required

    -
    +

    conditions

    -     		+

    Condition JSON with parameters or array parameters joined by criteria

    -     		+

    JSON

    -     		+

    Required

    -
    +

    name

    -     		+

    Name of the role

    -     		+

    String

    -     		+

    Required

    -
    +

    metadata.description

    -     		+

    The description of the role

    -     		+

    String

    -     		+

    Optional

    @@ -1785,283 +1785,283 @@ Developer Hub supports following permission policies:

    Catalog permissions
    .Catalog permissions -
    NameResource typePolicyDescription
    +
    NameResource typePolicyDescription

    catalog.entity.read

    -     		+

    catalog-entity

    -     		+

    read

    -     		+

    Allows a user or role to read from the catalog

    -
    +

    catalog.entity.create

    -     		  +  

    create

    -     		+

    Allows a user or role to create catalog entities, including registering an existing component in the catalog

    -
    +

    catalog.entity.refresh

    -     		+

    catalog-entity

    -     		+

    update

    -     		+

    Allows a user or role to refresh a single or multiple entities from the catalog

    -
    +

    catalog.entity.delete

    -     		+

    catalog-entity

    -     		+

    delete

    -     		+

    Allows a user or role to delete a single or multiple entities from the catalog

    -
    +

    catalog.location.read

    -     		  +  

    read

    -     		+

    Allows a user or role to read a single or multiple locations from the catalog

    -
    +

    catalog.location.create

    -     		  +  

    create

    -     		+

    Allows a user or role to create locations within the catalog

    -
    +

    catalog.location.delete

    -     		  +  

    delete

    -     		+

    Allows a user or role to delete locations from the catalog

    Bulk import permission
    .Bulk import permission -
    NameResource typePolicyDescription
    +
    NameResource typePolicyDescription

    bulk.import

    -     		+

    bulk-import

    -     		+

    use

    -     		+

    Allows the user to access the bulk import endpoints, such as listing all repositories and organizations accessible by all GitHub integrations and managing the import requests

    Scaffolder permissions
    .Scaffolder permissions -
    NameResource typePolicyDescription
    +
    NameResource typePolicyDescription

    scaffolder.action.execute

    -     		+

    scaffolder-action

    -     		+

    use

    -     		+

    Allows the execution of an action from a template

    -
    +

    scaffolder.template.parameter.read

    -     		+

    scaffolder-template

    -     		+

    read

    -     		+

    Allows a user or role to read a single or multiple one parameters from a template

    -
    +

    scaffolder.template.step.read

    -     		+

    scaffolder-template

    -     		+

    read

    -     		+

    Allows a user or role to read a single or multiple steps from a template

    -
    +

    scaffolder.task.create

    -     		  +  

    create

    -     		+

    Allows a user or role to trigger software templates which create new scaffolder tasks

    -
    +

    scaffolder.task.cancel

    -     		  +  

    use

    -     		+

    Allows a user or role to cancel currently running scaffolder tasks

    -
    +

    scaffolder.task.read

    -     		  +  

    read

    -     		+

    Allows a user or role to read all scaffolder tasks and their associated events and logs

    RBAC permissions
    .RBAC permissions -
    NameResource typePolicyDescription
    +
    NameResource typePolicyDescription

    policy.entity.read

    -     		+

    policy-entity

    -     		+

    read

    -     		+

    Allows a user or role to read permission policies and roles

    -
    +

    policy.entity.create

    -     		+

    policy-entity

    -     		+

    create

    -     		+

    Allows a user or role to create a single or multiple permission policies and roles

    -
    +

    policy.entity.update

    -     		+

    policy-entity

    -     		+

    update

    -     		+

    Allows a user or role to update a single or multiple permission policies and roles

    -
    +

    policy.entity.delete

    -     		+

    policy-entity

    -     		+

    delete

    -     		+

    Allows a user or role to delete a single or multiple permission policies and roles

    Kubernetes permissions
    .Kubernetes permissions -
    NameResource typePolicyDescription
    +
    NameResource typePolicyDescription

    kubernetes.proxy

    -     		  +  

    use

    -     		+

    Allows a user or role to access the proxy endpoint

    @@ -2084,53 +2084,53 @@ params: key: type value: kubernetes-cluster -

    NameResource typePolicyDescription
    +

    NameResource typePolicyDescription

    ocm.entity.read

    -     		  +  

    read

    -     		+

    Allows a user or role to read from the OCM plugin

    -
    +

    ocm.cluster.read

    -     		  +  

    read

    -     		+

    Allows a user or role to read the cluster information in the OCM plugin

    Topology permissions
    .Topology permissions -
    NameResource typePolicyDescription
    +
    NameResource typePolicyDescription

    topology.view.read

    -     		  +  

    read

    -     		+

    Allows a user or role to view the topology plugin

    -
    +

    kubernetes.proxy

    -     		  +  

    use

    -     		+

    Allows a user or role to access the proxy endpoint, allowing the user or role to read pod logs and events within RHDH

    @@ -2150,75 +2150,75 @@ The plugin specifies the parameters supported for conditions. You can access the conditional object schema from the RBAC API endpoint to understand how to construct a conditional JSON object, which is then used by the RBAC backend plugin API.

    A conditional object contains the following parameters: -

    Table 10. Conditional object parameters

    ParameterTypeDescription
    +

    Table 10. Conditional object parameters

    ParameterTypeDescription

    result

    -     		+

    String

    -     		+

    Always has the value CONDITIONAL

    -
    +

    roleEntityRef

    -     		+

    String

    -     		+

    String entity reference to the RBAC role, such as role:default/dev

    -
    +

    pluginId

    -     		+

    String

    -     		+

    Corresponding plugin ID, such as catalog

    -
    +

    permissionMapping

    -     		+

    String array

    -     		+

    Array permission actions, such as ['read', 'update', 'delete']

    -
    +

    resourceType

    -     		+

    String

    -     		+

    Resource type provided by the plugin, such as catalog-entity

    -
    +

    conditions

    -     		+

    JSON

    -     		+

    Condition JSON with parameters or array parameters joined by criteria

    @@ -2576,7 +2576,7 @@ Optional: Modify the file name in the Save as field and click Save.
  • To access the downloaded users list, go to the Downloads folder on your local machine and open the CSV file. -

    • Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/configuring/index.html b/main/configuring/index.html index a8a89c62c..7b4ff7171 100644 --- a/main/configuring/index.html +++ b/main/configuring/index.html @@ -1,6 +1,6 @@ -Configuring
    Red Hat Developer Hub 1.4

    Configuring

    Configuring Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    +Configuring
    Red Hat Developer Hub 1.4

    Configuring

    Configuring Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    Learn how to configure Red Hat Developer Hub for production to work in your IT ecosystem by adding custom config maps and secrets.

    Learn how to configure Red Hat Developer Hub for production to work in your IT ecosystem by adding custom config maps and secrets. @@ -80,7 +80,7 @@ You have provisioned your custom config maps and secrets in your <my-rhdh-project> project.

    Procedure

    1. Author your Backstage custom resource in a my-rhdh-custom-resource.yaml file to use your custom config maps and secrets. -

      Example 1. Minimal my-rhdh-custom-resource.yaml custom resource example

      apiVersion: rhdh.redhat.com/v1alpha3
+					
      Example 1. Minimal my-rhdh-custom-resource.yaml custom resource example
      apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
   name: my-rhdh-custom-resource
@@ -99,7 +99,7 @@
     route:
       enabled: true
   database:
-    enableLocalDb: true
      Example 2. my-rhdh-custom-resource.yaml custom resource example with dynamic plugins and RBAC policies config maps, and external PostgreSQL database secrets.
      apiVersion: rhdh.redhat.com/v1alpha3
+    enableLocalDb: true
      Example 2. my-rhdh-custom-resource.yaml custom resource example with dynamic plugins and RBAC policies config maps, and external PostgreSQL database secrets.
      apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
   name: <my-rhdh-custom-resource>
@@ -135,7 +135,7 @@
     appConfig:
       mountPath: /opt/app-root/src
       configMaps:
-         - name: my-rhdh-app-config
      Example 3. Mount files in the my-rhdh-app-config and rbac-policies config maps.
      spec:
+         - name: my-rhdh-app-config
      Example 3. Mount files in the my-rhdh-app-config and rbac-policies config maps.
      spec:
   application:
     appConfig:
       mountPath: /opt/app-root/src
@@ -143,7 +143,7 @@
          - name: my-rhdh-app-config
          - name: rbac-policies
      spec.application.extraEnvs.envs
      
 												Optionally, enter your additional environment variables that are not secrets, such as your proxy environment variables.
-											
      Example 4. Inject your HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
      spec:
+											
      Example 4. Inject your HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables.
      spec:
   application:
     extraEnvs:
       envs:
@@ -154,11 +154,11 @@
         - name: NO_PROXY
           value: 'localhost,example.org'
      spec.application.extraEnvs.secrets
      
 												Enter your environment variables secret name list.
-											
      Example 5. Inject the environment variables in your my-rhdh-secrets secret
      spec:
+											
      Example 5. Inject the environment variables in your my-rhdh-secrets secret
      spec:
   application:
     extraEnvs:
       secrets:
-         - name: my-rhdh-secrets
      Example 6. Inject the envvironment variables in the my-rhdh-secrets and my-rhdh-database-secrets secrets
      spec:
+         - name: my-rhdh-secrets
      Example 6. Inject the envvironment variables in the my-rhdh-secrets and my-rhdh-database-secrets secrets
      spec:
   application:
     extraEnvs:
       secrets:
@@ -1026,7 +1026,7 @@
 						In high-performance scenarios, enabling useRedisSets can result in memory leaks. If you are running a high-performance application or service, you must set useRedisSets to false.
 					
      
 					When you set useRedisSets to false, the keys are handled individually and Redis sets are not utilized. This configuration might lead to performance issues in production when using the clear function, as it requires iterating over all keys for deletion.
-

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/customizing/index.html b/main/customizing/index.html index 5cc522ab0..cd493aa4e 100644 --- a/main/customizing/index.html +++ b/main/customizing/index.html @@ -1,6 +1,6 @@ -Customizing
    Red Hat Developer Hub 1.4

    Customizing

    Customizing Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    +Customizing
    Red Hat Developer Hub 1.4

    Customizing

    Customizing Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    Learn to customize Red Hat Developer Hub, such as templates, learning paths, tech docs, tech radar, home page, quick access cards, and appearance.

    Learn to customize Red Hat Developer Hub, such as templates, learning paths, tech docs, tech radar, home page, quick access cards, and appearance. @@ -1433,27 +1433,27 @@ md: { w: 10, h: 1, x: 1 } sm: { w: 10, h: 1, x: 1 } xs: { w: 12, h: 1 } - xxs: { w: 12, h: 1 }

    Table 1. Available props

    PropDefaultDescription
    + xxs: { w: 12, h: 1 }

    Table 1. Available props

    PropDefaultDescription

    path

    -     		+

    /search

    -     		+

    Override the linked search path if needed

    -
    +

    queryParam

    -     		+

    query

    -     		+

    Override the search query parameter name if needed

    @@ -1470,27 +1470,27 @@ md: { h: 8 } sm: { h: 8 } xs: { h: 8 } - xxs: { h: 8 }

    Table 2. Available props

    PropDefaultDescription
    + xxs: { h: 8 }

    Table 2. Available props

    PropDefaultDescription

    title

    -     		+

    Quick Access

    -     		+

    Override the linked search path if needed

    -
    +

    path

    -     		+

    none

    -     		+

    Override the search query parameter name if needed

    @@ -1509,15 +1509,15 @@ xs: { h: 1 } xxs: { h: 1 } props: - title: Important info

    Table 3. Available props

    PropDefaultDescription
    + title: Important info

    Table 3. Available props

    PropDefaultDescription

    title

    -     		+

    none

    -     		+

    Title

    @@ -1815,7 +1815,7 @@ - <image host url 1> - <image host url 2> - <image host url 3> - # Other Configurations

    Legal Notice

    + # Other Configurations

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/install-rhdh-air-gapped/index.html b/main/install-rhdh-air-gapped/index.html index 8a91e437d..9392c9b6b 100644 --- a/main/install-rhdh-air-gapped/index.html +++ b/main/install-rhdh-air-gapped/index.html @@ -1,6 +1,6 @@ -Installing Red Hat Developer Hub in an air-gapped environment
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub in an air-gapped environment

    Red Hat Customer Content Services

    Abstract

    +Installing Red Hat Developer Hub in an air-gapped environment
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub in an air-gapped environment

    Red Hat Customer Content Services

    Abstract

    Red Hat Developer Hub is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy an air-gapped Developer Hub instance on any supported platform using either the Operator or Helm chart.

    1. Air-gapped environment

    An air-gapped environment, also known as an air-gapped network or isolated network, ensures security by physically segregating the system or network. This isolation is established to prevent unauthorized access, data transfer, or communication between the air-gapped system and external sources. @@ -124,7 +124,7 @@ tag: latest

  • Install the Red Hat Developer Hub using Helm chart. -

    • Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/install-rhdh-aks/index.html b/main/install-rhdh-aks/index.html index af3097edc..29a89192b 100644 --- a/main/install-rhdh-aks/index.html +++ b/main/install-rhdh-aks/index.html @@ -1,6 +1,6 @@ -Installing Red Hat Developer Hub on Microsoft Azure Kubernetes Service
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub on Microsoft Azure Kubernetes Service

    Red Hat Customer Content Services

    Abstract

    +Installing Red Hat Developer Hub on Microsoft Azure Kubernetes Service
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub on Microsoft Azure Kubernetes Service

    Red Hat Customer Content Services

    Abstract

    Red Hat Developer Hub is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a Developer Hub instance on Microsoft Azure Kubernetes Service (AKS) using either the Operator or Helm chart.

    You can install Red Hat Developer Hub on Microsoft Azure Kubernetes Service (AKS) using one of the following methods: @@ -191,7 +191,7 @@ To upgrade the deployment, run the following command: 

    helm upgrade $DEPLOYMENT_NAME -i https://github.com/openshift-helm-charts/charts/releases/download/redhat-redhat-developer-hub-1.4.0/redhat-developer-hub-1.4.0.tgz

    Delete

    • To delete the deployment, run the following command: - 

      helm -n $NAMESPACE delete $DEPLOYMENT_NAME

    Legal Notice

    + 

    helm -n $NAMESPACE delete $DEPLOYMENT_NAME

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/install-rhdh-eks/index.html b/main/install-rhdh-eks/index.html index 42f478479..a2cd6ef1a 100644 --- a/main/install-rhdh-eks/index.html +++ b/main/install-rhdh-eks/index.html @@ -1,6 +1,6 @@ -Installing Red Hat Developer Hub on Amazon Elastic Kubernetes Service
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub on Amazon Elastic Kubernetes Service

    Red Hat Customer Content Services

    Abstract

    +Installing Red Hat Developer Hub on Amazon Elastic Kubernetes Service
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub on Amazon Elastic Kubernetes Service

    Red Hat Customer Content Services

    Abstract

    Red Hat Developer Hub is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a Developer Hub instance on Amazon Elastic Kubernetes Service (EKS) using either the Operator or Helm chart.

    You can install Red Hat Developer Hub on Amazon Elastic Kubernetes Service (EKS) using one of the following methods: @@ -329,7 +329,7 @@ For the latest chart version, see https://github.com/openshift-helm-charts/charts/tree/main/charts/redhat/redhat/redhat-developer-hub

    Verification

    Wait until the DNS name is responsive, indicating that your Developer Hub instance is ready for use. -

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/install-rhdh-gke/index.html b/main/install-rhdh-gke/index.html index 0b1891310..09ecee891 100644 --- a/main/install-rhdh-gke/index.html +++ b/main/install-rhdh-gke/index.html @@ -1,6 +1,6 @@ -Installing Red Hat Developer Hub on Google Kubernetes Engine
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub on Google Kubernetes Engine

    Red Hat Customer Content Services

    Abstract

    +Installing Red Hat Developer Hub on Google Kubernetes Engine
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub on Google Kubernetes Engine

    Red Hat Customer Content Services

    Abstract

    Red Hat Developer Hub is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a Developer Hub instance on Google Kubernetes Engine (GKE) using either the Operator or Helm chart.

    You can install Red Hat Developer Hub on Google Kubernetes Engine (GKE) using one of the following methods: @@ -411,7 +411,7 @@ To upgrade your deployment, use the following command: 

    helm -n <your_namespace> upgrade -f values.yaml <your_deploy_name> openshift-helm-charts/redhat-developer-hub --version <UPGRADE_CHART_VERSION>

  • To delete your deployment, use the following command: - 

    helm -n <your_namespace> delete <your_deploy_name>

    • Legal Notice

    + 

    helm -n <your_namespace> delete <your_deploy_name>

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/install-rhdh-ocp/index.html b/main/install-rhdh-ocp/index.html index 236d0fc2c..176a79bf4 100644 --- a/main/install-rhdh-ocp/index.html +++ b/main/install-rhdh-ocp/index.html @@ -1,6 +1,6 @@ -Installing Red Hat Developer Hub on OpenShift Container Platform
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub on OpenShift Container Platform

    Red Hat Customer Content Services

    Abstract

    +Installing Red Hat Developer Hub on OpenShift Container Platform
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub on OpenShift Container Platform

    Red Hat Customer Content Services

    Abstract

    Red Hat Developer Hub is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a Developer Hub instance on Red Hat OpenShift Container Platform using either the Operator or Helm chart.

    You can install Red Hat Developer Hub on OpenShift Container Platform by using one of the following installers: @@ -203,7 +203,7 @@ Open the running Developer Hub instance URL in your browser to use Developer Hub.

    Additional resources

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/install-rhdh-osd-gcp/index.html b/main/install-rhdh-osd-gcp/index.html index 2d774f0e4..0eb7195b7 100644 --- a/main/install-rhdh-osd-gcp/index.html +++ b/main/install-rhdh-osd-gcp/index.html @@ -1,6 +1,6 @@ -Installing Red Hat Developer Hub on OpenShift Dedicated on Google Cloud Platform
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub on OpenShift Dedicated on Google Cloud Platform

    Red Hat Customer Content Services

    Abstract

    +Installing Red Hat Developer Hub on OpenShift Dedicated on Google Cloud Platform
    Red Hat Developer Hub 1.4

    Installing Red Hat Developer Hub on OpenShift Dedicated on Google Cloud Platform

    Red Hat Customer Content Services

    Abstract

    Red Hat Developer Hub is an enterprise-grade platform for building developer portals. Administrative users can configure roles, permissions, and other settings to enable other authorized users to deploy a Developer Hub instance on Red Hat OpenShift Dedicated on Google Cloud Platform (GCP) using either the Operator or Helm chart.

    You can install Developer Hub on OpenShift Dedicated on Google Cloud Platform (GCP) using one of the following methods: @@ -77,7 +77,7 @@ Configuring

  • Customizing -

    • Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/monitoring-and-logging/index.html b/main/monitoring-and-logging/index.html index a72e110e2..7229a395b 100644 --- a/main/monitoring-and-logging/index.html +++ b/main/monitoring-and-logging/index.html @@ -1,6 +1,6 @@ -Monitoring and logging
    Red Hat Developer Hub 1.4

    Monitoring and logging

    Tracking performance and capturing insights with monitoring and logging tools in Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    +Monitoring and logging
    Red Hat Developer Hub 1.4

    Monitoring and logging

    Tracking performance and capturing insights with monitoring and logging tools in Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    As a Red Hat Developer Hub Operations or Project Manager, you can monitor performance and gather insights using Red Hat Developer Hub's monitoring and logging tools.

    1. Enabling observability for Red Hat Developer Hub on OpenShift Container Platform

    In OpenShift Container Platform, metrics are exposed through an HTTP service endpoint under the /metrics canonical name. You can create a ServiceMonitor custom resource (CR) to scrape metrics from a service endpoint in a user-defined project. @@ -232,7 +232,7 @@ Go to the Containers tab.

  • Find the backend-backstage container and click it to view real-time log data as it’s generated by the Container Engine. -

    • Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/plugin-rhdh/index.html b/main/plugin-rhdh/index.html index 0f7db108c..a2d9304a0 100644 --- a/main/plugin-rhdh/index.html +++ b/main/plugin-rhdh/index.html @@ -1,6 +1,6 @@ -Configuring plugins in Red Hat Developer Hub
    Red Hat Developer Hub 1.4

    Configuring plugins in Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    +Configuring plugins in Red Hat Developer Hub
    Red Hat Developer Hub 1.4

    Configuring plugins in Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    Red Hat Developer Hub is a developer platform for building developer portals. You can add and configure plugins in Developer Hub to access various software development tools.

    The Red Hat Developer Hub is an enterprise-grade, integrated developer platform, extended through plugins, that helps reduce the friction and frustration of developers while boosting their productivity. @@ -42,19 +42,19 @@ 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.

    2.1.1. Red Hat supported plugins

    Red Hat supports the following 18 plugins: -

    NamePluginVersionPath and required variables
    +

    NamePluginVersionPath and required variables

    Analytics Provider Segment

    -     		+

    @backstage-community/plugin-analytics-provider-segment

    -     		+

    1.10.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment

    @@ -64,35 +64,35 @@

    SEGMENT_TEST_MODE

    -
    +

    Argo CD

    -     		+

    @roadiehq/backstage-plugin-argo-cd

    -     		+

    2.8.4

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd

    -
    +

    Argo CD

    -     		+

    @roadiehq/backstage-plugin-argo-cd-backend

    -     		+

    3.2.3

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd-backend-dynamic

    @@ -114,38 +114,38 @@

    ARGOCD_AUTH_TOKEN2

    -
    +

    GitHub

    -     		+

    @backstage/plugin-catalog-backend-module-github

    -     		+

    0.7.6

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic

    GITHUB_ORG

    -
    +

    GitHub Org

    -     		+

    @backstage/plugin-catalog-backend-module-github-org

    -     		+

    0.3.3

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic

    @@ -155,19 +155,19 @@

    GITHUB_ORG

    -
    +

    Keycloak

    -     		+

    @backstage-community/plugin-catalog-backend-module-keycloak

    -     		+

    3.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic

    @@ -186,19 +186,19 @@

    KEYCLOAK_CLIENT_SECRET

    -
    +

    Kubernetes

    -     		+

    @backstage/plugin-kubernetes-backend

    -     		+

    0.18.7

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-kubernetes-backend-dynamic

    @@ -211,35 +211,35 @@

    K8S_CLUSTER_TOKEN

    -
    +

    OCM

    -     		+

    @backstage-community/plugin-ocm

    -     		+

    5.2.4

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-ocm

    -
    +

    OCM

    -     		+

    @backstage-community/plugin-ocm-backend

    -     		+

    5.2.3

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-ocm-backend-dynamic

    @@ -252,147 +252,147 @@

    OCM_SA_TOKEN

    -
    +

    Quay

    -     		+

    @backstage-community/plugin-quay

    -     		+

    1.14.4

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-quay

    -
    +

    Quay

    -     		+

    @backstage-community/plugin-scaffolder-backend-module-quay

    -     		+

    2.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-quay-dynamic

    -
    +

    RBAC

    -     		+

    @backstage-community/plugin-rbac

    -     		+

    1.33.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-rbac

    -
    +

    Regex

    -     		+

    @backstage-community/plugin-scaffolder-backend-module-regex

    -     		+

    2.2.3

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-regex-dynamic

    -
    +

    Signals

    -     		+

    @backstage/plugin-signals-backend

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic

    -
    +

    TechDocs

    -     		+

    @backstage/plugin-techdocs

    -     		+

    1.11.0

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-techdocs

    -
    +

    TechDocs

    -     		+

    @backstage/plugin-techdocs-backend

    -     		+

    1.11.1

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-techdocs-backend-dynamic

    -
    +

    Tekton

    -     		+

    @backstage-community/plugin-tekton

    -     		+

    3.16.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-tekton

    -
    +

    Topology

    -     		+

    @backstage-community/plugin-topology

    -     		+

    1.29.7

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-topology

    @@ -406,19 +406,19 @@ For more information on Red Hat Technology Preview features, see Technology Preview Features Scope.

    2.1.2.1. Red Hat Technology Preview plugins

    Red Hat provides Technology Preview support for the following 54 plugins: -

    NamePluginVersionPath and required variables
    +

    NamePluginVersionPath and required variables

    3scale

    -     		+

    @backstage-community/plugin-3scale-backend

    -     		+

    3.0.3

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-3scale-backend-dynamic

    @@ -428,19 +428,19 @@

    THREESCALE_ACCESS_TOKEN

    -
    +

    Ansible Automation Platform (AAP)

    -     		+

    @janus-idp/backstage-plugin-aap-backend

    -     		+

    2.2.0

    -     		+

    ./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic

    @@ -450,35 +450,35 @@

    AAP_AUTH_TOKEN

    -
    +

    ACR

    -     		+

    @backstage-community/plugin-acr

    -     		+

    1.8.5

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-acr

    -
    +

    Argo CD

    -     		+

    @roadiehq/scaffolder-backend-argocd

    -     		+

    1.2.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-scaffolder-backend-argocd-dynamic

    @@ -500,67 +500,67 @@

    ARGOCD_AUTH_TOKEN2

    -
    +

    Argo CD (Red Hat)

    -     		+

    @backstage-community/plugin-redhat-argocd

    -     		+

    1.11.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-redhat-argocd

    -
    +

    Azure

    -     		+

    @backstage/plugin-scaffolder-backend-module-azure

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-azure-dynamic

    -
    +

    Azure Devops

    -     		+

    @backstage-community/plugin-azure-devops

    -     		+

    0.6.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-azure-devops

    -
    +

    Azure Devops

    -     		+

    @backstage-community/plugin-azure-devops-backend

    -     		+

    0.8.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-azure-devops-backend-dynamic

    @@ -570,297 +570,297 @@

    AZURE_ORG

    -
    +

    Azure Repositories

    -     		+

    @parfuemerie-douglas/scaffolder-backend-module-azure-repositories

    -     		+

    0.3.0

    -     		+

    ./dynamic-plugins/dist/parfuemerie-douglas-scaffolder-backend-module-azure-repositories-dynamic

    -
    +

    Bitbucket Cloud

    -     		+

    @backstage/plugin-catalog-backend-module-bitbucket-cloud

    -     		+

    0.4.1

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-bitbucket-cloud-dynamic

    BITBUCKET_WORKSPACE

    -
    +

    Bitbucket Cloud

    -     		+

    @backstage/plugin-scaffolder-backend-module-bitbucket-cloud

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-bitbucket-cloud-dynamic

    -
    +

    Bitbucket Server

    -     		+

    @backstage/plugin-catalog-backend-module-bitbucket-server

    -     		+

    0.2.3

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-bitbucket-server-dynamic

    BITBUCKET_HOST

    -
    +

    Bitbucket Server

    -     		+

    @backstage/plugin-scaffolder-backend-module-bitbucket-server

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-bitbucket-server-dynamic

    -
    +

    Bulk Import

    -     		+

    @red-hat-developer-hub/backstage-plugin-bulk-import

    -     		+

    1.10.3

    -     		+

    ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import

    -
    +

    Bulk Import

    -     		+

    @red-hat-developer-hub/backstage-plugin-bulk-import-backend

    -     		+

    5.2.0

    -     		+

    ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import-backend-dynamic

    -
    +

    Datadog

    -     		+

    @roadiehq/backstage-plugin-datadog

    -     		+

    2.4.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-datadog

    -
    +

    Dynatrace

    -     		+

    @backstage-community/plugin-dynatrace

    -     		+

    10.0.8

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-dynatrace

    -
    +

    Gerrit

    -     		+

    @backstage/plugin-scaffolder-backend-module-gerrit

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-gerrit-dynamic

    -
    +

    GitHub

    -     		+

    @backstage/plugin-scaffolder-backend-module-github

    -     		+

    0.5.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-github-dynamic

    -
    +

    GitHub Actions

    -     		+

    @backstage-community/plugin-github-actions

    -     		+

    0.6.24

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-github-actions

    -
    +

    GitHub Insights

    -     		+

    @roadiehq/backstage-plugin-github-insights

    -     		+

    2.5.1

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-github-insights

    -
    +

    GitHub Issues

    -     		+

    @backstage-community/plugin-github-issues

    -     		+

    0.4.8

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-github-issues

    -
    +

    GitHub Pull Requests

    -     		+

    @roadiehq/backstage-plugin-github-pull-requests

    -     		+

    2.6.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-github-pull-requests

    -
    +

    GitLab

    -     		+

    @immobiliarelabs/backstage-plugin-gitlab

    -     		+

    6.6.1

    -     		+

    ./dynamic-plugins/dist/immobiliarelabs-backstage-plugin-gitlab

    -
    +

    GitLab

    -     		+

    @backstage/plugin-catalog-backend-module-gitlab

    -     		+

    0.4.4

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-gitlab-dynamic

    -
    +

    GitLab

    -     		+

    @immobiliarelabs/backstage-plugin-gitlab-backend

    -     		+

    6.7.0

    -     		+

    ./dynamic-plugins/dist/immobiliarelabs-backstage-plugin-gitlab-backend-dynamic

    @@ -870,83 +870,83 @@

    GITLAB_TOKEN

    -
    +

    GitLab

    -     		+

    @backstage/plugin-scaffolder-backend-module-gitlab

    -     		+

    0.6.1

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-gitlab-dynamic

    -
    +

    GitLab Org

    -     		+

    @backstage/plugin-catalog-backend-module-gitlab-org

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-gitlab-org-dynamic

    -
    +

    Http Request

    -     		+

    @roadiehq/scaffolder-backend-module-http-request

    -     		+

    5.0.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-scaffolder-backend-module-http-request-dynamic

    -
    +

    Jenkins

    -     		+

    @backstage-community/plugin-jenkins

    -     		+

    0.12.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-jenkins

    -
    +

    Jenkins

    -     		+

    @backstage-community/plugin-jenkins-backend

    -     		+

    0.6.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-jenkins-backend-dynamic

    @@ -959,163 +959,163 @@

    JENKINS_TOKEN

    -
    +

    JFrog Artifactory

    -     		+

    @backstage-community/plugin-jfrog-artifactory

    -     		+

    1.10.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-jfrog-artifactory

    -
    +

    Jira

    -     		+

    @roadiehq/backstage-plugin-jira

    -     		+

    2.8.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-jira

    -
    +

    Kubernetes

    -     		+

    @backstage/plugin-kubernetes

    -     		+

    0.11.16

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-kubernetes

    -
    +

    Ldap

    -     		+

    @backstage/plugin-catalog-backend-module-ldap

    -     		+

    0.9.1

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-ldap-dynamic

    -
    +

    Lighthouse

    -     		+

    @backstage-community/plugin-lighthouse

    -     		+

    0.4.24

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-lighthouse

    -
    +

    MS Graph

    -     		+

    @backstage/plugin-catalog-backend-module-msgraph

    -     		+

    0.6.3

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-msgraph-dynamic

    -
    +

    Nexus Repository Manager

    -     		+

    @backstage-community/plugin-nexus-repository-manager

    -     		+

    1.10.6

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-nexus-repository-manager

    -
    +

    Notifications

    -     		+

    @backstage/plugin-notifications

    -     		+

    0.3.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-notifications

    -
    +

    Notifications

    -     		+

    @backstage/plugin-notifications-backend

    -     		+

    0.4.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic

    -
    +

    Notifications Module Email

    -     		+

    @backstage/plugin-notifications-backend-module-email

    -     		+

    0.3.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-notifications-backend-module-email-dynamic

    @@ -1131,35 +1131,35 @@

    EMAIL_SENDER

    -
    +

    PagerDuty

    -     		+

    @pagerduty/backstage-plugin

    -     		+

    0.15.2

    -     		+

    ./dynamic-plugins/dist/pagerduty-backstage-plugin

    -
    +

    PagerDuty

    -     		+

    @pagerduty/backstage-plugin-backend

    -     		+

    0.9.2

    -     		+

    ./dynamic-plugins/dist/pagerduty-backstage-plugin-backend-dynamic

    @@ -1175,67 +1175,67 @@

    PAGERDUTY_SUBDOMAIN

    -
    +

    Pingidentity

    -     		+

    @backstage-community/plugin-catalog-backend-module-pingidentity

    -     		+

    0.1.5

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-pingidentity-dynamic

    -
    +

    Scaffolder Relation Processor

    -     		+

    @backstage-community/plugin-catalog-backend-module-scaffolder-relation-processor

    -     		+

    2.0.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-scaffolder-relation-processor-dynamic

    -
    +

    Security Insights

    -     		+

    @roadiehq/backstage-plugin-security-insights

    -     		+

    2.4.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-security-insights

    -
    +

    ServiceNow

    -     		+

    @backstage-community/plugin-scaffolder-backend-module-servicenow

    -     		+

    2.2.3

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-servicenow-dynamic

    @@ -1248,51 +1248,51 @@

    SERVICENOW_PASSWORD

    -
    +

    Signals

    -     		+

    @backstage/plugin-signals

    -     		+

    0.0.11

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-signals

    -
    +

    SonarQube

    -     		+

    @backstage-community/plugin-sonarqube

    -     		+

    0.8.7

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-sonarqube

    -
    +

    SonarQube

    -     		+

    @backstage-community/plugin-sonarqube-backend

    -     		+

    0.3.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-sonarqube-backend-dynamic

    @@ -1302,70 +1302,70 @@

    SONARQUBE_TOKEN

    -
    +

    SonarQube

    -     		+

    @backstage-community/plugin-scaffolder-backend-module-sonarqube

    -     		+

    2.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-sonarqube-dynamic

    -
    +

    Tech Radar

    -     		+

    @backstage-community/plugin-tech-radar

    -     		+

    1.0.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-tech-radar

    -
    +

    Tech Radar

    -     		+

    @backstage-community/plugin-tech-radar-backend

    -     		+

    1.0.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-tech-radar-backend-dynamic

    TECH_RADAR_DATA_URL

    -
    +

    Utils

    -     		+

    @roadiehq/scaffolder-backend-module-utils

    -     		+

    3.0.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-scaffolder-backend-module-utils-dynamic

    @@ -1373,51 +1373,51 @@ A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See Other installable plugins in the Configuring plugins in Red Hat Developer Hub guide for further details. See Dynamic plugins support matrix.

    2.2. Other installable plugins

    The following Technology Preview plugins are not preinstalled and must be installed from an external source: -

    NamePluginVersionInstallation Details
    +

    NamePluginVersionInstallation Details

    Ansible Automation Platform Frontend

    -     		+

    @ansible/plugin-backstage-rhaap

    -     		+

    1.0.0

    -     		+

    Learn more

    -
    +

    Ansible Automation Platform

    -     		+

    @ansible/plugin-backstage-rhaap-backend

    -     		+

    1.0.0

    -     		+

    Learn more

    -
    +

    Ansible Automation Platform Scaffolder Backend

    -     		+

    @ansible/plugin-scaffolder-backend-module-backstage-rhaap

    -     		+

    1.0.0

    -     		+

    Learn more

    @@ -1493,147 +1493,147 @@ Communication between Developer Hub and Keycloak is enabled by using the Keycloak API. Username and password, or client credentials are supported authentication methods.

    The following table describes the parameters that you can configure to enable the plugin under catalog.providers.keycloakOrg.<ENVIRONMENT_NAME> object in the app-config.yaml file: -

    NameDescriptionDefault ValueRequired
    +

    NameDescriptionDefault ValueRequired

    baseUrl

    -     		+

    Location of the Keycloak server, such as https://localhost:8443/auth. Note that the newer versions of Keycloak omit the /auth context path.

    -     		+

    ""

    -     		+

    Yes

    -
    +

    realm

    -     		+

    Realm to synchronize

    -     		+

    master

    -     		+

    No

    -
    +

    loginRealm

    -     		+

    Realm used to authenticate

    -     		+

    master

    -     		+

    No

    -
    +

    username

    -     		+

    Username to authenticate

    -     		+

    ""

    -     		+

    Yes if using password based authentication

    -
    +

    password

    -     		+

    Password to authenticate

    -     		+

    ""

    -     		+

    Yes if using password based authentication

    -
    +

    clientId

    -     		+

    Client ID to authenticate

    -     		+

    ""

    -     		+

    Yes if using client credentials based authentication

    -
    +

    clientSecret

    -     		+

    Client Secret to authenticate

    -     		+

    ""

    -     		+

    Yes if using client credentials based authentication

    -
    +

    userQuerySize

    -     		+

    Number of users to query at a time

    -     		+

    100

    -     		+

    No

    -
    +

    groupQuerySize

    -     		+

    Number of groups to query at a time

    -     		+

    100

    -     		+

    No

    @@ -1832,7 +1832,7 @@ Select the Overview tab and navigate to the Deployment summary section to review the summary of your application’s deployment across namespaces. Additionally, select an appropriate Argo CD app to open the deployment details in Argo CD, or select a commit ID from the Revision column to review the changes in GitLab or GitHub.

    Deployment summary

    Additional resources

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/plugins-rhdh-about/index.html b/main/plugins-rhdh-about/index.html index bbdc789b6..b59377b80 100644 --- a/main/plugins-rhdh-about/index.html +++ b/main/plugins-rhdh-about/index.html @@ -1,6 +1,6 @@ -Introduction to plugins
    Red Hat Developer Hub 1.4

    Introduction to plugins

    Red Hat Customer Content Services

    Abstract

    +Introduction to plugins
    Red Hat Developer Hub 1.4

    Introduction to plugins

    Red Hat Customer Content Services

    Abstract

    The Red Hat Developer Hub (RHDH) application offers a unified platform with various plugins. Using the plugin ecosystem within the Developer Hub application, you can access your development infrastructure and software development tools.

    1. Plugins in Red Hat Developer Hub

    The Red Hat Developer Hub (RHDH) application offers a unified platform with various plugins. Using the plugin ecosystem within the RHDH application, you can access any kind of development infrastructure or software development tool. @@ -42,91 +42,91 @@ Static plugins are built into the core of the RHDH application. Installing or updating a static plugin requires a restart of the application after installing the plugin.

    The following table provides a comparison between static and dynamic plugins in RHDH. -

    FeatureStatic pluginsDynamic plugins
    +

    FeatureStatic pluginsDynamic plugins

    Integration

    -     		+

    Built into the core application.

    -     		+

    Loaded at runtime, separate from the core.

    -
    +

    Flexibility

    -     		+

    Requires core changes to add or update features.

    -     		+

    Add or update features without core changes.

    -
    +

    Development speed

    -     		+

    Slower, requires a complete rebuild for new features.

    -     		+

    Faster, deploy new functionalities quickly.

    -
    +

    Customization

    -     		+

    Limited to predefined options.

    -     		+

    Easy to tailor platform by loading specific plugins.

    -
    +

    Maintenance

    -     		+

    More complex due to tightly coupled features.

    -     		+

    Enhanced by modular architecture.

    -
    +

    Resource use

    -     		+

    All features loaded at startup.

    -     		+

    Only necessary plugins loaded dynamically.

    -
    +

    Innovation

    -     		+

    Slower experimentation due to rebuild cycles.

    -     		+

    Quick experimentation with new plugins.

    -

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/plugins-rhdh-configure/index.html b/main/plugins-rhdh-configure/index.html index 07cced422..a46b72939 100644 --- a/main/plugins-rhdh-configure/index.html +++ b/main/plugins-rhdh-configure/index.html @@ -1,6 +1,6 @@ -Configuring dynamic plugins
    Red Hat Developer Hub 1.4

    Configuring dynamic plugins

    Red Hat Customer Content Services

    Abstract

    +Configuring dynamic plugins
    Red Hat Developer Hub 1.4

    Configuring dynamic plugins

    Red Hat Customer Content Services

    Abstract

    As a platform engineer, you can configure dynamic plugins in RHDH to access your development infrastructure or software development tools.

    1. Installing Ansible plug-ins for Red Hat Developer Hub

    Ansible plug-ins for Red Hat Developer Hub deliver an Ansible-specific portal experience with curated learning paths, push-button content creation, integrated development tools, and other opinionated resources. @@ -115,147 +115,147 @@ Communication between Developer Hub and Keycloak is enabled by using the Keycloak API. Username and password, or client credentials are supported authentication methods.

    The following table describes the parameters that you can configure to enable the plugin under catalog.providers.keycloakOrg.<ENVIRONMENT_NAME> object in the app-config.yaml file: -

    NameDescriptionDefault ValueRequired
    +

    NameDescriptionDefault ValueRequired

    baseUrl

    -     		+

    Location of the Keycloak server, such as https://localhost:8443/auth.

    -     		+

    ""

    -     		+

    Yes

    -
    +

    realm

    -     		+

    Realm to synchronize

    -     		+

    master

    -     		+

    No

    -
    +

    loginRealm

    -     		+

    Realm used to authenticate

    -     		+

    master

    -     		+

    No

    -
    +

    username

    -     		+

    Username to authenticate

    -     		+

    ""

    -     		+

    Yes if using password based authentication

    -
    +

    password

    -     		+

    Password to authenticate

    -     		+

    ""

    -     		+

    Yes if using password based authentication

    -
    +

    clientId

    -     		+

    Client ID to authenticate

    -     		+

    ""

    -     		+

    Yes if using client credentials based authentication

    -
    +

    clientSecret

    -     		+

    Client Secret to authenticate

    -     		+

    ""

    -     		+

    Yes if using client credentials based authentication

    -
    +

    userQuerySize

    -     		+

    Number of users to query at a time

    -     		+

    100

    -     		+

    No

    -
    +

    groupQuerySize

    -     		+

    Number of groups to query at a time

    -     		+

    100

    -     		+

    No

    @@ -847,857 +847,857 @@ DELETE: Deletes a resource

    8.2.1. ServiceNow custom actions

    [GET] servicenow:now:table:retrieveRecord

    Retrieves information of a specified record from a table in the Developer Hub. -

    Table 1. Input parameters

    NameTypeRequirementDescription
    +

    Table 1. Input parameters

    NameTypeRequirementDescription

    tableName

    -     		+

    string

    -     		+

    Required

    -     		+

    Name of the table to retrieve the record from

    -
    +

    sysId

    -     		+

    string

    -     		+

    Required

    -     		+

    Unique identifier of the record to retrieve

    -
    +

    sysparmDisplayValue

    -     		+

    enum("true", "false", "all")

    -     		+

    Optional

    -     		+

    Returns field display values such as true, actual values as false, or both. The default value is false.

    -
    +

    sysparmExcludeReferenceLink

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to exclude Table API links for reference fields. The default value is false.

    -
    +

    sysparmFields

    -     		+

    string[]

    -     		+

    Optional

    -     		+

    Array of fields to return in the response

    -
    +

    sysparmView

    -     		+

    string

    -     		+

    Optional

    -     		+

    Renders the response according to the specified UI view. You can override this parameter using sysparm_fields.

    -
    +

    sysparmQueryNoDomain

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to access data across domains if authorized. The default value is false.

    -

    Table 2. Output parameters

    NameTypeDescription
    +

    Table 2. Output parameters

    NameTypeDescription

    result

    -     		+

    Record<PropertyKey, unknown>

    -     		+

    The response body of the request

    [GET] servicenow:now:table:retrieveRecords

    Retrieves information about multiple records from a table in the Developer Hub. -

    Table 3. Input parameters

    NameTypeRequirementDescription
    +

    Table 3. Input parameters

    NameTypeRequirementDescription

    tableName

    -     		+

    string

    -     		+

    Required

    -     		+

    Name of the table to retrieve the records from

    -
    +

    sysparamQuery

    -     		+

    string

    -     		+

    Optional

    -     		+

    Encoded query string used to filter the results

    -
    +

    sysparmDisplayValue

    -     		+

    enum("true", "false", "all")

    -     		+

    Optional

    -     		+

    Returns field display values such as true, actual values as false, or both. The default value is false.

    -
    +

    sysparmExcludeReferenceLink

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to exclude Table API links for reference fields. The default value is false.

    -
    +

    sysparmSuppressPaginationHeader

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to suppress pagination header. The default value is false.

    -
    +

    sysparmFields

    -     		+

    string[]

    -     		+

    Optional

    -     		+

    Array of fields to return in the response

    -
    +

    sysparmLimit

    -     		+

    int

    -     		+

    Optional

    -     		+

    Maximum number of results returned per page. The default value is 10,000.

    -
    +

    sysparmView

    -     		+

    string

    -     		+

    Optional

    -     		+

    Renders the response according to the specified UI view. You can override this parameter using sysparm_fields.

    -
    +

    sysparmQueryCategory

    -     		+

    string

    -     		+

    Optional

    -     		+

    Name of the query category to use for queries

    -
    +

    sysparmQueryNoDomain

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to access data across domains if authorized. The default value is false.

    -
    +

    sysparmNoCount

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Does not execute a select count(*) on the table. The default value is false.

    -

    Table 4. Output parameters

    NameTypeDescription
    +

    Table 4. Output parameters

    NameTypeDescription

    result

    -     		+

    Record<PropertyKey, unknown>

    -     		+

    The response body of the request

    [POST] servicenow:now:table:createRecord

    Creates a record in a table in the Developer Hub. -

    Table 5. Input parameters

    NameTypeRequirementDescription
    +

    Table 5. Input parameters

    NameTypeRequirementDescription

    tableName

    -     		+

    string

    -     		+

    Required

    -     		+

    Name of the table to save the record in

    -
    +

    requestBody

    -     		+

    Record<PropertyKey, unknown>

    -     		+

    Optional

    -     		+

    Field name and associated value for each parameter to define in the specified record

    -
    +

    sysparmDisplayValue

    -     		+

    enum("true", "false", "all")

    -     		+

    Optional

    -     		+

    Returns field display values such as true, actual values as false, or both. The default value is false.

    -
    +

    sysparmExcludeReferenceLink

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to exclude Table API links for reference fields. The default value is false.

    -
    +

    sysparmFields

    -     		+

    string[]

    -     		+

    Optional

    -     		+

    Array of fields to return in the response

    -
    +

    sysparmInputDisplayValue

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set field values using their display value such as true or actual value as false. The default value is false.

    -
    +

    sysparmSuppressAutoSysField

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to suppress auto-generation of system fields. The default value is false.

    -
    +

    sysparmView

    -     		+

    string

    -     		+

    Optional

    -     		+

    Renders the response according to the specified UI view. You can override this parameter using sysparm_fields.

    -

    Table 6. Output parameters

    NameTypeDescription
    +

    Table 6. Output parameters

    NameTypeDescription

    result

    -     		+

    Record<PropertyKey, unknown>

    -     		+

    The response body of the request

    [PUT] servicenow:now:table:modifyRecord

    Modifies a record in a table in the Developer Hub. -

    Table 7. Input parameters

    NameTypeRequirementDescription
    +

    Table 7. Input parameters

    NameTypeRequirementDescription

    tableName

    -     		+

    string

    -     		+

    Required

    -     		+

    Name of the table to modify the record from

    -
    +

    sysId

    -     		+

    string

    -     		+

    Required

    -     		+

    Unique identifier of the record to modify

    -
    +

    requestBody

    -     		+

    Record<PropertyKey, unknown>

    -     		+

    Optional

    -     		+

    Field name and associated value for each parameter to define in the specified record

    -
    +

    sysparmDisplayValue

    -     		+

    enum("true", "false", "all")

    -     		+

    Optional

    -     		+

    Returns field display values such as true, actual values as false, or both. The default value is false.

    -
    +

    sysparmExcludeReferenceLink

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to exclude Table API links for reference fields. The default value is false.

    -
    +

    sysparmFields

    -     		+

    string[]

    -     		+

    Optional

    -     		+

    Array of fields to return in the response

    -
    +

    sysparmInputDisplayValue

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set field values using their display value such as true or actual value as false. The default value is false.

    -
    +

    sysparmSuppressAutoSysField

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to suppress auto-generation of system fields. The default value is false.

    -
    +

    sysparmView

    -     		+

    string

    -     		+

    Optional

    -     		+

    Renders the response according to the specified UI view. You can override this parameter using sysparm_fields.

    -
    +

    sysparmQueryNoDomain

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to access data across domains if authorized. The default value is false.

    -

    Table 8. Output parameters

    NameTypeDescription
    +

    Table 8. Output parameters

    NameTypeDescription

    result

    -     		+

    Record<PropertyKey, unknown>

    -     		+

    The response body of the request

    [PATCH] servicenow:now:table:updateRecord

    Updates a record in a table in the Developer Hub. -

    Table 9. Input parameters

    NameTypeRequirementDescription
    +

    Table 9. Input parameters

    NameTypeRequirementDescription

    tableName

    -     		+

    string

    -     		+

    Required

    -     		+

    Name of the table to update the record in

    -
    +

    sysId

    -     		+

    string

    -     		+

    Required

    -     		+

    Unique identifier of the record to update

    -
    +

    requestBody

    -     		+

    Record<PropertyKey, unknown>

    -     		+

    Optional

    -     		+

    Field name and associated value for each parameter to define in the specified record

    -
    +

    sysparmDisplayValue

    -     		+

    enum("true", "false", "all")

    -     		+

    Optional

    -     		+

    Returns field display values such as true, actual values as false, or both. The default value is false.

    -
    +

    sysparmExcludeReferenceLink

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to exclude Table API links for reference fields. The default value is false.

    -
    +

    sysparmFields

    -     		+

    string[]

    -     		+

    Optional

    -     		+

    Array of fields to return in the response

    -
    +

    sysparmInputDisplayValue

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set field values using their display value such as true or actual value as false. The default value is false.

    -
    +

    sysparmSuppressAutoSysField

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to suppress auto-generation of system fields. The default value is false.

    -
    +

    sysparmView

    -     		+

    string

    -     		+

    Optional

    -     		+

    Renders the response according to the specified UI view. You can override this parameter using sysparm_fields.

    -
    +

    sysparmQueryNoDomain

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to access data across domains if authorized. The default value is false.

    -

    Table 10. Output parameters

    NameTypeDescription
    +

    Table 10. Output parameters

    NameTypeDescription

    result

    -     		+

    Record<PropertyKey, unknown>

    -     		+

    The response body of the request

    [DELETE] servicenow:now:table:deleteRecord

    Deletes a record from a table in the Developer Hub. -

    Table 11. Input parameters

    NameTypeRequirementDescription
    +

    Table 11. Input parameters

    NameTypeRequirementDescription

    tableName

    -     		+

    string

    -     		+

    Required

    -     		+

    Name of the table to delete the record from

    -
    +

    sysId

    -     		+

    string

    -     		+

    Required

    -     		+

    Unique identifier of the record to delete

    -
    +

    sysparmQueryNoDomain

    -     		+

    boolean

    -     		+

    Optional

    -     		+

    Set as true to access data across domains if authorized. The default value is false.

    @@ -1737,143 +1737,143 @@ In the above example, as the BackendFeature overrides the default implementation of the HTTP router service, you must set the ENABLE_CORE_ROOTHTTPROUTER_OVERRIDE environment variable to true so that the Developer Hub does not install the default implementation automatically.

    9.1. Overriding environment variables

    To allow a dynamic plugin to load a core service override, you must start the Developer Hub backend with the corresponding core service ID environment variable set to true. -

    Table 12. Environment variables and core service IDs

    VariableDescription
    +

    Table 12. Environment variables and core service IDs

    VariableDescription

    ENABLE_CORE_AUTH_OVERRIDE

    -     		+

    Override the core.auth service

    -
    +

    ENABLE_CORE_CACHE_OVERRIDE

    -     		+

    Override the core.cache service

    -
    +

    ENABLE_CORE_ROOTCONFIG_OVERRIDE

    -     		+

    Override the core.rootConfig service

    -
    +

    ENABLE_CORE_DATABASE_OVERRIDE

    -     		+

    Override the core.database service

    -
    +

    ENABLE_CORE_DISCOVERY_OVERRIDE

    -     		+

    Override the core.discovery service

    -
    +

    ENABLE_CORE_HTTPAUTH_OVERRIDE

    -     		+

    Override the core.httpAuth service

    -
    +

    ENABLE_CORE_HTTPROUTER_OVERRIDE

    -     		+

    Override the core.httpRouter service

    -
    +

    ENABLE_CORE_LIFECYCLE_OVERRIDE

    -     		+

    Override the core.lifecycle service

    -
    +

    ENABLE_CORE_LOGGER_OVERRIDE

    -     		+

    Override the core.logger service

    -
    +

    ENABLE_CORE_PERMISSIONS_OVERRIDE

    -     		+

    Override the core.permissions service

    -
    +

    ENABLE_CORE_ROOTHEALTH_OVERRIDE

    -     		+

    Override the core.rootHealth service

    -
    +

    ENABLE_CORE_ROOTHTTPROUTER_OVERRIDE

    -     		+

    Override the core.rootHttpRouter service

    -
    +

    ENABLE_CORE_ROOTLIFECYCLE_OVERRIDE

    -     		+

    Override the core.rootLifecycle service

    -
    +

    ENABLE_CORE_SCHEDULER_OVERRIDE

    -     		+

    Override the core.scheduler service

    -
    +

    ENABLE_CORE_USERINFO_OVERRIDE

    -     		+

    Override the core.userInfo service

    -
    +

    ENABLE_CORE_URLREADER_OVERRIDE

    -     		+

    Override the core.urlReader service

    -
    +

    ENABLE_EVENTS_SERVICE_OVERRIDE

    -     		+

    Override the events.service service

    -

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/plugins-rhdh-install/index.html b/main/plugins-rhdh-install/index.html index a1e095ab3..742074a45 100644 --- a/main/plugins-rhdh-install/index.html +++ b/main/plugins-rhdh-install/index.html @@ -1,6 +1,6 @@ -Installing and viewing plugins in Red Hat Developer Hub
    Red Hat Developer Hub 1.4

    Installing and viewing plugins in Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    +Installing and viewing plugins in Red Hat Developer Hub
    Red Hat Developer Hub 1.4

    Installing and viewing plugins in Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    Administrative users can install and configure plugins to enable other users to use plugins to extend RHDH functionality.

    1. Installing dynamic plugins in Red Hat Developer Hub

    The dynamic plugin support is based on the backend plugin manager package, which is a service that scans a configured root directory (dynamicPlugins.rootDirectory in the app-config.yaml file) for dynamic plugin packages and loads them dynamically. @@ -580,7 +580,7 @@ Open your Developer Hub application and click Administration.

  • Go to the Plugins tab to view a list of installed plugins and related information. -

    • Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/plugins-rhdh-reference/index.html b/main/plugins-rhdh-reference/index.html index b802953e0..5e2e2b2fd 100644 --- a/main/plugins-rhdh-reference/index.html +++ b/main/plugins-rhdh-reference/index.html @@ -1,6 +1,6 @@ -Dynamic plugins reference
    Red Hat Developer Hub 1.4

    Dynamic plugins reference

    Red Hat Customer Content Services

    Abstract

    +Dynamic plugins reference
    Red Hat Developer Hub 1.4

    Dynamic plugins reference

    Red Hat Customer Content Services

    Abstract

    Red Hat Developer Hub is preinstalled with a selection of dynamic plugins that users can enable and configure to extend RHDH functionality.

    The dynamic plugin support is based on the backend plugin manager package, which is a service that scans a configured root directory (dynamicPlugins.rootDirectory in the app config) for dynamic plugin packages and loads them dynamically. @@ -36,19 +36,19 @@ 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.

    1.1. Red Hat supported plugins

    Red Hat supports the following 18 plugins: -

    NamePluginVersionPath and required variables
    +

    NamePluginVersionPath and required variables

    Analytics Provider Segment

    -     		+

    @backstage-community/plugin-analytics-provider-segment

    -     		+

    1.10.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment

    @@ -58,35 +58,35 @@

    SEGMENT_TEST_MODE

    -
    +

    Argo CD

    -     		+

    @roadiehq/backstage-plugin-argo-cd

    -     		+

    2.8.4

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd

    -
    +

    Argo CD

    -     		+

    @roadiehq/backstage-plugin-argo-cd-backend

    -     		+

    3.2.3

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd-backend-dynamic

    @@ -108,38 +108,38 @@

    ARGOCD_AUTH_TOKEN2

    -
    +

    GitHub

    -     		+

    @backstage/plugin-catalog-backend-module-github

    -     		+

    0.7.6

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic

    GITHUB_ORG

    -
    +

    GitHub Org

    -     		+

    @backstage/plugin-catalog-backend-module-github-org

    -     		+

    0.3.3

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic

    @@ -149,19 +149,19 @@

    GITHUB_ORG

    -
    +

    Keycloak

    -     		+

    @backstage-community/plugin-catalog-backend-module-keycloak

    -     		+

    3.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic

    @@ -180,19 +180,19 @@

    KEYCLOAK_CLIENT_SECRET

    -
    +

    Kubernetes

    -     		+

    @backstage/plugin-kubernetes-backend

    -     		+

    0.18.7

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-kubernetes-backend-dynamic

    @@ -205,35 +205,35 @@

    K8S_CLUSTER_TOKEN

    -
    +

    OCM

    -     		+

    @backstage-community/plugin-ocm

    -     		+

    5.2.4

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-ocm

    -
    +

    OCM

    -     		+

    @backstage-community/plugin-ocm-backend

    -     		+

    5.2.3

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-ocm-backend-dynamic

    @@ -246,147 +246,147 @@

    OCM_SA_TOKEN

    -
    +

    Quay

    -     		+

    @backstage-community/plugin-quay

    -     		+

    1.14.4

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-quay

    -
    +

    Quay

    -     		+

    @backstage-community/plugin-scaffolder-backend-module-quay

    -     		+

    2.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-quay-dynamic

    -
    +

    RBAC

    -     		+

    @backstage-community/plugin-rbac

    -     		+

    1.33.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-rbac

    -
    +

    Regex

    -     		+

    @backstage-community/plugin-scaffolder-backend-module-regex

    -     		+

    2.2.3

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-regex-dynamic

    -
    +

    Signals

    -     		+

    @backstage/plugin-signals-backend

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic

    -
    +

    TechDocs

    -     		+

    @backstage/plugin-techdocs

    -     		+

    1.11.0

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-techdocs

    -
    +

    TechDocs

    -     		+

    @backstage/plugin-techdocs-backend

    -     		+

    1.11.1

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-techdocs-backend-dynamic

    -
    +

    Tekton

    -     		+

    @backstage-community/plugin-tekton

    -     		+

    3.16.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-tekton

    -
    +

    Topology

    -     		+

    @backstage-community/plugin-topology

    -     		+

    1.29.7

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-topology

    @@ -400,19 +400,19 @@ For more information on Red Hat Technology Preview features, see Technology Preview Features Scope.

    1.2.1. Red Hat Technology Preview plugins

    Red Hat provides Technology Preview support for the following 54 plugins: -

    NamePluginVersionPath and required variables
    +

    NamePluginVersionPath and required variables

    3scale

    -     		+

    @backstage-community/plugin-3scale-backend

    -     		+

    3.0.3

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-3scale-backend-dynamic

    @@ -422,19 +422,19 @@

    THREESCALE_ACCESS_TOKEN

    -
    +

    Ansible Automation Platform (AAP)

    -     		+

    @janus-idp/backstage-plugin-aap-backend

    -     		+

    2.2.0

    -     		+

    ./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic

    @@ -444,35 +444,35 @@

    AAP_AUTH_TOKEN

    -
    +

    ACR

    -     		+

    @backstage-community/plugin-acr

    -     		+

    1.8.5

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-acr

    -
    +

    Argo CD

    -     		+

    @roadiehq/scaffolder-backend-argocd

    -     		+

    1.2.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-scaffolder-backend-argocd-dynamic

    @@ -494,67 +494,67 @@

    ARGOCD_AUTH_TOKEN2

    -
    +

    Argo CD (Red Hat)

    -     		+

    @backstage-community/plugin-redhat-argocd

    -     		+

    1.11.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-redhat-argocd

    -
    +

    Azure

    -     		+

    @backstage/plugin-scaffolder-backend-module-azure

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-azure-dynamic

    -
    +

    Azure Devops

    -     		+

    @backstage-community/plugin-azure-devops

    -     		+

    0.6.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-azure-devops

    -
    +

    Azure Devops

    -     		+

    @backstage-community/plugin-azure-devops-backend

    -     		+

    0.8.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-azure-devops-backend-dynamic

    @@ -564,297 +564,297 @@

    AZURE_ORG

    -
    +

    Azure Repositories

    -     		+

    @parfuemerie-douglas/scaffolder-backend-module-azure-repositories

    -     		+

    0.3.0

    -     		+

    ./dynamic-plugins/dist/parfuemerie-douglas-scaffolder-backend-module-azure-repositories-dynamic

    -
    +

    Bitbucket Cloud

    -     		+

    @backstage/plugin-catalog-backend-module-bitbucket-cloud

    -     		+

    0.4.1

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-bitbucket-cloud-dynamic

    BITBUCKET_WORKSPACE

    -
    +

    Bitbucket Cloud

    -     		+

    @backstage/plugin-scaffolder-backend-module-bitbucket-cloud

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-bitbucket-cloud-dynamic

    -
    +

    Bitbucket Server

    -     		+

    @backstage/plugin-catalog-backend-module-bitbucket-server

    -     		+

    0.2.3

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-bitbucket-server-dynamic

    BITBUCKET_HOST

    -
    +

    Bitbucket Server

    -     		+

    @backstage/plugin-scaffolder-backend-module-bitbucket-server

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-bitbucket-server-dynamic

    -
    +

    Bulk Import

    -     		+

    @red-hat-developer-hub/backstage-plugin-bulk-import

    -     		+

    1.10.3

    -     		+

    ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import

    -
    +

    Bulk Import

    -     		+

    @red-hat-developer-hub/backstage-plugin-bulk-import-backend

    -     		+

    5.2.0

    -     		+

    ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import-backend-dynamic

    -
    +

    Datadog

    -     		+

    @roadiehq/backstage-plugin-datadog

    -     		+

    2.4.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-datadog

    -
    +

    Dynatrace

    -     		+

    @backstage-community/plugin-dynatrace

    -     		+

    10.0.8

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-dynatrace

    -
    +

    Gerrit

    -     		+

    @backstage/plugin-scaffolder-backend-module-gerrit

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-gerrit-dynamic

    -
    +

    GitHub

    -     		+

    @backstage/plugin-scaffolder-backend-module-github

    -     		+

    0.5.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-github-dynamic

    -
    +

    GitHub Actions

    -     		+

    @backstage-community/plugin-github-actions

    -     		+

    0.6.24

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-github-actions

    -
    +

    GitHub Insights

    -     		+

    @roadiehq/backstage-plugin-github-insights

    -     		+

    2.5.1

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-github-insights

    -
    +

    GitHub Issues

    -     		+

    @backstage-community/plugin-github-issues

    -     		+

    0.4.8

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-github-issues

    -
    +

    GitHub Pull Requests

    -     		+

    @roadiehq/backstage-plugin-github-pull-requests

    -     		+

    2.6.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-github-pull-requests

    -
    +

    GitLab

    -     		+

    @immobiliarelabs/backstage-plugin-gitlab

    -     		+

    6.6.1

    -     		+

    ./dynamic-plugins/dist/immobiliarelabs-backstage-plugin-gitlab

    -
    +

    GitLab

    -     		+

    @backstage/plugin-catalog-backend-module-gitlab

    -     		+

    0.4.4

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-gitlab-dynamic

    -
    +

    GitLab

    -     		+

    @immobiliarelabs/backstage-plugin-gitlab-backend

    -     		+

    6.7.0

    -     		+

    ./dynamic-plugins/dist/immobiliarelabs-backstage-plugin-gitlab-backend-dynamic

    @@ -864,83 +864,83 @@

    GITLAB_TOKEN

    -
    +

    GitLab

    -     		+

    @backstage/plugin-scaffolder-backend-module-gitlab

    -     		+

    0.6.1

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-gitlab-dynamic

    -
    +

    GitLab Org

    -     		+

    @backstage/plugin-catalog-backend-module-gitlab-org

    -     		+

    0.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-gitlab-org-dynamic

    -
    +

    Http Request

    -     		+

    @roadiehq/scaffolder-backend-module-http-request

    -     		+

    5.0.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-scaffolder-backend-module-http-request-dynamic

    -
    +

    Jenkins

    -     		+

    @backstage-community/plugin-jenkins

    -     		+

    0.12.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-jenkins

    -
    +

    Jenkins

    -     		+

    @backstage-community/plugin-jenkins-backend

    -     		+

    0.6.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-jenkins-backend-dynamic

    @@ -953,163 +953,163 @@

    JENKINS_TOKEN

    -
    +

    JFrog Artifactory

    -     		+

    @backstage-community/plugin-jfrog-artifactory

    -     		+

    1.10.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-jfrog-artifactory

    -
    +

    Jira

    -     		+

    @roadiehq/backstage-plugin-jira

    -     		+

    2.8.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-jira

    -
    +

    Kubernetes

    -     		+

    @backstage/plugin-kubernetes

    -     		+

    0.11.16

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-kubernetes

    -
    +

    Ldap

    -     		+

    @backstage/plugin-catalog-backend-module-ldap

    -     		+

    0.9.1

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-ldap-dynamic

    -
    +

    Lighthouse

    -     		+

    @backstage-community/plugin-lighthouse

    -     		+

    0.4.24

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-lighthouse

    -
    +

    MS Graph

    -     		+

    @backstage/plugin-catalog-backend-module-msgraph

    -     		+

    0.6.3

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-msgraph-dynamic

    -
    +

    Nexus Repository Manager

    -     		+

    @backstage-community/plugin-nexus-repository-manager

    -     		+

    1.10.6

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-nexus-repository-manager

    -
    +

    Notifications

    -     		+

    @backstage/plugin-notifications

    -     		+

    0.3.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-notifications

    -
    +

    Notifications

    -     		+

    @backstage/plugin-notifications-backend

    -     		+

    0.4.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic

    -
    +

    Notifications Module Email

    -     		+

    @backstage/plugin-notifications-backend-module-email

    -     		+

    0.3.2

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-notifications-backend-module-email-dynamic

    @@ -1125,35 +1125,35 @@

    EMAIL_SENDER

    -
    +

    PagerDuty

    -     		+

    @pagerduty/backstage-plugin

    -     		+

    0.15.2

    -     		+

    ./dynamic-plugins/dist/pagerduty-backstage-plugin

    -
    +

    PagerDuty

    -     		+

    @pagerduty/backstage-plugin-backend

    -     		+

    0.9.2

    -     		+

    ./dynamic-plugins/dist/pagerduty-backstage-plugin-backend-dynamic

    @@ -1169,67 +1169,67 @@

    PAGERDUTY_SUBDOMAIN

    -
    +

    Pingidentity

    -     		+

    @backstage-community/plugin-catalog-backend-module-pingidentity

    -     		+

    0.1.5

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-pingidentity-dynamic

    -
    +

    Scaffolder Relation Processor

    -     		+

    @backstage-community/plugin-catalog-backend-module-scaffolder-relation-processor

    -     		+

    2.0.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-scaffolder-relation-processor-dynamic

    -
    +

    Security Insights

    -     		+

    @roadiehq/backstage-plugin-security-insights

    -     		+

    2.4.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-backstage-plugin-security-insights

    -
    +

    ServiceNow

    -     		+

    @backstage-community/plugin-scaffolder-backend-module-servicenow

    -     		+

    2.2.3

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-servicenow-dynamic

    @@ -1242,51 +1242,51 @@

    SERVICENOW_PASSWORD

    -
    +

    Signals

    -     		+

    @backstage/plugin-signals

    -     		+

    0.0.11

    -     		+

    ./dynamic-plugins/dist/backstage-plugin-signals

    -
    +

    SonarQube

    -     		+

    @backstage-community/plugin-sonarqube

    -     		+

    0.8.7

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-sonarqube

    -
    +

    SonarQube

    -     		+

    @backstage-community/plugin-sonarqube-backend

    -     		+

    0.3.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-sonarqube-backend-dynamic

    @@ -1296,70 +1296,70 @@

    SONARQUBE_TOKEN

    -
    +

    SonarQube

    -     		+

    @backstage-community/plugin-scaffolder-backend-module-sonarqube

    -     		+

    2.2.2

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-sonarqube-dynamic

    -
    +

    Tech Radar

    -     		+

    @backstage-community/plugin-tech-radar

    -     		+

    1.0.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-tech-radar

    -
    +

    Tech Radar

    -     		+

    @backstage-community/plugin-tech-radar-backend

    -     		+

    1.0.0

    -     		+

    ./dynamic-plugins/dist/backstage-community-plugin-tech-radar-backend-dynamic

    TECH_RADAR_DATA_URL

    -
    +

    Utils

    -     		+

    @roadiehq/scaffolder-backend-module-utils

    -     		+

    3.0.0

    -     		+

    ./dynamic-plugins/dist/roadiehq-scaffolder-backend-module-utils-dynamic

    @@ -1367,57 +1367,57 @@ A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See Other installable plugins in the Configuring plugins in Red Hat Developer Hub guide for further details. See Dynamic plugins support matrix.

    2. Other installable plugins

    The following Technology Preview plugins are not preinstalled and must be installed from an external source: -

    NamePluginVersionInstallation Details
    +

    NamePluginVersionInstallation Details

    Ansible Automation Platform Frontend

    -     		+

    @ansible/plugin-backstage-rhaap

    -     		+

    1.0.0

    -     		+

    Learn more

    -
    +

    Ansible Automation Platform

    -     		+

    @ansible/plugin-backstage-rhaap-backend

    -     		+

    1.0.0

    -     		+

    Learn more

    -
    +

    Ansible Automation Platform Scaffolder Backend

    -     		+

    @ansible/plugin-scaffolder-backend-module-backstage-rhaap

    -     		+

    1.0.0

    -     		+

    Learn more

    Note
    • The above Red Hat Ansible Automation Platform (RHAAP) plugins, can be used as a replacement for the older plugin listed in the Technology Preview plugins section of the Configuring plugins in Red Hat Developer Hub guide. -

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/plugins-rhdh-troubleshooting/index.html b/main/plugins-rhdh-troubleshooting/index.html index 126b67d37..79cdf3f48 100644 --- a/main/plugins-rhdh-troubleshooting/index.html +++ b/main/plugins-rhdh-troubleshooting/index.html @@ -1,8 +1,8 @@ -Troubleshooting Red Hat Developer Hub plugins
    Red Hat Developer Hub 1.4

    Troubleshooting Red Hat Developer Hub plugins

    Troubleshooting RHDH plugins

    Red Hat Customer Content Services

    Abstract

    +Troubleshooting Red Hat Developer Hub plugins
    Red Hat Developer Hub 1.4

    Troubleshooting Red Hat Developer Hub plugins

    Troubleshooting RHDH plugins

    Red Hat Customer Content Services

    Abstract

    This document describes how to resolve common problems with Red Hat Developer Hub. -

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/plugins-rhdh-using/index.html b/main/plugins-rhdh-using/index.html index 548388e66..1f2d3fbbc 100644 --- a/main/plugins-rhdh-using/index.html +++ b/main/plugins-rhdh-using/index.html @@ -1,6 +1,6 @@ -Using dynamic plugins
    Red Hat Developer Hub 1.4

    Using dynamic plugins

    Red Hat Customer Content Services

    Abstract

    +Using dynamic plugins
    Red Hat Developer Hub 1.4

    Using dynamic plugins

    Red Hat Customer Content Services

    Abstract

    The following sections provide information about how you can use RHDH dynamic plugins.

    1. Using Ansible plug-ins for Red Hat Developer Hub

    Ansible plug-ins for Red Hat Developer Hub deliver an Ansible-specific portal experience with curated learning paths, push-button content creation, integrated development tools, and other opinionated resources. @@ -112,7 +112,7 @@ Click on the Open URL button on the top of a node.

    topology-user-3

    When you click on the Open URL button, it allows you to access the associated Ingresses and runs your application in a new tab. -

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/rel-notes-rhdh/index.html b/main/rel-notes-rhdh/index.html index c42cffa34..af6f18224 100644 --- a/main/rel-notes-rhdh/index.html +++ b/main/rel-notes-rhdh/index.html @@ -1,6 +1,6 @@ -Release notes
    Red Hat Developer Hub 1.4

    Release notes

    Release notes for Red Hat Developer Hub 1.4

    Red Hat Customer Content Services

    Abstract

    +Release notes
    Red Hat Developer Hub 1.4

    Release notes

    Release notes for Red Hat Developer Hub 1.4

    Red Hat Customer Content Services

    Abstract

    Red Hat Developer Hub is a developer platform for building developer portals. This document contains release notes for the Red Hat Developer Hub 1.4.

    Red Hat Developer Hub (Developer Hub) 1.4 is now generally available. Developer Hub is a fully supported, enterprise-grade productized version of upstream Backstage v1.29.2. You can access and download the Red Hat Developer Hub application from the Red Hat Customer Portal or from the Ecosystem Catalog. @@ -96,7 +96,7 @@ This section lists known issues in Red Hat Developer Hub 1.4.

    None. -

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/telemetry/index.html b/main/telemetry/index.html index 6169eb96a..4e060092d 100644 --- a/main/telemetry/index.html +++ b/main/telemetry/index.html @@ -1,6 +1,6 @@ -Telemetry data collection
    Red Hat Developer Hub 1.4

    Telemetry data collection

    Collecting and analyzing telemetry data to enhance Red Hat Developer Hub experience

    Red Hat Customer Content Services

    Abstract

    +Telemetry data collection
    Red Hat Developer Hub 1.4

    Telemetry data collection

    Collecting and analyzing telemetry data to enhance Red Hat Developer Hub experience

    Red Hat Customer Content Services

    Abstract

    As a Red Hat Developer Hub administrator, you can collect and analyze telemetry data to enhance your Red Hat Developer Hub experience.

    1. Telemetry data collection

    The telemetry data collection feature helps in collecting and analyzing the telemetry data to improve your experience with Red Hat Developer Hub. This feature is enabled by default. @@ -243,7 +243,7 @@ Replace <segment_key> with a unique identifier for your Segment source.

  • Click Upgrade. -

    • Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version. diff --git a/main/upgrade-rhdh/index.html b/main/upgrade-rhdh/index.html index 1d3404098..3730a8e52 100644 --- a/main/upgrade-rhdh/index.html +++ b/main/upgrade-rhdh/index.html @@ -1,6 +1,6 @@ -Upgrading Red Hat Developer Hub
    Red Hat Developer Hub 1.4

    Upgrading Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    +Upgrading Red Hat Developer Hub
    Red Hat Developer Hub 1.4

    Upgrading Red Hat Developer Hub

    Red Hat Customer Content Services

    Abstract

    You can upgrade a Red Hat Developer Hub instance to a later version from the OpenShift Container Platform web console using either the Operator or the Helm chart.

    1. Upgrading the Red Hat Developer Hub Operator

    If you use the Operator to deploy your Red Hat Developer Hub instance, then an administrator can use the OpenShift Container Platform web console to upgrade the Operator to a later version. @@ -56,7 +56,7 @@ 

    helm upgrade -i rhdh -f new-values.yml \
   openshift-helm-charts/redhat-developer-hub --version 1.4.0
    Note

    You can also provide extra values to the chart by creating a new-values.yml file on your workstation with values that override the attributes in the installed chart or by adding new attributes. -

    Legal Notice

    +

    Legal Notice

    Copyright © 2025 Red Hat, Inc.
    The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.