Rechercher
SupportConsoleDéveloppeursCommencer un essaiContact

10.4. Contribuer aux démarrages rapides

download PDF

OpenShift Container Platform introduit la ressource personnalisée quick start, qui est définie par un objet ConsoleQuickStart. Les opérateurs et les administrateurs peuvent utiliser cette ressource pour contribuer aux démarrages rapides du cluster.

Conditions préalables

  • Vous devez disposer des privilèges d'administrateur de cluster.

Procédure

  1. Pour créer un nouveau démarrage rapide, exécutez : 

    oc get -o yaml consolequickstart spring-with-s2i > my-quick-start.yaml

  2. Exécutez : 

    $ oc create -f my-quick-start.yaml
  3. Mettez à jour le fichier YAML en suivant les instructions données dans cette documentation.
  4. Enregistrez vos modifications.

10.4.1. Consulter la documentation de l'API de démarrage rapide

Procédure

  • Pour consulter la documentation de l'API de démarrage rapide, exécutez : 

    $ oc explain consolequickstarts

Exécutez oc explain -h pour plus d'informations sur l'utilisation de oc explain.

10.4.2. Mise en correspondance des éléments de l'aide-mémoire avec le CR de l'aide-mémoire

Cette section vous aide à établir une correspondance visuelle entre les parties de la ressource personnalisée (CR) du démarrage rapide et l'endroit où elles apparaissent dans le démarrage rapide au sein de la console Web.

10.4.2.1. élément de conclusion

Visualisation de l'élément de conclusion dans le fichier YAML

...
summary:
  failed: Try the steps again.
  success: Your Spring application is running.
title: Run the Spring application
conclusion: >-
  Your Spring application is deployed and ready. 1

1
texte de conclusion

Visualisation de l'élément de conclusion dans la console web

La conclusion figure dans la dernière section de l'introduction rapide.

quick start conclusion in the web console

10.4.2.2. élément de description

Visualisation de l'élément description dans le fichier YAML

apiVersion: console.openshift.io/v1
kind: ConsoleQuickStart
metadata:
  name: spring-with-s2i
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.' 1
...

1
texte de description

Visualisation de l'élément de description dans la console web

La description apparaît sur la tuile d'introduction de l'introduction rapide à la page Quick Starts.

quick start description in the web console

10.4.2.3. élément displayName

Visualisation de l'élément displayName dans le fichier YAML

apiVersion: console.openshift.io/v1
kind: ConsoleQuickStart
metadata:
  name: spring-with-s2i
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.'
  displayName: Get started with Spring 1
  durationMinutes: 10

1
displayName texte.

Visualisation de l'élément displayName dans la console web

Le nom d'affichage apparaît sur la tuile d'introduction de l'introduction rapide à la page Quick Starts.

quick start display name in the web console

10.4.2.4. élément durationMinutes

Visualisation de l'élément durationMinutes dans le fichier YAML

apiVersion: console.openshift.io/v1
kind: ConsoleQuickStart
metadata:
  name: spring-with-s2i
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.'
  displayName: Get started with Spring
  durationMinutes: 10 1

1
durationMinutes en minutes. Cette valeur définit la durée du démarrage rapide.

Visualisation de l'élément durationMinutes dans la console web

L'élément durée minutes apparaît sur la tuile d'introduction de l'introduction rapide à la page Quick Starts.

quick start durationMinutes element in the web console

10.4.2.5. élément d'icône

Visualisation de l'élément icône dans le fichier YAML

...
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.'
  displayName: Get started with Spring
  durationMinutes: 10
  icon: >-   1
    data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGlkPSJMYXllcl8xIiBkYXRhLW5hbWU9IkxheWVyIDEiIHZpZXdCb3g9IjAgMCAxMDI0IDEwMjQiPjxkZWZzPjxzdHlsZT4uY2xzLTF7ZmlsbDojMTUzZDNjO30uY2xzLTJ7ZmlsbDojZDhkYTlkO30uY2xzLTN7ZmlsbDojNThjMGE4O30uY2xzLTR7ZmlsbDojZmZmO30uY2xzLTV7ZmlsbDojM2Q5MTkxO308L3N0eWxlPjwvZGVmcz48dGl0bGU+c25vd2Ryb3BfaWNvbl9yZ2JfZGVmYXVsdDwvdGl0bGU+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMTAxMi42OSw1OTNjLTExLjEyLTM4LjA3LTMxLTczLTU5LjIxLTEwMy44LTkuNS0xMS4zLTIzLjIxLTI4LjI5LTM5LjA2LTQ3Ljk0QzgzMy41MywzNDEsNzQ1LjM3LDIzNC4xOCw2NzQsMTY4Ljk0Yy01LTUuMjYtMTAuMjYtMTAuMzEtMTUuNjUtMTUuMDdhMjQ2LjQ5LDI0Ni40OSwwLDAsMC0zNi41NS0yNi44LDE4Mi41LDE4Mi41LDAsMCwwLTIwLjMtMTEuNzcsMjAxLjUzLDIwMS41MywwLDAsMC00My4xOS0xNUExNTUuMjQsMTU1LjI0LDAsMCwwLDUyOCw5NS4yYy02Ljc2LS42OC0xMS43NC0uODEtMTQuMzktLjgxaDBsLTEuNjIsMC0xLjYyLDBhMTc3LjMsMTc3LjMsMCwwLDAtMzEuNzcsMy4zNSwyMDguMjMsMjA4LjIzLDAsMCwwLTU2LjEyLDE3LjU2LDE4MSwxODEsMCwwLDAtMjAuMjcsMTEuNzUsMjQ3LjQzLDI0Ny40MywwLDAsMC0zNi41NywyNi44MUMzNjAuMjUsMTU4LjYyLDM1NSwxNjMuNjgsMzUwLDE2OWMtNzEuMzUsNjUuMjUtMTU5LjUsMTcyLTI0MC4zOSwyNzIuMjhDOTMuNzMsNDYwLjg4LDgwLDQ3Ny44Nyw3MC41Miw0ODkuMTcsNDIuMzUsNTIwLDIyLjQzLDU1NC45LDExLjMxLDU5MywuNzIsNjI5LjIyLTEuNzMsNjY3LjY5LDQsNzA3LjMxLDE1LDc4Mi40OSw1NS43OCw4NTkuMTIsMTE4LjkzLDkyMy4wOWEyMiwyMiwwLDAsMCwxNS41OSw2LjUyaDEuODNsMS44Ny0uMzJjODEuMDYtMTMuOTEsMTEwLTc5LjU3LDE0My40OC0xNTUuNiwzLjkxLTguODgsNy45NS0xOC4wNSwxMi4yLTI3LjQzcTUuNDIsOC41NCwxMS4zOSwxNi4yM2MzMS44NSw0MC45MSw3NS4xMiw2NC42NywxMzIuMzIsNzIuNjNsMTguOCwyLjYyLDQuOTUtMTguMzNjMTMuMjYtNDkuMDcsMzUuMy05MC44NSw1MC42NC0xMTYuMTksMTUuMzQsMjUuMzQsMzcuMzgsNjcuMTIsNTAuNjQsMTE2LjE5bDUsMTguMzMsMTguOC0yLjYyYzU3LjItOCwxMDAuNDctMzEuNzIsMTMyLjMyLTcyLjYzcTYtNy42OCwxMS4zOS0xNi4yM2M0LjI1LDkuMzgsOC4yOSwxOC41NSwxMi4yLDI3LjQzLDMzLjQ5LDc2LDYyLjQyLDE0MS42OSwxNDMuNDgsMTU1LjZsMS44MS4zMWgxLjg5YTIyLDIyLDAsMCwwLDE1LjU5LTYuNTJjNjMuMTUtNjQsMTAzLjk1LTE0MC42LDExNC44OS0yMTUuNzhDMTAyNS43Myw2NjcuNjksMTAyMy4yOCw2MjkuMjIsMTAxMi42OSw1OTNaIi8+PHBhdGggY2xhc3M9ImNscy0yIiBkPSJNMzY0LjE1LDE4NS4yM2MxNy44OS0xNi40LDM0LjctMzAuMTUsNDkuNzctNDAuMTFhMjEyLDIxMiwwLDAsMSw2NS45My0yNS43M0ExOTgsMTk4LDAsMCwxLDUxMiwxMTYuMjdhMTk2LjExLDE5Ni4xMSwwLDAsMSwzMiwzLjFjNC41LjkxLDkuMzYsMi4wNiwxNC41MywzLjUyLDYwLjQxLDIwLjQ4LDg0LjkyLDkxLjA1LTQ3LjQ0LDI0OC4wNi0yOC43NSwzNC4xMi0xNDAuNywxOTQuODQtMTg0LjY2LDI2OC40MmE2MzAuODYsNjMwLjg2LDAsMCwwLTMzLjIyLDU4LjMyQzI3Niw2NTUuMzQsMjY1LjQsNTk4LDI2NS40LDUyMC4yOSwyNjUuNCwzNDAuNjEsMzExLjY5LDI0MC43NCwzNjQuMTUsMTg1LjIzWiIvPjxwYXRoIGNsYXNzPSJjbHMtMyIgZD0iTTUyNy41NCwzODQuODNjODQuMDYtOTkuNywxMTYuMDYtMTc3LjI4LDk1LjIyLTIzMC43NCwxMS42Miw4LjY5LDI0LDE5LjIsMzcuMDYsMzEuMTMsNTIuNDgsNTUuNSw5OC43OCwxNTUuMzgsOTguNzgsMzM1LjA3LDAsNzcuNzEtMTAuNiwxMzUuMDUtMjcuNzcsMTc3LjRhNjI4LjczLDYyOC43MywwLDAsMC0zMy4yMy01OC4zMmMtMzktNjUuMjYtMTMxLjQ1LTE5OS0xNzEuOTMtMjUyLjI3QzUyNi4zMywzODYuMjksNTI3LDM4NS41Miw1MjcuNTQsMzg0LjgzWiIvPjxwYXRoIGNsYXNzPSJjbHMtNCIgZD0iTTEzNC41OCw5MDguMDdoLS4wNmEuMzkuMzksMCwwLDEtLjI3LS4xMWMtMTE5LjUyLTEyMS4wNy0xNTUtMjg3LjQtNDcuNTQtNDA0LjU4LDM0LjYzLTQxLjE0LDEyMC0xNTEuNiwyMDIuNzUtMjQyLjE5LTMuMTMsNy02LjEyLDE0LjI1LTguOTIsMjEuNjktMjQuMzQsNjQuNDUtMzYuNjcsMTQ0LjMyLTM2LjY3LDIzNy40MSwwLDU2LjUzLDUuNTgsMTA2LDE2LjU5LDE0Ny4xNEEzMDcuNDksMzA3LjQ5LDAsMCwwLDI4MC45MSw3MjNDMjM3LDgxNi44OCwyMTYuOTMsODkzLjkzLDEzNC41OCw5MDguMDdaIi8+PHBhdGggY2xhc3M9ImNscy01IiBkPSJNNTgzLjQzLDgxMy43OUM1NjAuMTgsNzI3LjcyLDUxMiw2NjQuMTUsNTEyLDY2NC4xNXMtNDguMTcsNjMuNTctNzEuNDMsMTQ5LjY0Yy00OC40NS02Ljc0LTEwMC45MS0yNy41Mi0xMzUuNjYtOTEuMThhNjQ1LjY4LDY0NS42OCwwLDAsMSwzOS41Ny03MS41NGwuMjEtLjMyLjE5LS4zM2MzOC02My42MywxMjYuNC0xOTEuMzcsMTY3LjEyLTI0NS42Niw0MC43MSw1NC4yOCwxMjkuMSwxODIsMTY3LjEyLDI0NS42NmwuMTkuMzMuMjEuMzJhNjQ1LjY4LDY0NS42OCwwLDAsMSwzOS41Nyw3MS41NEM2ODQuMzQsNzg2LjI3LDYzMS44OCw4MDcuMDUsNTgzLjQzLDgxMy43OVoiLz48cGF0aCBjbGFzcz0iY2xzLTQiIGQ9Ik04ODkuNzUsOTA4YS4zOS4zOSwwLDAsMS0uMjcuMTFoLS4wNkM4MDcuMDcsODkzLjkzLDc4Nyw4MTYuODgsNzQzLjA5LDcyM2EzMDcuNDksMzA3LjQ5LDAsMCwwLDIwLjQ1LTU1LjU0YzExLTQxLjExLDE2LjU5LTkwLjYxLDE2LjU5LTE0Ny4xNCwwLTkzLjA4LTEyLjMzLTE3My0zNi42Ni0yMzcuNHEtNC4yMi0xMS4xNi04LjkzLTIxLjdjODIuNzUsOTAuNTksMTY4LjEyLDIwMS4wNSwyMDIuNzUsMjQyLjE5QzEwNDQuNzksNjIwLjU2LDEwMDkuMjcsNzg2Ljg5LDg4OS43NSw5MDhaIi8+PC9zdmc+Cg==
...

1
L'icône est définie comme une valeur base64.

Visualisation de l'élément icône dans la console web

L'icône apparaît sur la tuile d'introduction de l'introduction rapide à la page Quick Starts.

quick start icon element in the web console

10.4.2.6. élément d'introduction

Visualisation de l'élément d'introduction dans le fichier YAML

...
  introduction: >- 1
    **Spring** is a Java framework for building applications based on a distributed microservices architecture.

    - Spring enables easy packaging and configuration of Spring applications into a self-contained executable application which can be easily deployed as a container to OpenShift.

    - Spring applications can integrate OpenShift capabilities to provide a natural "Spring on OpenShift" developer experience for both existing and net-new Spring applications. For example:

    - Externalized configuration using Kubernetes ConfigMaps and integration with Spring Cloud Kubernetes

    - Service discovery using Kubernetes Services

    - Load balancing with Replication Controllers

    - Kubernetes health probes and integration with Spring Actuator

    - Metrics: Prometheus, Grafana, and integration with Spring Cloud Sleuth

    - Distributed tracing with Istio & Jaeger tracing

    - Developer tooling through Red Hat OpenShift and Red Hat CodeReady developer tooling to quickly scaffold new Spring projects, gain access to familiar Spring APIs in your favorite IDE, and deploy to Red Hat OpenShift
...

1
L'introduction présente le démarrage rapide et énumère les tâches qu'il contient.

Visualisation de l'élément d'introduction dans la console web

Après avoir cliqué sur une carte de démarrage rapide, un panneau latéral s'affiche pour présenter le démarrage rapide et énumérer les tâches qu'il contient.

quick start introduction element in the web console

10.4.3. Ajout d'une icône personnalisée à un démarrage rapide

Une icône par défaut est fournie pour tous les démarrages rapides. Vous pouvez créer votre propre icône.

Procédure

  1. Trouvez le fichier .svg que vous souhaitez utiliser comme icône personnalisée.
  2. Utilisez un outil en ligne pour convertir le texte en base64.

  3. Dans le fichier YAML, ajoutez icon: >-, puis sur la ligne suivante, incluez data:image/svg xml;base64 suivi de la sortie de la conversion base64. Par exemple : 

    icon: >-
   data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHJvbGU9ImltZyIgdmlld.

10.4.4. Limiter l'accès à un démarrage rapide

Tous les programmes de démarrage rapide ne doivent pas être accessibles à tout le monde. La section accessReviewResources du fichier YAML permet de limiter l'accès au démarrage rapide.

Pour permettre à l'utilisateur d'accéder au démarrage rapide uniquement s'il a la possibilité de créer des ressources HelmChartRepository, utilisez la configuration suivante : 

accessReviewResources:
  - group: helm.openshift.io
    resource: helmchartrepositories
    verb: create

Pour n'autoriser l'utilisateur à accéder au démarrage rapide que s'il a la possibilité de répertorier les groupes d'opérateurs et les manifestes de paquets, et donc d'installer des opérateurs, utilisez la configuration suivante : 

accessReviewResources:
  - group: operators.coreos.com
    resource: operatorgroups
    verb: list
  - group: packages.operators.coreos.com
    resource: packagemanifests
    verb: list

10.4.5. Liens vers d'autres démarrages rapides

Procédure

  • Dans la section nextQuickStart du fichier YAML, indiquez le name, et non le displayName, de l'introduction rapide vers laquelle vous souhaitez établir un lien. Par exemple : 

    nextQuickStart:
  - add-healthchecks

10.4.6. Balises prises en charge pour un démarrage rapide

Rédigez votre contenu en markdown à l'aide de ces balises. Le markdown est converti en HTML.

ÉtiquetteDescription

'b',

Définit le texte en gras.

'img',

Incorpore une image.

'i',

Définit le texte en italique.

'strike',

Définit le texte barré.

's',

Définit un texte plus petit

'del',

Définit un texte plus petit.

'em',

Définit le texte mis en valeur.

'strong',

Définit le texte important.

'a',

Définit une balise d'ancrage.

'p',

Définit le texte du paragraphe.

'h1',

Définit une rubrique de niveau 1.

'h2',

Définit une rubrique de niveau 2.

'h3',

Définit une rubrique de niveau 3.

'h4',

Définit une rubrique de niveau 4.

'ul',

Définit une liste non ordonnée.

'ol',

Définit une liste ordonnée.

'li',

Définit un élément de liste.

'code',

Définit un texte comme un code.

'pre',

Définit un bloc de texte préformaté.

'button',

Définit un bouton dans le texte.

10.4.7. Démarrage rapide de la mise en évidence de la référence au markdown

La fonction de mise en évidence ou d'indication permet aux démarrages rapides de contenir un lien qui peut mettre en évidence et animer un composant de la console web.

La syntaxe markdown contient :

  • Texte du lien entre crochets
  • Le mot-clé highlight, suivi de l'ID de l'élément à animer

10.4.7.1. Changeur de perspective

[Perspective switcher]{{highlight qs-perspective-switcher}}

10.4.7.2. Liens de navigation du point de vue de l'administrateur

[Home]{{highlight qs-nav-home}}
[Operators]{{highlight qs-nav-operators}}
[Workloads]{{highlight qs-nav-workloads}}
[Serverless]{{highlight qs-nav-serverless}}
[Networking]{{highlight qs-nav-networking}}
[Storage]{{highlight qs-nav-storage}}
[Service catalog]{{highlight qs-nav-servicecatalog}}
[Compute]{{highlight qs-nav-compute}}
[User management]{{highlight qs-nav-usermanagement}}
[Administration]{{highlight qs-nav-administration}}

10.4.7.3. Liens de navigation du point de vue du développeur

[Add]{{highlight qs-nav-add}}
[Topology]{{highlight qs-nav-topology}}
[Search]{{highlight qs-nav-search}}
[Project]{{highlight qs-nav-project}}
[Helm]{{highlight qs-nav-helm}}

10.4.7.4. Liens de navigation communs

[Builds]{{highlight qs-nav-builds}}
[Pipelines]{{highlight qs-nav-pipelines}}
[Monitoring]{{highlight qs-nav-monitoring}}

10.4.8. Référence de l'extrait de code

Vous pouvez exécuter un extrait de code CLI lorsqu'il est inclus dans un démarrage rapide à partir de la console web. Pour utiliser cette fonctionnalité, vous devez d'abord installer le Web Terminal Operator. Les actions du terminal web et des extraits de code qui s'exécutent dans le terminal web ne sont pas présentes si vous n'installez pas l'Opérateur de terminal web. Vous pouvez également copier un extrait de code dans le presse-papiers, que l'Opérateur de terminal Web soit installé ou non.

10.4.8.1. Syntaxe pour les extraits de code en ligne

`code block`{{copy}}
`code block`{{execute}}
Note

Si la syntaxe execute est utilisée, l'action Copy to clipboard est présente, que le Web Terminal Operator soit installé ou non.

10.4.8.2. Syntaxe pour les extraits de code multi-lignes

```
multi line code block
```{{copy}}

```
multi line code block
```{{execute}}
Red Hat logoGithubRedditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez leBlog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

© 2024 Red Hat, Inc.