Skip to main content

Function: registerProjectGrouping()

function registerProjectGrouping(projectGrouping: ProjectGrouping): void;

Defined in: plugin/registry.tsx:1204

Register custom grouping for project namespaces.

The returned key is opaque and only distinguishes entries that share a project ID. Return the project ID to retain Headlamp's default cross-cluster grouping.

Parameters​

ParameterTypeDescription
projectGroupingProjectGroupingProject grouping definition

Returns​

void

Nothing.

Example​

registerProjectGrouping({
getProjectKey: ({ namespace, projectId }) =>
namespace.metadata.labels?.['example.com/separate-by-cluster'] === 'true'
? `${projectId}:${namespace.cluster}`
: projectId,
});