VS CodeからLXC / LXDコンテナーでPythonスクリプトを実行/デバッグする

こんにちは、Habr！

この記事では、 VS Codeエディターで数回クリックするだけで、Pythonスクリプトを開発し、隔離された環境で実行するための開発環境のセットアップを共有したいと思います。

隔離された環境として、Ubuntu 17.10 OSを実行するLXCベースのコンテナーの初期構成と作成が検討されます。 なぜDockerではありませんか？ いくつかの議論をすることは、答えるのが難しいです。 部分的に、OS仮想化の概念はプロセス仮想化よりも精神的に主観的に近いですが、ここで説明する原則は、修正を加えて、Dockerコンテナーでコードを実行するのに適しています。

あなたは何を得ますか？

• コンテナ内でワンクリックでPythonスクリプトを実行する方法と、VS Codeからのリモートデバッグを学ぶ
• LXDをインストールし、ネットワークを構成し、最初のコンテナーを開始する方法を学ぶ
• VS Codeソースコードエディターのインストールと構成を確認してください。VSCodeソースコードエディターは、快適にコードを記述してデバッグできる拡張機能のセットです。

ここにないものは何ですか？

• LXC / LXDの完全なレビューはありません。Linuxコンテナに関する追加情報を自分で見つける必要があります。
• 開発者のホストで仮想環境を作成するためのpython virtualenvモジュールは、コンテナーの代替とは見なされません。
• DockerとLXDの精神の比較はありません。経験に基づいて自分で結論を導きます。

内容：

• バックエンドリポジトリの選択
• LXDパッケージをインストールする
• LXDを初期化する
• LXCネットワーク構成
• コンテナー構成プロファイルの作成
• コンテナ作成
• コンテナにソフトウェアをインストールする
• VSコードと拡張機能をインストールする
• VSコードを構成する
• ディレクトリリンクホスト<->コンテナ
• コンテナでスクリプトを実行するためのVSコードの構成
• VSコードでのリモートデバッグ
• 外部Pythonライブラリ用のIntelliSense

バックエンドリポジトリの選択

LXDをインストールする前に、使用するコンテナのバックエンドストレージのタイプを決定する必要があります。 後で変更することはできません。 いくつかのオプションが利用可能です：ZFS、btrfs、LVM、またはホストファイルシステム。 比較のために、公式ドキュメントに比較表があります。 将来、コンテナのCOW （コピーオンライト）スナップショットを簡単に作成できるZFSを選択することをお勧めします。 ZFSユーティリティパッケージをシステムにインストールします。

$ sudo apt install zfsutils-linux 

LXDパッケージをインストールする

問題はありません。パッケージはシステムの標準配信に含まれているため、コンソールでコマンドを実行します。

 $ sudo apt install lxd 

LXDをインストールすると、現在のユーザーがlxdシステムグループに追加されますが、システムで必要な特権を使用して構成を続行するには、ユーザーセッションを再アクティブ化する必要があります 。 ログアウトしてDesktop Menegerのセッションを再入力するか、完全に再起動してください。 idコマンドを使用して、現在のユーザーセッションがlxdグループにあるかどうかを確認できます。

 $ id uid=1000(user1) gid=1000(user1) groups=1000(user1),4(adm),24(cdrom),27(sudo),30(dip),46(plugdev),118(lpadmin),128(sambashare),129(lxd) 

lxdグループが表示されていれば、すべて問題ありません。続行できます。

LXDを初期化する

LXDの初期化は、 lxdグループのメンバーである現在のユーザーに代わってインタラクティブに実行されます。 コマンドを実行し、以下の指示とコメントに従ってください：

 $ lxd init #   ,       ?     ZFS! #    <yes>,  <ENTER> Do you want to configure a new storage pool (yes/no) [default=yes]? #         <ENTER> Name of the new storage pool [default=default]: lxdpool #       ,  ZFS Name of the storage backend to use (dir, lvm, zfs) [default=zfs]: zfs #   ZFS ? ..    lxdpool  ZFS . #    <ENTER> Create a new ZFS pool (yes/no) [default=yes]? #  ,       ? # ,           dd #         . #     <no>,  <ENTER> Would you like to use an existing block device (yes/no) [default=no]? #    loop- (zfs pool)? #    GB,  1GB Size in GB of the new loop device (1GB minimum) [default=15GB]: 5 #   LXD   ? #   LXD   ,      -   unix  /var/lib/lxd/unix.socket #  <no>,  <ENTER>: Would you like LXD to be available over the network (yes/no) [default=no]? #        ? Would you like stale cached images to be updated automatically (yes/no) [default=yes]? no #     ?  <no>,       Would you like to create a new network bridge (yes/no) [default=yes]? no # LXD has been successfully configured. 

LXCネットワーク構成

ここでネットワークを設定せず、コンテナの作成に進むと、コンテナが作成されると、コンテナがどのネットワークにも接続されていないという警告が表示されます。 これはエラーではなく、単にインターフェイスを介したネットワークアクセスがありません。 最初に、必要な数のコンテナを作成し、 lxc network attachコマンドを使用してネットワークを構成し、コンテナをコンテナに接続できます。 次に、構築するネットワークのタイプを決定する必要があります。 LXCネットワークの構築にはいくつかのオプションがありますが、 ブリッジオプション（ホストとコンテナ間の単純なソフトウェアスイッチ）を選択し、それに基づいてネットワークを構築します。

ネットワークブリッジを作成する場合、名前を指定した後すぐにプロパティを設定するか、IPv4およびIPv6サブネットをランダムに選択する自動構成に依存できます。 デフォルトでは、パラメーターはipv4.nat = falseであり、何らかの理由で、コンテナーからの通過トラフィックのパケットは、ホストカーネルでIP転送を明示的に有効にしても、ホストを越えて他のローカルネットワークセグメントにルーティングされません。 どうやらLXDのNATは、ローカルネットワークセグメントからグローバルへのアドレスのトランスレーター以上のものです。このオプションをアクティブにすると、ホストのIP転送もアクティブになるため、明示的に有効にします。

 $ lxc network create lxdbr0 ipv6.address=none ipv4.address=10.0.3.1/24 ipv4.nat=true Network lxdbr0 created $ lxc network list +--------+----------+---------+-------------+---------+ | NAME | TYPE | MANAGED | DESCRIPTION | USED BY | +--------+----------+---------+-------------+---------+ | ens33 | physical | NO | | 0 | +--------+----------+---------+-------------+---------+ | lxdbr0 | bridge | YES | | 0 | +--------+----------+---------+-------------+---------+ 

コンテナー構成プロファイルの作成

コンテナの構成は、条件付きでグローバルとローカルの2つのレベルに分けられます。 グローバル構成は、特定のコンテナーまたはコンテナーのグループに接続されている構成プロファイルで指定され、ローカル構成は特定のコンテナーにのみ適用されます。 つまり、プロファイル内のすべての設定がコンテナに継承され、ローカル設定がプロファイルよりも優先されます。 1つのコンテナに複数のプロファイルを添付できます。

LXDプロファイルを作成して、新しく作成されたコンテナがホスト上のlxdbr0スイッチ（ネットワークブリッジ）にリンクされるタイプnicのインターフェースを持つようにします。

 $ lxc profile copy default network0 $ lxc profile device add network0 eth0 nic parent=lxdbr0 nictype=bridged 

コンテナ作成

たとえば、コンテナを作成してpytestと呼ぶと、この名前でホストからアクセスできます。 ubuntuリポジトリからイメージをダウンロードする起動コマンドを実行します：バージョン17.10およびamd64アーキテクチャと、このイメージからコンテナーを作成します。 さらに、オプションは、このコンテナーをnetwork0プロファイルから構成する必要があることを示します。

 $ lxc launch ubuntu:17.10/amd64 --profile network0 pytest 

次に、ネットワークからイメージをダウンロードします。 少し待って、少し後でシステムで使用可能なコンテナとそのステータスを確認できます。

 $ lxc list +--------+---------+------------------+------+------------+-----------+ | NAME | STATE | IPV4 | IPV6 | TYPE | SNAPSHOTS | +--------+---------+------------------+------+------------+-----------+ | pytest | RUNNING | 10.0.3.13 (eth0) | | PERSISTENT | 0 | +--------+---------+------------------+------+------------+-----------+ 

コンテナにソフトウェアをインストールする

ここで、必要なソフトウェアをコンテナにインストールします。 システムを更新するコンテナ内でパッケージマネージャを実行します。

 $ lxc exec pytest -- /bin/bash -c 'apt update && apt upgrade -y' 

次に、 pipパッケージマネージャー（Pythonパッケージインストーラー）とptvsd pythonモジュール（Python用Visual Studioリモートデバッグサーバー）をインストールします。 ptvsdモジュールは必ずバージョン3.0.0にインストールする必要があります。最新バージョン（現在の3.2.1.0）では、github.comの問題に示されているエラーを受け取りました。 一時的なソリューションとしてptvsdと対話するVS CodeのPython拡張の作成者は、バージョン3.0.0の使用を推奨しています。

 $ lxc exec pytest -- /bin/bash -c 'apt install python3-pip -y' $ lxc exec pytest -- /bin/bash -c 'pip3 install ptvsd==3.0.0' 

LXDに関しては、セットアップが完了しました。

VSコードと拡張機能をインストールする

アプリケーションのインストールオプションは、公式ページのcode.visualstudio.com/docs/setup/linuxで説明されていますが、コマンドを少し変更します。

 $ cd ~ $ wget -c https://packages.microsoft.com/keys/microsoft.asc $ cat microsoft.asc | gpg --dearmor > microsoft.gpg $ sudo mv microsoft.gpg /etc/apt/trusted.gpg.d/microsoft.gpg $ sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/repos/vscode stable main" > /etc/apt/sources.list.d/vscode.list' $ sudo apt update $ sudo apt install code 

実行後、Microsoftリポジトリの最新バージョンのVSコードがシステムに表示されます。

PS執筆の時点で、新しいバージョン1.18.0がリリースされました。私の意見では、最も期待されている（2年）コミュニティ機能のいくつかは、「マルチルートワークスペース」と「エクスプローラーのGitインジケーター」が安定したアセンブリに含まれていました。すべての変更について読むことができますこのページ 。

拡張機能のインストールに進みます。 たとえば、 Atomを （作成者として）使用した後にVS Codeを初めてインストールする場合は、以下のリストの拡張機能に注意することをお勧めします。この記事の目的を達成するには、PythonとCode Runnerのみをインストールするだけで十分です。 拡張機能は、エディターの左側のマーケットプレイスからインストールされます。

• CSSクラス名のIntelliSense
• Python
• ジンジャ
• Djangoテンプレート
• ファイルアイコン
• ワンダークプロ
• 微妙なマッチ括弧
• 藤堂ハイライト
• コードランナー

VSコードを構成する

以下の設定はオプションであり、コンテナでのPythonスクリプトの実行に直接関係しませんが、Atomのように視覚的にしたい場合は、これにより近づきます。

開いているエディターで、エディターの設定を開きます：ファイル->設定->設定。 右側のUSER_SETTINGSで開くウィンドウで、次の変更を加えて保存します（Ctrl + S）：

 { //   "telemetry.enableTelemetry": false, "editor.fontFamily": "Menlo, Consolas, 'DejaVu Sans Mono', monospace", "editor.lineHeight": 21, "editor.minimap.enabled": true, "editor.minimap.showSlider": "always", "editor.minimap.renderCharacters": false, "files.insertFinalNewline": true, "files.trimFinalNewlines": true, "explorer.openEditors.visible": 0, //   : "terminal.integrated.lineHeight": 1.25, "terminal.integrated.scrollback": 2000, //  : "workbench.iconTheme": "file-icons", "workbench.colorTheme": "One Dark Pro", "workbench.colorCustomizations": { // https://code.visualstudio.com/docs/getstarted/theme-color-reference "editor.lineHighlightBackground": "#2C323C" }, //    "editor.matchBrackets": false, "subtleBrackets.styles": { "global": { "color": "#61afef", "borderColor": "#61afef", "borderWidth": "1px", "borderStyle": "none none solid none" } }, // Python "python.pythonPath": "python3", //  -: "code-runner.executorMap": { "python": "python3 $fileName" } } 

ディレクトリリンクホスト<->コンテナ

私たちはすでに素晴らしい仕事をしており、最終段階に来ています。 これで、コンテナでスクリプトを実行する準備がほぼすべて整いました。

/ home / user1 / projectsなどに プロジェクトディレクトリを作成します。 将来のPythonプロジェクトをホストします。 このディレクトリをコンテナにリンクします。つまり、コンテナ内でディスクデバイスを作成し、このディレクトリをinternal / mnt / hostfsに関連付けます。 次のコマンドを実行します。

 $ mkdir ~/projects $ lxc config device add pytest hostfs disk path=/mnt/hostfs source=/home/user1/projects/ 

/ home / user1 / projectsディレクトリにディレクトリまたはファイルをローカルで作成すると、アドレス/ mnt / hostfsのコンテナにすぐに反映されます。 これを確認するには、コンテナでBASHシェルをインタラクティブに実行し、lsコマンドを発行します。

 $ lxc exec pytest -- /bin/bash $ ls -l /mnt/hostfs/ 

コンテナ内のファイルとディレクトリが読み取り専用になり、 nobody：nogroupに等しいUID：GIDを持つことがわかります。 スクリプトを実行するにはこれで十分ですが、コンテナ内のファイルとディレクトリを書き込み可能にする必要がある場合は、 この記事の 「 ユーザー/グループの直接マッピング 」の章をお読みください 。

コンテナでスクリプトを実行するためのVSコードの構成

そのため、エディターを閉じてから再度開くことができるようになりました。 メニューファイル->新規ファイルをクリックします 。 新しいタブが作成され、次のpython-codeを作成する必要があります。このコードはコンテナで実行します。 ディレクトリ/ home / user1 / projects / pytest / test.pyに保存してから、ファイル（タブ）を閉じることができます。

 import os #### BEGIN. Visual Studio remote debugging server for Python # import ptvsd # print('Waiting connection on port 3000') # ptvsd.enable_attach('my_secret', address=('0.0.0.0', 3000)) # ptvsd.wait_for_attach() # ptvsd.break_into_debugger() #### END. Visual Studio remote debugging server for Python with open('/etc/lsb-release') as f: lsb_release = f.readlines() info = { 'HOSTNAME': os.uname().nodename, 'DISTRIB': lsb_release[3][21:-2], 'USER': os.environ['USER'], 'LOGNAME': os.environ['LOGNAME'], 'HOME': os.environ['HOME'], 'PWD': os.environ['PWD'] } print(info) 

VS Codeは、pylintモジュールがインストールされていないことを「言います」が、今は必要ありません。pipモジュールマネージャーを使用して、後で自分でインストールできます。 次に、VS Codeでワークスペースを開く必要があります。そのためには、 ファイルエクスプローラーの左側で、 [ フォルダーを開く ]ボタンをクリックし、ディレクトリ/ home / user1 / projects / pytest /を選択します。



VS Codeが再初期化され、すべてのウィンドウが完全に閉じられ、test.pyファイルが表示されるワークスペースが開きます。 File Explorer VS Codeの左側の名前をダブルクリックして開きます。
[ファイル]-> [設定]-> [設定]メニューをクリックしてワークスペースの設定を呼び出し、右上のウィンドウでUSER_SETTINGSの代わりにドロップダウンリストからWORKSPACE_SETTINGSを選択します。



次の設定を作成して保存し、次のようにします。

 { "code-runner.executorMap": { //     root: // "python": "lxc exec pytest -- /bin/bash -c 'cd /mnt/hostfs/pytest && python3 $fileName'" //        ubuntu: "python": "lxc exec pytest -- /bin/bash -c 'su -l ubuntu -c \"cd /mnt/hostfs/pytest && python3 $fileName\"'" }, "code-runner.runInTerminal": true } 

ファイルエクスプローラーでは、 .vscodeディレクトリにsettings.jsonファイルがあり、（現在のプロジェクトの） ワークスペース設定がそこに保存されます。
開いているtest.pyファイルに戻り、[ コードの実行 ]コンテキストメニューからコマンドを実行します。



統合ターミナルの出力には、リモートマシン（コンテナ）でコードが実行されたことを確認できる情報が表示されます。 コンテナでプロジェクトを実行する必要があるときはいつでも、WORKSPACE_SETTINGSで設定を行うか、各プロジェクトの.vscode / settings.jsonファイルを作成してから、設定のパスを少し調整します。

VSコードでのリモートデバッグ

test.pyファイルの行のコメントを解除して、このファイルを保存します。

 #### BEGIN. Visual Studio remote debugging server for Python import ptvsd print('Waiting connection on port 3000') ptvsd.enable_attach('my_secret', address=('0.0.0.0', 3000)) ptvsd.wait_for_attach() ptvsd.break_into_debugger() #### END. Visual Studio remote debugging server for Python 

リモートデバッグが必要な場合は、これらのコード行を、実行のために起動されるファイルに挿入する必要があります。 コンテナ側のptvsdモジュールはポート3000を開き、外部デバッガーが接続することを想定しています。 必要に応じて、独自の方法でptvsdを構成できます。

[コードの実行]コンテキストメニューを呼び出してコードを実行します。 統合端末では、スクリプトがポート3000での接続を待機しているというメッセージが表示されます。デバッガーに移動して、このプロジェクトの新しい構成を作成します。



launch.jsonファイルを編集用に開き、既にプリセットがあります。 次のコードブロックを貼り付けます。

  { "name": "Python LXC", "type": "python", "request": "attach", "localRoot": "${workspaceRoot}", "remoteRoot": "/mnt/hostfs/pytest", "host": "pytest", "port": 3000, "secret": "my_secret" } 

保存すると、 setting.jsonファイルの横の.vscode / launch.jsonディレクトリに表示されます。 次に、左側の[ Python LXC]ドロップダウンリストを選択します。これは先ほど作成したデバッガー構成です。



[デバッグの開始]をクリックします。 ファイルtest.pyのあるウィンドウに、動作中のデバッガーと、コードがリモートで開始されたことの確認が表示されます。



それだけです セットアップが完了しました。 新しいpythonプロジェクトに将来必要なのは、2つの.vscode / settings.jsonおよび.vscode / launche.json構成ファイルを構成することです 。 トピックについて質問がある場合は、コメントでお尋ねください。 あなたの注意、成功したプロジェクトに感謝​​します！

11/10/2017 21:35 MSKからのUPD。
コメントでは、ユーザーSirEdvinは、コンテナにのみインストールされているpythonモジュールのエディターでの自動補完（またはMicrosoftの用語ではIntelliSense）の可能性について尋ねました。つまり、これらのモジュールはVS Codeが実行されているローカルマシン上にありません。
この点は記事では見逃していたので、小さな章で補足します。

外部Pythonライブラリの自動補完セットアップ（IntelliSense）

たとえば、プロジェクトでは、Pythonのデフォルトボックスで提供されていないモジュールを使用し、このモジュールをコンテナにのみインストールしました。 ホストにモジュールをインストールせずにエディターでVS Codeを「理解」、オートコンプリート、プロンプト表示するが、コンテナーのモジュールから取得する方法は？
この問題を解決するには、 YOUR_path_to_project / .vscode / settings.jsonでWORKSPACE_SETTINGS設定を開き 、 python.autoComplete.extraPathsパラメーターを追加し、Pythonモジュールを含むコンテナーディレクトリのリストをキーとして指定します。

たとえば、コンテナは/ var / lib / lxd / containers / pytest / rootfs /のホストファイルシステムで利用できます 。 これは、 pytestコンテナのルートファイルシステムです。 Pythonが外部ライブラリをインストールする場所がわかっているので、このパスを簡単に追加して、外部ライブラリへのフルパスを取得できます。 numpyなどのモジュールの場合、フルパスは/var/lib/lxd/containers/pytest/rootfs/usr/local/lib/python3.6/dist-packagesになります。 このように、このパスをpython.autoComplete.extraPaths設定に追加します。



設定を保存して、プロジェクトに戻ります。 numpyモジュールをインポートして、CTRL +スペースキーで自動補完を呼び出してください。 画面のようにできるはずです：



すぐに動作しない場合は、落胆しないでください。VSCodeは結果をキャッシュし、すぐに動作しない場合があります。エディターを閉じて開き、from ... importキーワードの後に​​CTRL + SPACEキーを押してみてください。

それだけです:)