qu'est-ce que l'API Docker

L'API Docker fait référence à l'interface du programme d'application de Docker, qui est l'accord pour la connexion de différents composants du système logiciel. Docker dispose principalement de trois API externes : 1. API Docker Registry 2. API Docker Hub ; API distante.

L'environnement d'exploitation de ce tutoriel : système linux5.9.8, version docker-1.13.1, ordinateur Dell G3.

1. Qu'est-ce que l'API

1. Qu'est-ce que l'API spécifiquement ?

Le mot API est expliqué dans Wikipédia comme suit : Application Programming Interface (anglais : application Programming Interface, en abrégé API), également connue sous le nom d'application Programming Interface, est une convention permettant de connecter différents composants d'un système logiciel. Après avoir lu cette explication, je suppose que vous êtes encore un peu confus, mais cela n'a pas d'importance. Ci-dessous, nous présenterons ce qu'est une API en langage profane.

Chacun d'entre nous possède un téléphone portable. Lorsque le téléphone portable est à court d'énergie, nous trouverons certainement un chargeur fixe et un câble de chargement pour le charger. Utilisez Apple pour Apple, utilisez Android pour Android. Mais vous n'utiliserez certainement pas de câble Android pour charger un téléphone Apple. La raison est très simple, car votre téléphone Apple dispose d'une interface Lightning et celui d'Android a une micro-interface. Si vous souhaitez charger ou transférer des données sur votre téléphone mobile, vous devez acheter des câbles de chargement et des câbles de données appropriés. C'est la compréhension la plus simple et la plus simple de l'interface.

De même, il en va de même pour l'interface du programme. Chaque programme possède une interface standard externe fixe. Cette interface est définie par le développeur qui a développé le programme. Si vous souhaitez vous y connecter, vous devez suivre leurs normes d'interface.

2. Qu'est-ce que REST

Maintenant que j'apprends l'API, je vois souvent un mot appelé REST, et le nom anglais complet est Representational State Transfer. Alors, qu’est-ce que REST ? Le terme REST a été proposé par le Dr Roy Fielding, président de la Fondation Apache, et sa signification chinoise est « transformation de l'état de la couche de présentation ». Le chinois n'est pas facile à comprendre, mais si nous l'apprenons sous les aspects suivants, vous pourrez probablement comprendre ce qu'est le repos.

2.1. Qu'est-ce que la couche de présentation ?

La couche de présentation fait ici référence à la couche de présentation des ressources. La soi-disant « ressource » est une information spécifique sur le réseau. Un texte, un film et un service peuvent être considérés comme une ressource. Alors, que servent à identifier et à représenter ces ressources ? Ensuite, vous devez utiliser l'URI. Par exemple, lorsque nous téléchargeons un film, il doit y avoir une adresse URI correspondante. Lorsque nous lisons un roman en ligne, il existe également une adresse URI correspondante. Et cette adresse est unique et unique. La ressource est identifiée par un URI, ce que l'on peut comprendre puisque cette ressource a été « exprimée » sur le réseau. Ainsi, la signification de la couche de présentation est en réalité la forme sous laquelle les « ressources » sont concrètement présentées.

2.2. Qu'est-ce que la transition d'état ?

Au sens commun, si l'on veut changer l'état d'un objet, nous avons absolument besoin de quelques opérations et moyens. Il en va de même pour les ressources sur Internet. Lorsque vous téléchargez un film, vous devez d'abord le télécharger, puis vous pouvez l'ouvrir et en profiter. Les téléchargements et les acquisitions nécessitent le protocole HTTP. Dans le protocole HTTP, il existe quatre méthodes de fonctionnement de base : GET, POST, PUT et DELETE (obtenir, créer, mettre à jour, supprimer). Grâce à ces quatre méthodes de base, certaines opérations de transformation d'état peuvent être effectuées sur les ressources du réseau.

Donc, REST est la transformation d'état de la couche de présentation. Vous pouvez comprendre les deux points ci-dessus séparément, puis les combiner. Cela peut être compris simplement et grossièrement comme : méthode + ressource URI.

GET /movie/war/Pearl Harbor

DELETE /movie/war/Pearl Harbor

...

2. Types d'API Docker

L'API Docker suit également le style de repos, nous comprenons donc les deux points ci-dessus Enfin. , nous avons commencé à acquérir les connaissances pertinentes sur la propre API de Docker.

Tout d'abord, nous considérons Docker comme une ressource. Nous pouvons utiliser Docker via l'API, et les méthodes de fonctionnement sont également les mêmes que celles de http.

Deuxièmement, nous devons comprendre quelles API Docker possède et qui peuvent être utilisées en externe. Ici, Docker dispose officiellement de trois API externes majeures

• API Docker Registry
• API Docker Hub
• API Docker Remote

1. API

Il s'agit de l'API de l'entrepôt d'images Docker. En exploitant cet ensemble d'API, vous pouvez librement automatiser et gérer par programme votre entrepôt d'images.

2. API Docker Hub

L'API Docker Hub est une API pour les opérations de gestion des utilisateurs. Docker Hub utilise la vérification et les espaces de noms publics pour stocker les informations de compte, authentifier les comptes et effectuer l'autorisation de compte. L'API permet également des opérations sur les référentiels d'utilisateurs et les référentiels de bibliothèques associés.

3. API Docker Remote

Cette API est utilisée pour contrôler l'API du serveur Docker hôte, qui est équivalente au client de ligne de commande Docker. Avec lui, vous pouvez faire fonctionner à distance des conteneurs Docker et, plus important encore, vous pouvez exploiter et maintenir automatiquement les processus Docker via des programmes.

3. Préparation avant d'utiliser l'API

Comme nous l'avons dit précédemment, les méthodes de http sont utilisées pour faire fonctionner l'API rest. Alors, comment utiliser ces méthodes spécifiquement ? Nous proposons ici plusieurs façons courantes d'utiliser et d'appeler l'API Docker, puis d'en faire l'expérience. Avant d'en faire l'expérience, nous devons activer l'API Docker Rest, sinon vous ne pourrez pas l'utiliser si elle n'est pas activée. Méthode d'ouverture spécifique :

$ vim /usr/lib/systemd/system/docker.service

Add -H tcp://0.0.0.0:8088 -H unix:///var/run/docker.sock directement après ExecStart=/usr/bin/dockerd (notez que le port 8088 peut être défini par vous-même, faites ne suit pas le conflit actuel)

$ systemctl daemon-reload
$ systemctl restart docker

Une fois le redémarrage terminé, nous exécutons la commande curl 127.0.0.1:8088/info | python -mjson.tool pour afficher l'état du docker (sous forme json, python -mjson.tool emprunte cet outil, cela rend json formaté et plus facile à lire)

Après avoir activé l'API docker, nous avons encore une question, c'est-à-dire où pouvons-nous interroger l'API existante de docker ? Étant donné que Docker fournit les trois principales bibliothèques d'API : l'API Docker Registry, l'API Docker Hub et l'API Docker Remote. Alors, où puis-je afficher des API spécifiques et détaillées, telles que les adresses d'API disponibles sous l'API Docker Registry ? Existe-t-il une API pour interroger des images ? Certains ont-ils été supprimés ? En fait, tout cela est disponible. Nous pouvons le vérifier directement dans le manuel de l'API du site officiel. L'adresse est : https://docs.docker.com/engine/api/v1.38/ (Vous voulez voir quoi. version la dernière v1.38 peut être remplacée par le numéro de version cible)

Il convient de noter ici que le responsable ne recommande plus d'utiliser les versions antérieures à l'API v1.12, et il est recommandé d'utiliser la v1.24 ou les versions supérieures.

Pour vérifier la version de l'API docker locale, vous pouvez utiliser la commande docker version :

4. Comment faire fonctionner l'API docker

1 La méthode curl la plus simple

CURL Cette commande, je pense que tout le monde. le connaît, il est sous Linux par défaut. Tous sont livrés avec l'installation. De nombreuses méthodes de test http peuvent utiliser directement CURL.

Par exemple, si nous vérifions les détails de l'image de docker, nous pouvons directement utiliser curl pour la récupérer :

 $ curl -X GET http://127.0.0.1:8088/images/json

Cet affichage sera brouillon Nous pouvons ajouter python -mjson.tool après la commande pour le formater

.

$  curl -X GET http://127.0.0.1:8088/images/json | python -mjson.tool

Le format des résultats est plus standardisé et plus facile à lire.

Afficher tous les conteneurs :

$ curl -X GET http://127.0.0.1:8088/containers/json | python -mjson.tool

Créer un conteneur :

Ici, créez un conteneur pour la base de données mariadb, définissez le mot de passe sur 123456 et le port d'écoute est 3306

$ curl -X POST -H "Content-Type: application/json" -d '{
    "Image": "mariadb",
    "Env": ["MYSQL_ROOT_PASSWORD=123456"],
    "ExposedPorts": {
        "3306/tcp": {}
    },
    "HostConfig": {
        "PortBindings": {
            "3306/tcp": [{"HostIp": "","HostPort": "3306"}]
        }
    },
    "NetworkSettings": {
        "Ports": {
            "5000/tcp": [{"HostIp": "0.0.0.0","HostPort": "3306"}]
        }
    }
}' http://127.0.0.1:8088/containers/create

Démarrez/arrêtez/redémarrez un conteneur :

$ curl -X POST http://127.0.0.1:8088/containers/{id}/start   (注意这里是POST方法）
$ curl -X POST http://127.0.0.1:8088/containers/{id}/stop   (注意这里是POST方法）
$ curl -X POST http://127.0.0.1:8088/containers/{id}/restart   (注意这里是POST方法）
...

Il existe de nombreuses méthodes API en particulier. Vous pouvez vous connecter au lien mentionné ci-dessus pour voir

https://docs.docker.com/engine/api/v1.38

2. Python est très puissant, tout le monde le reconnaît. De nombreux scénarios d'automatisation utilisent désormais Python pour charger des bibliothèques tierces correspondantes, puis écrivent une logique métier pour automatiser le fonctionnement et la maintenance des développeurs. Docker fournit également une bibliothèque très puissante pour Python, appelée docker. Nous pouvons nous connecter à l'adresse officielle du SDK Python pour savoir comment Python exploite spécifiquement Docker.

L'adresse est :

https://docker-py.readthedocs.io/en/stable/

2.1 Installer la bibliothèque Docker Python

$ pip install docker

2.2 Commencer

import docker
client = docker.DockerClient(base_url='unix://var/run/docker.sock', version="auto")
client.containers.run("ubuntu", "echo hello world")

C'est un. très Nous pouvons analyser un exemple d'utilisation simple :

La première ligne indique l'introduction du docker de bibliothèque tierce.

La deuxième ligne est utilisée pour configurer les informations de base du serveur Docker, y compris base_url (l'adresse du serveur Docker) et la version (auto peut vérifier automatiquement la version de Docker).

La troisième ligne équivaut à exécuter une commande docker run ubuntu echo hello world.

2.3. Utilisation avancée

import docker
client = docker.DockerClient(base_url="tcp://ip:port")
client.images.list()       # 类似docker images命令，显示image的信息列表
client.containers.list()       #  类似docker ps命令
client.containers.list(all=True)       # 类似docker ps -a命令
container = client.containers.get(container_id)           # 获取daodocker容器，这里container_id 是你要输入的具体容器id
container.start()            # 类似docker start 传入具体的容器id ，开启容器

Résumé :

De nombreuses entreprises sont désormais entrées dans l'ère de l'exploitation et de la maintenance automatisées, il est donc indispensable de maîtriser les compétences et les règles d'utilisation des API. Ci-dessus, nous avons présenté grossièrement l'introduction de l'API Docker. En fait, vous devez être très bon dans ce domaine. Il y a ici beaucoup de flexibilité et de complexité, mais ici, vous avez besoin d'une certaine connaissance de la programmation de scripts. Apprentissage recommandé : "

Tutoriel vidéo Docker

"

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!