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.
@@ -78,67 +78,67 @@
You can find the supported platforms and life cycle dates for both current and past versions of Red Hat Developer Hub on the Life Cycle page.
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
Components
Red Hat Developer Hub application
Red Hat Developer Hub database
Red Hat Developer Hub Operator
+
Table 1. Recommended sizing for running Red Hat Developer Hub
Components
Red Hat Developer Hub application
Red Hat Developer Hub database
Red 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
@@ -150,7 +150,7 @@
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.
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/pr-833/audit-log/index.html b/pr-833/audit-log/index.html
index ad6a3fa8e..1f7fa8add 100644
--- a/pr-833/audit-log/index.html
+++ b/pr-833/audit-log/index.html
@@ -1,6 +1,6 @@
-Audit log
Red Hat Developer Hub1.4
Audit log
Tracking user activities, system events, and data changes with Red Hat Developer Hub audit logs
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
-
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/pr-833/authentication/index.html b/pr-833/authentication/index.html
index 4f7a63272..1d632b931 100644
--- a/pr-833/authentication/index.html
+++ b/pr-833/authentication/index.html
@@ -1,6 +1,6 @@
-Authentication
Red Hat Developer Hub1.4
Authentication
Configuring authentication to external services in Red Hat Developer Hub
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.
@@ -355,7 +355,7 @@
GroupTransformer,
keycloakTransformerExtensionPoint,
UserTransformer,
-} from '@janus-idp/backstage-plugin-keycloak-backend';
+} from '@backstage-community/plugin-catalog-backend-module-keycloak';
const customGroupTransformer: GroupTransformer = async (
entity, // entity output from default parser
@@ -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"}
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/pr-833/authorization/index.html b/pr-833/authorization/index.html
index d55957fcd..82bd99924 100644
--- a/pr-833/authorization/index.html
+++ b/pr-833/authorization/index.html
@@ -1,6 +1,6 @@
-Authorization
Red Hat Developer Hub1.4
Authorization
Configuring authorization by using role based access control (RBAC) in Red Hat Developer Hub
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.
Deletes all permission policies added to the specified entity.
-
Table 7. Request parameters
Name
Description
Type
Presence
+
Table 7. Request parameters
Name
Description
Type
Presence
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
Name
Description
Type
Presence
+
Table 8. Request parameters
Name
Description
Type
Presence
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
Name
Description
Type
Presence
+
Table 9. Request parameters
Name
Description
Type
Presence
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
-
Name
Resource type
Policy
Description
+
Name
Resource type
Policy
Description
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
-
Name
Resource type
Policy
Description
+
Name
Resource type
Policy
Description
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
-
Name
Resource type
Policy
Description
+
Name
Resource type
Policy
Description
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
-
Name
Resource type
Policy
Description
+
Name
Resource type
Policy
Description
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
-
Name
Resource type
Policy
Description
+
Name
Resource type
Policy
Description
kubernetes.proxy
-
+
use
-
+
Allows a user or role to access the proxy endpoint
@@ -2084,53 +2084,53 @@
params:
key: type
value: kubernetes-cluster
-
Name
Resource type
Policy
Description
+
Name
Resource type
Policy
Description
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
-
Name
Resource type
Policy
Description
+
Name
Resource type
Policy
Description
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:
-