YATAS : outil des bonnes pratiques sur les infras cloud | Padok

plugins:
  - name: "aws"
    enabled: true
    description: "Check for AWS good practices"
    
		exclude:
      - "AWS_S3_001"

...

Comment choisir le format d’export de mon rapport YATAS ? (markdown - html - notion)

Pourquoi voudrais-je changer le format d’export ?

Super, nous avons appris à lancer une analyse. Mais vous ne trouvez que ce rapport est un peu triste et difficile à lire ? On a pensé à tout, comme Yatas est conçu de manière modulaire, nous avons créé quelques plugins pour exporter vos rapports.

Nous avons déjà créé à formats différents pour exporter vos analyses :

💡 Les plugins se cumulent : on peut les exporter de plusieurs façons différentes en même temps.

Comment utiliser les plugins simples ? (markdown - html)

• Les 2 premiers modules n’ont pas besoin de gérer de l’authentification et sont donc faciles à mettre en place. Ils vont se contenter de créer les fichiers avec l’extension attendue que vous pourrez ensuite utiliser comme bon vous le semble.

• Pour l’exporter en Markdown ajouter ce plugin dans le fichier .yatas.yml

  plugins:
  	- ...
  	- name: "markdown"
  	  enabled: true
  	  type: "report"
  	  source: "github.com/padok-team/yatas-markdown"
  	  version: "latest"
  	  description: "Generates a markdown report"

• Pour l’exporter en HTML ajouter ce plugin dans le fichier .yatas.yml

  plugins:
  	- ...
  	- name: "html"
  	  enabled: true
  	  type: "report"
  	  source: "github.com/Thibaut-Padok/yatas-html"
  	  version: "latest"
  	  description: "Generates a html report in report.html file"

Comment exporter ces rapports dans notion ?

Notion offre une interface parfaite pour y exporter ces rapports YATAS et les stocker. J’ai donc créé un plugin permettant de créer la structure de donnée permettant de stocker des rapports YATAS dans une page notion choisie. Le fonctionnement est un peu plus compliqué que pour les autres plugins vu qu’on a besoin de s’authentifier.

 ℹ️ Pour pouvoir créer une intégration et générer des rapports dans vos pages notions, vous avez besoin d’être administrateur de votre workspace.

• Créer une intégration Notion et Obtenir un token d’authentification:

  • Pour obtenir un token, il va falloir créer une connexion :

  • Cliquer Settings & members, puis sur manage intergration

  • Cliquer sur New integration

    • Mettre yatas-notion comme nom

    • Ajouter le logo de YATAS que vous pouvez trouver ici 

    • Sélectionner le workspace que vous désirez

      • Read
      • Write
      • update

        S’assurer d’avoir toutes les content capabilities:

    • sur Submit

    • Vous aurez une nouvelle section Secret avec le secret de l’intégration ce secret correspond $NotionConnectionToken dans la config

  • Dans le menu de droite, ajouter une nouvelle connexion à la page :

    Autoriser la page :

    Même si vous avez créé une connexion et obtenu un Token, YATAS ne sera autorisé à modifier que les pages sur lesquels vous avez activé cette connexion.

    Pour ce faire, choisissez la page dans laquelle sera créée la base de données des rapports (inline database).

    • Récupérer l’id de la page :

• Configurer YATAS

  Maintenant que l’on a un token, qu’on a autorisé la page et récupéré l’id de la page, on peut tout simplement configurer le plugin notion comme il suit :

  plugins:
  	- ...
    - name: "notion"
      enabled: true
      type: "report"
      source: "github.com/Thibaut-Padok/yatas-notion"
      version: "latest"
      description: "Add your yatas report in a notion database"
  pluginsConfiguration:
  	- ...
    - pluginName: notion
      pageID: $NotionPageID #The one you want the yatas database to be, it will create the database if not exist. This page must use a Notion connection YATAS-Notion
      token: $NotionConnectionToken # The secret to be able to use Notion Connection

• Éxecuter yatas --install pour télécharger le nouveau plugin et voici le résultat attendu :

Comment rendre ces rapports plus jolie dans notion ?

Le plugin yatas-notion peut utiliser l’API web de notion pour vérouiller les rapports yatas et rendre plus esthétiques la base de données en mode liste au lieu de table. Pour bénéficier de ces fonctionnalités vous avez besoin d’ajouter votre token utilisateur.

Ce token est optionnel, et il est peu recommandé de laisser ce token dans le fichier de configuration .yatas.yaml, car il permet d’effectuer des actions à votre place sur toutes vos pages notion.

Trouver le token web

• Se connecter à notion dans un navigateur

• Clique droit et sélectionne Inspect

• Application > Storage > Cookies > https://www.notion.so > token_v2

• Copier la valeur du token_v2
  
  

Configuration du token optionnel

• Rajouter le token optionnel dans la configuration du plugin

  plugins:
  	- ...
    - name: "notion"
      enabled: true
      type: "report"
      source: "github.com/Thibaut-Padok/yatas-notion"
      version: "latest"
      description: "Add your yatas report in a notion database"
  pluginsConfiguration:
  	- ...
    - pluginName: notion
      pageID: $NotionPageID #The one you want the yatas database to be, it will create the database if not exist. This page must use a Notion connection YATAS-Notion
      token: $NotionConnectionToken # The secret to be able to use Notion Connection

• Supprimer la database afin de bénéficier de la création de base de données avancée.

• Executer yatas

  ℹ️ Tous les rapports générés seront désormais verrouillés ainsi, il n’est pas possible de cocher une check box par mégarde. Le résultat attendu est le suivant:

Conclusion

On vous a présenté l’outil YATAS, maintenant à vous de jouer ! N’hésitez pas à créer votre propre module, à nous partager vos bonnes pratiques et nous faire des retours sur son fonctionnement. Et surtout faites-nous savoir quel est le prochain CloudProvider que vous souhaitez que YATAS prenne en charge !