You can add extensions that allow you to customize your plugin. Those extensions are then loaded to the console at run-time.
console.action/filter
ActionFilter
can be used to filter an action.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The context ID helps to narrow the scope of
contributed actions to a particular area of the application. Examples include |
|
|
no |
A
function that will filter actions based on some conditions. |
console.action/group
ActionGroup
contributes an action group that can also be a submenu.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
ID used to identify the action section. |
|
|
yes |
The label to display in the UI. Required for submenus. |
|
|
yes |
Whether this group should be displayed as submenu. |
|
|
yes |
Insert this item before the item referenced here. For arrays, the first one found in order is used. |
|
|
yes |
Insert this item after the
item referenced here. For arrays, the first one found in order is
used. The |
console.action/provider
ActionProvider
contributes a hook that returns list of actions for specific context.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The context ID helps to narrow the scope of
contributed actions to a particular area of the application. Examples include |
|
|
no |
A React hook
that returns actions for the given scope. If |
console.action/resource-provider
ResourceActionProvider
contributes a hook that returns list of actions for specific resource model.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The model for which this provider provides actions for. |
|
|
no |
A react hook which returns actions for the given resource model |
console.alert-action
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
|
|
|
no |
|
|
|
no |
console.catalog/item-filter
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The unique identifier for the catalog this provider contributes to. |
|
|
no |
Type ID for the catalog item type. |
|
|
no |
Filters items
of a specific type. Value is a function that takes |
console.catalog/item-metadata
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The unique identifier for the catalog this provider contributes to. |
|
|
no |
Type ID for the catalog item type. |
|
|
no |
A hook which returns a function that will be used to provide metadata to catalog items of a specific type. |
console.catalog/item-provider
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The unique identifier for the catalog this provider contributes to. |
|
|
no |
Type ID for the catalog item type. |
|
|
no |
Title for the catalog item provider |
|
|
no |
Fetch items and normalize it for the catalog. Value is a react effect hook. |
|
|
yes |
Priority for this provider. Defaults to |
console.catalog/item-type
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Type for the catalog item. |
|
|
no |
Title for the catalog item. |
|
|
yes |
Description for the type specific catalog. |
|
|
yes |
Description for the catalog item type. |
|
|
yes |
Custom filters specific to the catalog item. |
|
|
yes |
Custom groupings specific to the catalog item. |
console.catalog/item-type-metadata
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Type for the catalog item. |
|
|
yes |
Custom filters specific to the catalog item. |
|
|
yes |
Custom groupings specific to the catalog item. |
console.cluster-overview/inventory-item
Adds a new inventory item into cluster overview page.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The component to be rendered. |
console.cluster-overview/multiline-utilization-item
Adds a new cluster overview multi-line utilization item.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The title of the utilization item. |
|
|
no |
Prometheus utilization query. |
|
|
no |
Convert Prometheus data to human-readable form. |
|
|
yes |
Shows Top consumer popover instead of plain value |
console.cluster-overview/utilization-item
Adds a new cluster overview utilization item.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The title of the utilization item. |
|
|
no |
Prometheus utilization query. |
|
|
no |
Convert Prometheus data to human-readable form. |
|
|
yes |
Prometheus total query. |
|
|
yes |
Prometheus request query. |
|
|
yes |
Prometheus limit query. |
|
|
yes |
Shows Top consumer popover instead of plain value |
console.context-provider
Adds a new React context provider to the web console application root.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Context Provider component. |
|
|
no |
Hook for the Context value. |
console.dashboards/card
Adds a new dashboard card.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The ID of the dashboard tab to which the card will be added. |
|
|
no |
The grid position of the card on the dashboard. |
|
|
no |
Dashboard card component. |
|
|
yes |
Card’s vertical span in the column.
Ignored for small screens; defaults to |
console.dashboards/overview/activity/resource
Adds an activity to the Activity Card of Overview Dashboard where the triggering of activity is based on watching a Kubernetes resource.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The utilization item to be replaced. |
|
|
no |
The action component. |
|
|
yes |
Function which determines if the given resource represents the action. If not defined, every resource represents activity. |
|
|
yes |
Time stamp for the given action, which will be used for ordering. |
console.dashboards/overview/detail/item
Adds an item to the Details card of Overview dashboard.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The value, based
on the |
console.dashboards/overview/health/operator
Adds a health subsystem to the status card of the Overview dashboard, where the source of status is a Kubernetes REST API.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Title of Operators section in the pop-up menu. |
|
|
no |
Kubernetes resources
which will be fetched and passed to |
|
|
yes |
Resolves status for the Operators. |
|
|
yes |
Loader for pop-up row component. |
|
|
yes |
Links to all resources page. If not provided, then a list page of the first resource from resources prop is used. |
console.dashboards/overview/health/prometheus
Adds a health subsystem to the status card of Overview dashboard where the source of status is Prometheus.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The display name of the subsystem. |
|
|
no |
The Prometheus queries |
|
|
no |
Resolve the subsystem’s health. |
|
|
yes |
Additional
resource which will be fetched and passed to |
|
|
yes |
Loader for pop-up menu content. If defined, a health item is represented as a link, which opens a pop-up menu with the given content. |
|
|
yes |
The title of the popover. |
|
|
yes |
Control plane topology for which the subsystem should be hidden. |
console.dashboards/overview/health/resource
Adds a health subsystem to the status card of Overview dashboard where the source of status is a Kubernetes Resource.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The display name of the subsystem. |
|
|
no |
Kubernetes resources
that will be fetched and passed to |
|
|
no |
Resolve the subsystem’s health. |
|
|
yes |
Loader for pop-up menu content. If defined, a health item is represented as a link, which opens a pop-up menu with the given content. |
|
|
yes |
The title of the popover. |
console.dashboards/overview/health/url
Adds a health subsystem to the status card of Overview dashboard where the source of status is a Kubernetes REST API.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The display name of the subsystem. |
|
|
no |
The URL to fetch data from. It will be prefixed with base Kubernetes URL. |
|
`CodeRef<URLHealthHandler<T, K8sResourceCommon |
K8sResourceCommon[]>>` |
no |
Resolve the subsystem’s health. |
|
|
yes |
Additional
resource which will be fetched and passed to |
|
|
yes |
Loader for popup content. If defined, a health item will be represented as a link which opens popup with given content. |
|
|
yes |
console.dashboards/overview/inventory/item
Adds a resource tile to the overview inventory card.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The model for |
|
|
yes |
Function which maps various statuses to groups. |
|
|
yes |
Additional
resources which will be fetched and passed to the |
console.dashboards/overview/inventory/item/group
Adds an inventory status group.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The id of the status group. |
|
|
no |
React component representing the status group icon. |
console.dashboards/overview/inventory/item/replacement
Replaces an overview inventory card.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The model for |
|
|
yes |
Function which maps various statuses to groups. |
|
|
yes |
Additional
resources which will be fetched and passed to the |
console.dashboards/overview/prometheus/activity/resource
Adds an activity to the Activity Card of Prometheus Overview Dashboard where the triggering of activity is based on watching a Kubernetes resource.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Queries to watch |
|
|
no |
The action component. |
|
|
yes |
Function which determines if the given resource represents the action. If not defined, every resource represents activity. |
console.dashboards/project/overview/item
Adds a resource tile to the project overview inventory card.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The model for |
|
|
yes |
Function which maps various statuses to groups. |
|
|
yes |
Additional
resources which will be fetched and passed to the |
console.dashboards/tab
Adds a new dashboard tab, placed after the Overview tab.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
A unique tab identifier, used as tab link |
|
|
no |
Navigation section to which the tab belongs to. |
|
|
no |
The title of the tab. |
console.file-upload
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Supported file extensions. |
|
|
no |
Function which handles the file drop action. |
console.flag
Gives full control over the web console feature flags.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Used to set or unset arbitrary feature flags. |
console.flag/hookProvider
Gives full control over the web console feature flags with hook handlers.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Used to set or unset arbitrary feature flags. |
console.flag/model
Adds a new web console feature flag driven by the presence of a CRD on the cluster.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The name of the flag to set once the CRD is detected. |
|
|
no |
The model which refers to a
|
console.global-config
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Unique identifier for the cluster config resource instance. |
|
|
no |
The name of the cluster config resource instance. |
|
|
no |
The model which refers to a cluster config resource. |
|
|
no |
The namespace of the cluster config resource instance. |
console.model-metadata
Customize the display of models by overriding values retrieved and generated through API discovery.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The model to customize. May specify only a group, or optional version and kind. |
|
|
yes |
Whether to consider this model reference as Technology Preview or Developer Preview. |
|
|
yes |
The color to associate to this model. |
|
|
yes |
Override the label. Requires |
|
|
yes |
Override the plural label. Requires
|
|
|
yes |
Customize the abbreviation. Defaults to all
uppercase characters in |
console.navigation/href
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
A unique identifier for this item. |
|
|
no |
The name of this item. |
|
|
no |
The link href value. |
|
|
yes |
The perspective ID to which this item belongs to. If not specified, contributes to the default perspective. |
|
|
yes |
Navigation section to which this item belongs to. If not specified, render this item as a top level link. |
|
|
yes |
Adds data attributes to the DOM. |
|
|
yes |
Mark this item as active when the URL starts with one of these paths. |
|
|
yes |
Insert this item before the item referenced here. For arrays, the first one found in order is used. |
|
|
yes |
Insert this item after the
item referenced here. For arrays, the first one found in order is used.
|
|
|
yes |
If |
|
|
yes |
If |
console.navigation/resource-cluster
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
A unique identifier for this item. |
|
|
no |
The model for which this navigation item links to. |
|
|
yes |
The perspective ID to which this item belongs to. If not specified, contributes to the default perspective. |
|
|
yes |
Navigation section to which this item belongs to. If not specified, render this item as a top-level link. |
|
|
yes |
Adds data attributes to the DOM. |
|
|
yes |
Mark this item as active when the URL starts with one of these paths. |
|
|
yes |
Insert this item before the item referenced here. For arrays, the first one found in order is used. |
|
|
yes |
Insert this item after the
item referenced here. For arrays, the first one found in order is used.
|
|
|
yes |
Overrides the default name. If not supplied the name of the link will equal the plural value of the model. |
console.navigation/resource-ns
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
A unique identifier for this item. |
|
|
no |
The model for which this navigation item links to. |
|
|
yes |
The perspective ID to which this item belongs to. If not specified, contributes to the default perspective. |
|
|
yes |
Navigation section to which this item belongs to. If not specified, render this item as a top-level link. |
|
|
yes |
Adds data attributes to the DOM. |
|
|
yes |
Mark this item as active when the URL starts with one of these paths. |
|
|
yes |
Insert this item before the item referenced here. For arrays, the first one found in order is used. |
|
|
yes |
Insert this item after the
item referenced here. For arrays, the first one found in order is used.
|
|
|
yes |
Overrides the default name. If not supplied the name of the link will equal the plural value of the model. |
console.navigation/section
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
A unique identifier for this item. |
|
|
yes |
The perspective ID to which this item belongs to. If not specified, contributes to the default perspective. |
|
|
yes |
Adds data attributes to the DOM. |
|
|
yes |
Insert this item before the item referenced here. For arrays, the first one found in order is used. |
|
|
yes |
Insert this item after the
item referenced here. For arrays, the first one found in order is used.
|
|
|
yes |
Name of this section. If not supplied, only a separator will be shown above the section. |
console.navigation/separator
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
A unique identifier for this item. |
|
|
yes |
The perspective ID to which this item belongs to. If not specified, contributes to the default perspective. |
|
|
yes |
Navigation section to which this item belongs to. If not specified, render this item as a top level link. |
|
|
yes |
Adds data attributes to the DOM. |
|
|
yes |
Insert this item before the item referenced here. For arrays, the first one found in order is used. |
|
|
yes |
Insert this item after the
item referenced here. For arrays, the first one found in order is used.
|
console.page/resource/details
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The model for which this resource page links to. |
|
|
no |
The component to be rendered when the route matches. |
console.page/resource/list
Adds new resource list page to Console router.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The model for which this resource page links to. |
|
|
no |
The component to be rendered when the route matches. |
console.page/route
Adds a new page to the web console router. See React Router.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The component to be rendered when the route matches. |
|
|
no |
Valid URL path or array of paths that
|
|
|
yes |
The perspective to which this page belongs to. If not specified, contributes to all perspectives. |
|
|
yes |
When true, will only match if the path matches
the |
console.page/route/standalone
Adds a new standalone page, rendered outside the common page layout, to the web console router. See React Router.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The component to be rendered when the route matches. |
|
|
no |
Valid URL path or array of paths that
|
|
|
yes |
When true, will only match if the path matches
the |
console.perspective
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The perspective identifier. |
|
|
no |
The perspective display name. |
|
|
no |
The perspective display icon. |
|
|
no |
The function to get perspective landing page URL. |
|
|
no |
The function to get redirect URL for import flow. |
|
|
yes |
Whether the perspective is the default. There can only be one default. |
|
|
yes |
Default pinned resources on the nav |
|
|
yes |
The hook to detect default perspective |
console.project-overview/inventory-item
Adds a new inventory item into the Project Overview page.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The component to be rendered. |
console.project-overview/utilization-item
Adds a new project overview utilization item.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The title of the utilization item. |
|
|
no |
Prometheus utilization query. |
|
|
no |
Convert Prometheus data to human-readable form. |
|
|
yes |
Prometheus total query. |
|
|
yes |
Prometheus request query. |
|
|
yes |
Prometheus limit query. |
|
|
yes |
Shows the top consumer popover instead of plain value. |
console.pvc/alert
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The alert component. |
console.pvc/create-prop
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Label for the create prop action. |
|
|
no |
Path for the create prop action. |
console.pvc/delete
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Predicate that tells whether to use the extension or not. |
|
|
no |
Method for the PVC delete operation. |
|
|
no |
Alert component to show additional information. |
console.pvc/status
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Priority for the status component. A larger value means higher priority. |
|
|
no |
The status component. |
|
|
no |
Predicate that tells whether to render the status component or not. |
console.redux-reducer
Adds new reducer to Console Redux store which operates on plugins.<scope>
substate.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The key to represent the reducer-managed substate within the Redux state object. |
|
|
no |
The reducer function, operating on the reducer-managed substate. |
console.resource/create
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The model for which this create resource page will be rendered. |
|
|
no |
The component to be rendered when the model matches |
console.storage-provider
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
|
|
|
no |
console.tab/horizontalNav
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The model for which this provider show tab. |
|
|
no |
The page to be show in horizontal tab. It takes tab name as name and href of the tab |
|
|
no |
The component to be rendered when the route matches. |
console.telemetry/listener
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Listen for telemetry events |
console.topology/adapter/build
BuildAdapter
contributes an adapter to adapt element to data that can be used by the Build
component.
Name | Value Type | Optional | Description |
---|---|---|---|
|
`CodeRef<(element: GraphElement) ⇒ AdapterDataType<BuildConfigData> |
undefined>` |
no |
console.topology/adapter/network
NetworkAdapater
contributes an adapter to adapt element to data that can be used by the Networking
component.
Name | Value Type | Optional | Description |
---|---|---|---|
|
`CodeRef<(element: GraphElement) ⇒ NetworkAdapterType |
undefined>` |
no |
console.topology/adapter/pod
PodAdapter
contributes an adapter to adapt element to data that can be used by the Pod
component.
Name | Value Type | Optional | Description |
---|---|---|---|
|
`CodeRef<(element: GraphElement) ⇒ AdapterDataType<PodsAdapterDataType> |
undefined>` |
no |
console.topology/component/factory
Getter for a ViewComponentFactory
.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Getter for a |
console.topology/create/connector
Getter for the create connector function.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Getter for the create connector function. |
console.topology/data/factory
Topology Data Model Factory Extension
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
Unique ID for the factory. |
|
|
no |
Priority for the factory |
|
|
yes |
Resources to be fetched from useK8sWatchResources hook. |
|
|
yes |
Keys in resources containing workloads. |
|
|
yes |
Getter for the data model factory. |
|
|
yes |
Getter for function to determine if a resource is depicted by this model factory. |
|
|
yes |
Getter for function to reconcile data model after all extensions' models have loaded. |
console.topology/decorator/provider
Topology Decorator Provider Extension
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
console.topology/details/resource-alert
DetailsResourceAlert
contributes an alert for specific topology context or graph element.
Name | Value Type | Optional | Description |
---|---|---|---|
|
|
no |
The ID of this alert. Used to save state if the alert should not be shown after dismissed. |
|
`CodeRef<(element: GraphElement) ⇒ DetailsResourceAlertContent |
null>` |
no |
console.topology/details/resource-link
DetailsResourceLink
contributes a link for specific topology context or graph element.
Name | Value Type | Optional | Description |
---|---|---|---|
|
`CodeRef<(element: GraphElement) ⇒ React.Component |
undefined>` |
no |
Return the resource link if provided, otherwise undefined. Use the |
|
|
yes |
console.topology/details/tab
DetailsTab
contributes a tab for the topology details panel.