Aller au contenu
medium

Comment lire cette documentation

15 min de lecture

Cette documentation couvre un large spectre de sujets DevSecOps. Ce guide vous explique comment elle est organisée, quelles fonctionnalités interactives sont à votre disposition, et comment optimiser votre lecture selon votre profil.

Ce site existe pour une raison simple : réduire l’écart entre “j’ai entendu parler de DevSecOps” et “je sais l’appliquer concrètement”. L’objectif n’est pas de collecter des tutoriels, mais de construire une compréhension solide des principes avant de manipuler les outils.

La sécurité n’est pas une section à part : c’est un fil conducteur. Chaque guide intègre les considérations de sécurité dès le départ, pas comme un ajout tardif. Vous apprendrez à déployer, automatiser et opérer des systèmes en tenant compte des risques dès la conception.

Ce que vous obtiendrez concrètement :

  • Comprendre pourquoi une pratique existe avant de voir comment l’implémenter
  • Appliquer des principes de sécurité sans attendre d’être expert en cybersécurité
  • Éviter les erreurs classiques documentées par ceux qui les ont faites
  • Avoir des repères pour évaluer si une solution est adaptée à votre contexte

Ce site propose plusieurs fonctionnalités pour enrichir votre apprentissage. Prenez le temps de les découvrir pour optimiser votre lecture.

Le vocabulaire DevSecOps est riche en termes techniques. Pour vous aider, les termes du glossaire sont intégrés directement dans les articles.

Quand vous lisez un guide, les termes techniques apparaissent avec un soulignement pointillé. Au survol, une infobulle affiche la définition courte. En cliquant, vous accédez à la page du glossaire avec la définition complète.

tooltip-glossaire

Activer/désactiver les tooltips : dans le header du site, un bouton permet de basculer entre les modes :

  • Glossaire activé : les termes sont soulignés en pointillé, les tooltips s’affichent au survol
  • Glossaire désactivé : le texte apparaît normalement, sans surcharge visuelle

glossaire-toggle

À la fin de nombreux guides, un quiz interactif vous permet de valider vos connaissances. Ces contrôles ne sont pas là pour vous piéger, mais pour :

  • Vérifier votre compréhension des concepts clés
  • Identifier les points à revoir avant de passer à la suite
  • Ancrer les connaissances par la pratique active

quiz-example

Comment fonctionne un quiz :

  1. Lancez le quiz en cliquant sur le bouton de démarrage

  2. Répondez aux questions dans le temps imparti (généralement 5-10 minutes)

  3. Consultez vos résultats avec le score et les explications détaillées

  4. Identifiez les lacunes grâce aux explications fournies pour chaque réponse

Les quiz comportent différents types de questions :

  • QCM : choix multiples avec une seule bonne réponse
  • Vrai/Faux : affirmations à valider ou infirmer
  • Mot à trouver : terme technique à saisir

Certains guides incluent une section FAQ (Foire Aux Questions) en fin de page. Ces questions-réponses couvrent :

  • Les interrogations fréquentes des lecteurs
  • Les cas particuliers non détaillés dans le guide principal
  • Les pièges courants à éviter

faq-example

Navigation dans la FAQ : cliquez sur une question pour déplier la réponse. Les réponses peuvent contenir du code, des liens et des exemples.

Le site dispose d’une recherche full-text accessible via le champ de recherche dans le header ou avec le raccourci clavier Ctrl+K (ou Cmd+K sur Mac).

search-example

La recherche indexe :

  • Les titres et descriptions des pages
  • Le contenu intégral des guides
  • Les termes du glossaire

Sur les guides longs, une table des matières apparaît sur le côté droit de la page. Elle permet de :

  • Voir la structure du guide d’un coup d’œil
  • Naviguer directement vers une section
  • Suivre votre position dans le document (section courante surlignée)

Vous découvrez le domaine. Les termes comme “CI/CD”, “conteneur” ou “infrastructure as code” sont encore flous.

Ce que vous trouverez :

  • Le vocabulaire et les concepts de base
  • Une progression logique des fondamentaux vers la pratique
  • Des quiz pour valider chaque étape

Conseil : activez le glossaire, lisez les sections “Fondamentaux” en premier, et faites les quiz pour ancrer les concepts.

  • Des recettes magiques : pas de “déployez un orchestrateur en 5 minutes” sans comprendre ce que vous faites
  • Du copier-coller sans explication : chaque commande est contextualisée, avec le “pourquoi” et le “comment vérifier”
  • Des checklists hors-sol : les listes de bonnes pratiques sont accompagnées de scénarios réels
  • Une exhaustivité encyclopédique : je documente ce que je pratique, pas tout ce qui existe
  • De la théorie pure : chaque concept est illustré par un cas d’usage concret

La documentation est organisée en sections thématiques accessibles via la sidebar (menu latéral gauche). Chaque section répond à un besoin spécifique :

Fondamentaux

Poser les bases : vocabulaire, principes, modèles mentaux. À lire en premier si vous débutez.

Administration Linux

Gérer des systèmes au quotidien : services, réseaux, utilisateurs. Le socle technique indispensable.

Conteneurisation

Isoler, packager, orchestrer des applications. Docker, Kubernetes et l’écosystème associé.

Infrastructure as Code

Automatiser la création et la configuration d’infrastructure. Reproductibilité et versionnement.

Pipelines CI/CD

Automatiser les tests, les builds, les déploiements. Le cœur de l’intégration continue.

Sécurité

Durcir, analyser, détecter. Intégrer la sécurité à chaque étape du cycle de vie.

Observabilité

Comprendre ce qui se passe en production : logs, métriques, traces, alertes.

Chaque section peut être lue indépendamment, mais des liens internes connectent les sujets liés pour faciliter l’exploration.

Objectif : acquérir le vocabulaire et les concepts de base pour ne plus être perdu dans une conversation DevOps.

  1. Lisez les fondamentaux DevOps : Qu’est-ce que DevOps ? puis DevSecOps

  2. Activez le glossaire pour comprendre les termes techniques au fil de la lecture

  3. Faites le quiz de chaque guide pour valider votre compréhension

  4. Explorez les menaces : Menace, risque, vulnérabilité, attaque

Critère de réussite : vous pouvez expliquer la différence entre DevOps et DevSecOps à un collègue, et vous savez pourquoi la sécurité doit être intégrée tôt.

Objectif : comprendre ce qui se passe entre votre code et la production.

  1. Commencez par les pipelines CI/CD : vous connaissez déjà le code, partez de là

  2. Découvrez la conteneurisation : comprendre les environnements d’exécution avec Docker

  3. Explorez l’Infrastructure as Code : automatiser ce qui était manuel avec Terraform ou Ansible

  4. Validez avec les quiz à chaque étape

Critère de réussite : vous pouvez configurer un pipeline qui teste, build et déploie votre application sans intervention manuelle.

Objectif : intégrer la sécurité dans vos pratiques d’exploitation.

  1. Comprenez les principes : le “pourquoi” avant le “comment”

  2. Analysez le code et les dépendances : détecter les vulnérabilités automatiquement

  3. Appliquez le durcissement : référentiels CIS, ANSSI et bonnes pratiques

  4. Automatisez les contrôles : intégrer les scans dans vos pipelines

Critère de réussite : vous savez identifier les points de contrôle sécurité dans votre pipeline et vous avez mis en place au moins un scan automatisé.

Objectif : réduire les risques liés à votre chaîne de livraison logicielle.

Explorez la section sécurité en vous concentrant sur : gestion des secrets, analyse des dépendances, signature des artefacts, politiques d’admission. Les guides sont liés entre eux pour former un parcours cohérent.

Critère de réussite : votre pipeline détecte les secrets committés par erreur et bloque les dépendances avec des CVE critiques.

Le site utilise des encadrés colorés pour signaler des informations importantes. Apprenez à les reconnaître :

Les commandes sont présentées avec le langage indiqué pour la coloration syntaxique. Les commentaires expliquent le contexte :

Fenêtre de terminal
# Vérifier que le service est actif avant de continuer
systemctl is-active --quiet nginx && echo "OK" || echo "Service arrêté"

Conseil : ne copiez-collez pas aveuglément. Lisez le contexte autour de la commande pour comprendre pourquoi elle est utilisée et comment vérifier qu’elle a fonctionné.

Les liens vers d’autres pages utilisent des chemins absolus /docs/.... Ils permettent de naviguer entre sujets connexes. Les liens sont toujours accompagnés de contexte pour vous aider à décider si la ressource liée vous sera utile.

  1. Activez le glossaire dans le header

  2. Lisez le guide en entier une première fois, sans chercher à tout retenir

  3. Revenez sur les points clés en utilisant la table des matières

  4. Faites le quiz pour identifier les lacunes

  5. Consultez les liens vers les ressources complémentaires

  1. Désactivez le glossaire pour une lecture fluide

  2. Utilisez la recherche (Ctrl+K) pour trouver directement l’information

  3. Naviguez via la table des matières pour aller à la section pertinente

  4. Copiez les commandes dont vous avez besoin

  1. Parcourez les quiz des sections concernées

  2. Relisez les encadrés (tip, caution, danger) qui résument les points essentiels

  3. Consultez le glossaire pour le vocabulaire technique

  4. Révisez les FAQ qui couvrent les questions fréquentes

Vous avez repéré une erreur, une information obsolète ou vous souhaitez proposer une amélioration ? Rejoignez le Discord pour échanger et contribuer.

  • Exploitez les fonctionnalités interactives : glossaire, quiz, FAQ, recherche
  • Adaptez le glossaire à votre niveau : activé pour découvrir, désactivé pour lire vite
  • Validez avec les quiz : ils sont là pour ancrer les connaissances, pas pour évaluer
  • Utilisez la recherche : Ctrl+K est votre ami pour trouver rapidement
  • Suivez les encadrés : tip, caution, danger résument les points essentiels
  • La documentation est modulaire : chaque guide peut être lu indépendamment