You can add extensions that allow you to customize your plugin. Those extensions are then loaded to the console at run-time.
7.5.1. Dynamic plugin extension types
console.action/filter
ActionFilter can be used to filter an action.
| Name | Value Type | Optional | Description |
|---|
|
contextId
|
string
|
no
|
The context ID helps to narrow the scope of contributed actions to a particular area of the application. Examples include topology and helm.
|
|
filter
|
CodeRef<(scope: any, action: Action) ⇒ boolean>
|
no
|
A function that will filter actions based on some conditions. scope: The scope in which actions should be provided for. A hook might be required if you want to remove the ModifyCount action from a deployment with a horizontal pod autoscaler (HPA).
|
console.action/group
ActionGroup contributes an action group that can also be a submenu.
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
ID used to identify the action section.
|
|
label
|
string
|
yes
|
The label to display in the UI. Required for submenus.
|
|
submenu
|
boolean
|
yes
|
Whether this group should be displayed as submenu.
|
|
insertBefore
|
string | string[]
|
yes
|
Insert this item before the item referenced here. For arrays, the first one found in order is used.
|
|
insertAfter
|
string | string[]
|
yes
|
Insert this item after the item referenced here. For arrays, the first one found in order is used. The insertBefore value takes precedence.
|
console.action/provider
ActionProvider contributes a hook that returns list of actions for specific context.
| Name | Value Type | Optional | Description |
|---|
|
contextId
|
string
|
no
|
The context ID helps to narrow the scope of contributed actions to a particular area of the application. Examples include topology and helm.
|
|
provider
|
CodeRef<ExtensionHook<Action[], any>>
|
no
|
A React hook that returns actions for the given scope. If contextId = resource, then the scope will always be a Kubernetes resource object.
|
console.action/resource-provider
ResourceActionProvider contributes a hook that returns list of actions for specific resource model.
| Name | Value Type | Optional | Description |
|---|
|
model
|
ExtensionK8sKindVersionModel
|
no
|
The model for which this provider provides actions for.
|
|
provider
|
CodeRef<ExtensionHook<Action[], any>>
|
no
|
A react hook which returns actions for the given resource model
|
console.alert-action
| Name | Value Type | Optional | Description |
|---|
|
alert
|
string
|
no
| |
|
text
|
string
|
no
| |
|
action
|
CodeRef<(alert: any) ⇒ void>
|
no
| |
console.catalog/item-filter
| Name | Value Type | Optional | Description |
|---|
|
catalogId
|
string | string[]
|
no
|
The unique identifier for the catalog this provider contributes to.
|
|
type
|
string
|
no
|
Type ID for the catalog item type.
|
|
filter
|
CodeRef<(item: CatalogItem) ⇒ boolean>
|
no
|
Filters items of a specific type. Value is a function that takes CatalogItem[] and returns a subset based on the filter criteria.
|
| Name | Value Type | Optional | Description |
|---|
|
catalogId
|
string | string[]
|
no
|
The unique identifier for the catalog this provider contributes to.
|
|
type
|
string
|
no
|
Type ID for the catalog item type.
|
|
provider
|
CodeRef<ExtensionHook<CatalogItemMetadataProviderFunction, CatalogExtensionHookOptions>>
|
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 |
|---|
|
catalogId
|
string | string[]
|
no
|
The unique identifier for the catalog this provider contributes to.
|
|
type
|
string
|
no
|
Type ID for the catalog item type.
|
|
title
|
string
|
no
|
Title for the catalog item provider
|
|
provider
|
CodeRef<ExtensionHook<CatalogItem<any>[], CatalogExtensionHookOptions>>
|
no
|
Fetch items and normalize it for the catalog. Value is a react effect hook.
|
|
priority
|
number
|
yes
|
Priority for this provider. Defaults to 0. Higher priority providers may override catalog items provided by other providers.
|
console.catalog/item-type
| Name | Value Type | Optional | Description |
|---|
|
type
|
string
|
no
|
Type for the catalog item.
|
|
title
|
string
|
no
|
Title for the catalog item.
|
|
catalogDescription
|
string | CodeRef<React.ReactNode>
|
yes
|
Description for the type specific catalog.
|
|
typeDescription
|
string
|
yes
|
Description for the catalog item type.
|
|
filters
|
CatalogItemAttribute[]
|
yes
|
Custom filters specific to the catalog item.
|
|
groupings
|
CatalogItemAttribute[]
|
yes
|
Custom groupings specific to the catalog item.
|
| Name | Value Type | Optional | Description |
|---|
|
type
|
string
|
no
|
Type for the catalog item.
|
|
filters
|
CatalogItemAttribute[]
|
yes
|
Custom filters specific to the catalog item.
|
|
groupings
|
CatalogItemAttribute[]
|
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 |
|---|
|
component
|
CodeRef<React.ComponentType<{}>>
|
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 |
|---|
|
title
|
string
|
no
|
The title of the utilization item.
|
|
getUtilizationQueries
|
CodeRef<GetMultilineQueries>
|
no
|
Prometheus utilization query.
|
|
humanize
|
CodeRef<Humanize>
|
no
|
Convert Prometheus data to human-readable form.
|
|
TopConsumerPopovers
|
CodeRef<React.ComponentType<TopConsumerPopoverProps>[]>
|
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 |
|---|
|
title
|
string
|
no
|
The title of the utilization item.
|
|
getUtilizationQuery
|
CodeRef<GetQuery>
|
no
|
Prometheus utilization query.
|
|
humanize
|
CodeRef<Humanize>
|
no
|
Convert Prometheus data to human-readable form.
|
|
getTotalQuery
|
CodeRef<GetQuery>
|
yes
|
Prometheus total query.
|
|
getRequestQuery
|
CodeRef<GetQuery>
|
yes
|
Prometheus request query.
|
|
getLimitQuery
|
CodeRef<GetQuery>
|
yes
|
Prometheus limit query.
|
|
TopConsumerPopover
|
CodeRef<React.ComponentType<TopConsumerPopoverProps>>
|
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 |
|---|
|
provider
|
CodeRef<Provider<T>>
|
no
|
Context Provider component.
|
|
useValueHook
|
CodeRef<() ⇒ T>
|
no
|
Hook for the Context value.
|
console.dashboards/card
Adds a new dashboard card.
| Name | Value Type | Optional | Description |
|---|
|
tab
|
string
|
no
|
The ID of the dashboard tab to which the card will be added.
|
|
position
|
'LEFT' | 'RIGHT' | 'MAIN'
|
no
|
The grid position of the card on the dashboard.
|
|
component
|
CodeRef<React.ComponentType<{}>>
|
no
|
Dashboard card component.
|
|
span
|
OverviewCardSpan
|
yes
|
Card’s vertical span in the column. Ignored for small screens; defaults to 12.
|
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 |
|---|
|
k8sResource
|
CodeRef<FirehoseResource & { isList: true; }>
|
no
|
The utilization item to be replaced.
|
|
component
|
CodeRef<React.ComponentType<K8sActivityProps<T>>>
|
no
|
The action component.
|
|
isActivity
|
CodeRef<(resource: T) ⇒ boolean>
|
yes
|
Function which determines if the given resource represents the action. If not defined, every resource represents activity.
|
|
getTimestamp
|
CodeRef<(resource: T) ⇒ Date>
|
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 |
|---|
|
component
|
CodeRef<React.ComponentType<{}>>
|
no
|
The value, based on the DetailItem component
|
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 |
|---|
|
title
|
string
|
no
|
Title of Operators section in the pop-up menu.
|
|
resources
|
CodeRef<FirehoseResource[]>
|
no
|
Kubernetes resources which will be fetched and passed to healthHandler.
|
|
getOperatorsWithStatuses
|
CodeRef<GetOperatorsWithStatuses<T>>
|
yes
|
Resolves status for the Operators.
|
|
operatorRowLoader
|
CodeRef<React.ComponentType<OperatorRowProps<T>>>
|
yes
|
Loader for pop-up row component.
|
|
viewAllLink
|
string
|
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 |
|---|
|
title
|
string
|
no
|
The display name of the subsystem.
|
|
queries
|
string[]
|
no
|
The Prometheus queries
|
|
healthHandler
|
CodeRef<PrometheusHealthHandler>
|
no
|
Resolve the subsystem’s health.
|
|
additionalResource
|
CodeRef<FirehoseResource>
|
yes
|
Additional resource which will be fetched and passed to healthHandler.
|
|
popupComponent
|
CodeRef<React.ComponentType<PrometheusHealthPopupProps>>
|
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.
|
|
popupTitle
|
string
|
yes
|
The title of the popover.
|
|
disallowedControlPlaneTopology
|
string[]
|
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 |
|---|
|
title
|
string
|
no
|
The display name of the subsystem.
|
|
resources
|
CodeRef<WatchK8sResources<T>>
|
no
|
Kubernetes resources that will be fetched and passed to healthHandler.
|
|
healthHandler
|
CodeRef<ResourceHealthHandler<T>>
|
no
|
Resolve the subsystem’s health.
|
|
popupComponent
|
CodeRef<WatchK8sResults<T>>
|
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.
|
|
popupTitle
|
string
|
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 |
|---|
|
title
|
string
|
no
|
The display name of the subsystem.
|
|
url
|
string
|
no
|
The URL to fetch data from. It will be prefixed with base Kubernetes URL.
|
|
healthHandler
|
`CodeRef<URLHealthHandler<T, K8sResourceCommon
|
K8sResourceCommon[]>>`
|
no
|
|
Resolve the subsystem’s health.
|
additionalResource
|
CodeRef<FirehoseResource>
|
yes
|
|
Additional resource which will be fetched and passed to healthHandler.
|
popupComponent
|
CodeRef<React.ComponentType<{ healthResult?: T; healthResultError?: any; k8sResult?: FirehoseResult<R>; }>>
|
yes
|
|
Loader for popup content. If defined, a health item will be represented as a link which opens popup with given content.
|
popupTitle
|
string
|
yes
|
console.dashboards/overview/inventory/item
Adds a resource tile to the overview inventory card.
| Name | Value Type | Optional | Description |
|---|
|
model
|
CodeRef<T>
|
no
|
The model for resource which will be fetched. Used to get the model’s label or abbr.
|
|
mapper
|
CodeRef<StatusGroupMapper<T, R>>
|
yes
|
Function which maps various statuses to groups.
|
|
additionalResources
|
CodeRef<WatchK8sResources<R>>
|
yes
|
Additional resources which will be fetched and passed to the mapper function.
|
console.dashboards/overview/inventory/item/group
Adds an inventory status group.
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
The id of the status group.
|
|
icon
|
CodeRef<React.ReactElement<any, string | React.JSXElementConstructor<any>>>
|
no
|
React component representing the status group icon.
|
console.dashboards/overview/inventory/item/replacement
Replaces an overview inventory card.
| Name | Value Type | Optional | Description |
|---|
|
model
|
CodeRef<T>
|
no
|
The model for resource which will be fetched. Used to get the model’s label or abbr.
|
|
mapper
|
CodeRef<StatusGroupMapper<T, R>>
|
yes
|
Function which maps various statuses to groups.
|
|
additionalResources
|
CodeRef<WatchK8sResources<R>>
|
yes
|
Additional resources which will be fetched and passed to the mapper function.
|
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 |
|---|
|
queries
|
string[]
|
no
|
Queries to watch
|
|
component
|
CodeRef<React.ComponentType<PrometheusActivityProps>>
|
no
|
The action component.
|
|
isActivity
|
CodeRef<(results: PrometheusResponse[]) ⇒ boolean>
|
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 |
|---|
|
model
|
CodeRef<T>
|
no
|
The model for resource which will be fetched. Used to get the model’s label or abbr.
|
|
mapper
|
CodeRef<StatusGroupMapper<T, R>>
|
yes
|
Function which maps various statuses to groups.
|
|
additionalResources
|
CodeRef<WatchK8sResources<R>>
|
yes
|
Additional resources which will be fetched and passed to the mapper function.
|
console.dashboards/tab
Adds a new dashboard tab, placed after the Overview tab.
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
A unique tab identifier, used as tab link href and when adding cards to this tab.
|
|
navSection
|
'home' | 'storage'
|
no
|
Navigation section to which the tab belongs to.
|
|
title
|
string
|
no
|
The title of the tab.
|
console.file-upload
| Name | Value Type | Optional | Description |
|---|
|
fileExtensions
|
string[]
|
no
|
Supported file extensions.
|
|
handler
|
CodeRef<FileUploadHandler>
|
no
|
Function which handles the file drop action.
|
console.flag
Gives full control over the web console feature flags.
| Name | Value Type | Optional | Description |
|---|
|
handler
|
CodeRef<FeatureFlagHandler>
|
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 |
|---|
|
handler
|
CodeRef<FeatureFlagHandler>
|
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 |
|---|
|
flag
|
string
|
no
|
The name of the flag to set once the CRD is detected.
|
|
model
|
ExtensionK8sModel
|
no
|
The model which refers to a CustomResourceDefinition.
|
console.global-config
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
Unique identifier for the cluster config resource instance.
|
|
name
|
string
|
no
|
The name of the cluster config resource instance.
|
|
model
|
ExtensionK8sModel
|
no
|
The model which refers to a cluster config resource.
|
|
namespace
|
string
|
no
|
The namespace of the cluster config resource instance.
|
Customize the display of models by overriding values retrieved and generated through API discovery.
| Name | Value Type | Optional | Description |
|---|
|
model
|
ExtensionK8sGroupModel
|
no
|
The model to customize. May specify only a group, or optional version and kind.
|
|
badge
|
ModelBadge
|
yes
|
Whether to consider this model reference as Technology Preview or Developer Preview.
|
|
color
|
string
|
yes
|
The color to associate to this model.
|
|
label
|
string
|
yes
|
Override the label. Requires kind be provided.
|
|
labelPlural
|
string
|
yes
|
Override the plural label. Requires kind be provided.
|
|
abbr
|
string
|
yes
|
Customize the abbreviation. Defaults to all uppercase characters in kind, up to 4 characters long. Requires that kind is provided.
|
console.navigation/href
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
A unique identifier for this item.
|
|
name
|
string
|
no
|
The name of this item.
|
|
href
|
string
|
no
|
The link href value.
|
|
perspective
|
string
|
yes
|
The perspective ID to which this item belongs to. If not specified, contributes to the default perspective.
|
|
section
|
string
|
yes
|
Navigation section to which this item belongs to. If not specified, render this item as a top level link.
|
|
dataAttributes
|
{ [key: string]: string; }
|
yes
|
Adds data attributes to the DOM.
|
|
startsWith
|
string[]
|
yes
|
Mark this item as active when the URL starts with one of these paths.
|
|
insertBefore
|
string | string[]
|
yes
|
Insert this item before the item referenced here. For arrays, the first one found in order is used.
|
|
insertAfter
|
string | string[]
|
yes
|
Insert this item after the item referenced here. For arrays, the first one found in order is used. insertBefore takes precedence.
|
|
namespaced
|
boolean
|
yes
|
If true, adds /ns/active-namespace to the end.
|
|
prefixNamespaced
|
boolean
|
yes
|
If true, adds /k8s/ns/active-namespace to the beginning
|
console.navigation/resource-cluster
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
A unique identifier for this item.
|
|
model
|
ExtensionK8sModel
|
no
|
The model for which this navigation item links to.
|
|
perspective
|
string
|
yes
|
The perspective ID to which this item belongs to. If not specified, contributes to the default perspective.
|
|
section
|
string
|
yes
|
Navigation section to which this item belongs to. If not specified, render this item as a top-level link.
|
|
dataAttributes
|
{ [key: string]: string; }
|
yes
|
Adds data attributes to the DOM.
|
|
startsWith
|
string[]
|
yes
|
Mark this item as active when the URL starts with one of these paths.
|
|
insertBefore
|
string | string[]
|
yes
|
Insert this item before the item referenced here. For arrays, the first one found in order is used.
|
|
insertAfter
|
string | string[]
|
yes
|
Insert this item after the item referenced here. For arrays, the first one found in order is used. insertBefore takes precedence.
|
|
name
|
string
|
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 |
|---|
|
id
|
string
|
no
|
A unique identifier for this item.
|
|
model
|
ExtensionK8sModel
|
no
|
The model for which this navigation item links to.
|
|
perspective
|
string
|
yes
|
The perspective ID to which this item belongs to. If not specified, contributes to the default perspective.
|
|
section
|
string
|
yes
|
Navigation section to which this item belongs to. If not specified, render this item as a top-level link.
|
|
dataAttributes
|
{ [key: string]: string; }
|
yes
|
Adds data attributes to the DOM.
|
|
startsWith
|
string[]
|
yes
|
Mark this item as active when the URL starts with one of these paths.
|
|
insertBefore
|
string | string[]
|
yes
|
Insert this item before the item referenced here. For arrays, the first one found in order is used.
|
|
insertAfter
|
string | string[]
|
yes
|
Insert this item after the item referenced here. For arrays, the first one found in order is used. insertBefore takes precedence.
|
|
name
|
string
|
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 |
|---|
|
id
|
string
|
no
|
A unique identifier for this item.
|
|
perspective
|
string
|
yes
|
The perspective ID to which this item belongs to. If not specified, contributes to the default perspective.
|
|
dataAttributes
|
{ [key: string]: string; }
|
yes
|
Adds data attributes to the DOM.
|
|
insertBefore
|
string | string[]
|
yes
|
Insert this item before the item referenced here. For arrays, the first one found in order is used.
|
|
insertAfter
|
string | string[]
|
yes
|
Insert this item after the item referenced here. For arrays, the first one found in order is used. insertBefore takes precedence.
|
|
name
|
string
|
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 |
|---|
|
id
|
string
|
no
|
A unique identifier for this item.
|
|
perspective
|
string
|
yes
|
The perspective ID to which this item belongs to. If not specified, contributes to the default perspective.
|
|
section
|
string
|
yes
|
Navigation section to which this item belongs to. If not specified, render this item as a top level link.
|
|
dataAttributes
|
{ [key: string]: string; }
|
yes
|
Adds data attributes to the DOM.
|
|
insertBefore
|
string | string[]
|
yes
|
Insert this item before the item referenced here. For arrays, the first one found in order is used.
|
|
insertAfter
|
string | string[]
|
yes
|
Insert this item after the item referenced here. For arrays, the first one found in order is used. insertBefore takes precedence.
|
console.page/resource/details
| Name | Value Type | Optional | Description |
|---|
|
model
|
ExtensionK8sGroupKindModel
|
no
|
The model for which this resource page links to.
|
|
component
|
CodeRef<React.ComponentType<{ match: match<{}>; namespace: string; model: ExtensionK8sModel; }>>
|
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 |
|---|
|
model
|
ExtensionK8sGroupKindModel
|
no
|
The model for which this resource page links to.
|
|
component
|
CodeRef<React.ComponentType<{ match: match<{}>; namespace: string; model: ExtensionK8sModel; }>>
|
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 |
|---|
|
component
|
CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>
|
no
|
The component to be rendered when the route matches.
|
|
path
|
string | string[]
|
no
|
Valid URL path or array of paths that path-to-regexp@^1.7.0 understands.
|
|
perspective
|
string
|
yes
|
The perspective to which this page belongs to. If not specified, contributes to all perspectives.
|
|
exact
|
boolean
|
yes
|
When true, will only match if the path matches the location.pathname exactly.
|
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 |
|---|
|
component
|
CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>
|
no
|
The component to be rendered when the route matches.
|
|
path
|
string | string[]
|
no
|
Valid URL path or array of paths that path-to-regexp@^1.7.0 understands.
|
|
exact
|
boolean
|
yes
|
When true, will only match if the path matches the location.pathname exactly.
|
console.perspective
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
The perspective identifier.
|
|
name
|
string
|
no
|
The perspective display name.
|
|
icon
|
CodeRef<LazyComponent>
|
no
|
The perspective display icon.
|
|
landingPageURL
|
CodeRef<(flags: { [key: string]: boolean; }, isFirstVisit: boolean) ⇒ string>
|
no
|
The function to get perspective landing page URL.
|
|
importRedirectURL
|
CodeRef<(namespace: string) ⇒ string>
|
no
|
The function to get redirect URL for import flow.
|
|
default
|
boolean
|
yes
|
Whether the perspective is the default. There can only be one default.
|
|
defaultPins
|
ExtensionK8sModel[]
|
yes
|
Default pinned resources on the nav
|
|
usePerspectiveDetection
|
CodeRef<() ⇒ [boolean, boolean]>
|
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 |
|---|
|
component
|
CodeRef<React.ComponentType<{ projectName: string; }>>
|
no
|
The component to be rendered.
|
console.project-overview/utilization-item
Adds a new project overview utilization item.
| Name | Value Type | Optional | Description |
|---|
|
title
|
string
|
no
|
The title of the utilization item.
|
|
getUtilizationQuery
|
CodeRef<GetProjectQuery>
|
no
|
Prometheus utilization query.
|
|
humanize
|
CodeRef<Humanize>
|
no
|
Convert Prometheus data to human-readable form.
|
|
getTotalQuery
|
CodeRef<GetProjectQuery>
|
yes
|
Prometheus total query.
|
|
getRequestQuery
|
CodeRef<GetProjectQuery>
|
yes
|
Prometheus request query.
|
|
getLimitQuery
|
CodeRef<GetProjectQuery>
|
yes
|
Prometheus limit query.
|
|
TopConsumerPopover
|
CodeRef<React.ComponentType<TopConsumerPopoverProps>>
|
yes
|
Shows the top consumer popover instead of plain value.
|
console.pvc/alert
| Name | Value Type | Optional | Description |
|---|
|
alert
|
CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>
|
no
|
The alert component.
|
console.pvc/create-prop
| Name | Value Type | Optional | Description |
|---|
|
label
|
string
|
no
|
Label for the create prop action.
|
|
path
|
string
|
no
|
Path for the create prop action.
|
console.pvc/delete
| Name | Value Type | Optional | Description |
|---|
|
predicate
|
CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>
|
no
|
Predicate that tells whether to use the extension or not.
|
|
onPVCKill
|
CodeRef<(pvc: K8sResourceCommon) ⇒ Promise<void>>
|
no
|
Method for the PVC delete operation.
|
|
alert
|
CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>
|
no
|
Alert component to show additional information.
|
console.pvc/status
| Name | Value Type | Optional | Description |
|---|
|
priority
|
number
|
no
|
Priority for the status component. A larger value means higher priority.
|
|
status
|
CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>
|
no
|
The status component.
|
|
predicate
|
CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>
|
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 |
|---|
|
scope
|
string
|
no
|
The key to represent the reducer-managed substate within the Redux state object.
|
|
reducer
|
CodeRef<Reducer<any, AnyAction>>
|
no
|
The reducer function, operating on the reducer-managed substate.
|
console.resource/create
| Name | Value Type | Optional | Description |
|---|
|
model
|
ExtensionK8sModel
|
no
|
The model for which this create resource page will be rendered.
|
|
component
|
CodeRef<React.ComponentType<CreateResourceComponentProps>>
|
no
|
The component to be rendered when the model matches
|
console.storage-provider
| Name | Value Type | Optional | Description |
|---|
|
name
|
string
|
no
| |
|
Component
|
CodeRef<React.ComponentType<Partial<RouteComponentProps<{}, StaticContext, any>>>>
|
no
| |
console.tab/horizontalNav
| Name | Value Type | Optional | Description |
|---|
|
model
|
ExtensionK8sKindVersionModel
|
no
|
The model for which this provider show tab.
|
|
page
|
{ name: string; href: string; }
|
no
|
The page to be show in horizontal tab. It takes tab name as name and href of the tab
|
|
component
|
CodeRef<React.ComponentType<PageComponentProps<K8sResourceCommon>>>
|
no
|
The component to be rendered when the route matches.
|
console.telemetry/listener
| Name | Value Type | Optional | Description |
|---|
|
listener
|
CodeRef<TelemetryEventListener>
|
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 |
|---|
|
adapt
|
`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 |
|---|
|
adapt
|
`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 |
|---|
|
adapt
|
`CodeRef<(element: GraphElement) ⇒ AdapterDataType<PodsAdapterDataType>
|
undefined>`
|
no
|
console.topology/component/factory
Getter for a ViewComponentFactory.
| Name | Value Type | Optional | Description |
|---|
|
getFactory
|
CodeRef<ViewComponentFactory>
|
no
|
Getter for a ViewComponentFactory.
|
console.topology/create/connector
Getter for the create connector function.
| Name | Value Type | Optional | Description |
|---|
|
getCreateConnector
|
CodeRef<CreateConnectionGetter>
|
no
|
Getter for the create connector function.
|
console.topology/data/factory
Topology Data Model Factory Extension
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
Unique ID for the factory.
|
|
priority
|
number
|
no
|
Priority for the factory
|
|
resources
|
WatchK8sResourcesGeneric
|
yes
|
Resources to be fetched from useK8sWatchResources hook.
|
|
workloadKeys
|
string[]
|
yes
|
Keys in resources containing workloads.
|
|
getDataModel
|
CodeRef<TopologyDataModelGetter>
|
yes
|
Getter for the data model factory.
|
|
isResourceDepicted
|
CodeRef<TopologyDataModelDepicted>
|
yes
|
Getter for function to determine if a resource is depicted by this model factory.
|
|
getDataModelReconciler
|
CodeRef<TopologyDataModelReconciler>
|
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 |
|---|
|
id
|
string
|
no
| |
|
priority
|
number
|
no
| |
|
quadrant
|
TopologyQuadrant
|
no
| |
|
decorator
|
CodeRef<TopologyDecoratorGetter>
|
no
| |
console.topology/details/resource-alert
DetailsResourceAlert contributes an alert for specific topology context or graph element.
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
The ID of this alert. Used to save state if the alert should not be shown after dismissed.
|
|
contentProvider
|
`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 |
|---|
|
link
|
`CodeRef<(element: GraphElement) ⇒ React.Component
|
undefined>`
|
no
|
|
Return the resource link if provided, otherwise undefined. Use the ResourceIcon and ResourceLink properties for styles.
|
priority
|
number
|
yes
|
console.topology/details/tab
DetailsTab contributes a tab for the topology details panel.
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
A unique identifier for this details tab.
|
|
label
|
string
|
no
|
The tab label to display in the UI.
|
|
insertBefore
|
string | string[]
|
yes
|
Insert this item before the item referenced here. For arrays, the first one found in order is used.
|
|
insertAfter
|
string | string[]
|
yes
|
Insert this item after the item referenced here. For arrays, the first one found in order is used. The insertBefore value takes precedence.
|
console.topology/details/tab-section
DetailsTabSection contributes a section for a specific tab in the topology details panel.
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
A unique identifier for this details tab section.
|
|
tab
|
string
|
no
|
The parent tab ID that this section should contribute to.
|
|
provider
|
CodeRef<DetailsTabSectionExtensionHook>
|
no
|
A hook that returns a component, or if null or undefined renders in the topology sidebar.SDK component: <Section title=\{}>… padded area
|
|
section
|
`CodeRef<(element: GraphElement, renderNull?: () ⇒ null) ⇒ React.Component
|
undefined>`
|
no
|
|
@deprecated Fallback if no provider is defined. renderNull is a no-op already.
|
insertBefore
|
string | string[]
|
yes
|
|
Insert this item before the item referenced here.For arrays, the first one found in order is used.
|
insertAfter
|
string | string[]
|
yes
|
console.topology/display/filters
Topology Display Filters Extension
| Name | Value Type | Optional | Description |
|---|
|
getTopologyFilters
|
CodeRef<() ⇒ TopologyDisplayOption[]>
|
no
| |
|
applyDisplayOptions
|
CodeRef<TopologyApplyDisplayOptions>
|
no
| |
console.topology/relationship/provider
Topology relationship provider connector extension
| Name | Value Type | Optional | Description |
|---|
|
provides
|
CodeRef<RelationshipProviderProvides>
|
no
| |
|
tooltip
|
string
|
no
| |
|
create
|
CodeRef<RelationshipProviderCreate>
|
no
| |
|
priority
|
number
|
no
| |
console.user-preference/group
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
ID used to identify the user preference group.
|
|
label
|
string
|
no
|
The label of the user preference group
|
|
insertBefore
|
string
|
yes
|
ID of user preference group before which this group should be placed
|
|
insertAfter
|
string
|
yes
|
ID of user preference group after which this group should be placed
|
console.user-preference/item
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
ID used to identify the user preference item and referenced in insertAfter and insertBefore to define the item order.
|
|
label
|
string
|
no
|
The label of the user preference
|
|
description
|
string
|
no
|
The description of the user preference.
|
|
field
|
UserPreferenceField
|
no
|
The input field options used to render the values to set the user preference.
|
|
groupId
|
string
|
yes
|
IDs used to identify the user preference groups the item would belong to.
|
|
insertBefore
|
string
|
yes
|
ID of user preference item before which this item should be placed
|
|
insertAfter
|
string
|
yes
|
ID of user preference item after which this item should be placed
|
console.yaml-template
YAML templates for editing resources via the yaml editor.
| Name | Value Type | Optional | Description |
|---|
|
model
|
ExtensionK8sModel
|
no
|
Model associated with the template.
|
|
template
|
CodeRef<string>
|
no
|
The YAML template.
|
|
name
|
string
|
no
|
The name of the template. Use the name default to mark this as the default template.
|
dev-console.add/action
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
ID used to identify the action.
|
|
label
|
string
|
no
|
The label of the action
|
|
description
|
string
|
no
|
The description of the action.
|
|
href
|
string
|
no
|
The href to navigate to.
|
|
groupId
|
string
|
yes
|
IDs used to identify the action groups the action would belong to.
|
|
icon
|
CodeRef<React.ReactNode>
|
yes
|
The perspective display icon.
|
|
accessReview
|
AccessReviewResourceAttributes[]
|
yes
|
Optional access review to control the visibility or enablement of the action.
|
dev-console.add/action-group
| Name | Value Type | Optional | Description |
|---|
|
id
|
string
|
no
|
ID used to identify the action group.
|
|
name
|
string
|
no
|
The title of the action group
|
|
insertBefore
|
string
|
yes
|
ID of action group before which this group should be placed
|
|
insertAfter
|
string
|
yes
|
ID of action group after which this group should be placed
|
dev-console.import/environment
| Name | Value Type | Optional | Description |
|---|
|
imageStreamName
|
string
|
no
|
Name of the image stream to provide custom environment variables for
|
|
imageStreamTags
|
string[]
|
no
|
List of supported image stream tags
|
|
environments
|
ImageEnvironment[]
|
no
|
List of environment variables
|
console.page/resource/tab
Deprecated. Use console.tab/horizontalNav instead. Adds a new resource tab page to Console router.
| Name | Value Type | Optional | Description |
|---|
|
model
|
ExtensionK8sGroupKindModel
|
no
|
The model for which this resource page links to.
|
|
component
|
CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>
|
no
|
The component to be rendered when the route matches.
|
|
name
|
string
|
no
|
The name of the tab.
|
|
href
|
string
|
yes
|
The optional href for the tab link. If not provided, the first path is used.
|
|
exact
|
boolean
|
yes
|
When true, will only match if the path matches the location.pathname exactly.
|
7.5.2. OpenShift Container Platform console API
useActivePerspective
Hook that provides the currently active perspective and a callback for setting the active perspective. It returns a tuple containing the current active perspective and setter callback.
const Component: React.FC = (props) => {
const [activePerspective, setActivePerspective] = useActivePerspective();
return <select
value={activePerspective}
onChange={(e) => setActivePerspective(e.target.value)}
>
{
// ...perspective options
}
</select>
}GreenCheckCircleIcon
Component for displaying a green check mark circle icon.
<GreenCheckCircleIcon title="Healthy" />
| Parameter Name | Description |
|---|
|
className
|
(optional) additional class name for the component
|
|
title
|
(optional) icon title
|
|
size
|
(optional) icon size: ('sm', 'md', 'lg', 'xl')
|
RedExclamationCircleIcon
Component for displaying a red exclamation mark circle icon.
<RedExclamationCircleIcon title="Failed" />
| Parameter Name | Description |
|---|
|
className
|
(optional) additional class name for the component
|
|
title
|
(optional) icon title
|
|
size
|
(optional) icon size: ('sm', 'md', 'lg', 'xl')
|
YellowExclamationTriangleIcon
Component for displaying a yellow triangle exclamation icon.
<YellowExclamationTriangleIcon title="Warning" />
| Parameter Name | Description |
|---|
|
className
|
(optional) additional class name for the component
|
|
title
|
(optional) icon title
|
|
size
|
(optional) icon size: ('sm', 'md', 'lg', 'xl')
|
BlueInfoCircleIcon
Component for displaying a blue info circle icon.
<BlueInfoCircleIcon title="Info" />
| Parameter Name | Description |
|---|
|
className
|
(optional) additional class name for the component
|
|
title
|
(optional) icon title
|
|
size
|
(optional) icon size: ('sm', 'md', 'lg', 'xl')
|
ErrorStatus
Component for displaying an error status popover.
<ErrorStatus title={errorMsg} />| Parameter Name | Description |
|---|
|
title
|
(optional) status text
|
|
iconOnly
|
(optional) if true, only displays icon
|
|
noTooltip
|
(optional) if true, tooltip won’t be displayed
|
|
className
|
(optional) additional class name for the component
|
|
popoverTitle
|
(optional) title for popover
|
InfoStatus
Component for displaying an information status popover.
<InfoStatus title={infoMsg} />| Parameter Name | Description |
|---|
|
title
|
(optional) status text
|
|
iconOnly
|
(optional) if true, only displays icon
|
|
noTooltip
|
(optional) if true, tooltip won’t be displayed
|
|
className
|
(optional) additional class name for the component
|
|
popoverTitle
|
(optional) title for popover
|
ProgressStatus
Component for displaying a progressing status popover.
<ProgressStatus title={progressMsg} />| Parameter Name | Description |
|---|
|
title
|
(optional) status text
|
|
iconOnly
|
(optional) if true, only displays icon
|
|
noTooltip
|
(optional) if true, tooltip won’t be displayed
|
|
className
|
(optional) additional class name for the component
|
|
popoverTitle
|
(optional) title for popover
|
SuccessStatus
Component for displaying a success status popover.
<SuccessStatus title={successMsg} />| Parameter Name | Description |
|---|
|
title
|
(optional) status text
|
|
iconOnly
|
(optional) if true, only displays icon
|
|
noTooltip
|
(optional) if true, tooltip won’t be displayed
|
|
className
|
(optional) additional class name for the component
|
|
popoverTitle
|
(optional) title for popover
|
checkAccess
Provides information about user access to a given resource. It returns an object with resource access information.
| Parameter Name | Description |
|---|
|
resourceAttributes
|
resource attributes for access review
|
|
impersonate
|
impersonation details
|
useAccessReview
Hook that provides information about user access to a given resource. It returns an array with isAllowed and loading values.
| Parameter Name | Description |
|---|
|
resourceAttributes
|
resource attributes for access review
|
|
impersonate
|
impersonation details
|
useResolvedExtensions
React hook for consuming Console extensions with resolved CodeRef properties. This hook accepts the same argument(s) as useExtensions hook and returns an adapted list of extension instances, resolving all code references within each extension’s properties. Initially, the hook returns an empty array. Once the resolution is complete, the React component is re-rendered with the hook returning an adapted list of extensions. When the list of matching extensions changes, the resolution is restarted. The hook will continue to return the previous result until the resolution completes. The hook’s result elements are guaranteed to be referentially stable across re-renders. It returns a tuple containing a list of adapted extension instances with resolved code references, a boolean flag indicating whether the resolution is complete, and a list of errors detected during the resolution.
const [navItemExtensions, navItemsResolved] = useResolvedExtensions<NavItem>(isNavItem);
// process adapted extensions and render your component
| Parameter Name | Description |
|---|
|
typeGuards
|
A list of callbacks that each accept a dynamic plugin extension as an argument and return a boolean flag indicating whether or not the extension meets desired type constraints
|
HorizontalNav
A component that creates a Navigation bar for a page.- Routing is handled as part of the component.- console.tab/horizontalNav can be used to add additional content to any horizontal nav.
const HomePage: React.FC = (props) => {
const page = {
href: '/home',
name: 'Home',
component: () => <>Home</>
}
return <HorizontalNav match={props.match} pages={[page]} />
}| Parameter Name | Description |
|---|
|
resource
|
The resource associated with this Navigation, an object of K8sResourceCommon type
|
|
pages
|
An array of page objects
|
|
match
|
match object provided by React Router
|
VirtualizedTable
A component for making virtualized tables.
const MachineList: React.FC<MachineListProps> = (props) => {
return (
<VirtualizedTable<MachineKind>
{...props}
aria-label='Machines'
columns={getMachineColumns}
Row={getMachineTableRow}
/>
);
}| Parameter Name | Description |
|---|
|
data
|
data for table
|
|
loaded
|
flag indicating data is loaded
|
|
loadError
|
error object if issue loading data
|
|
columns
|
column setup
|
|
Row
|
row setup
|
|
unfilteredData
|
original data without filter
|
|
NoDataEmptyMsg
|
(optional) no data empty message component
|
|
EmptyMsg
|
(optional) empty message component
|
|
scrollNode
|
(optional) function to handle scroll
|
|
label
|
(optional) label for table
|
|
ariaLabel
|
(optional) aria label
|
|
gridBreakPoint
|
sizing of how to break up grid for responsiveness
|
|
onSelect
|
(optional) function for handling select of table
|
|
rowData
|
(optional) data specific to row
|
TableData
Component for displaying table data within a table row.
const PodRow: React.FC<RowProps<K8sResourceCommon>> = ({ obj, activeColumnIDs }) => {
return (
<>
<TableData id={columns[0].id} activeColumnIDs={activeColumnIDs}>
<ResourceLink kind="Pod" name={obj.metadata.name} namespace={obj.metadata.namespace} />
</TableData>
<TableData id={columns[1].id} activeColumnIDs={activeColumnIDs}>
<ResourceLink kind="Namespace" name={obj.metadata.namespace} />
</TableData>
</>
);
};| Parameter Name | Description |
|---|
|
id
|
unique id for table
|
|
activeColumnIDs
|
active columns
|
|
className
|
(optional) option class name for styling
|
useActiveColumns
A hook that provides a list of user-selected active TableColumns.
// See implementation for more details on TableColumn type
const [activeColumns, userSettingsLoaded] = useActiveColumns({
columns,
showNamespaceOverride: false,
columnManagementID,
});
return userSettingsAreLoaded ? <VirtualizedTable columns= {activeColumns} {...otherProps} /> : null| Parameter Name | Description |
|---|
|
options
|
Which are passed as a key-value map
|
|
``
|
\{TableColumn[]} options.columns - An array of all available TableColumns
|
|
``
|
{boolean} [options.showNamespaceOverride] - (optional) If true, a namespace column will be included, regardless of column management selections
|
|
``
|
{string} [options.columnManagementID] - (optional) A unique id used to persist and retrieve column management selections to and from user settings. Usually a 'groupverionkind' string for a resource.
|
A tuple containing the current user selected active columns (a subset of options.columns), and a boolean flag indicating whether user settings have been loaded.
Component for generating a page header.
const exampleList: React.FC = () => {
return (
<>
<ListPageHeader title="Example List Page"/>
</>
);
};| Parameter Name | Description |
|---|
|
title
|
heading title
|
|
helpText
|
(optional) help section as react node
|
|
badge
|
(optional) badge icon as react node
|
ListPageCreate
Component for adding a create button for a specific resource kind that automatically generates a link to the create YAML for this resource.
const exampleList: React.FC<MyProps> = () => {
return (
<>
<ListPageHeader title="Example Pod List Page"/>
<ListPageCreate groupVersionKind="Pod">Create Pod</ListPageCreate>
</ListPageHeader>
</>
);
};| Parameter Name | Description |
|---|
|
groupVersionKind
|
the resource group/version/kind to represent
|
ListPageCreateLink
Component for creating a stylized link.
const exampleList: React.FC<MyProps> = () => {
return (
<>
<ListPageHeader title="Example Pod List Page"/>
<ListPageCreateLink to={'/link/to/my/page'}>Create Item</ListPageCreateLink>
</ListPageHeader>
</>
);
};| Parameter Name | Description |
|---|
|
to
|
string location where link should direct
|
|
createAccessReview
|
(optional) object with namespace and kind used to determine access
|
|
children
|
(optional) children for the component
|
ListPageCreateButton
Component for creating button.
const exampleList: React.FC<MyProps> = () => {
return (
<>
<ListPageHeader title="Example Pod List Page"/>
<ListPageCreateButton createAccessReview={access}>Create Pod</ListPageCreateButton>
</ListPageHeader>
</>
);
};| Parameter Name | Description |
|---|
|
createAccessReview
|
(optional) object with namespace and kind used to determine access
|
|
pfButtonProps
|
(optional) Patternfly Button props
|
ListPageCreateDropdown
Component for creating a dropdown wrapped with permissions check.
const exampleList: React.FC<MyProps> = () => {
const items = {
SAVE: 'Save',
DELETE: 'Delete',
}
return (
<>
<ListPageHeader title="Example Pod List Page"/>
<ListPageCreateDropdown createAccessReview={access} items={items}>Actions</ListPageCreateDropdown>
</ListPageHeader>
</>
);
};| Parameter Name | Description |
|---|
|
items
|
key:ReactNode pairs of items to display in dropdown component
|
|
onClick
|
callback function for click on dropdown items
|
|
createAccessReview
|
(optional) object with namespace and kind used to determine access
|
|
children
|
(optional) children for the dropdown toggle
|
ListPageFilter
Component that generates filter for list page.
// See implementation for more details on RowFilter and FilterValue types
const [staticData, filteredData, onFilterChange] = useListPageFilter(
data,
rowFilters,
staticFilters,
);
// ListPageFilter updates filter state based on user interaction and resulting filtered data can be rendered in an independent component.
return (
<>
<ListPageHeader .../>
<ListPagBody>
<ListPageFilter data={staticData} onFilterChange={onFilterChange} />
<List data={filteredData} />
</ListPageBody>
</>
)| Parameter Name | Description |
|---|
|
data
|
An array of data points
|
|
loaded
|
indicates that data has loaded
|
|
onFilterChange
|
callback function for when filter is updated
|
|
rowFilters
|
(optional) An array of RowFilter elements that define the available filter options
|
|
nameFilterPlaceholder
|
(optional) placeholder for name filter
|
|
labelFilterPlaceholder
|
(optional) placeholder for label filter
|
|
hideLabelFilter
|
(optional) only shows the name filter instead of both name and label filter
|
|
hideNameLabelFilter
|
(optional) hides both name and label filter
|
|
columnLayout
|
(optional) column layout object
|
|
hideColumnManagement
|
(optional) flag to hide the column management
|
useListPageFilter
A hook that manages filter state for the ListPageFilter component. It returns a tuple containing the data filtered by all static filters, the data filtered by all static and row filters, and a callback that updates rowFilters.
// See implementation for more details on RowFilter and FilterValue types
const [staticData, filteredData, onFilterChange] = useListPageFilter(
data,
rowFilters,
staticFilters,
);
// ListPageFilter updates filter state based on user interaction and resulting filtered data can be rendered in an independent component.
return (
<>
<ListPageHeader .../>
<ListPagBody>
<ListPageFilter data={staticData} onFilterChange={onFilterChange} />
<List data={filteredData} />
</ListPageBody>
</>
)| Parameter Name | Description |
|---|
|
data
|
An array of data points
|
|
rowFilters
|
(optional) An array of RowFilter elements that define the available filter options
|
|
staticFilters
|
(optional) An array of FilterValue elements that are statically applied to the data
|
ResourceLink
Component that creates a link to a specific resource type with an icon badge.
<ResourceLink
kind="Pod"
name="testPod"
title={metadata.uid}
/>| Parameter Name | Description |
|---|
|
kind
|
(optional) the kind of resource i.e. Pod, Deployment, Namespace
|
|
groupVersionKind
|
(optional) object with groupd, version, and kind
|
|
className
|
(optional) class style for component
|
|
displayName
|
(optional) display name for component, overwrites the resource name if set
|
|
inline
|
(optional) flag to create icon badge and name inline with children
|
|
linkTo
|
(optional) flag to create a Link object - defaults to true
|
|
name
|
(optional) name of resource
|
|
namesapce
|
(optional) specific namespace for the kind resource to link to
|
|
hideIcon
|
(optional) flag to hide the icon badge
|
|
title
|
(optional) title for the link object (not displayed)
|
|
dataTest
|
(optional) identifier for testing
|
|
onClick
|
(optional) callback function for when component is clicked
|
|
truncate
|
(optional) flag to truncate the link if too long
|
ResourceIcon
Component that creates an icon badge for a specific resource type.
<ResourceIcon kind="Pod"/>
| Parameter Name | Description |
|---|
|
kind
|
(optional) the kind of resource i.e. Pod, Deployment, Namespace
|
|
groupVersionKind
|
(optional) object with group, version, and kind
|
|
className
|
(optional) class style for component
|
useK8sModel
Hook that retrieves the k8s model for provided K8sGroupVersionKind from redux. It returns an array with the first item as k8s model and second item as inFlight status.
const Component: React.FC = () => {
const [model, inFlight] = useK8sModel({ group: 'app'; version: 'v1'; kind: 'Deployment' });
return ...
}| Parameter Name | Description |
|---|
|
groupVersionKind
|
group, version, kind of k8s resource \{@link K8sGroupVersionKind} is preferred alternatively can pass reference for group, version, kind which is deprecated i.e groupversionkind \{@link K8sResourceKindReference}.
|
useK8sModels
Hook that retrieves all current k8s models from redux. It returns an array with the first item as the list of k8s model and second item as inFlight status.
const Component: React.FC = () => {
const [models, inFlight] = UseK8sModels();
return ...
}useK8sWatchResource
Hook that retrieves the k8s resource along with status for loaded and error. It returns an array with first item as resource(s), second item as loaded status and third item as error state if any.
const Component: React.FC = () => {
const watchRes = {
...
}
const [data, loaded, error] = useK8sWatchResource(watchRes)
return ...
}| Parameter Name | Description |
|---|
|
initResource
|
options needed to watch for resource.
|
useK8sWatchResources
Hook that retrieves the k8s resources along with their respective status for loaded and error. It returns a map where keys are as provided in initResouces and value has three properties data, loaded and error.
const Component: React.FC = () => {
const watchResources = {
'deployment': {...},
'pod': {...}
...
}
const {deployment, pod} = useK8sWatchResources(watchResources)
return ...
}| Parameter Name | Description |
|---|
|
initResources
|
resources need to be watched as key-value pair, wherein key will be unique to resource and value will be options needed to watch for the respective resource.
|
consoleFetch
A custom wrapper around fetch that adds console specific headers and allows for retries and timeouts.It also validates the response status code and throws appropriate error or logs out the user if required. It returns a promise that resolves to the response.
| Parameter Name | Description |
|---|
|
url
|
The URL to fetch
|
|
options
|
The options to pass to fetch
|
|
timeout
|
The timeout in milliseconds
|
consoleFetchJSON
A custom wrapper around fetch that adds console specific headers and allows for retries and timeouts. It also validates the response status code and throws appropriate error or logs out the user if required. It returns the response as a JSON object. Uses consoleFetch internally. It returns a promise that resolves to the response as JSON object.
| Parameter Name | Description |
|---|
|
url
|
The URL to fetch
|
|
method
|
The HTTP method to use. Defaults to GET
|
|
options
|
The options to pass to fetch
|
|
timeout
|
The timeout in milliseconds
|
|
cluster
|
The name of the cluster to make the request to. Defaults to the active cluster the user has selected
|
consoleFetchText
A custom wrapper around fetch that adds console specific headers and allows for retries and timeouts. It also validates the response status code and throws appropriate error or logs out the user if required. It returns the response as a text. Uses consoleFetch internally. It returns a promise that resolves to the response as text.
| Parameter Name | Description |
|---|
|
url
|
The URL to fetch
|
|
options
|
The options to pass to fetch
|
|
timeout
|
The timeout in milliseconds
|
|
cluster
|
The name of the cluster to make the request to. Defaults to the active cluster the user has selected
|
A function that creates impersonation and multicluster related headers for API requests using current redux state. it returns an object containing the appropriate impersonation and clustr requst headers, based on redux state.
| Parameter Name | Description |
|---|
|
targetCluster
|
override the current active cluster with the provided targetCluster
|
k8sGetResource
It fetches a resource from the cluster, based on the provided options. If the name is provided it returns one resource else it returns all the resources matching the model. It returns a promise that resolves to the response as JSON object with a resource if the name is providedelse it returns all the resources matching the model. In case of failure, the promise gets rejected with HTTP error response.
| Parameter Name | Description |
|---|
|
options
|
Which are passed as key-value pairs in the map
|
|
``
|
options.model - k8s model
|
|
``
|
options.name - The name of the resource, if not provided then it’ll look for all the resources matching the model.
|
|
``
|
options.ns - The namespace to look into, should not be specified for cluster-scoped resources.
|
|
``
|
options.path - Appends as subpath if provided
|
|
``
|
options.queryParams - The query parameters to be included in the URL.
|
|
``
|
options.requestInit - The fetch init object to use. This can have request headers, method, redirect, etc. See more (link: https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_lib_dom_d.requestinit.html)
|
k8sCreateResource
It creates a resource in the cluster, based on the provided options. It returns a promise that resolves to the response of the resource created. In case of failure promise gets rejected with HTTP error response.
| Parameter Name | Description |
|---|
|
options
|
Which are passed as key-value pairs in the map
|
|
``
|
options.model - k8s model
|
|
``
|
options.data - payload for the resource to be created
|
|
``
|
options.path - Appends as subpath if provided
|
|
``
|
options.queryParams - The query parameters to be included in the URL.
|
k8sUpdateResource
It updates the entire resource in the cluster, based on providedoptions. When a client needs to replace an existing resource entirely, they can use k8sUpdate. Alternatively can use k8sPatch to perform the partial update. It returns a promise that resolves to the response of the resource updated. In case of failure promise gets rejected with HTTP error response.
| Parameter Name | Description |
|---|
|
options
|
which are passed as key-value pair in the map
|
|
``
|
options.model - k8s model
|
|
``
|
options.data - payload for the k8s resource to be updated
|
|
``
|
options.ns - namespace to look into, it should not be specified for cluster-scoped resources.
|
|
``
|
options.name - resource name to be updated.
|
|
``
|
options.path - Appends as subpath if provided
|
|
``
|
options.queryParams - The query parameters to be included in the URL.
|
k8sPatchResource
It patches any resource in the cluster, based on provided options. When a client needs to perform the partial update, they can use k8sPatch. Alternatively can use k8sUpdate to replace an existing resource entirely. See more Data Tracker. It returns a promise that resolves to the response of the resource patched. In case of failure promise gets rejected with HTTP error response.
| Parameter Name | Description |
|---|
|
options
|
Which are passed as key-value pairs in the map.
|
|
``
|
options.model - k8s model
|
|
``
|
options.resource - The resource to be patched.
|
|
``
|
options.data - Only the data to be patched on existing resource with the operation, path, and value.
|
|
``
|
options.path - Appends as subpath if provided.
|
|
``
|
options.queryParams - The query parameters to be included in the URL.
|
k8sDeleteResource
It deletes resources from the cluster, based on the provided model, resource. The garbage collection works based on 'Foreground'|'Background', can be configured with propagationPolicy property in provided model or passed in json. It returns a promise that resolves to the response of kind Status. In case of failure promise gets rejected with HTTP error response.
{ kind: 'DeleteOptions', apiVersion: 'v1', propagationPolicy }| Parameter Name | Description |
|---|
|
options
|
which are passed as key-value pair in the map.
|
|
``
|
options.model - k8s model
|
|
``
|
options.resource - The resource to be deleted.
|
|
``
|
options.path - Appends as subpath if provided
|
|
``
|
options.queryParams - The query parameters to be included in the URL.
|
|
``
|
options.requestInit - The fetch init object to use. This can have request headers, method, redirect, etc. See more \{@link https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_lib_dom_d.requestinit.html }
|
|
``
|
options.json - Can control garbage collection of resources explicitly if provided else will default to model’s "propagationPolicy".
|
k8sListResource
Lists the resources as an array in the cluster, based on provided options. It returns a promise that resolves to the response.
| Parameter Name | Description |
|---|
|
options
|
Which are passed as key-value pairs in the map
|
|
``
|
options.model - k8s model
|
|
``
|
options.queryParams - The query parameters to be included in the URL and can pass label selector’s as well with key "labelSelector".
|
|
``
|
options.requestInit - The fetch init object to use. This can have request headers, method, redirect, etc. See more \{@link https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_lib_dom_d.requestinit.html }
|
k8sListResourceItems
Same interface as \{@link k8sListResource} but returns the sub items. It returns the apiVersion for the model i.e group/version.
Provides apiVersion for a k8s model.
| Parameter Name | Description |
|---|
|
model
|
k8s model
|
getGroupVersionKindForResource
Provides a group, version, and kind for a resource. It returns the group, version, kind for the provided resource. If the resource does not have an API group, group "core" will be returned.If the resource has an invalid apiVersion then it’ll throw Error.
| Parameter Name | Description |
|---|
|
resource
|
k8s resource
|
Provides a group, version, and kind for a k8s model. This returns the group, version, kind for the provided model. If the model does not have an apiGroup, group "core" will be returned.
| Parameter Name | Description |
|---|
|
model
|
k8s model
|
Component that shows the status in a popup window. Helpful component for building console.dashboards/overview/health/resource extensions.
<StatusPopupSection
firstColumn={
<>
<span>{title}</span>
<span className="text-secondary">
My Example Item
</span>
</>
}
secondColumn='Status'
>| Parameter Name | Description |
|---|
|
firstColumn
|
values for first column of popup
|
|
secondColumn
|
(optional) values for second column of popup
|
|
children
|
(optional) children for the popup
|
Status element used in status popup; used in StatusPopupSection.
<StatusPopupSection
firstColumn='Example'
secondColumn='Status'
>
<StatusPopupItem icon={healthStateMapping[MCGMetrics.state]?.icon}>
Complete
</StatusPopupItem>
<StatusPopupItem icon={healthStateMapping[RGWMetrics.state]?.icon}>
Pending
</StatusPopupItem>
</StatusPopupSection>| Parameter Name | Description |
|---|
|
value
|
(optional) text value to display
|
|
icon
|
(optional) icon to display
|
|
children
|
child elements
|
Overview
Creates a wrapper component for a dashboard.
<Overview>
<OverviewGrid mainCards={mainCards} leftCards={leftCards} rightCards={rightCards} />
</Overview>| Parameter Name | Description |
|---|
|
className
|
(optional) style class for div
|
|
children
|
(optional) elements of the dashboard
|
OverviewGrid
Creates a grid of card elements for a dashboard; used within Overview.
<Overview>
<OverviewGrid mainCards={mainCards} leftCards={leftCards} rightCards={rightCards} />
</Overview>| Parameter Name | Description |
|---|
|
mainCards
|
cards for grid
|
|
leftCards
|
(optional) cards for left side of grid
|
|
rightCards
|
(optional) cards for right side of grid
|
InventoryItem
Creates an inventory card item.
return (
<InventoryItem>
<InventoryItemTitle>{title}</InventoryItemTitle>
<InventoryItemBody error={loadError}>
{loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
</InventoryItemBody>
</InventoryItem>
)| Parameter Name | Description |
|---|
|
children
|
elements to render inside the item
|
InventoryItemTitle
Creates a title for an inventory card item; used within InventoryItem.
return (
<InventoryItem>
<InventoryItemTitle>{title}</InventoryItemTitle>
<InventoryItemBody error={loadError}>
{loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
</InventoryItemBody>
</InventoryItem>
)| Parameter Name | Description |
|---|
|
children
|
elements to render inside the title
|
InventoryItemBody
Creates the body of an inventory card; used within InventoryCard and can be used with InventoryTitle.
return (
<InventoryItem>
<InventoryItemTitle>{title}</InventoryItemTitle>
<InventoryItemBody error={loadError}>
{loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
</InventoryItemBody>
</InventoryItem>
)| Parameter Name | Description |
|---|
|
children
|
elements to render inside the Inventory Card or title
|
|
error
|
elements of the div
|
InventoryItemStatus
Creates a count and icon for an inventory card with optional link address; used within InventoryItemBody
return (
<InventoryItem>
<InventoryItemTitle>{title}</InventoryItemTitle>
<InventoryItemBody error={loadError}>
{loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
</InventoryItemBody>
</InventoryItem>
)| Parameter Name | Description |
|---|
|
count
|
count for display
|
|
icon
|
icon for display
|
|
linkTo
|
(optional) link address
|
InventoryItemLoading
Creates a skeleton container for when an inventory card is loading; used with InventoryItem and related components
if (loadError) {
title = <Link to={workerNodesLink}>{t('Worker Nodes')}</Link>;
} else if (!loaded) {
title = <><InventoryItemLoading /><Link to={workerNodesLink}>{t('Worker Nodes')}</Link></>;
}
return (
<InventoryItem>
<InventoryItemTitle>{title}</InventoryItemTitle>
</InventoryItem>
)useFlag
Hook that returns the given feature flag from FLAGS redux state. It returns the boolean value of the requested feature flag or undefined.
| Parameter Name | Description |
|---|
|
flag
|
The feature flag to return
|
YAMLEditor
A basic lazy loaded YAML editor with hover help and completion.
<React.Suspense fallback={<LoadingBox />}>
<YAMLEditor
value={code}
/>
</React.Suspense>ResourceYAMLEditor
A lazy loaded YAML editor for Kubernetes resources with hover help and completion. The component use the YAMLEditor and add on top of it more functionality likeresource update handling, alerts, save, cancel and reload buttons, accessibility and more. Unless onSave callback is provided, the resource update is automatically handled.It should be wrapped in a React.Suspense component.
<React.Suspense fallback={<LoadingBox />}>
<ResourceYAMLEditor
initialResource={resource}
header="Create resource"
onSave={(content) => updateResource(content)}
/>
</React.Suspense>| Parameter Name | Description |
|---|
|
initialResource
|
YAML/Object representing a resource to be shown by the editor. This prop is used only during the initial render
|
|
header
|
Add a header on top of the YAML editor
|
|
onSave
|
Callback for the Save button. Passing it will override the default update performed on the resource by the editor
|
ResourceEventStream
A component to show events related to a particular resource.
const [resource, loaded, loadError] = useK8sWatchResource(clusterResource);
return <ResourceEventStream resource={resource} />| Parameter Name | Description |
|---|
|
resource
|
An object whose related events should be shown.
|
usePrometheusPoll
Sets up a poll to Prometheus for a single query. It returns a tuple containing the query response, a boolean flag indicating whether the response has completed, and any errors encountered during the request or post-processing of the request.
| Parameter Name | Description |
|---|
|
``
|
{PrometheusEndpoint} props.endpoint - one of the PrometheusEndpoint (label, query, range, rules, targets)
|
|
``
|
{string} [props.query] - (optional) Prometheus query string. If empty or undefined, polling is not started.
|
|
``
|
{number} [props.delay] - (optional) polling delay interval (ms)
|
|
``
|
{number} [props.endTime] - (optional) for QUERY_RANGE enpoint, end of the query range
|
|
``
|
{number} [props.samples] - (optional) for QUERY_RANGE enpoint
|
|
``
|
{number} [options.timespan] - (optional) for QUERY_RANGE enpoint
|
|
``
|
{string} [options.namespace] - (optional) a search param to append
|
|
``
|
{string} [options.timeout] - (optional) a search param to append
|
Timestamp
A component to render timestamp. The timestamps are synchronized between invidual instances of the Timestamp component. The provided timestamp is formatted according to user locale.
| Parameter Name | Description |
|---|
|
timestamp
|
the timestamp to render. Format is expected to be ISO 8601 (used by Kubernetes), epoch timestamp, or an instance of a Date.
|
|
simple
|
render simple version of the component omitting icon and tooltip.
|
|
omitSuffix
|
formats the date ommiting the suffix.
|
|
className
|
additional class name for the component.
|
useModal
A hook to launch Modals.
const context: AppPage: React.FC = () => {<br/> const [launchModal] = useModal();<br/> const onClick = () => launchModal(ModalComponent);<br/> return (<br/> <Button onClick={onClick}>Launch a Modal</Button><br/> )<br/>}<br/>`ActionServiceProvider
Component that allows to receive contributions from other plugins for the console.action/provider extension type.
const context: ActionContext = { 'a-context-id': { dataFromDynamicPlugin } };
...
<ActionServiceProvider context={context}>
{({ actions, options, loaded }) =>
loaded && (
<ActionMenu actions={actions} options={options} variant={ActionMenuVariant.DROPDOWN} />
)
}
</ActionServiceProvider>| Parameter Name | Description |
|---|
|
context
|
Object with contextId and optional plugin data
|
NamespaceBar
A component that renders a horizontal toolbar with a namespace dropdown menu in the leftmost position. Additional components can be passed in as children and will be rendered to the right of the namespace dropdown. This component is designed to be used at the top of the page. It should be used on pages where the user needs to be able to change the active namespace, such as on pages with k8s resources.
const logNamespaceChange = (namespace) => console.log(`New namespace: ${namespace}`);
...
<NamespaceBar onNamespaceChange={logNamespaceChange}>
<NamespaceBarApplicationSelector />
</NamespaceBar>
<Page>
...| Parameter Name | Description |
|---|
|
onNamespaceChange
|
(optional) A function that is executed when a namespace option is selected. It accepts the new namespace in the form of a string as its only argument. The active namespace is updated automatically when an option is selected, but additional logic can be applied via this function. When the namespace is changed, the namespace parameter in the URL will be changed from the previous namespace to the newly selected namespace.
|
|
isDisabled
|
(optional) A boolean flag that disables the namespace dropdown if set to true. This option only applies to the namespace dropdown and has no effect on child components.
|
|
children
|
(optional) Additional elements to be rendered inside the toolbar to the right of the namespace dropdown.
|
ErrorBoundaryFallbackPage
Creates full page ErrorBoundaryFallbackPage component to display the "Oh no! Something went wrong." message along with the stack trace and other helpful debugging information. This is to be used inconjunction with an component.
//in ErrorBoundary component
return (
if (this.state.hasError) {
return <ErrorBoundaryFallbackPage errorMessage={errorString} componentStack={componentStackString}
stack={stackTraceString} title={errorString}/>;
}
return this.props.children;
)| Parameter Name | Description |
|---|
|
errorMessage
|
text description of the error message
|
|
componentStack
|
component trace of the exception
|
|
stack
|
stack trace of the exception
|
|
title
|
title to render as the header of the error boundary page
|
PerspectiveContext
@deprecated - use the provided usePerspectiveContext insteadCreates the perspective context.
| Parameter Name | Description |
|---|
|
PerspectiveContextType
|
object with active perspective and setter
|
useAccessReviewAllowed
@deprecated - Use useAccessReview from @console/dynamic-plugin-sdk instead.Hook that provides allowed status about user access to a given resource. It returns the isAllowed boolean value.
| Parameter Name | Description |
|---|
|
resourceAttributes
|
resource attributes for access review
|
|
impersonate
|
impersonation details
|
useSafetyFirst
@deprecated - This hook is not related to console functionality.Hook that ensures a safe asynchronnous setting of React state in case a given component could be unmounted. It returns an array with a pair of state value and it’s set function.
| Parameter Name | Description |
|---|
|
initialState
|
initial state value
|
