日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

NetApp Astra Control Python SDK

寄稿者

NetApp Astra Control Python SDK は、 Astra Control の導入を自動化するために使用できるオープンソースパッケージです。また、このパッケージは、独自の自動化プラットフォームを作成する際に、おそらく Astra Control REST API について学ぶ際の貴重な資料となります。

注記 簡単にするために、このページの以降の部分では、 NetApp Astra Control Python SDK を * SDK と呼びます。

関連する 2 つのソフトウェアツール

SDK には、 Astra Control REST API にアクセスするときに異なる抽象化レベルで動作する 2 つの異なる関連ツールが含まれています。

Astra SDK

Astra SDK は、コアプラットフォーム機能を提供します。基盤となる REST API 呼び出しを抽象化する一連の Python クラスが含まれています。このクラスは、アプリケーション、バックアップ、 Snapshot 、クラスタなど、さまざまな Astra Control リソースに対する管理操作をサポートしています。

Astra SDKは、パッケージの一部であり、1つにまとめられています astraSDK.py ファイル。このファイルを環境にインポートし、クラスを直接使用できます。

注記 NetApp Astra Control Python SDK * (または SDK のみ)は、パッケージ全体の名前です。*Astra SDK*は、1つのファイル内の主要なPythonクラスを指します astraSDK.py
Toolkit スクリプト

Astra SDKファイルに加えて、を使用します toolkit.py スクリプトも使用できます。このスクリプトは、 Python 関数として内部的に定義されている個別の管理アクションにアクセスできるようにすることで、抽象化のレベルを高めて動作します。このスクリプトは、 Astra SDK をインポートし、必要に応じてクラスに呼び出します。

にアクセスする方法

SDK には、次の方法でアクセスできます。

Python パッケージ

SDK は、から入手できます "Python パッケージインデックス" 名前* actoolkit *。パッケージにはバージョン番号が割り当てられており、必要に応じて更新が続行されます。パッケージを環境にインストールするには、 * PIP * パッケージ管理ユーティリティを使用する必要があります。

インストールが完了したら、を配置することでastraSDK.pyクラスを利用できます import astraSDK スクリプト内で実行できます。さらに、 actoolkit コマンドプロンプトから直接呼び出すことができます。はと同じです toolkit.py (actoolkit list clusters はと同じです ./toolkit.py list clusters)。

を参照してください "PyPi : NetApp Astra Control Python SDK" を参照してください。

GitHub ソースコード

SDK ソースコードは GitHub からも入手できます。リポジトリには次のものが含まれます。

  • astraSDK.py (Pythonクラスを使用したAstra SDK)

  • toolkit.py (上位レベルの関数ベースのスクリプト)

  • インストール要件と手順の詳細

  • インストールスクリプト

  • その他のドキュメント

のクローンを作成できます "GitHub : NetApp / NetApp-Astra - ツールキット" ローカル環境へのリポジトリ。

インストールと基本的な要件

パッケージのインストールおよび使用準備の一環として、いくつかのオプションと要件を考慮する必要があります。

インストールオプションの概要

次のいずれかの方法で SDK をインストールできます。

  • 準備したを使用します "Docker:Astra -ツールキット" イメージ。必要な依存関係がすべてインストールされています actoolkit

  • Pipを使用してをインストールします actoolkit PyPIからPython環境へのパッケージ化

  • GitHubリポジトリのクローンを作成し、Pythonクライアントコードからアクセスできるように、2つのコアPythonファイルをコピー/変更します

詳細については、 PyPi および GitHub のページを参照してください。

Astra Control 環境の要件

Astra SDKのPythonクラスを直接使用する場合も、の関数を使用する場合もあります toolkit.py スクリプトを使用すると、最終的には、Astra Control環境でREST APIにアクセスすることになります。そのため、 API トークンを持つ Astra アカウントが必要になります。を参照してください "作業を開始する前に" 詳細については、このドキュメントの「 * はじめに * 」セクションの他のページを参照してください。

NetApp Astra Control Python SDK の要件

SDK には、ローカル Python 環境に関連するいくつかの前提条件があります。たとえば、Python 3.8以降を使用する必要があります。また、必要な Python パッケージもいくつかあります。詳細については、 GitHub リポジトリページまたは PyPI パッケージページを参照してください。

役立つリソースの概要