Introduction
Pour la deuxième année consécutive et malgré son jeune âge, Kong est nommé leader et visionnaire par le Magic Quadrant du Gartner sur les API management.
Cette ascension fulgurante attise naturellement notre curiosité, je vous propose donc dans cet article de découvrir ensemble la solution d’API Management Kong.
Cet article s’adresse à un public familier avec les notions d’API et d’API Management.
Si ce n’est pas votre cas, je vous invite à explorer les liens ci-dessous :
https://accetal.fr/glossaire-api-management/
https://accetal.fr/introuduction-api-management/
https://accetal.fr/webinar-quels-criteres-pour-bien-choisir-sa-solution-dapi-management/
Vous pouvez également si vous le souhaitez, suivre la formation complète sur les API :
https://accetal.fr/formations/reussir-lapisation-de-son-si/
Kong, qu’est ce que c’est au juste ?
Kong, c’est d’abord Kong Gateway, une passerelle d’API Open Source et Cloud-native, qui adresse aussi bien des API, que des microservices.
Compatible avec différents systèmes d’exploitation, elle peut également être déployée via Docker ou Kubernetes.
Elle se dit légère, rapide mais aussi flexible notamment grâce à son système de plugins et de modules. Elle est ainsi proposée sous différents formats allant :
- de la simple passerelle d’api pour le mode OPEN SOURCE,
- à une solution complète d’API management pour le mode ENTERPRISE avec :
- l’interface Kong Manager : un portail de gestion/publication Api
- l’interface Kong Developer : un portail développeur
- le module Kong Vitals : un outil de monitoring (logs, métriques, performance…)
- le module Kong Immunity : un outil d’analyse de logs (maching learning, alertes…)
- une gestion des contrôles d’accès de type RBAC (Role-based Access Contrôle)
- ainsi qu’un ensemble de plugins.
En janvier 2021, Kong va encore plus loin et lance Kong Connect (Konnect), une plateforme d’administration en mode SaaS. Cette plateforme comporte un nouveau module « Runtime Manager » dont l’objet est la gestion de plusieurs nœuds Kong Gateway, tout en s’affranchissant de base de données.
Ci-dessous, la liste des modules Konnect en modes SaaS :
- ServiceHub (équivalent de Kong Manager, pour gérer les services)
- RuntimeManager (facilite le déploiement des runtimes de Kong Gateway)
- Portal Developper
- Vitals
La petite histoire : naissance de la bête
Tout commence par Mashape, une société née avec le succès montant des API dans les années 2010.
Mashape avait pour ambition de créer la première marketplace dédiée aux API, une sorte de Airbnb mais pour de la location d’API. Les fournisseurs y publiaient leurs API (description, spécification, tarification). Les développeurs accédaient alors à un catalogue d’API, qu’ils pouvaient directement tester, souscrire et surtout consommer via la plateforme Mashape.
C’est-à-dire que toutes les requêtes d’API devaient passer par une API gateway assez puissante et robuste pour gérer une telle volumétrie de transactions.
En 2015, Mashape donne un nom à cette Api Gateway et décide de la rendre open Source : c’est la naissance de Kong.
La version Enterprise fera son apparition en 2018 et en 2021 Kong donne naissance à un petit dernier très prometteur, Konnect. Celui-ci fournit le portail Konnect et la plupart de ses modules en mode SaaS, tandis que l’hébergement des runtimes restent à la charge des clients.
Avec ces nouveaux produits, Kong s’impose aux côtés d’autres géants de l’API management, et prend place dans la case Leaders du Gartner magic-quadrant-api-management de 2020 et 2021 : https://accetal.fr/magic-quadrant-api-management-2021/.
Dissection du gorille : qu’a-t-il dans le ventre ?
Dans le mode Enterprise, on retrouve bien tous les composants d’une plateforme de gestion d’API.
Une API gateway : « Kong Gateway »
Celle-ci se compose des éléments ci-dessous :
Un reverse proxy
Kong Gateway repose sur la plateforme web OpenResty, qui est une surcouche de Nginx combinée à un moteur LuaJIT.
- Nginx est un serveur web et reverse proxy. Léger et rapide, il est réputé pour ses hautes performances.
- Lua est un langage de script dont les threads peuvent se greffer à un programme existant afin d’en étendre les fonctionnalités. C’est sur ce mécanisme que repose le système de plugins de Kong Gateway.
Des plugins
Ce qu’on appelle plugins chez Kong, c’est l’équivalent des policies, c’est-à-dire des règles et actions qui sont appliquées aux requêtes et réponses qui transitent sur la Gateway (authentification, autorisations, quotas, cache…).
Kong propose aujourd’hui plus de 60 plugins, et il est possible de créer ses propres plugins en langage Lua, GO, JS et Python (liste des plugins : https://docs.konghq.com/hub/).
Une base de données
Pour la persistance des données (enregistrement des configurations des API, des déclarations d’applications …), Kong gateway donne le choix entre Cassandra et PostgreSQL, mais supporte également un mode DB-less.
Des outils d’administration
L’Api Gateway est fournie avec deux outils d’administration :
- Une API REST: Kong Admin API, accessible par défaut sur le port 8001
Docs : https://docs.konghq.com/gateway/2.6.x/admin-api/
Exemples de requêtes d’administration via l’API Admin pour exposer un service sur l’api gateway:
curl -X POST http://127.0.0.1:8001/services --data name=demo-api --data url=http://mockbin.org
curl -X POST http://127.0.0.1:8001/services/demo-api/routes --data paths[]=/demo-api- Un CLI pour faciliter le CI/CD dans un cadre DevOps: Kong decK
Docs : https://docs.konghq.com/deck/1.8.x/reference/deck/
Ex : Commande deck pour exporter/importer la configuration d’une instance Kong Gateway :
deck dump
deck syncUn portail fournisseur : « Kong Manager » ou « Konnect » pour la version SaaS
« Kong manager » est une interface web d’administration de Kong Gateway. On y publie les API, gère leurs cycles de vie puis on les surveille grâce au module « Vitals ».
Il permet également de gérer et personnaliser le portail développeur.
Quant au module complémentaire de machine learning « Kong Immunity », il facilite la détection des comportements anormaux en analysant les logs en temps réels.
Un portail développeur : « Kong Developers » ou « Konnect Developers »
Le portail développeur est dédié aux consommateurs des API.
Il présente un catalogue d’API classées par catégories et est entièrement personnalisable pour correspondre à la chartre graphique d’une entreprise par exemple.
En quelques clics, les consommateurs d’API (les développeurs) sont capables de tester ces API, d’y souscrire, et de suivre leurs consommations directement depuis ce portail.
Place à la pratique : apprivoisons Konnect
Créer un compte
Pour commencer avec Konnect, il faut se créer un compte puis se connecter via le portail https://konnect.konghq.com/ :
Préparer une instance du runtime Kong Gateway
Une fois le compte créé, nous aurons besoins d’installer un runtime. Pour cela, cliquez sur le menu runtime sur le panneau gauche, puis sur le bouton « Configure Runtime ».
Ensuite, laissez-vous guider en suivant les instructions selon le mode de déploiement que vous souhaitez (container docker, Linux ou Kubernetes).
Le runtime configuré apparaitra sur le portail Konnect.
Publier une API
Pour notre exemple, nous allons publier l’api Petstore mise à disposition par Smartbear, très souvent utilisée pour les démos et les exemples : https://petstore.swagger.io/.
- Sur le portail Konnect, nous allons déclarer ce service, pour cela cliquez sur le menu « Services » du panel gauche, puis sur le bouton « Add New Service », et renseignez le formulaire avant de le soumettre.
- Cliquez sur la version déclarée (1.0.5 dans cet exemple), puis cliquez sur « New Implementation ».
- Configurer l’upstream service (il s’agit du service backend) comme suit :
- Configurez ensuite la route en renseignant le nom le chemin (path) qui exposera le service via la gateway :
- Cliquez sur le bouton « Create » puis tester sur la machine dans laquelle est installée le runtime de notre test : la requête ci-dessous doit retourner un code statut http 200 OK.
curl http://127.0.0.1:8000/petstores/store/inventoryA ce stade, nous avons publié notre API (dans cet exemple l’api petstore) sur notre gateway.
Cette dernière redirige les appels commençant par « http://127.0.0.1:8000/petstores… » vers http://petstore.swagger.io/v2…
Ainsi, notre appel de test a été redirigé par notre gateway vers « http://petstore.swagger.io/v2/store/inventory« .
Ajouter un plugin
Kong est extensible grâce à des plugins qui peuvent être ajoutés à différents niveaux (service, global …). Nous allons ici ajouter un plugin au niveau de notre service, celui-ci sécurisera l’accès à notre API à l’aide d’une APIKey.
- Dans le menu « Services », sélectionnez l’API Petstore, sélectionnez la version « 1.0.5 » puis cliquez sur « New Plugin ».
- Activez le plugin « Key Authentication » (laisser les paramètres par défaut, puis cliquez sur « Create »).
- Testez de nouveau l’api :
curl http://127.0.0.1:8000/petstores/store/inventoryCette fois-ci un code erreur 401 est retournée car aucune apikey n’a été fournie lors de l’appel. Ce contrôle est effectué par le plugin « Key Authentication » que nous avons activé pour le service.
Créer un consommateur pour interroger l’API
Désormais, notre API nécessite une clé de souscription pour être consommée. Nous allons donc devoir déclarer un consommateur et lui attribuer une clé.
- Dans le menu « Shared Config/Consumers », créez un consommateur en cliquant sur le bouton « New consumer ».
- Sélectionnez le consumer nouvellement créé, et générez une apikey dans l’onglet « Credentials » via le bouton « new Key Auth Credentials ».
- Enfin, cliquez sur « Create » sans rien renseigner pour générer une clé automatiquement.
- Copiez la clé et envoyez la dans la requête au niveau de l’entête « apikey ».
curl --header apikey: http://127.0.0.1:8000/petstores/store/inventoryL’api-key étant renseignée, vous devriez obtenir un code statut http 200 OK.
Pour aller plus loin
Maintenant que vous savez comment publier une API sur Kong Gateway via le portail Konnect et la sécuriser à l’aide d’ApiKey, vous pouvez aller plus loin en testant d’autres plugins et en manipulant les différents modules.
Vous trouverez toute la documentation Kong disponible à cette adresse : https://docs.konghq.com/.
Je vous recommande par ailleurs de vous inscrire à Kong Academy, une plateforme d’apprentissage générant des environnements Kong éphémères au début de chaque cours.
Enfin, pour les plus curieux d’entre vous, les sources de Kong Gateway OSS sont disponibles dans le repository : https://github.com/Mashape/kong.
Vous avez des questions ? Vous souhaitez être accompagnés ? Contactez-nous !
Publié le 08/12/21
Partagez cet article :