gsutil をインストールする

このページでは、コマンドラインから Cloud Storage にアクセスできるツール gsutil のインストールと設定について説明します。

gsutil をインストールすると、一般公開データへの読み取り / 書き込みアクセス権がすぐに付与されます。Cloud Storage サービスに対して認証すると、共有している保護下のデータへの読み取り / 書き込みアクセス権が付与されます。課金を有効にすると、自分のバケットを作成、管理できます。

システム要件

• gsutil ツールは、Linux/Unix、Mac OS、Windows（XP 以降）で動作します。

• 複合オブジェクトを使用する場合は、コンパイル済みの crcmod をインストールする必要があります。これは、Windows では 32 ビット版 Python でのみ利用可能です。

警告: 一部の Linux ディストリビューションには、GrandStream BudgeTone の gsutil という名前の別のツールがプリインストールされています。Cloud Storage の gsutil のではなくこのコマンドを実行すると、"Choose one of -b, -d, -e, or -r to do something" のようなエラー メッセージが出力される可能性があります。その場合、gsutil の Cloud Storage バージョンを PATH 環境変数の前に移動するか、Cloud Storage gsutil の実行時にフルパス（例: /home/users/joan/gsutil/gsutil ls）を指定できます。

gsutil のインストール

注: 以前に Google Cloud SDK をインストールした場合や、Google Compute Engine のインスタンスを使用している場合は、すでに gsutil がインストールされています。

gsutil のインストールと更新については、Google Cloud SDK の一部として行う場合に公式なサポートの対象となります。

Google Cloud SDK の一部としての gsutil のインストール

Google Cloud SDK の一部としてインストールするには、オペレーティング システムで次の操作を行います。

Linux

1. コマンド プロンプトで次のコマンドを入力します。

   curl https://sdk.cloud.google.com | bash

2. shell を再起動します。

   exec -l $SHELL

3. gcloud init を実行して gcloud 環境を初期化します。

   gcloud init

Debian/Ubuntu

Debian システムと Ubuntu システムにインストールする場合、Cloud SDK はパッケージ形式で利用できます。このパッケージに含まれているのは、gcloud、gcloud alpha、gcloud beta、gsutil、bq の各コマンドのみです。kubectl や、gcloud コマンドでアプリケーションをデプロイするために必要な App Engine 拡張機能は含まれていません。これらのコンポーネントが必要な場合は、個別にインストールする必要があります。詳細については、このセクションの後半をご覧ください。

サポート期間対象内の公式のすべての Ubuntu のリリースや、Wheezy 以降の Debian の安定版リリースの場合、Debian や Ubuntu パッケージから Cloud SDK をインストールできます。

注: Google Compute Engine のインスタンスを使用している場合、Cloud SDK がデフォルトでインストールされています。次のように、Cloud SDK を手動でインストールすることもできます。

1. Cloud SDK の配布 URI をパッケージ ソースとして追加します。

   echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list

   注: apt-transport-https がインストールされていることを確認してください。

   sudo apt-get install apt-transport-https ca-certificates gnupg

   トラブルシューティングのヒント: 使用しているディストリビューションで signed-by オプションがサポートされていない場合は、次のコマンドを代わりに実行してください。

   echo "deb https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
   トラブルシューティングのヒント: cloud-sdk リポジトリのエントリが重複していないことを確認してください。
2. Google Cloud の公開鍵をインポートします。

   curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add -

   トラブルシューティングのヒント: 鍵が期限切れで最新バージョンを取得できない場合は、最新の apt-get.gpg キーファイルを取得します。
   トラブルシューティングのヒント: 使用しているディストリビューションの apt-key コマンドで --keyring 引数がサポートされていない場合は、次のコマンドを代わりに実行してください。

   curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -
3. Cloud SDK を更新してインストールします。

   sudo apt-get update && sudo apt-get install google-cloud-sdk

   注: プロンプトの無効化やドライランなどの、追加の apt-get オプションについては、apt-get のマニュアル ページをご覧ください。
4. 必要に応じて、次の追加コンポーネントをインストールします。
   • google-cloud-sdk-app-engine-python
   • google-cloud-sdk-app-engine-python-extras
   • google-cloud-sdk-app-engine-java
   • google-cloud-sdk-app-engine-go
   • google-cloud-sdk-bigtable-emulator
   • google-cloud-sdk-cbt
   • google-cloud-sdk-cloud-build-local
   • google-cloud-sdk-datalab
   • google-cloud-sdk-datastore-emulator
   • google-cloud-sdk-firestore-emulator
   • google-cloud-sdk-pubsub-emulator
   • kubectl

   たとえば、google-cloud-sdk-app-engine-java コンポーネントは次のようにインストールできます。

   sudo apt-get install google-cloud-sdk-app-engine-java

5. gcloud init を実行して開始します。

   gcloud init

macOS

1. コマンド プロンプトで次のコマンドを入力します。

   curl https://sdk.cloud.google.com | bash

2. shell を再起動します。

   exec -l $SHELL

3. gcloud init を実行して gcloud 環境を初期化します。

   gcloud init

Windows

1. Cloud SDK のインストーラをダウンロードします。

   または、PowerShell ターミナルを開き、以下の PowerShell コマンドを実行します。

   (New-Object Net.WebClient).DownloadFile("https://dl.google.com/dl/cloudsdk/channels/rapid/GoogleCloudSDKInstaller.exe", "$env:Temp\GoogleCloudSDKInstaller.exe")
   
   & $env:Temp\GoogleCloudSDKInstaller.exe
         

2. インストーラを起動して、画面の指示に沿って操作します。インストーラには Google LLC による署名が付いています。

   Cloud SDK には Python が必要です。サポートされているバージョンは 3.5～3.7、2.7.9 以降です。

   インストーラにより、必要な Python バージョンを含むすべての必須依存関係がインストールされます。 Cloud SDK では現時点で Python 2 をデフォルトで使用していますが、必要に応じて既存の Python インストール環境を使用する場合は、バンドル版 Python をインストールするためのオプションをオフにすることができます。

   注: Cloud SDK はデフォルトで Python 2 が使用されますが、まもなく Python 3 に移行される予定です（除外と、他のバージョンを使用するように Python インタープリタを構成する方法については、gcloud topic startup を実行してください）。今後の中断を避けるために Python 3 にアップグレードすることを検討してください。
3. インストールが完了したら、次のオプションを受け入れます。
   • Cloud SDK シェルを起動する
   • gcloud init を実行する

   これにより、ターミナル ウィンドウが開いて gcloud init コマンドが実行されます。

4. デフォルトのインストールには、gcloud コマンドでアプリケーションをデプロイするために必要な App Engine 拡張機能は含まれていません。これらのコンポーネントは、Cloud SDK コンポーネント マネージャーを使用してインストールできます。

components update コマンド（gcloud components update）を使用して更新を実行します。

gsutil の使用方法については、クイックスタート: gsutil ツールの使用演習をご覧になるか、gsutil help を実行してください。

別のインストール方法

gsutil をスタンドアロン サービスとしてインストールする方法はいくつかあります。Cloud SDK に付属している他のあらゆるコンポーネントが不要な場合や、PyPI でパッケージを管理している場合、これらのいずれかの方法を選択できます。

gsutil をスタンドアロンとしてインストールする場合は、追加のシステム要件として、パソコンに Python をインストールしておく必要があります。gsutil ではマイナー バージョン 2.7.x～3.7.x が正式にサポートされています。Python は Linux と macOS のほとんどのディストリビューションにデフォルトでインストールされていますが、Windows にはデフォルトでインストールされていません。そのため、Windows で gsutil を実行するには事前に Python をインストールしておくことが必要です。

手順については、希望の方法を展開してください。

tar または zip アーカイブからのインストール

Linux / macOS

1. gsutil は gsutil.tar.gz または gsutil.zip としてダウンロードできます。 どちらを使用しても問題ありませんが、ここで説明するインストール手順では gsutil.tar.gz を使用しているものとします。

   ダウンロードする形式にかかわらず、gsutil は 1 つのアーカイブにバンドルされています。このアーカイブをわかりやすい場所に保存します。

2. アーカイブ ファイルを取り出します。

   シェル ウィンドウを開き、gsutil をダウンロードしたディレクトリに移動し、次のコマンドを実行します。

   tar xfz gsutil.tar.gz -C $HOME

   これで、gsutil がホーム ディレクトリにインストールされ、gsutil というディレクトリが作成されます。gsutil ディレクトリには、gsutil ツール、gslib ディレクトリ、boto ライブラリなど複数のディレクトリが含まれる third_party ディレクトリが収められています。

   gsutil を別の場所にインストールする場合は、$HOME をコンピュータ上の別の場所に移動します。

3. PATH 環境変数に gsutil を追加します。

   Linux では ~/.bashrc ファイル、macOS では ~/.bash_profile に、次の行を追加します。

   export PATH=${PATH}:$HOME/gsutil

   ホーム ディレクトリに gsutil をインストールしなかった場合は、gsutil の場所と一致するように $HOME/gsutil を必ず変更してください。

4. シェル プログラムまたはデバイス プログラムを再起動します。

   場合によって、PATH 環境変数を有効にするためにシェル プログラムまたはデバイス プログラムの再起動が必要になることがあります。

これで gsutil を使い始めることが可能です。gsutil コマンドの一覧を表示するには、コマンド プロンプトに「gsutil」と入力します。

Windows

1. Python をダウンロードしてインストールします。

   gsutil と連携するバージョンの Python をインストールします（上記のシステム要件をご覧ください）。32 ビット版の Python をインストールし、デフォルトのロケーション（たとえば、C:\Python27）にインストールすることをおすすめします。

2. gsutil をダウンロードします。

   gsutil は gsutil.zip という名前の単一アーカイブにバンドルされています。このアーカイブを C:\ などのわかりやすい場所に保存します。

3. アーカイブ ファイルを取り出します。

   アーカイブ ファイルはルート ディレクトリに取り出すことをおすすめします。こうすると、ルート ディレクトリに gsutil という名前のディレクトリが作成されます（例: C:\gsutil）。これには、gsutil ツールとそのツールに必要なすべてのライブラリとその他のファイルが含まれています。

4. コマンド プロンプト ウィンドウを起動して gsutil を実行し、gsutil コマンドの一覧を取得します。

   Windows で gsutil コマンドを実行するには、Python インタープリタを実行する必要があります。たとえば、gsutil コマンドの一覧を表示するには、コマンド プロンプトに「python gsutil」と入力します。また、C:\gsutil ディレクトリの外側で gsutil を実行するには、gsutil 実行可能ファイルへのフルパスを指定する必要があります。たとえば、gsutil を C:\Users\Admin\MyDocuments ディレクトリで実行するには、コマンド プロンプトで「python C:\gsutil\gsutil」と入力します。

これで gsutil を使い始めることが可能です。

gsutil を使いやすくする

次の内容が含まれている gsutil.cmd コマンド ファイルを作成することで、gsutil を実行しやすくできます（前述のとおり、Python と gsutil をインストールしていることを前提とします）。

cmd.exe /C C:\Python27\python.exe "C:\gsutil\gsutil" %*"

gsutil.cmd のディレクトリの場所をシステムパスに追加すると、任意の場所から gsutil command を実行できます（command は有効な gsutil コマンドです）。

スタンドアロンの gsutil の更新

スタンドアロン サービスとして使用する場合、gsutil には組み込み update コマンドがあります。このコマンドは、gsutil の最新リリースをチェックし、現在インストールされているバージョンが最新リリースではない場合に最新リリースに自動更新できることを知らせます。コマンド gsutil update（Windows の場合は python gsutil update ）を使用します。

Python パッケージ インデックス（PyPI）からのインストール

試験運用中

PyPI からの gsutil のインストールは Cloud Storage の新機能で、現在試験運用中のため頻繁に変更が加えられています。そのため、旧サービスと互換性のない変更を加えることがあります。この機能の試験運用期間が終了しましたらお知らせします。
 

CentOS、RHEL、Fedora

1. 必要なシステム パッケージをインストールします。

   PyPI から gsutil を正常にインストールするには、複数のパッケージが必要です。次のコマンドを使用すると、複数のパッケージをインストールできます。

   sudo yum install gcc openssl-devel python-devel python-setuptools libffi-devel

2. pip をインストールします。

   pip インストーラを使用することをおすすめします。次のコマンドを使用すると、pip をインストールできます。

   sudo yum install python-pip

   CentOS または RHEL を使用していて、パッケージ python-pip が見つからない場合、Extra Packages for Enterprise Linux（EPEL）リポジトリ ソースが有効になっていないことが考えられます。これを有効にするには、こちらの手順を行ってください。

3. PyPI から gsutil をインストールします。

   PyPI から gsutil をインストールするには、次のコマンドを使用します。

   sudo pip install gsutil

これで gsutil を使い始めることが可能です。gsutil コマンドの一覧を表示するには、コマンド プロンプトに「gsutil」と入力します。

Debian / Ubuntu

1. 必要なシステム パッケージをインストールします。

   PyPI から gsutil を正常にインストールするには、複数のパッケージが必要です。次のコマンドを使用すると、複数のパッケージをインストールできます。

   sudo apt-get install gcc python-dev python-setuptools libffi-dev

2. pip をインストールします。

   pip インストーラを使用することをおすすめします。次のコマンドを使用すると、pip をインストールできます。

   sudo apt-get install python-pip

3. PyPI から gsutil をインストールします。

   PyPI から gsutil をインストールするには、次のコマンドを使用します。

   sudo pip install gsutil

これで gsutil を使い始めることが可能です。gsutil コマンドの一覧を表示するには、コマンド プロンプトに「gsutil」と入力します。

macOS

1. pip をインストールします。

   pip インストーラを使用することをおすすめします。次のコマンドを使用すると、pip をインストールできます。

   sudo easy_install -U pip

2. PyPI から gsutil をインストールします。

   PyPI から gsutil をインストールするには、次のコマンドを使用します。

   sudo pip install gsutil

これで gsutil を使い始めることが可能です。gsutil コマンドの一覧を表示するには、コマンド プロンプトに「gsutil」と入力します。

Windows

1. pip をインストールします。

   Python バージョン 2.7.9 以降を使用する場合は、次のコマンドを実行します。

   python -m ensurepip

   それ以外の場合は、pip をインストールするためのファイル get-pip.py をダウンロードし、次のコマンドで pip をインストールします。

   python get-pip.py

2. PyPI から gsutil をインストールします。

   PyPI から gsutil をインストールするには、次のコマンドを実行します。

   pip install gsutil

これで gsutil を使い始めることが可能です。gsutil コマンドの一覧を表示するには、コマンド プロンプトに「gsutil」と入力します。

PyPI からインストールした gsutil の更新

PyPI からインストールした場合、gsutil update コマンドは使用できません。gsutil を更新するには、次のように pip インストーラを使用します。

sudo pip install -U gsutil

保護下のデータにアクセスするための認証情報のセットアップ

gsutil をインストールした場合、誰でもアクセスできるオブジェクトはダウンロードしてアクセスできますが、保護下のデータにアクセスしたり、保護下のバケットに書き込みを行ったりするには、認証情報（認証）をセットアップする必要があります。たとえば、別のユーザーが Cloud Storage アカウントを作成して、特定のユーザーのみがアクセス可能なデータをアップロードした場合は、そのデータにアクセスできるように Cloud Storage サービスに対する認証情報をセットアップする必要があります。

gsutil を Google Cloud SDK の一部としてインストールした場合は、以下の手順を行ってください。それ以外の場合は、スタンドアロンの gsutil を認証するをご覧ください。

注: gsutil を Cloud SDK から使用するか、スタンドアロンとして使用する場合、gsutil version -l を使用し、出力で「using cloud sdk」を探します。

Google Cloud SDK を認証する

gsutil を Google Cloud SDK として使用している場合、アクセスの認証と承認には OAuth2 を使用します。上記の Google Cloud SDK の一部としての gsutil のインストールを行った場合は、次の手順をすでに行っている可能性があります。以前に gcloud init を実行している場合は、構成を再初期化するか新しい構成を作成するかが尋ねられます。

1. コマンド プロンプト インスタンスを開きます。

2. コマンド プロンプトで gcloud init を実行します。

   次の出力が表示されます。

   Welcome! This command will take you through the configuration of gcloud.
    
   Your current configuration has been set to: [default]
    
   To continue, you must login. Would you like to login (Y/n)?
   

3. 「Y」と入力し、Enter キーを押してログインします。

   • このコマンドにより、URL が出力され、プロジェクトへのアクセスをリクエストするためにブラウザ ウィンドウを開く操作が試行されます。ブラウザ ウィンドウが開くと、次の出力が表示されます。

     Your browser has been opened to visit:
      
     https://accounts.google.com/o/oauth2/auth?redirect_uri=http%3A%2F%2F...
     

     次のステップに進みます。

   • ローカルマシンで作業している場合や、ブラウザが URL を自動的に読み込まない場合、--console-only フラグを使用して gcloud init コマンドを再試行します。

     gcloud init --console-only
     

     このコマンドを使用したり、ブラウザが開かないこと（リモートマシンで作業している場合など）が Cloud SDK で検出されたりすると、次の出力が表示されます。

     Go to the following link in your browser:
      
     https://accounts.google.com/o/oauth2/auth?redirect_uri=urn%3Aietf%3Awg%3A...
      
     Enter verification code:
     

     ブラウザを開き、表示された URL に移動します。

4. プロンプトが表示されたら、Cloud Storage のデータに関連付けられている Google アカウントでブラウザ ウィンドウにログインします。

5. アクセスを許可します。

   • ブラウザが自動的に開いた場合は、アプリケーションの権限を確認して準備ができたら、[同意する] をクリックします。その後、確認コードが自動的にコマンドライン ツールに送信されます。

   • リモートマシンで作業している場合や、--console-only フラグを使用した場合には、URL から確認コードをコピーして、ターミナルのコマンドラインで「Enter verification code:」の後に貼り付けます。

6. この構成のデフォルトのプロジェクトを選択します。

   認証情報を設定すると、gcloud コマンドライン ツールで、この構成のデフォルトのプロジェクトを指定するよう求められ、使用可能なプロジェクトのリストが表示されます。リストからプロジェクト ID を選択します。

   このプロパティを設定すると、-p フラグでオーバーライドしたり、CLOUDSDK_CORE_PROJECT 環境変数を設定したりしない限り、gsutil mb などプロジェクトを必要とする gsutil コマンドでデフォルトのプロジェクト ID が使用されます。

注:Compute Engine API を有効にしている場合は、gcloud init で次にプロジェクトのデフォルトのゾーンとリージョンを設定するように求められることがあります。この設定は、gsutil. のパフォーマンスには影響しません。

以上です。これで、保護下のデータにアクセスする準備ができました。gsutil コマンドの一覧を表示するには、コマンド プロンプトに「gsutil」と入力します。

スタンドアロンの gsutil を認証する

gsutil を Google Cloud SDK の一部としてインストールしなかった場合に認証情報を確立するには、こちらの手順を展開してください。

1. 新しいコマンド プロンプトを開きます。
2. （Windows のみ）: gsutil をインストールしたディレクトリに切り替えます（デフォルトは C:\gsutil です）。
3. コマンド プロンプトで gsutil config（Windows の場合は python gsutil config）を実行します。

   このコマンドを初めて実行すると、認証ページの URL が出力されます。このページで Cloud Storage へのアクセスに対して gsutil を認証できます。次のような gsutil ダイアログが表示されます。

   This script creates a boto config file at <your_homedir>/.boto
   containing your credentials, based on your responses to the following questions.
   
   Please navigate your browser to the following URL: <http://urlto/authorization/dialog>
   In your browser you should see a page that requests you to authorize gsutil to access
   Cloud Storage on your behalf. After you approve, an authorization code is displayed.
   
   Enter the authorization code:
   

   注: gsutil でブラウザ ウィンドウを開く場合は、gsutil config -b（Windows の場合は python gsutil config -b）を使用します。SSH を使用してリモートマシンに接続する場合、-b オプションが機能しないことがあります。

   
   
4. URL をコピーしてブラウザ ウィンドウに貼り付けます。

   プロンプトが表示されたら、Cloud Storage のデータに関連付けられている Google アカウントでブラウザ ウィンドウにログインします。

5. [アクセスを許可] ボタンをクリックします。

   これで、gsutil が認証されて Cloud Storage にアクセスできるようになります。

6. 次のページに表示される承認コードを gsutil プロンプトにコピーし、Enter キーを押します。

   承認コードを指定すると、次の内容が出力されます。

   Please navigate your browser to the following URL:
   https://console.cloud.google.com/
   What is your project-id?
   

7. プロジェクト ID を gsutil のプロンプトに入力します。

   プロジェクト ID が割り当てられている場合は、ここに入力できます。それ以外の場合は、URL をコピーしてブラウザ ウィンドウに貼り付け、Google Cloud Console にログインしてプロジェクト ID を確認します（ID を探すには、右上のプルダウンにある [すべてのプロジェクトを管理] をクリックします）。

   このプロジェクトが gsutil のデフォルトとして設定されます。gsutil のプロジェクト ID を設定できるのは 1 回のみです。gsutil のプロジェクト ID は boto 構成ファイルを編集することで変更できます。

これで、保護下のデータにアクセスする準備ができました。gsutil コマンドの一覧を表示するには、コマンド プロンプトに「gsutil」と入力します。

HMAC を使用して認証する

gsutil の認証には OAuth 2.0 が推奨されますが、認証情報の HMAC キーを使用することもできます。HMAC で認証するには、gsutil config コマンドで -a フラグを使用します。

gsutil config -a

このコマンドを使用した後の操作は、HMAC キーに関連付けられているアクセス ID とシークレットが求められる点を除き、スタンドアロンの gsutil の認証と同様です（前のセクションを参照してください）。

Google Cloud SDK を使用している場合は、次のコマンドを使用して認証情報の引き渡しを無効にする必要もあります。

gcloud config set pass_credentials_to_gsutil false