Portainer on ポンコツ地方エンジニアの技術ブログ

Portainer API を使って Docker Engine API を叩いてみる

Mon, 27 Jun 2022 00:00:00 +0900

Docker を WebUI で操作できる Portainer には API が用意されており、これを使えば Portainer の UI でできることを全て自動化できます。また、Portainer API を介して Docker Engine API も叩くことができるので試してみました。

Portainer の API のドキュメントは以下です。

https://docs.portainer.io/api/docs

Docker Engine API のドキュメントは以下です。

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

Python + aiohttp で実装してみました。

環境

Docker 20.10.12
Portainer 2.13.1
Python 3.8.10
aiohttp 3.8.1

サンプルコード

細かい解説は後にして、先にコード全体を載せます。

import asyncio
import aiohttp

PORTAINER_URL="http://portainer_url"

async def main():
 async with aiohttp.ClientSession() as session:

 # トークンを取得
 r = await session.post(f'{PORTAINER_URL}/api/auth', json={ 'Username': 'Admin', 'Password': 'AdminPassword' })
 data = await r.json()
 jwt = data['jwt']
 
 # ヘッダー
 headers={ 'Authorization': f'Bearer {jwt}' }
 #headers={ 'X-API-Key': 'token' }

 # EnvironmentID を取得
 r = await session.get(f'{PORTAINER_URL}/api/endpoint_groups', headers=headers)
 environments = await r.json()
 id = environments[0]['Id']

 # コンテナ一覧の取得
 r = await session.get(f'{PORTAINER_URL}/api/endpoints/{id}/docker/containers/json', json={ 'all': 'true' }, headers=headers)
 containers = await r.json()
 print(containers)

if __name__ == '__main__':
 asyncio.run(main())

トークンの取得

Portainer のアカウントを使って JWT トークンを取得します。

r = await session.post(f'{PORTAINER_URL}/api/auth', json={ 'Username': 'Admin', 'Password': 'AdminPassword' })
data = await r.json()
jwt = data['jwt']

このトークンは8時間の間だけ有効だそうです。
または、Portainer の myaccount 画面からでも API トークンを発行できます。
それぞれヘッダーの書き方が少し異なります。

前者の場合は

headers={ 'Authorization': f'Bearer {jwt}' }

後者の場合は

headers={ 'X-API-Key': 'token' }

のように記述します。

Environment(endpoint) ID の取得

Portainer は複数の Docker ホストを管理できるので、Docker Engine API を叩く際にはどのホストの Docker に対する操作かを指定する必要があります。　　　　なので、Docker Engine API を叩く前に Environment の一覧を取得します。

https://app.swaggerhub.com/apis/portainer/portainer-ce/2.13.1#/endpoint_groups/EndpointGroupList

r = await session.get(f'{PORTAINER_URL}/api/endpoint_groups', headers=headers)
environments = await r.json()
id = environments[0]['Id']

コンテナの一覧を取得

コンテナの一覧を取得してみます。
API の仕様は以下を参照してください。

https://docs.docker.com/engine/api/v1.41/#tag/Container

Portainer のエンドポイント /api/endpoints/{id}/docker より後ろが docker のエンドポイントと同じになるみたいですね。

r = await session.get(f'{PORTAINER_URL}/api/endpoints/{id}/docker/containers/json', json={ 'all': 'true' }, headers=headers)
containers = await r.json()

ここまでやれば、後は大体のことができるんじゃないかと思います。

参考 URL

Portainer を Docker Swarm で動かす

Fri, 27 May 2022 00:00:00 +0900

以前 Portainer を docker-compose で動かしました。

https://kuttsun.blogspot.com/2022/04/portainer-docker-compose.html

今回はこの Portainer を Docker Swarm が有効になっている環境で動かしてみます。
クラスタを構成している全ノードが Portainer で管理できるようになります。

環境

Docker 20.10.12
Portainer 2.13.1

Docker Swarm の有効化

以下のコマンドを実行します。

$ docker swarm init

ちょっと試すだけならばここまでで OK です。
必要なら worker ノードの追加なども行ってください。

Portainer の起動

公式ドキュメントが以下になります。

https://docs.portainer.io/v/ce-2.9/start/install/agent/swarm/linux

こちらに yml ファイルの置き場所が記載されているので、Community Edition のほうのファイルをダウンロードします。

$ curl -L https://downloads.portainer.io/ce2-13/portainer-agent-stack.yml -o portainer-agent-stack.yml

中身はこんな感じです。

version: '3.2'

services:
 agent:
 image: portainer/agent:2.13.1
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
 - /var/lib/docker/volumes:/var/lib/docker/volumes
 networks:
 - agent_network
 deploy:
 mode: global
 placement:
 constraints: [node.platform.os == linux]

 portainer:
 image: portainer/portainer-ce:2.13.1
 command: -H tcp://tasks.agent:9001 --tlsskipverify
 ports:
 - "9443:9443"
 - "9000:9000"
 - "8000:8000"
 volumes:
 - portainer_data:/data
 networks:
 - agent_network
 deploy:
 mode: replicated
 replicas: 1
 placement:
 constraints: [node.role == manager]

networks:
 agent_network:
 driver: overlay
 attachable: true

volumes:
 portainer_data:

これを docker stack deploy で起動します。

$ docker stack deploy -c portainer-agent-stack.yml portainer
Creating network portainer_agent_network
Creating service portainer_agent
Creating service portainer_portainer

以上で完了です。
あとは http://localhost:9000 にアクセスすれば OK です。

起動した portainer を停止・削除したい場合は以下のコマンドを実行します。

$ docker stack rm portainer

参考 URL

Portainer を docker-compose で動かす

Tue, 19 Apr 2022 00:00:00 +0900

Docker の GUI 管理ツールである Portainer を docker-compose で動かしてみました。

環境

Docker 20.10.7
portainer-ce 2.11

docker-compose.yml

Docker での動かし方は公式ドキュメントに記載されています。

https://docs.portainer.io/v/ce-2.11/start/install/server/docker/linux

これを docker-compose に落とし込んだのが以下です。

version: '3'
services:
 portainer:
 image: portainer/portainer-ce
 container_name: portainer
 restart: unless-stopped
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
 - portainer_data:/data
 ports:
 - 8000:8000
 - 9000:9000
 - 9443:9443
volumes:
 portainer_data:

通常 HTTPS で 9443 番ポートでアクセスしますが、HTTP でアクセスしたい場合は 9000 番ポートを使用します。
8000 番ポートは Edge コンピュート機能を使用する場合にのみ必要とありますが、使っていないので詳細はわかりません。それ以外には特筆すべき点はないかと思います。

これで http://localhost:9000 にアクセスすれば画面が表示されます。

Portainer Agent を追加する

以上で Portainer が使えるようになったのですが、Docker Volume の中が閲覧出来ませんでした。
これを有効化するには、Docker Swarm または Portainer Agent を追加する必要があるようです。

https://docs.portainer.io/user/docker/volumes/browse

Docker Swarm はまた別記事にするとして、ここでは Portainer Agent を追加します。
やり方については以下の記事が参考になりました。

https://stackoverflow.com/questions/64735377/install-portainer-portainer-agent-using-docker-compose

version: '3.2'
services:
 agent:
 image: portainer/agent
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
 - /var/lib/docker/volumes:/var/lib/docker/volumes
 portainer:
 image: portainer/portainer-ce
 command: -H tcp://agent:9001 --tlsskipverify
 ports:
 - "9000:9000"
 volumes:
 - portainer_data:/data
volumes:
 portainer_data:

これで Docker Volume の中を閲覧できるようになりました。

Docker Swarm での動かし方は別記事に書きました。

https://kuttsun.blogspot.com/2022/05/portainer-docker-swarm.html