7.5. Référence du plugin dynamique

Vous pouvez ajouter des extensions qui vous permettent de personnaliser votre plugin. Ces extensions sont ensuite chargées dans la console au moment de l'exécution.

7.5.1. Types d'extensions dynamiques de plugins

`console.action/filter`

ActionFilter peut être utilisé pour filtrer une action.

Nom	Type de valeur	En option	Description
`contextId`	`string`	non	L'identifiant de contexte permet de limiter la portée des actions de contribution à un domaine particulier de l'application. Les exemples incluent `topology` et `helm`.
`filter`	`CodeRef<(scope: any, action: Action) ⇒ boolean>`	non	Une fonction qui filtrera les actions sur la base de certaines conditions. `scope`: Le champ d'application dans lequel les actions doivent être prévues. Un crochet peut être nécessaire si vous souhaitez supprimer l'action `ModifyCount` d'un déploiement avec un pod autoscaler horizontal (HPA).

`console.action/group`

ActionGroup contribue à un groupe d'actions qui peut également être un sous-menu.

Nom	Type de valeur	En option	Description
`id`	`string`	non	ID utilisé pour identifier la section d'action.
`label`	`string`	yes	L'étiquette à afficher dans l'interface utilisateur. Nécessaire pour les sous-menus.
`submenu`	`boolean`	yes	Indique si ce groupe doit être affiché en tant que sous-menu.
`insertBefore`	`string` \| `string[]`	yes	Insérer cet élément avant l'élément référencé ici. Pour les tableaux, le premier élément trouvé dans l'ordre est utilisé.
`insertAfter`	`string` \| `string[]`	yes	Insérer cet élément après l'élément référencé ici. Pour les tableaux, le premier élément trouvé dans l'ordre est utilisé. La valeur `insertBefore` est prioritaire.

`console.action/provider`

ActionProvider apporte un crochet qui renvoie une liste d'actions pour un contexte spécifique.

Nom	Type de valeur	En option	Description
`contextId`	`string`	non	L'identifiant de contexte permet de limiter la portée des actions de contribution à un domaine particulier de l'application. Les exemples incluent `topology` et `helm`.
`provider`	`CodeRef<ExtensionHook<Action[], any>>`	non	Un crochet React qui renvoie des actions pour le champ d'application donné. Si `contextId` = `resource`, le champ d'application sera toujours un objet ressource Kubernetes.

`console.action/resource-provider`

ResourceActionProvider apporte un crochet qui renvoie une liste d'actions pour un modèle de ressource spécifique.

Nom	Type de valeur	En option	Description
`model`	`ExtensionK8sKindVersionModel`	non	Le modèle pour lequel ce prestataire fournit des actions.
`provider`	`CodeRef<ExtensionHook<Action[], any>>`	non	Un hook react qui renvoie des actions pour le modèle de ressource donné

`console.alert-action`

Nom	Type de valeur	En option
`alert`	`string`	non
`text`	`string`	non
`action`	`CodeRef<(alert: any) ⇒ void>`	non

`console.catalog/item-filter`

Nom	Type de valeur	En option	Description
`catalogId`	`string` \| `string[]`	non	L'identifiant unique du catalogue auquel ce fournisseur contribue.
`type`	`string`	non	ID de type pour le type d'article du catalogue.
`filter`	`CodeRef<(item: CatalogItem) ⇒ boolean>`	non	Filtre les éléments d'un type spécifique. Value est une fonction qui prend `CatalogItem[]` et renvoie un sous-ensemble basé sur les critères de filtrage.

`console.catalog/item-metadata`

Nom	Type de valeur	En option	Description
`catalogId`	`string` \| `string[]`	non	L'identifiant unique du catalogue auquel ce fournisseur contribue.
`type`	`string`	non	ID de type pour le type d'article du catalogue.
`provider`	`CodeRef<ExtensionHook<CatalogItemMetadataProviderFunction, CatalogExtensionHookOptions>>`	non	Un crochet qui renvoie une fonction qui sera utilisée pour fournir des métadonnées aux éléments de catalogue d'un type spécifique.

`console.catalog/item-provider`

Nom	Type de valeur	En option	Description
`catalogId`	`string` \| `string[]`	non	L'identifiant unique du catalogue auquel ce fournisseur contribue.
`type`	`string`	non	ID de type pour le type d'article du catalogue.
`title`	`string`	non	Titre du fournisseur de l'article de catalogue
`provider`	`CodeRef<ExtensionHook<CatalogItem<any>[], CatalogExtensionHookOptions>>`	non	Récupère les éléments et les normalise pour le catalogue. La valeur est un crochet d'effet react.
`priority`	`number`	yes	Priorité pour ce fournisseur. La valeur par défaut est `0`. Les fournisseurs ayant une priorité plus élevée peuvent remplacer les éléments de catalogue fournis par d'autres fournisseurs.

`console.catalog/item-type`

Nom	Type de valeur	En option	Description
`type`	`string`	non	Type d'élément du catalogue.
`title`	`string`	non	Titre de l'article du catalogue.
`catalogDescription`	`string` \| `CodeRef<React.ReactNode>`	yes	Description du catalogue spécifique au type.
`typeDescription`	`string`	yes	Description du type d'article du catalogue.
`filters`	`CatalogItemAttribute[]`	yes	Filtres personnalisés spécifiques à l'article du catalogue.
`groupings`	`CatalogItemAttribute[]`	yes	Regroupements personnalisés spécifiques à l'article du catalogue.

`console.catalog/item-type-metadata`

Nom	Type de valeur	En option	Description
`type`	`string`	non	Type d'élément du catalogue.
`filters`	`CatalogItemAttribute[]`	yes	Filtres personnalisés spécifiques à l'article du catalogue.
`groupings`	`CatalogItemAttribute[]`	yes	Regroupements personnalisés spécifiques à l'article du catalogue.

`console.cluster-overview/inventory-item`

Ajoute un nouvel élément d'inventaire à la page d'aperçu du cluster.

Nom	Type de valeur	En option	Description
`component`	`CodeRef<React.ComponentType<{}>>`	non	Le composant à rendre.

`console.cluster-overview/multiline-utilization-item`

Ajoute un nouvel élément d'utilisation multi-lignes de la vue d'ensemble du cluster.

Nom	Type de valeur	En option	Description
`title`	`string`	non	Titre de l'élément d'utilisation.
`getUtilizationQueries`	`CodeRef<GetMultilineQueries>`	non	Demande d'utilisation du Prométhée.
`humanize`	`CodeRef<Humanize>`	non	Convertir les données Prometheus en format lisible par l'homme.
`TopConsumerPopovers`	`CodeRef<React.ComponentType<TopConsumerPopoverProps>[]>`	yes	Affiche le popover Top consumer au lieu d'une simple valeur

`console.cluster-overview/utilization-item`

Ajoute un nouvel élément d'utilisation de la vue d'ensemble du cluster.

Nom	Type de valeur	En option	Description
`title`	`string`	non	Titre de l'élément d'utilisation.
`getUtilizationQuery`	`CodeRef<GetQuery>`	non	Demande d'utilisation du Prométhée.
`humanize`	`CodeRef<Humanize>`	non	Convertir les données Prometheus en format lisible par l'homme.
`getTotalQuery`	`CodeRef<GetQuery>`	yes	Requête totale de Prometheus.
`getRequestQuery`	`CodeRef<GetQuery>`	yes	Requête de demande de Prométhée.
`getLimitQuery`	`CodeRef<GetQuery>`	yes	Demande de limite de Prométhée.
`TopConsumerPopover`	`CodeRef<React.ComponentType<TopConsumerPopoverProps>>`	yes	Affiche le popover Top consumer au lieu d'une simple valeur

`console.context-provider`

Ajoute un nouveau fournisseur de contexte React à la racine de l'application de la console web.

Nom	Type de valeur	En option	Description
`provider`	`CodeRef<Provider<T>>`	non	Composant du fournisseur de contexte.
`useValueHook`	`CodeRef<() ⇒ T>`	non	Crochet pour la valeur du contexte.

`console.dashboards/card`

Ajoute une nouvelle carte de tableau de bord.

Nom	Type de valeur	En option	Description
`tab`	`string`	non	L'ID de l'onglet du tableau de bord auquel la carte sera ajoutée.
`position`	`'LEFT' \| 'RIGHT' \| 'MAIN'`	non	La position de la carte sur le tableau de bord.
`component`	`CodeRef<React.ComponentType<{}>>`	non	Composant de la carte du tableau de bord.
`span`	`OverviewCardSpan`	yes	Espace vertical de la carte dans la colonne. Ignoré pour les petits écrans ; la valeur par défaut est `12`.

`console.dashboards/overview/activity/resource`

Ajoute une activité à la carte d'activité du tableau de bord de la vue d'ensemble où le déclenchement de l'activité est basé sur l'observation d'une ressource Kubernetes.

Nom	Type de valeur	En option	Description
`k8sResource`	`CodeRef<FirehoseResource & { isList: true; }>`	non	Le poste d'utilisation à remplacer.
`component`	`CodeRef<React.ComponentType<K8sActivityProps<T>>>`	non	La composante action.
`isActivity`	`CodeRef<(resource: T) ⇒ boolean>`	yes	Fonction qui détermine si la ressource donnée représente l'action. Si elle n'est pas définie, chaque ressource représente l'activité.
`getTimestamp`	`CodeRef<(resource: T) ⇒ Date>`	yes	Horodatage de l'action donnée, qui sera utilisé pour la commande.

`console.dashboards/overview/detail/item`

Ajoute un élément à la carte Details du tableau de bord Overview.

Nom	Type de valeur	En option	Description
`component`	`CodeRef<React.ComponentType<{}>>`	non	La valeur, basée sur la composante `DetailItem`

`console.dashboards/overview/health/operator`

Ajoute un sous-système de santé à la carte d'état du tableau de bord Overview, où la source d'état est une API REST Kubernetes.

Nom	Type de valeur	En option	Description
`title`	`string`	non	Titre de la section Opérateurs dans le menu contextuel.
`resources`	`CodeRef<FirehoseResource[]>`	non	Ressources Kubernetes qui seront récupérées et transmises à `healthHandler`.
`getOperatorsWithStatuses`	`CodeRef<GetOperatorsWithStatuses<T>>`	yes	Résout les problèmes de statut des opérateurs.
`operatorRowLoader`	`CodeRef<React.ComponentType<OperatorRowProps<T>>>`	yes	Chargeur pour le composant "pop-up row".
`viewAllLink`	`string`	yes	Liens vers la page de toutes les ressources. Si elle n'est pas fournie, la page de liste de la première ressource de la liste des ressources est utilisée.

`console.dashboards/overview/health/prometheus`

Ajoute un sous-système de santé à la carte d'état d'un tableau de bord de synthèse dont la source d'état est Prometheus.

Nom	Type de valeur	En option	Description
`title`	`string`	non	Nom d'affichage du sous-système.
`queries`	`string[]`	non	Les requêtes de Prométhée
`healthHandler`	`CodeRef<PrometheusHealthHandler>`	non	Résoudre le problème de santé du sous-système.
`additionalResource`	`CodeRef<FirehoseResource>`	yes	Ressource supplémentaire qui sera recherchée et transmise à `healthHandler`.
`popupComponent`	`CodeRef<React.ComponentType<PrometheusHealthPopupProps>>`	yes	Chargeur pour le contenu du menu contextuel. S'il est défini, un élément de santé est représenté par un lien qui ouvre un menu contextuel avec le contenu donné.
`popupTitle`	`string`	yes	Le titre du popover.
`disallowedControlPlaneTopology`	`string[]`	yes	Topologie du plan de contrôle pour laquelle le sous-système doit être masqué.

`console.dashboards/overview/health/resource`

Ajoute un sous-système de santé à la carte d'état du tableau de bord Overview lorsque la source d'état est une ressource Kubernetes.

Nom	Type de valeur	En option	Description
`title`	`string`	non	Nom d'affichage du sous-système.
`resources`	`CodeRef<WatchK8sResources<T>>`	non	Ressources Kubernetes qui seront récupérées et transmises à `healthHandler`.
`healthHandler`	`CodeRef<ResourceHealthHandler<T>>`	non	Résoudre le problème de santé du sous-système.
`popupComponent`	`CodeRef<WatchK8sResults<T>>`	yes	Chargeur pour le contenu du menu contextuel. S'il est défini, un élément de santé est représenté par un lien qui ouvre un menu contextuel avec le contenu donné.
`popupTitle`	`string`	yes	Le titre du popover.

`console.dashboards/overview/health/url`

Ajoute un sous-système de santé à la carte d'état du tableau de bord Overview lorsque la source d'état est une API REST Kubernetes.

Nom	Type de valeur	En option	Description
`title`	`string`	non	Nom d'affichage du sous-système.
`url`	`string`	non	L'URL à partir de laquelle les données doivent être récupérées. Elle sera préfixée par l'URL de base de Kubernetes.
`healthHandler`	`CodeRef<URLHealthHandler<T, K8sResourceCommon	K8sResourceCommon[]>>`	non
Résoudre le problème de santé du sous-système.	`additionalResource`	`CodeRef<FirehoseResource>`	yes
Ressource supplémentaire qui sera recherchée et transmise à `healthHandler`.	`popupComponent`	`CodeRef<React.ComponentType<{ healthResult?: T; healthResultError?: any; k8sResult?: FirehoseResult<R>; }>>`	yes
Chargeur pour le contenu de la fenêtre contextuelle. S'il est défini, un élément de santé sera représenté par un lien qui ouvrira une fenêtre contextuelle avec le contenu donné.	`popupTitle`	`string`	yes

`console.dashboards/overview/inventory/item`

Ajoute une tuile de ressource à la carte d'inventaire de la vue d'ensemble.

Nom	Type de valeur	En option	Description
`model`	`CodeRef<T>`	non	Le modèle de `resource` qui sera récupéré. Utilisé pour obtenir le modèle `label` ou `abbr`.
`mapper`	`CodeRef<StatusGroupMapper<T, R>>`	yes	Fonction qui associe différents statuts à des groupes.
`additionalResources`	`CodeRef<WatchK8sResources<R>>`	yes	Ressources supplémentaires qui seront récupérées et transmises à la fonction `mapper`.

`console.dashboards/overview/inventory/item/group`

Ajoute un groupe d'état d'inventaire.

Nom	Type de valeur	En option	Description
`id`	`string`	non	L'identifiant du groupe d'état.
`icon`	`CodeRef<React.ReactElement<any, string` \| `React.JSXElementConstructor<any>>>`	non	Composant React représentant l'icône du groupe d'état.

`console.dashboards/overview/inventory/item/replacement`

Remplace une carte d'inventaire.

Nom	Type de valeur	En option	Description
`model`	`CodeRef<T>`	non	Le modèle de `resource` qui sera récupéré. Utilisé pour obtenir le modèle `label` ou `abbr`.
`mapper`	`CodeRef<StatusGroupMapper<T, R>>`	yes	Fonction qui associe différents statuts à des groupes.
`additionalResources`	`CodeRef<WatchK8sResources<R>>`	yes	Ressources supplémentaires qui seront récupérées et transmises à la fonction `mapper`.

`console.dashboards/overview/prometheus/activity/resource`

Ajoute une activité à la carte d'activité du tableau de bord Prometheus Overview où le déclenchement de l'activité est basé sur l'observation d'une ressource Kubernetes.

Nom	Type de valeur	En option	Description
`queries`	`string[]`	non	Requêtes à surveiller
`component`	`CodeRef<React.ComponentType<PrometheusActivityProps>>`	non	La composante action.
`isActivity`	`CodeRef<(results: PrometheusResponse[]) ⇒ boolean>`	yes	Fonction qui détermine si la ressource donnée représente l'action. Si elle n'est pas définie, chaque ressource représente l'activité.

`console.dashboards/project/overview/item`

Ajoute une tuile de ressource à la carte d'inventaire de la vue d'ensemble du projet.

Nom	Type de valeur	En option	Description
`model`	`CodeRef<T>`	non	Le modèle de `resource` qui sera récupéré. Utilisé pour obtenir le modèle `label` ou `abbr`.
`mapper`	`CodeRef<StatusGroupMapper<T, R>>`	yes	Fonction qui associe différents statuts à des groupes.
`additionalResources`	`CodeRef<WatchK8sResources<R>>`	yes	Ressources supplémentaires qui seront récupérées et transmises à la fonction `mapper`.

`console.dashboards/tab`

Ajoute un nouvel onglet au tableau de bord, placé après l'onglet Overview.

Nom	Type de valeur	En option	Description
`id`	`string`	non	Identifiant unique de l'onglet, utilisé comme lien vers l'onglet `href` et lors de l'ajout de cartes à cet onglet.
`navSection`	`'home' \| 'storage'`	non	Section de navigation à laquelle appartient l'onglet.
`title`	`string`	non	Le titre de l'onglet.

`console.file-upload`

Nom	Type de valeur	En option	Description
`fileExtensions`	`string[]`	non	Extensions de fichiers prises en charge.
`handler`	`CodeRef<FileUploadHandler>`	non	Fonction qui gère l'action de dépôt de fichier.

`console.flag`

Permet de contrôler entièrement les drapeaux des fonctions de la console web.

Nom	Type de valeur	En option	Description
`handler`	`CodeRef<FeatureFlagHandler>`	non	Permet d'activer ou de désactiver des drapeaux de caractéristiques arbitraires.

`console.flag/hookProvider`

Permet de contrôler entièrement les indicateurs de fonctionnalité de la console web avec des gestionnaires de crochets.

Nom	Type de valeur	En option	Description
`handler`	`CodeRef<FeatureFlagHandler>`	non	Permet d'activer ou de désactiver des drapeaux de caractéristiques arbitraires.

`console.flag/model`

Ajout d'une nouvelle fonctionnalité de la console web, pilotée par la présence d'un CRD sur le cluster.

Nom	Type de valeur	En option	Description
`flag`	`string`	non	Nom de l'indicateur à activer lorsque le CRD est détecté.
`model`	`ExtensionK8sModel`	non	Le modèle qui se réfère à une `CustomResourceDefinition`.

`console.global-config`

Nom	Type de valeur	En option	Description
`id`	`string`	non	Identifiant unique de l'instance de ressource de configuration de cluster.
`name`	`string`	non	Le nom de l'instance de ressource de configuration de cluster.
`model`	`ExtensionK8sModel`	non	Le modèle qui se réfère à une ressource de configuration de cluster.
`namespace`	`string`	non	L'espace de noms de l'instance de ressource de configuration de cluster.

`console.model-metadata`

Personnaliser l'affichage des modèles en remplaçant les valeurs récupérées et générées par la découverte de l'API.

Nom	Type de valeur	En option	Description
`model`	`ExtensionK8sGroupModel`	non	Le modèle à personnaliser. Peut ne spécifier qu'un groupe, ou une version et un type optionnels.
`badge`	`ModelBadge`	yes	Considérer ou non ce modèle de référence comme un Technology Preview ou un Developer Preview.
`color`	`string`	yes	La couleur à associer à ce modèle.
`label`	`string`	yes	Remplacer l'étiquette. Nécessite que `kind` soit fourni.
`labelPlural`	`string`	yes	Remplacer l'étiquette plurielle. Exige que `kind` soit fourni.
`abbr`	`string`	yes	Personnalisez l'abréviation. Par défaut, tous les caractères majuscules de `kind` sont utilisés, dans la limite de 4 caractères. Nécessite que `kind` soit fourni.

`console.navigation/href`

Nom	Type de valeur	En option	Description
`id`	`string`	non	Un identifiant unique pour cet élément.
`name`	`string`	non	Le nom de cet élément.
`href`	`string`	non	La valeur de la référence du lien.
`perspective`	`string`	yes	L'identifiant de la perspective à laquelle cet élément appartient. Si elle n'est pas spécifiée, elle contribue à la perspective par défaut.
`section`	`string`	yes	Section de navigation à laquelle cet élément appartient. S'il n'est pas spécifié, cet élément est rendu comme un lien de premier niveau.
`dataAttributes`	`{ [key: string]: string; }`	yes	Ajoute des attributs de données au DOM.
`startsWith`	`string[]`	yes	Marquer cet élément comme actif lorsque l'URL commence par l'un de ces chemins.
`insertBefore`	`string` \| `string[]`	yes	Insérer cet élément avant l'élément référencé ici. Pour les tableaux, le premier élément trouvé dans l'ordre est utilisé.
`insertAfter`	`string` \| `string[]`	yes	Insérer cet élément après l'élément référencé ici. Pour les tableaux, le premier trouvé dans l'ordre est utilisé. `insertBefore` est prioritaire.
`namespaced`	`boolean`	yes	Si `true`, ajouter `/ns/active-namespace` à la fin.
`prefixNamespaced`	`boolean`	yes	Si `true`, ajoute `/k8s/ns/active-namespace` au début de l'article

`console.navigation/resource-cluster`

Nom	Type de valeur	En option	Description
`id`	`string`	non	Un identifiant unique pour cet élément.
`model`	`ExtensionK8sModel`	non	Le modèle auquel cet élément de navigation renvoie.
`perspective`	`string`	yes	L'identifiant de la perspective à laquelle cet élément appartient. Si elle n'est pas spécifiée, elle contribue à la perspective par défaut.
`section`	`string`	yes	Section de navigation à laquelle cet élément appartient. S'il n'est pas spécifié, cet élément est rendu comme un lien de premier niveau.
`dataAttributes`	`{ [key: string]: string; }`	yes	Ajoute des attributs de données au DOM.
`startsWith`	`string[]`	yes	Marquer cet élément comme actif lorsque l'URL commence par l'un de ces chemins.
`insertBefore`	`string` \| `string[]`	yes	Insérer cet élément avant l'élément référencé ici. Pour les tableaux, le premier élément trouvé dans l'ordre est utilisé.
`insertAfter`	`string` \| `string[]`	yes	Insérer cet élément après l'élément référencé ici. Pour les tableaux, le premier trouvé dans l'ordre est utilisé. `insertBefore` est prioritaire.
`name`	`string`	yes	Remplace le nom par défaut. S'il n'est pas fourni, le nom du lien sera égal à la valeur plurielle du modèle.

`console.navigation/resource-ns`

Nom	Type de valeur	En option	Description
`id`	`string`	non	Un identifiant unique pour cet élément.
`model`	`ExtensionK8sModel`	non	Le modèle auquel cet élément de navigation renvoie.
`perspective`	`string`	yes	L'identifiant de la perspective à laquelle cet élément appartient. Si elle n'est pas spécifiée, elle contribue à la perspective par défaut.
`section`	`string`	yes	Section de navigation à laquelle cet élément appartient. S'il n'est pas spécifié, cet élément est rendu comme un lien de premier niveau.
`dataAttributes`	`{ [key: string]: string; }`	yes	Ajoute des attributs de données au DOM.
`startsWith`	`string[]`	yes	Marquer cet élément comme actif lorsque l'URL commence par l'un de ces chemins.
`insertBefore`	`string \| string[]`	yes	Insérer cet élément avant l'élément référencé ici. Pour les tableaux, le premier élément trouvé dans l'ordre est utilisé.
`insertAfter`	`string` \| `string[]`	yes	Insérer cet élément après l'élément référencé ici. Pour les tableaux, le premier trouvé dans l'ordre est utilisé. `insertBefore` est prioritaire.
`name`	`string`	yes	Remplace le nom par défaut. S'il n'est pas fourni, le nom du lien sera égal à la valeur plurielle du modèle.

`console.navigation/section`

Nom	Type de valeur	En option	Description
`id`	`string`	non	Un identifiant unique pour cet élément.
`perspective`	`string`	yes	L'identifiant de la perspective à laquelle cet élément appartient. Si elle n'est pas spécifiée, elle contribue à la perspective par défaut.
`dataAttributes`	`{ [key: string]: string; }`	yes	Ajoute des attributs de données au DOM.
`insertBefore`	`string` \| `string[]`	yes	Insérer cet élément avant l'élément référencé ici. Pour les tableaux, le premier élément trouvé dans l'ordre est utilisé.
`insertAfter`	`string` \| `string[]`	yes	Insérer cet élément après l'élément référencé ici. Pour les tableaux, le premier trouvé dans l'ordre est utilisé. `insertBefore` est prioritaire.
`name`	`string`	yes	Nom de cette section. S'il n'est pas fourni, seul un séparateur sera affiché au-dessus de la section.

`console.navigation/separator`

Nom	Type de valeur	En option	Description
`id`	`string`	non	Un identifiant unique pour cet élément.
`perspective`	`string`	yes	L'identifiant de la perspective à laquelle cet élément appartient. Si elle n'est pas spécifiée, elle contribue à la perspective par défaut.
`section`	`string`	yes	Section de navigation à laquelle cet élément appartient. S'il n'est pas spécifié, cet élément est rendu comme un lien de premier niveau.
`dataAttributes`	`{ [key: string]: string; }`	yes	Ajoute des attributs de données au DOM.
`insertBefore`	`string` \| `string[]`	yes	Insérer cet élément avant l'élément référencé ici. Pour les tableaux, le premier élément trouvé dans l'ordre est utilisé.
`insertAfter`	`string` \| `string[]`	yes	Insérer cet élément après l'élément référencé ici. Pour les tableaux, le premier trouvé dans l'ordre est utilisé. `insertBefore` est prioritaire.

`console.page/resource/details`

Nom	Type de valeur	En option	Description
`model`	`ExtensionK8sGroupKindModel`	non	Le modèle pour lequel cette page de ressources renvoie.
`component`	`CodeRef<React.ComponentType<{ match: match<{}>; namespace: string; model: ExtensionK8sModel; }>>`	non	Le composant à afficher lorsque l'itinéraire correspond.

`console.page/resource/list`

Ajoute une nouvelle page de liste de ressources au routeur de la console.

Nom	Type de valeur	En option	Description
`model`	`ExtensionK8sGroupKindModel`	non	Le modèle pour lequel cette page de ressources renvoie.
`component`	`CodeRef<React.ComponentType<{ match: match<{}>; namespace: string; model: ExtensionK8sModel; }>>`	non	Le composant à afficher lorsque l'itinéraire correspond.

`console.page/route`

Ajoute une nouvelle page au routeur de la console web. Voir React Router.

Nom	Type de valeur	En option	Description
`component`	`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`	non	Le composant à afficher lorsque l'itinéraire correspond.
`path`	`string` \| `string[]`	non	Chemin d'URL valide ou tableau de chemins d'accès que `path-to-regexp@^1.7.0` comprend.
`perspective`	`string`	yes	La perspective à laquelle cette page appartient. Si elle n'est pas spécifiée, elle contribue à toutes les perspectives.
`exact`	`boolean`	yes	Si la valeur est vraie, la correspondance ne se fera que si le chemin d'accès correspond exactement à `location.pathname`.

`console.page/route/standalone`

Ajoute une nouvelle page autonome, rendue en dehors de la mise en page commune, au routeur de la console web. Voir React Router.

Nom	Type de valeur	En option	Description
`component`	`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`	non	Le composant à afficher lorsque l'itinéraire correspond.
`path`	`string` \| `string[]`	non	Chemin d'URL valide ou tableau de chemins d'accès que `path-to-regexp@^1.7.0` comprend.
`exact`	`boolean`	yes	Si la valeur est vraie, la correspondance ne se fera que si le chemin d'accès correspond exactement à `location.pathname`.

`console.perspective`

Nom	Type de valeur	En option	Description
`id`	`string`	non	L'identificateur de perspective.
`name`	`string`	non	Le nom d'affichage de la perspective.
`icon`	`CodeRef<LazyComponent>`	non	L'icône d'affichage de la perspective.
`landingPageURL`	`CodeRef<(flags: { [key: string]: boolean; }, isFirstVisit: boolean) ⇒ string>`	non	Fonction permettant d'obtenir l'URL de la page d'atterrissage de la perspective.
`importRedirectURL`	`CodeRef<(namespace: string) ⇒ string>`	non	La fonction pour obtenir l'URL de redirection pour le flux d'importation.
`default`	`boolean`	yes	Si la perspective est la valeur par défaut. Il ne peut y avoir qu'une seule valeur par défaut.
`defaultPins`	`ExtensionK8sModel[]`	yes	Ressources épinglées par défaut dans la navigation
`usePerspectiveDetection`	`CodeRef<() ⇒ [boolean, boolean]>`	yes	Le crochet pour détecter la perspective par défaut

`console.project-overview/inventory-item`

Ajoute un nouvel élément d'inventaire à la page Project Overview.

Nom	Type de valeur	En option	Description
`component`	`CodeRef<React.ComponentType<{ projectName: string; }>>`	non	Le composant à rendre.

`console.project-overview/utilization-item`

Ajoute un nouvel élément d'utilisation de la vue d'ensemble du projet.

Nom	Type de valeur	En option	Description
`title`	`string`	non	Titre de l'élément d'utilisation.
`getUtilizationQuery`	`CodeRef<GetProjectQuery>`	non	Demande d'utilisation du Prométhée.
`humanize`	`CodeRef<Humanize>`	non	Convertir les données Prometheus en format lisible par l'homme.
`getTotalQuery`	`CodeRef<GetProjectQuery>`	yes	Requête totale de Prometheus.
`getRequestQuery`	`CodeRef<GetProjectQuery>`	yes	Requête de demande de Prométhée.
`getLimitQuery`	`CodeRef<GetProjectQuery>`	yes	Demande de limite de Prométhée.
`TopConsumerPopover`	`CodeRef<React.ComponentType<TopConsumerPopoverProps>>`	yes	Affiche le popover du consommateur supérieur au lieu d'une simple valeur.

`console.pvc/alert`

Nom	Type de valeur	En option	Description
`alert`	`CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>`	non	Le composant d'alerte.

`console.pvc/create-prop`

Nom	Type de valeur	En option	Description
`label`	`string`	non	Étiquette pour l'action de création d'un accessoire.
`path`	`string`	non	Chemin d'accès à l'action de création d'un accessoire.

`console.pvc/delete`

Nom	Type de valeur	En option	Description
`predicate`	`CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>`	non	Prédicat qui indique si l'extension doit être utilisée ou non.
`onPVCKill`	`CodeRef<(pvc: K8sResourceCommon) ⇒ Promise<void>>`	non	Méthode pour l'opération de suppression du PVC.
`alert`	`CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>`	non	Composant d'alerte pour afficher des informations supplémentaires.

`console.pvc/status`

Nom	Type de valeur	En option	Description
`priority`	`number`	non	Priorité du composant d'état. Une valeur plus élevée signifie une plus grande priorité.
`status`	`CodeRef<React.ComponentType<{ pvc: K8sResourceCommon; }>>`	non	L'élément d'état.
`predicate`	`CodeRef<(pvc: K8sResourceCommon) ⇒ boolean>`	non	Prédicat qui indique si le composant d'état doit être rendu ou non.

`console.redux-reducer`

Ajoute un nouveau réducteur au magasin Console Redux qui opère sur plugins.<scope> substate.

Nom	Type de valeur	En option	Description
`scope`	`string`	non	La clé pour représenter le substate géré par le réducteur dans l'objet d'état Redux.
`reducer`	`CodeRef<Reducer<any, AnyAction>>`	non	La fonction du réducteur, qui opère sur le sous-état géré par le réducteur.

`console.resource/create`

Nom	Type de valeur	En option	Description
`model`	`ExtensionK8sModel`	non	Le modèle pour lequel cette page de création de ressources sera rendue.
`component`	`CodeRef<React.ComponentType<CreateResourceComponentProps>>`	non	Le composant à rendre lorsque le modèle correspond

`console.storage-provider`

Nom	Type de valeur	En option	Description
`name`	`string`	non
`Component`	`CodeRef<React.ComponentType<Partial<RouteComponentProps<{}, StaticContext, any>>>>`	non

`console.tab/horizontalNav`

Nom	Type de valeur	En option	Description
`model`	`ExtensionK8sKindVersionModel`	non	Le modèle pour lequel cet onglet de présentation du fournisseur est utilisé.
`page`	`{ name: string; href: string; }`	non	La page à afficher dans l'onglet horizontal. Il prend le nom de l'onglet comme nom et href de l'onglet
`component`	`CodeRef<React.ComponentType<PageComponentProps<K8sResourceCommon>>>`	non	Le composant à afficher lorsque l'itinéraire correspond.

`console.telemetry/listener`

Nom	Type de valeur	En option	Description
`listener`	`CodeRef<TelemetryEventListener>`	non	Écouter les événements de télémétrie

`console.topology/adapter/build`

BuildAdapter contribue à un adaptateur pour adapter l'élément aux données qui peuvent être utilisées par le composant Build.

Nom	Type de valeur	En option	Description
`adapt`	`CodeRef<(element : GraphElement) ⇒ AdapterDataType<BuildConfigData>	undefined>`	non

`console.topology/adapter/network`

NetworkAdapater contribue à un adaptateur pour adapter l'élément aux données qui peuvent être utilisées par le composant Networking.

Nom	Type de valeur	En option	Description
`adapt`	`CodeRef<(element : GraphElement) ⇒ NetworkAdapterType	undefined>`	non

`console.topology/adapter/pod`

PodAdapter contribue à un adaptateur pour adapter l'élément aux données qui peuvent être utilisées par le composant Pod.

Nom	Type de valeur	En option	Description
`adapt`	`CodeRef<(element : GraphElement) ⇒ AdapterDataType<PodsAdapterDataType>	undefined>`	non

`console.topology/component/factory`

Getter pour un ViewComponentFactory.

Nom	Type de valeur	En option	Description
`getFactory`	`CodeRef<ViewComponentFactory>`	non	Getter pour un `ViewComponentFactory`.

`console.topology/create/connector`

Getter pour la fonction de création de connecteur.

Nom	Type de valeur	En option	Description
`getCreateConnector`	`CodeRef<CreateConnectionGetter>`	non	Getter pour la fonction de création de connecteur.

`console.topology/data/factory`

Modèle de données topologiques Extension de l'usine

Nom	Type de valeur	En option	Description
`id`	`string`	non	Identifiant unique de l'usine.
`priority`	`number`	non	Priorité à l'usine
`resources`	`WatchK8sResourcesGeneric`	yes	Ressources à récupérer à partir du crochet useK8sWatchResources.
`workloadKeys`	`string[]`	yes	Clés dans les ressources contenant des charges de travail.
`getDataModel`	`CodeRef<TopologyDataModelGetter>`	yes	Obteneur pour la fabrique de modèles de données.
`isResourceDepicted`	`CodeRef<TopologyDataModelDepicted>`	yes	Getter pour la fonction permettant de déterminer si une ressource est représentée par cette fabrique de modèles.
`getDataModelReconciler`	`CodeRef<TopologyDataModelReconciler>`	yes	Getter pour la fonction de réconciliation du modèle de données après le chargement des modèles de toutes les extensions.

`console.topology/decorator/provider`

Extension du fournisseur de décorateur de topologie

Nom	Type de valeur	En option
`id`	`string`	non
`priority`	`number`	non
`quadrant`	`TopologyQuadrant`	non
`decorator`	`CodeRef<TopologyDecoratorGetter>`	non

`console.topology/details/resource-alert`

DetailsResourceAlert génère une alerte pour un contexte topologique ou un élément graphique spécifique.

Nom	Type de valeur	En option	Description
`id`	`string`	non	L'identifiant de cette alerte. Utilisé pour sauvegarder l'état si l'alerte ne doit pas être affichée après avoir été supprimée.
`contentProvider`	`CodeRef<(element : GraphElement) ⇒ DetailsResourceAlertContent	null>`	non

`console.topology/details/resource-link`

DetailsResourceLink apporte un lien pour un contexte topologique ou un élément de graphe spécifique.

Nom	Type de valeur	En option	Description
`link`	`CodeRef<(element : GraphElement) ⇒ React.Component	undefined>`	non
Renvoie le lien de la ressource s'il est fourni, sinon il n'est pas défini. Utilisez les propriétés `ResourceIcon` et `ResourceLink` pour les styles.	`priority`	`number`	yes

`console.topology/details/tab`

DetailsTab crée un onglet pour le panneau des détails de la topologie.

Nom	Type de valeur	En option	Description
`id`	`string`	non	Un identifiant unique pour cet onglet de détails.
`label`	`string`	non	L'étiquette de l'onglet à afficher dans l'interface utilisateur.
`insertBefore`	`string` \| `string[]`	yes	Insérer cet élément avant l'élément référencé ici. Pour les tableaux, le premier élément trouvé dans l'ordre est utilisé.
`insertAfter`	`string` \| `string[]`	yes	Insérer cet élément après l'élément référencé ici. Pour les tableaux, le premier élément trouvé dans l'ordre est utilisé. La valeur `insertBefore` est prioritaire.

`console.topology/details/tab-section`

DetailsTabSection contribue à la création d'une section pour un onglet spécifique dans le panneau des détails de la topologie.

Nom	Type de valeur	En option	Description
`id`	`string`	non	Identifiant unique pour cette section de l'onglet Détails.
`tab`	`string`	non	L'identifiant de l'onglet parent auquel cette section doit contribuer.
`provider`	`CodeRef<DetailsTabSectionExtensionHook>`	non	Composant SDK : <Section title=\{}>... zone matelassée
`section`	`CodeRef<(element : GraphElement, renderNull? : () ⇒ null) ⇒ React.Component	undefined>`	non
@deprecated Fallback si aucun fournisseur n'est défini. renderNull est déjà un no-op.	`insertBefore`	`string` \| `string[]`	yes
Pour les tableaux, le premier élément trouvé dans l'ordre est utilisé.	`insertAfter`	`string` \| `string[]`	yes

`console.topology/display/filters`

Extension des filtres d'affichage de la topologie

Nom	Type de valeur	En option	Description
`getTopologyFilters`	`CodeRef<() ⇒ TopologyDisplayOption[]>`	non
`applyDisplayOptions`	`CodeRef<TopologyApplyDisplayOptions>`	non

`console.topology/relationship/provider`

Extension du connecteur du fournisseur de relations topologiques

Nom	Type de valeur	En option
`provides`	`CodeRef<RelationshipProviderProvides>`	non
`tooltip`	`string`	non
`create`	`CodeRef<RelationshipProviderCreate>`	non
`priority`	`number`	non

`console.user-preference/group`

Nom	Type de valeur	En option	Description
`id`	`string`	non	ID utilisé pour identifier le groupe de préférences des utilisateurs.
`label`	`string`	non	L'étiquette du groupe de préférences de l'utilisateur
`insertBefore`	`string`	yes	ID du groupe de préférences de l'utilisateur devant lequel ce groupe doit être placé
`insertAfter`	`string`	yes	ID du groupe de préférences de l'utilisateur après lequel ce groupe doit être placé

`console.user-preference/item`

Nom	Type de valeur	En option	Description
`id`	`string`	non	ID utilisé pour identifier l'élément de préférence de l'utilisateur et référencé dans insertAfter et insertBefore pour définir l'ordre des éléments.
`label`	`string`	non	L'étiquette de la préférence de l'utilisateur
`description`	`string`	non	La description de la préférence de l'utilisateur.
`field`	`UserPreferenceField`	non	Les options du champ de saisie utilisées pour rendre les valeurs afin de définir la préférence de l'utilisateur.
`groupId`	`string`	yes	ID utilisés pour identifier les groupes de préférences des utilisateurs auxquels l'élément appartient.
`insertBefore`	`string`	yes	ID de l'élément de préférence de l'utilisateur devant lequel cet élément doit être placé
`insertAfter`	`string`	yes	ID de l'élément de préférence de l'utilisateur après lequel cet élément doit être placé

`console.yaml-template`

Modèles YAML pour l'édition des ressources via l'éditeur YAML.

Nom	Type de valeur	En option	Description
`model`	`ExtensionK8sModel`	non	Modèle associé au modèle.
`template`	`CodeRef<string>`	non	Le modèle YAML.
`name`	`string`	non	Le nom du modèle. Utilisez le nom `default` pour indiquer qu'il s'agit du modèle par défaut.

`dev-console.add/action`

Nom	Type de valeur	En option	Description
`id`	`string`	non	ID utilisé pour identifier l'action.
`label`	`string`	non	Le libellé de l'action
`description`	`string`	non	La description de l'action.
`href`	`string`	non	Le href vers lequel naviguer.
`groupId`	`string`	yes	ID utilisés pour identifier les groupes d'action auxquels l'action doit appartenir.
`icon`	`CodeRef<React.ReactNode>`	yes	L'icône d'affichage de la perspective.
`accessReview`	`AccessReviewResourceAttributes[]`	yes	Contrôle d'accès facultatif pour contrôler la visibilité ou l'activation de l'action.

`dev-console.add/action-group`

Nom	Type de valeur	En option	Description
`id`	`string`	non	ID utilisé pour identifier le groupe d'action.
`name`	`string`	non	Le titre du groupe d'action
`insertBefore`	`string`	yes	ID du groupe d'action devant lequel ce groupe doit être placé
`insertAfter`	`string`	yes	ID du groupe d'action après lequel ce groupe doit être placé

`dev-console.import/environment`

Nom	Type de valeur	En option	Description
`imageStreamName`	`string`	non	Nom du flux d'images pour lequel des variables d'environnement personnalisées doivent être fournies
`imageStreamTags`	`string[]`	non	Liste des balises de flux d'images prises en charge
`environments`	`ImageEnvironment[]`	non	Liste des variables d'environnement

`console.page/resource/tab`

Déclassé. Utilisez plutôt console.tab/horizontalNav. Ajoute un nouvel onglet de ressources au routeur de la console.

Nom	Type de valeur	En option	Description
`model`	`ExtensionK8sGroupKindModel`	non	Le modèle pour lequel cette page de ressources renvoie.
`component`	`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`	non	Le composant à afficher lorsque l'itinéraire correspond.
`name`	`string`	non	Le nom de l'onglet.
`href`	`string`	yes	L'adresse facultative du lien de l'onglet. S'il n'est pas fourni, le premier `path` est utilisé.
`exact`	`boolean`	yes	Si la valeur est vraie, la correspondance ne se fera que si le chemin d'accès correspond exactement à `location.pathname`.

7.5.2. API de la console OpenShift Container Platform

`useActivePerspective`

Crochet qui fournit la perspective actuellement active et un rappel pour définir la perspective active. Il renvoie un tuple contenant la perspective active actuelle et le callback du setter.

const Component: React.FC = (props) => {
   const [activePerspective, setActivePerspective] = useActivePerspective();
   return <select
     value={activePerspective}
     onChange={(e) => setActivePerspective(e.target.value)}
   >
     {
       // ...perspective options
     }
   </select>
}

`GreenCheckCircleIcon`

Composant permettant d'afficher l'icône d'un cercle vert coché.

<CheckCircleIcon vert title="Healthy" />

Nom du paramètre	Description
`className`	(facultatif) nom de classe supplémentaire pour le composant
`title`	(facultatif) titre de l'icône
`size`	(facultatif) taille de l'icône : ("sm", "md", "lg", "xl")

`RedExclamationCircleIcon`

Composant permettant d'afficher une icône de cercle avec un point d'exclamation rouge.

<RedExclamationCircleIcon title="Failed" />

Nom du paramètre	Description
`className`	(facultatif) nom de classe supplémentaire pour le composant
`title`	(facultatif) titre de l'icône
`size`	(facultatif) taille de l'icône : ("sm", "md", "lg", "xl")

`YellowExclamationTriangleIcon`

Composant permettant d'afficher une icône d'exclamation en forme de triangle jaune.

<YellowExclamationTriangleIcon title="Warning" />

Nom du paramètre	Description
`className`	(facultatif) nom de classe supplémentaire pour le composant
`title`	(facultatif) titre de l'icône
`size`	(facultatif) taille de l'icône : ("sm", "md", "lg", "xl")

`BlueInfoCircleIcon`

Composant permettant d'afficher une icône bleue en forme de cercle d'information.

<BlueInfoCircleIcon title="Info" />

Nom du paramètre	Description
`className`	(facultatif) nom de classe supplémentaire pour le composant
`title`	(facultatif) titre de l'icône
`size`	(facultatif) taille de l'icône : ("sm", "md", "lg", "xl")

`ErrorStatus`

Composant permettant d'afficher une fenêtre contextuelle sur l'état de l'erreur.

<ErrorStatus title={errorMsg} />

Nom du paramètre	Description
`title`	(facultatif) texte d'état
`iconOnly`	(optionnel) si vrai, affiche uniquement l'icône
`noTooltip`	(facultatif) si vrai, l'infobulle ne sera pas affichée
`className`	(facultatif) nom de classe supplémentaire pour le composant
`popoverTitle`	(facultatif) titre du popover

`InfoStatus`

Composant permettant d'afficher une fenêtre contextuelle sur l'état des informations.

<InfoStatus title={infoMsg} />

Nom du paramètre	Description
`title`	(facultatif) texte d'état
`iconOnly`	(optionnel) si vrai, affiche uniquement l'icône
`noTooltip`	(facultatif) si vrai, l'infobulle ne sera pas affichée
`className`	(facultatif) nom de classe supplémentaire pour le composant
`popoverTitle`	(facultatif) titre du popover

`ProgressStatus`

Composant permettant d'afficher une fenêtre contextuelle sur l'état d'avancement des travaux.

<ProgressStatus title={progressMsg} />

Nom du paramètre	Description
`title`	(facultatif) texte d'état
`iconOnly`	(optionnel) si vrai, affiche uniquement l'icône
`noTooltip`	(facultatif) si vrai, l'infobulle ne sera pas affichée
`className`	(facultatif) nom de classe supplémentaire pour le composant
`popoverTitle`	(facultatif) titre du popover

`SuccessStatus`

Composant permettant d'afficher une fenêtre contextuelle sur l'état de la réussite.

<SuccessStatus title={successMsg} />

Nom du paramètre	Description
`title`	(facultatif) texte d'état
`iconOnly`	(optionnel) si vrai, affiche uniquement l'icône
`noTooltip`	(facultatif) si vrai, l'infobulle ne sera pas affichée
`className`	(facultatif) nom de classe supplémentaire pour le composant
`popoverTitle`	(facultatif) titre du popover

`checkAccess`

Fournit des informations sur l'accès des utilisateurs à une ressource donnée. Il renvoie un objet contenant des informations sur l'accès à la ressource.

Nom du paramètre	Description
`resourceAttributes`	attributs des ressources pour l'examen de l'accès
`impersonate`	détails de l'usurpation d'identité

`useAccessReview`

Crochet qui fournit des informations sur l'accès des utilisateurs à une ressource donnée. Il renvoie un tableau contenant les valeurs isAllowed et loading.

Nom du paramètre	Description
`resourceAttributes`	attributs des ressources pour l'examen de l'accès
`impersonate`	détails de l'usurpation d'identité

`useResolvedExtensions`

Crochet React pour consommer les extensions Console avec les propriétés CodeRef résolues. Ce hook accepte le(s) même(s) argument(s) que le hook useExtensions et renvoie une liste adaptée d'instances d'extensions, en résolvant toutes les références de code dans les propriétés de chaque extension. Initialement, le hook renvoie un tableau vide. Une fois la résolution terminée, le composant React est re-rendu avec le hook renvoyant une liste adaptée d'extensions. Lorsque la liste des extensions correspondantes change, la résolution est relancée. Le hook continuera à renvoyer le résultat précédent jusqu'à ce que la résolution soit terminée. Les éléments de résultat du crochet sont garantis pour être référentiellement stables à travers les re-renders. Il renvoie un tuple contenant une liste d'instances d'extensions adaptées avec des références de code résolues, un drapeau booléen indiquant si la résolution est complète, et une liste d'erreurs détectées au cours de la résolution.

const [navItemExtensions, navItemsResolved] = useResolvedExtensions<NavItem>(isNavItem);
// process adapted extensions and render your component

Nom du paramètre	Description
`typeGuards`	Une liste de callbacks qui acceptent chacun une extension de plugin dynamique comme argument et renvoient un drapeau booléen indiquant si l'extension répond ou non aux contraintes de type souhaitées

`HorizontalNav`

Un composant qui crée une barre de navigation pour une page - Le routage est géré en tant que partie du composant - console.tab/horizontalNav peut être utilisé pour ajouter du contenu supplémentaire à n'importe quelle barre de navigation horizontale.

const HomePage: React.FC = (props) => {
    const page = {
      href: '/home',
      name: 'Home',
      component: () => <>Home</>
    }
    return <HorizontalNav match={props.match} pages={[page]} />
}

Nom du paramètre	Description
`resource`	La ressource associée à cette navigation, un objet de type K8sResourceCommon
`pages`	Un tableau d'objets de page
`match`	objet de correspondance fourni par React Router

`VirtualizedTable`

Composant permettant de réaliser des tableaux virtualisés.

const MachineList: React.FC<MachineListProps> = (props) => {
  return (
    <VirtualizedTable<MachineKind>
     {...props}
     aria-label='Machines'
     columns={getMachineColumns}
     Row={getMachineTableRow}
    />
  );
}

Nom du paramètre	Description
`data`	données pour le tableau
`loaded`	drapeau indiquant que les données sont chargées
`loadError`	objet d'erreur en cas de problème lors du chargement des données
`columns`	configuration de la colonne
`Row`	configuration des rangs
`unfilteredData`	données originales sans filtre
`NoDataEmptyMsg`	(facultatif) pas de données composant de message vide
`EmptyMsg`	(facultatif) composant de message vide
`scrollNode`	(facultatif) pour gérer le défilement
`label`	(facultatif) étiquette pour le tableau
`ariaLabel`	(facultatif) étiquette aria
`gridBreakPoint`	dimensionnement du découpage de la grille pour la réactivité
`onSelect`	fonction (optionnelle) pour la gestion de la sélection de la table
`rowData`	(facultatif) données spécifiques à la ligne

`TableData`

Composant permettant d'afficher les données d'un tableau à l'intérieur d'une ligne du tableau.

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>
    </>
  );
};

Nom du paramètre	Description
`id`	identifiant unique pour la table
`activeColumnIDs`	colonnes actives
`className`	(optionnel) nom de la classe d'option pour le style

`useActiveColumns`

Un crochet qui fournit une liste de TableColumns actives sélectionnées par l'utilisateur.

  // See implementation for more details on TableColumn type
  const [activeColumns, userSettingsLoaded] = useActiveColumns({
    columns,
    showNamespaceOverride: false,
    columnManagementID,
  });
  return userSettingsAreLoaded ? <VirtualizedTable columns= {activeColumns} {...otherProps} /> : null

Nom du paramètre	Description
`options`	Qui sont transmises sous la forme d'une carte clé-valeur
``	\N{TableColumn[]} options.columns - Un tableau de toutes les colonnes de table disponibles
``	{boolean} [options.showNamespaceOverride] - (facultatif) Si true, une colonne d'espace de noms sera incluse, indépendamment des sélections de gestion des colonnes
``	{string} [options.columnManagementID] - (facultatif) Un identifiant unique utilisé pour persister et récupérer les sélections de gestion de colonnes vers et depuis les paramètres utilisateur. Il s'agit généralement d'une chaîne "_{groupverionkind}" pour une ressource.

Un tuple contenant les colonnes actives sélectionnées par l'utilisateur actuel (un sous-ensemble de options.columns), et un drapeau booléen indiquant si les paramètres de l'utilisateur ont été chargés.

`ListPageHeader`

Composant permettant de générer un en-tête de page.

const exampleList: React.FC = () => {
  return (
    <>
      <ListPageHeader title="Example List Page"/>
    </>
  );
};

Nom du paramètre	Description
`title`	titre de la rubrique
`helpText`	(optionnel) section d'aide comme react node
`badge`	(facultatif) icône de badge comme react node

`ListPageCreate`

Composant permettant d'ajouter un bouton de création pour un type de ressource spécifique qui génère automatiquement un lien vers le YAML de création de cette ressource.

const exampleList: React.FC<MyProps> = () => {
  return (
    <>
      <ListPageHeader title="Example Pod List Page"/>
        <ListPageCreate groupVersionKind="Pod">Create Pod</ListPageCreate>
      </ListPageHeader>
    </>
  );
};

Nom du paramètre	Description
`groupVersionKind`	le groupe/la version/la nature de la ressource à représenter

`ListPageCreateLink`

Composant permettant de créer un lien stylisé.

const exampleList: React.FC<MyProps> = () => {
 return (
  <>
   <ListPageHeader title="Example Pod List Page"/>
      <ListPageCreateLink to={'/link/to/my/page'}>Create Item</ListPageCreateLink>
   </ListPageHeader>
  </>
 );
};

Nom du paramètre	Description
`to`	chaîne de caractères emplacement où le lien doit être dirigé
`createAccessReview`	(facultatif) objet avec l'espace de noms et le type utilisés pour déterminer l'accès
`children`	(facultatif) enfants du composant

`ListPageCreateButton`

Composant permettant de créer un bouton.

const exampleList: React.FC<MyProps> = () => {
  return (
    <>
      <ListPageHeader title="Example Pod List Page"/>
        <ListPageCreateButton createAccessReview={access}>Create Pod</ListPageCreateButton>
      </ListPageHeader>
    </>
  );
};

Nom du paramètre	Description
`createAccessReview`	(facultatif) objet avec l'espace de noms et le type utilisés pour déterminer l'accès
`pfButtonProps`	(facultatif) Accessoires du bouton Patternfly

`ListPageCreateDropdown`

Composant permettant de créer une liste déroulante avec contrôle des autorisations.

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>
    </>
  );
};

Nom du paramètre	Description
`items`	key:ReactNode paires d'éléments à afficher dans le composant déroulant
`onClick`	fonction de rappel pour les clics sur les éléments de la liste déroulante
`createAccessReview`	(facultatif) objet avec l'espace de noms et le type utilisés pour déterminer l'accès
`children`	(facultatif) enfants pour le menu déroulant à bascule

`ListPageFilter`

Composant qui génère un filtre pour la page de liste.

  // 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>
    </>
  )

Nom du paramètre	Description
`data`	Un tableau de points de données
`loaded`	indique que les données ont été chargées
`onFilterChange`	fonction de rappel pour la mise à jour du filtre
`rowFilters`	(facultatif) Un tableau d'éléments RowFilter définissant les options de filtrage disponibles
`nameFilterPlaceholder`	(facultatif) caractère générique pour le filtre de nom
`labelFilterPlaceholder`	(facultatif) caractère générique pour le filtre de l'étiquette
`hideLabelFilter`	(optionnel) affiche uniquement le filtre de nom au lieu des filtres de nom et d'étiquette
`hideNameLabelFilter`	(facultatif) masque les filtres de nom et d'étiquette
`columnLayout`	(facultatif) objet de mise en page de la colonne
`hideColumnManagement`	(optionnel) pour masquer la gestion de la colonne

`useListPageFilter`

Un crochet qui gère l'état des filtres pour le composant ListPageFilter. Il renvoie un tuple contenant les données filtrées par tous les filtres statiques, les données filtrées par tous les filtres statiques et les filtres de ligne, ainsi qu'un rappel qui met à jour les filtres de ligne.

  // 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>
    </>
  )

Nom du paramètre	Description
`data`	Un tableau de points de données
`rowFilters`	(facultatif) Un tableau d'éléments RowFilter définissant les options de filtrage disponibles
`staticFilters`	(facultatif) Un tableau d'éléments FilterValue qui sont appliqués de manière statique aux données

`ResourceLink`

Composant qui crée un lien vers un type de ressource spécifique avec un badge en forme d'icône.

  <ResourceLink
      kind="Pod"
      name="testPod"
      title={metadata.uid}
  />

Nom du paramètre	Description
`kind`	(facultatif) le type de ressource, c'est-à-dire Pod, Deployment, Namespace
`groupVersionKind`	(optionnel) objet avec groupd, version et type
`className`	(facultatif) style de classe pour le composant
`displayName`	(facultatif) nom d'affichage du composant, remplace le nom de la ressource s'il est défini
`inline`	(optionnel) drapeau pour créer un badge d'icône et un nom en ligne avec les enfants
`linkTo`	(optionnel) drapeau pour créer un objet Link - valeur par défaut : true
`name`	(facultatif) nom de la ressource
`namesapce`	(facultatif) espace de noms spécifique pour le type de ressource à lier
`hideIcon`	(optionnel) drapeau pour cacher l'icône du badge
`title`	(facultatif) titre de l'objet lien (non affiché)
`dataTest`	(facultatif) identifiant pour les tests
`onClick`	(optionnel) fonction de rappel lorsque le composant est cliqué
`truncate`	(optionnel) drapeau pour tronquer le lien s'il est trop long

`ResourceIcon`

Composant qui crée une icône de badge pour un type de ressource spécifique.

<ResourceIcon kind="Pod"/>

Nom du paramètre	Description
`kind`	(facultatif) le type de ressource, c'est-à-dire Pod, Deployment, Namespace
`groupVersionKind`	(facultatif) objet avec groupe, version et type
`className`	(facultatif) style de classe pour le composant

`useK8sModel`

Crochet qui récupère le modèle k8s pour le type K8sGroupVersionKind fourni par redux. Il renvoie un tableau dont le premier élément est le modèle k8s et le deuxième élément est le statut inFlight.

const Component: React.FC = () => {
  const [model, inFlight] = useK8sModel({ group: 'app'; version: 'v1'; kind: 'Deployment' });
  return ...
}

Nom du paramètre	Description
`groupVersionKind`	group, version, kind of k8s resource \N{@link K8sGroupVersionKind} est préférable ; il est également possible de passer une référence pour group, version, kind, qui est obsolète, c'est-à-dire `group_versionkind` \{@link K8sResourceKindReference}.

`useK8sModels`

Hook qui récupère tous les modèles k8s actuels de redux. Il renvoie un tableau dont le premier élément est la liste des modèles k8s et le deuxième élément est le statut inFlight.

const Component: React.FC = () => {
  const [models, inFlight] = UseK8sModels();
  return ...
}

`useK8sWatchResource`

Crochet qui récupère la ressource k8s avec l'état de chargement et d'erreur. Il renvoie un tableau dont le premier élément est la (les) ressource(s), le deuxième l'état de chargement et le troisième l'état d'erreur, le cas échéant.

const Component: React.FC = () => {
  const watchRes = {
        ...
      }
  const [data, loaded, error] = useK8sWatchResource(watchRes)
  return ...
}

Nom du paramètre	Description
`initResource`	les options nécessaires pour surveiller les ressources.

`useK8sWatchResources`

Hook qui récupère les ressources k8s avec leur statut respectif (loaded et error). Il renvoie une carte dont les clés sont celles fournies dans initResouces et la valeur a trois propriétés : data, loaded et error.

const Component: React.FC = () => {
  const watchResources = {
        'deployment': {...},
        'pod': {...}
        ...
      }
  const {deployment, pod} = useK8sWatchResources(watchResources)
  return ...
}

Nom du paramètre	Description
`initResources`	les ressources doivent être surveillées sous la forme d'une paire clé-valeur, dans laquelle la clé est unique pour la ressource et la valeur correspond aux options nécessaires pour surveiller la ressource en question.

`consoleFetch`

Une enveloppe personnalisée autour de fetch qui ajoute des en-têtes spécifiques à la console et permet des tentatives et des délais d'attente. Elle valide également le code d'état de la réponse et lance l'erreur appropriée ou déconnecte l'utilisateur si nécessaire. Il renvoie une promesse qui résout la réponse.

Nom du paramètre	Description
`url`	L'URL à rechercher
`options`	Les options à transmettre à fetch
`timeout`	Le délai d'attente en millisecondes

`consoleFetchJSON`

Une enveloppe personnalisée autour de fetch qui ajoute des en-têtes spécifiques à la console et permet des tentatives et des délais d'attente. Il valide également le code d'état de la réponse et lance l'erreur appropriée ou déconnecte l'utilisateur si nécessaire. Il renvoie la réponse sous la forme d'un objet JSON. Il utilise consoleFetch en interne. Il retourne une promesse qui résout la réponse en tant qu'objet JSON.

Nom du paramètre	Description
`url`	L'URL à rechercher
`method`	La méthode HTTP à utiliser. La valeur par défaut est GET
`options`	Les options à transmettre à fetch
`timeout`	Le délai d'attente en millisecondes
`cluster`	Le nom de la grappe à laquelle adresser la demande. Par défaut, il s'agit de la grappe active sélectionnée par l'utilisateur

`consoleFetchText`

Une enveloppe personnalisée autour de fetch qui ajoute des en-têtes spécifiques à la console et permet des tentatives et des délais d'attente. Il valide également le code d'état de la réponse et lance l'erreur appropriée ou déconnecte l'utilisateur si nécessaire. Il renvoie la réponse sous forme de texte. Elle utilise consoleFetch en interne. Il retourne une promesse qui résout la réponse en tant que texte.

Nom du paramètre	Description
`url`	L'URL à rechercher
`options`	Les options à transmettre à fetch
`timeout`	Le délai d'attente en millisecondes
`cluster`	Le nom de la grappe à laquelle adresser la demande. Par défaut, il s'agit de la grappe active sélectionnée par l'utilisateur

`getConsoleRequestHeaders`

Une fonction qui crée des en-têtes relatifs à l'impersonnalisation et au multicluster pour les demandes d'API en utilisant l'état actuel de redux. Elle renvoie un objet contenant les en-têtes de demande d'impersonnalisation et de multicluster appropriés, en fonction de l'état de redux.

Nom du paramètre	Description
`targetCluster`	remplacer le cluster actif actuel par le targetCluster fourni

`k8sGetResource`

Il récupère une ressource dans le cluster, en fonction des options fournies. Si le nom est fourni, elle renvoie une ressource, sinon elle renvoie toutes les ressources correspondant au modèle. Il renvoie une promesse qui correspond à la réponse sous forme d'objet JSON avec une ressource si le nom est fourni, sinon il renvoie toutes les ressources correspondant au modèle. En cas d'échec, la promesse est rejetée avec une réponse d'erreur HTTP.

Nom du paramètre	Description
`options`	Qui sont transmises sous forme de paires clé-valeur dans la carte
``	options.model - modèle k8s
``	options.name - Le nom de la ressource, s'il n'est pas fourni, il recherchera toutes les ressources correspondant au modèle.
``	options.ns - L'espace de noms à examiner, ne doit pas être spécifié pour les ressources à l'échelle d'un cluster.
``	options.path - Ajoute un sous-chemin s'il est fourni
``	options.queryParams - Les paramètres de requête à inclure dans l'URL.
``	options.requestInit - L'objet d'initialisation de la recherche à utiliser. Il peut contenir des en-têtes de requête, une méthode, une redirection, etc. En savoir plus (lien : https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_lib_dom_d.requestinit.html)

`k8sCreateResource`

Il crée une ressource dans le cluster, sur la base des options fournies. Elle renvoie une promesse qui correspond à la réponse de la ressource créée. En cas d'échec, la promesse est rejetée avec une réponse d'erreur HTTP.

Nom du paramètre	Description
`options`	Qui sont transmises sous forme de paires clé-valeur dans la carte
``	options.model - modèle k8s
``	options.data - données utiles pour la ressource à créer
``	options.path - Ajoute un sous-chemin s'il est fourni
``	options.queryParams - Les paramètres de requête à inclure dans l'URL.

`k8sUpdateResource`

Il met à jour l'ensemble de la ressource dans le cluster, en fonction des options fournies. Lorsqu'un client doit remplacer entièrement une ressource existante, il peut utiliser k8sUpdate. Il peut également utiliser k8sPatch pour effectuer une mise à jour partielle. Il renvoie une promesse qui se résout en réponse à la ressource mise à jour. En cas d'échec, la promesse est rejetée avec une réponse d'erreur HTTP.

Nom du paramètre	Description
`options`	qui sont transmises sous forme de paires clé-valeur dans la carte
``	options.model - modèle k8s
``	options.data - charge utile pour la ressource k8s à mettre à jour
``	options.ns - espace de noms à examiner, il ne doit pas être spécifié pour les ressources à l'échelle d'un cluster.
``	options.name - nom de la ressource à mettre à jour.
``	options.path - Ajoute un sous-chemin s'il est fourni
``	options.queryParams - Les paramètres de requête à inclure dans l'URL.

`k8sPatchResource`

Il patche n'importe quelle ressource dans le cluster, sur la base des options fournies. Lorsqu'un client a besoin d'effectuer une mise à jour partielle, il peut utiliser k8sPatch. Il peut également utiliser k8sUpdate pour remplacer entièrement une ressource existante. En savoir plus Data Tracker. Il renvoie une promesse qui se résout à la réponse de la ressource patchée. En cas d'échec, la promesse est rejetée avec une réponse d'erreur HTTP.

Nom du paramètre	Description
`options`	Qui sont transmises sous forme de paires clé-valeur dans la carte.
``	options.model - modèle k8s
``	options.resource - La ressource à corriger.
``	options.data - Uniquement les données à patcher sur la ressource existante avec l'opération, le chemin et la valeur.
``	options.path - Ajoute un sous-chemin si celui-ci est fourni.
``	options.queryParams - Les paramètres de requête à inclure dans l'URL.

`k8sDeleteResource`

Il supprime les ressources du cluster, en se basant sur le modèle et la ressource fournis. Le ramassage des ordures fonctionne sur la base de 'Foreground'|'Background', peut être configuré avec la propriété propagationPolicy dans le modèle fourni ou passé en json. Il renvoie une promesse qui se résout en une réponse de type Status. En cas d'échec, la promesse est rejetée avec une réponse d'erreur HTTP.

{ kind : 'DeleteOptions', apiVersion : 'v1', propagationPolicy }

Nom du paramètre	Description
`options`	qui sont transmises sous la forme d'une paire clé-valeur dans la carte.
``	options.model - modèle k8s
``	options.resource - La ressource à supprimer.
``	options.path - Ajoute un sous-chemin s'il est fourni
``	options.queryParams - Les paramètres de requête à inclure dans l'URL.
``	options.requestInit - L'objet d'initialisation de la recherche à utiliser. Il peut contenir des en-têtes de requête, une méthode, une redirection, etc. En savoir plus \N{@link https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_lib_dom_d.requestinit.html }
``	options.json - Peut contrôler explicitement le ramassage des ordures des ressources s'il est fourni, sinon le modèle sera appliqué par défaut (propagationPolicy).

`k8sListResource`

Liste les ressources sous forme de tableau dans le cluster, en fonction des options fournies. Elle renvoie une promesse qui se résout en réponse.

Nom du paramètre	Description
`options`	Qui sont transmises sous forme de paires clé-valeur dans la carte
``	options.model - modèle k8s
``	options.queryParams - Les paramètres de requête à inclure dans l'URL et peuvent également passer des sélecteurs d'étiquettes avec la clé "labelSelector".
``	options.requestInit - L'objet d'initialisation de la recherche à utiliser. Il peut contenir des en-têtes de requête, une méthode, une redirection, etc. En savoir plus \N{@link https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_lib_dom_d.requestinit.html }

`k8sListResourceItems`

Même interface que \N{@link k8sListResource} mais renvoie les sous-éléments. Elle renvoie la version de l'api pour le modèle, c'est-à-dire group/version.

`getAPIVersionForModel`

Fournit la version de l'api pour un modèle k8s.

Nom du paramètre	Description
`model`	modèle k8s

`getGroupVersionKindForResource`

Fournit un groupe, une version et un type de ressource. Il renvoie le groupe, la version et le type de la ressource fournie. Si la ressource n'a pas de groupe API, le groupe "core" sera renvoyé. Si la ressource a une version API invalide, une erreur sera levée.

Nom du paramètre	Description
`resource`	ressource k8s

`getGroupVersionKindForModel`

Fournit un groupe, une version et un type pour un modèle k8s. Cette commande renvoie le groupe, la version et le type du modèle fourni. Si le modèle n'a pas d'apiGroup, le groupe "core" sera renvoyé.

Nom du paramètre	Description
`model`	modèle k8s

`StatusPopupSection`

Composant qui affiche l'état dans une fenêtre contextuelle. Composant utile pour construire des extensions console.dashboards/overview/health/resource.

  <StatusPopupSection
    firstColumn={
      <>
        <span>{title}</span>
        <span className="text-secondary">
          My Example Item
        </span>
      </>
    }
    secondColumn='Status'
  >

Nom du paramètre	Description
`firstColumn`	valeurs de la première colonne de la fenêtre contextuelle
`secondColumn`	(facultatif) valeurs pour la deuxième colonne de la fenêtre contextuelle
`children`	(optionnel) enfants pour le popup

`StatusPopupItem`

Élément d'état utilisé dans la fenêtre contextuelle d'état ; utilisé dans StatusPopupSection.

<StatusPopupSection
   firstColumn='Example'
   secondColumn='Status'
>
   <StatusPopupItem icon={healthStateMapping[MCGMetrics.state]?.icon}>
      Complete
   </StatusPopupItem>
   <StatusPopupItem icon={healthStateMapping[RGWMetrics.state]?.icon}>
       Pending
   </StatusPopupItem>
</StatusPopupSection>

Nom du paramètre	Description
`value`	(facultatif) valeur du texte à afficher
`icon`	(facultatif) icône à afficher
`children`	éléments enfants

`Overview`

Crée un composant enveloppant pour un tableau de bord.

    <Overview>
      <OverviewGrid mainCards={mainCards} leftCards={leftCards} rightCards={rightCards} />
    </Overview>

Nom du paramètre	Description
`className`	(optionnel) classe de style pour le div
`children`	(facultatif) éléments du tableau de bord

`OverviewGrid`

Crée une grille d'éléments de cartes pour un tableau de bord ; utilisé dans Overview.

    <Overview>
      <OverviewGrid mainCards={mainCards} leftCards={leftCards} rightCards={rightCards} />
    </Overview>

Nom du paramètre	Description
`mainCards`	cartes pour la grille
`leftCards`	(facultatif) cartes pour le côté gauche de la grille
`rightCards`	(facultatif) cartes pour le côté droit de la grille

`InventoryItem`

Crée un élément de carte d'inventaire.

  return (
    <InventoryItem>
      <InventoryItemTitle>{title}</InventoryItemTitle>
      <InventoryItemBody error={loadError}>
        {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
      </InventoryItemBody>
    </InventoryItem>
  )

Nom du paramètre	Description
`children`	les éléments à rendre à l'intérieur de l'élément

`InventoryItemTitle`

Crée un titre pour un article de carte d'inventaire ; utilisé dans InventoryItem.

 return (
   <InventoryItem>
     <InventoryItemTitle>{title}</InventoryItemTitle>
     <InventoryItemBody error={loadError}>
       {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
     </InventoryItemBody>
   </InventoryItem>
 )

Nom du paramètre	Description
`children`	à rendre à l'intérieur du titre

`InventoryItemBody`

Crée le corps d'une carte d'inventaire ; utilisé dans InventoryCard et peut être utilisé avec InventoryTitle.

 return (
   <InventoryItem>
     <InventoryItemTitle>{title}</InventoryItemTitle>
     <InventoryItemBody error={loadError}>
       {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
     </InventoryItemBody>
   </InventoryItem>
 )

Nom du paramètre	Description
`children`	à rendre dans la carte d'inventaire ou le titre
`error`	des éléments de la div

`InventoryItemStatus`

Crée un compte et une icône pour une fiche d'inventaire avec une adresse de lien optionnelle InventoryItemBody

 return (
   <InventoryItem>
     <InventoryItemTitle>{title}</InventoryItemTitle>
     <InventoryItemBody error={loadError}>
       {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
     </InventoryItemBody>
   </InventoryItem>
 )

Nom du paramètre	Description
`count`	compter pour l'affichage
`icon`	icône pour l'affichage
`linkTo`	(facultatif) adresse du lien

`InventoryItemLoading`

Crée un conteneur squelette pour le chargement d'une carte d'inventaire ; utilisé avec InventoryItem et les composants connexes

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`

Crochet qui renvoie l'indicateur de fonctionnalité donné à partir de l'état redux FLAGS. Il renvoie la valeur booléenne de l'indicateur demandé ou undefined.

Nom du paramètre	Description
`flag`	L'indicateur de caractéristique à renvoyer

`YAMLEditor`

Un éditeur YAML basique à chargement paresseux avec aide au survol et complétion.

<React.Suspense fallback={<LoadingBox />}>
  <YAMLEditor
    value={code}
  />
</React.Suspense>

Nom du paramètre	Description
`value`	Chaîne représentant le code yaml à rendre.
`options`	Les options de l'éditeur Monaco. Pour plus de détails, veuillez consulter le site https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IStandaloneEditorConstructionOptions.html.
`minHeight`	Hauteur minimale de l'éditeur dans les valeurs de hauteur CSS valides.
`showShortcuts`	Booléen pour afficher les raccourcis en haut de l'éditeur.
`toolbarLinks`	Tableau de ReactNode rendu dans la section des liens de la barre d'outils en haut de l'éditeur.
`onChange`	Rappel pour l'événement de changement de code.
`onSave`	Rappel appelé lorsque la commande CTRL / CMD S est déclenchée.
`ref`	Référence React à `{ editor?: IStandaloneCodeEditor }` En utilisant la propriété "editor", vous pouvez accéder à toutes les méthodes de contrôle de l'éditeur. Pour plus d'informations, consultez le site https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IStandaloneCodeEditor.html.

`ResourceYAMLEditor`

Un éditeur YAML à chargement paresseux pour les ressources Kubernetes avec aide au survol et complétion. Le composant utilise l'éditeur YAMLEditor et y ajoute des fonctionnalités telles que la gestion de la mise à jour des ressources, des alertes, des boutons de sauvegarde, d'annulation et de rechargement, l'accessibilité et plus encore. Sauf si onSave callback est fourni, la mise à jour des ressources est automatiquement gérée. Il doit être enveloppé dans un composant React.Suspense.

<React.Suspense fallback={<LoadingBox />}>
  <ResourceYAMLEditor
    initialResource={resource}
    header="Create resource"
    onSave={(content) => updateResource(content)}
  />
</React.Suspense>

Nom du paramètre	Description
`initialResource`	YAML/Objet représentant une ressource à afficher par l'éditeur. Cet objet n'est utilisé que lors du rendu initial
`header`	Ajouter un en-tête au dessus de l'éditeur YAML
`onSave`	Rappel pour le bouton Enregistrer. Le fait de le passer permet de remplacer la mise à jour par défaut effectuée sur la ressource par l'éditeur

`ResourceEventStream`

Composant permettant d'afficher les événements liés à une ressource particulière.

const [resource, loaded, loadError] = useK8sWatchResource(clusterResource);
return <ResourceEventStream resource={resource} />

Nom du paramètre	Description
`resource`	Objet dont les événements connexes doivent être affichés.

`usePrometheusPoll`

Met en place une interrogation de Prometheus pour une seule requête. Il renvoie un tuple contenant la réponse à la requête, un drapeau booléen indiquant si la réponse a été complétée, et toutes les erreurs rencontrées pendant la requête ou le post-traitement de la requête.

Nom du paramètre	Description
``	{PrometheusEndpoint} props.endpoint - un des PrometheusEndpoint (label, query, range, rules, targets)
``	{chaîne} [props.query] - (facultatif) Chaîne de requête Prometheus. Si elle est vide ou indéfinie, l'interrogation n'est pas lancée.
``	{number} [props.delay] - Intervalle (facultatif) du délai d'interrogation (ms)
``	{number} [props.endTime] - (optionnel) pour l'enpoint QUERY_RANGE, fin de l'intervalle de la requête
``	{number} [props.samples] - (optionnel) pour l'enpoint QUERY_RANGE
``	{number} [options.timespan] - (optionnel) pour l'enpoint QUERY_RANGE
``	{chaîne} [options.namespace] - (optionnel) un paramètre de recherche à ajouter
``	{chaîne} [options.timeout] - (optionnel) un paramètre de recherche à ajouter

`Timestamp`

Composant permettant de restituer les horodatages. Les horodatages sont synchronisés entre les différentes instances du composant Horodatage. L'horodatage fourni est formaté en fonction de la locale de l'utilisateur.

Nom du paramètre	Description
`timestamp`	l'horodatage à rendre. Le format doit être ISO 8601 (utilisé par Kubernetes), epoch timestamp, ou une instance de Date.
`simple`	rendre une version simple du composant en omettant l'icône et l'infobulle.
`omitSuffix`	formate la date en omettant le suffixe.
`className`	nom de classe supplémentaire pour le composant.

`useModal`

Un crochet pour lancer les modales.

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`

Composant permettant de recevoir des contributions d'autres plugins pour le type d'extension console.action/provider.

   const context: ActionContext = { 'a-context-id': { dataFromDynamicPlugin } };

   ...

   <ActionServiceProvider context={context}>
       {({ actions, options, loaded }) =>
         loaded && (
           <ActionMenu actions={actions} options={options} variant={ActionMenuVariant.DROPDOWN} />
         )
       }
   </ActionServiceProvider>

Nom du paramètre	Description
`context`	Objet avec contextId et des données de plugin optionnelles

`NamespaceBar`

Un composant qui rend une barre d'outils horizontale avec un menu déroulant d'espace de noms dans la position la plus à gauche. D'autres composants peuvent être ajoutés en tant qu'enfants et seront affichés à droite du menu déroulant de l'espace de noms. Ce composant est conçu pour être utilisé en haut de la page. Il doit être utilisé sur les pages où l'utilisateur doit pouvoir changer l'espace de noms actif, par exemple sur les pages contenant des ressources k8s.

   const logNamespaceChange = (namespace) => console.log(`New namespace: ${namespace}`);

   ...

   <NamespaceBar onNamespaceChange={logNamespaceChange}>
     <NamespaceBarApplicationSelector />
   </NamespaceBar>
   <Page>

     ...

Nom du paramètre	Description
`onNamespaceChange`	(facultatif) Fonction exécutée lorsqu'une option d'espace de noms est sélectionnée. Elle accepte comme seul argument le nouvel espace de noms sous la forme d'une chaîne de caractères. L'espace de noms actif est mis à jour automatiquement lorsqu'une option est sélectionnée, mais une logique supplémentaire peut être appliquée via cette fonction. Lorsque l'espace de noms est modifié, le paramètre d'espace de noms dans l'URL passe de l'espace de noms précédent à l'espace de noms nouvellement sélectionné.
`isDisabled`	(facultatif) Indicateur booléen qui désactive la liste déroulante de l'espace de noms s'il vaut true. Cette option ne s'applique qu'à la liste déroulante de l'espace de noms et n'a aucun effet sur les composants enfants.
`children`	(facultatif) Éléments supplémentaires à afficher dans la barre d'outils à droite de la liste déroulante de l'espace de noms.

`ErrorBoundaryFallbackPage`

Crée un composant ErrorBoundaryFallbackPage pleine page pour afficher le message "Oh non ! Quelque chose n'a pas fonctionné." ainsi que la trace de la pile et d'autres informations de débogage utiles. Ce composant doit être utilisé en conjonction avec un autre composant.

//in ErrorBoundary component
 return (
   if (this.state.hasError) {
     return <ErrorBoundaryFallbackPage errorMessage={errorString} componentStack={componentStackString}
      stack={stackTraceString} title={errorString}/>;
   }

   return this.props.children;
)

Nom du paramètre	Description
`errorMessage`	description textuelle du message d'erreur
`componentStack`	trace du composant de l'exception
`stack`	trace de la pile de l'exception
`title`	titre à rendre en tant qu'en-tête de la page limite d'erreur

`PerspectiveContext`

@deprecated - use the provided usePerspectiveContext insteadCrée le contexte de la perspective.

Nom du paramètre	Description
`PerspectiveContextType`	avec une perspective active et un filtre

`useAccessReviewAllowed`

@deprecated - Use useAccessReview from @console/dynamic-plugin-sdk instead.Hook that provides allowed status about user access to a given resource. Il renvoie la valeur booléenne isAllowed.

Nom du paramètre	Description
`resourceAttributes`	attributs des ressources pour l'examen de l'accès
`impersonate`	détails de l'usurpation d'identité

`useSafetyFirst`

@deprecated - Ce hook n'est pas lié à la fonctionnalité de la console. Hook qui assure un réglage asynchrone sûr de l'état de React dans le cas où un composant donné pourrait être démonté. Il retourne un tableau avec une paire de valeur d'état et sa fonction set.

Nom du paramètre	Description
`initialState`	valeur de l'état initial

7.5.3. Dépannage de votre plugin dynamique

Consultez cette liste de conseils de dépannage si vous rencontrez des problèmes lors du chargement de votre plugin.

Vérifiez que vous avez activé votre plugin dans la configuration de l'opérateur de la console et que le nom de votre plugin apparaît dans la sortie en exécutant la commande suivante :
```
$ oc get console.operator.openshift.io cluster -o jsonpath='{.spec.plugins}'
```
- Vérifiez les plugins activés sur la carte de statut de la page Overview dans le site Administrator perspective. Vous devrez rafraîchir votre navigateur si le plugin a été récemment activé.
Vérifiez que votre service de plugin est sain :
- Vérification de l'état de votre plugin pod et de la disponibilité de vos conteneurs.
- Vérifier que le sélecteur d'étiquette de service correspond au pod et que le port cible est correct.
- Curl le plugin-manifest.json du service dans un terminal sur le pod de console ou un autre pod sur le cluster.
Vérifiez que le nom de la ressource ConsolePlugin (consolePlugin.name) correspond au nom du plugin utilisé dans package.json.
Vérifiez que le nom du service, l'espace de noms, le port et le chemin d'accès sont correctement déclarés dans la ressource ConsolePlugin.
Vérifiez que votre service de plugin utilise HTTPS et des certificats de service.
Vérifiez les certificats ou les erreurs de connexion dans les journaux de la console.
Vérifiez que l'indicateur de fonctionnalité sur lequel votre plugin s'appuie n'est pas désactivé.
Vérifiez que votre plugin n'a pas de consolePlugin.dependencies dans package.json qui ne soit pas respecté.
- Il peut s'agir de dépendances de la version de la console ou de dépendances d'autres plugins. Filtrez la console JS de votre navigateur sur le nom de votre plugin pour voir les messages qui sont enregistrés.
Vérifier qu'il n'y a pas de fautes de frappe dans la perspective de l'extension navale ou dans les identifiants de section.
- Votre plugin peut être chargé, mais des éléments de navigation manquent si les identifiants sont incorrects. Essayez de naviguer vers une page de plugin directement en modifiant l'URL.
Vérifiez qu'aucune stratégie de réseau ne bloque le trafic entre le pod de la console et votre service de plugin.
- Si nécessaire, ajustez les politiques de réseau pour permettre aux pods de console dans l'espace de noms openshift-console de faire des requêtes à votre service.
Vérifiez la liste des plugins dynamiques à charger dans votre navigateur dans l'onglet Console du navigateur des outils de développement.
- Évaluez window.SERVER_FLAGS.consolePlugins pour voir le plugin dynamique sur le frontend de la console.

Ressources supplémentaires

Comprendre les certificats de service après-vente