こんにちは。よっしーです(^^)
今日は、asdfによるgcloudのインストールについて解説しています。
背景
asdfによるgcloudのインストールについて調査する機会がありましたので、その時の内容を備忘として記事に残しました。
gcloudとは
gcloudは、Google Cloud Platform (GCP) のコマンドラインインターフェース (CLI) ツールです。以下は、gcloudの主な特徴と用途です：
- 機能：GCPのリソースを管理、設定、操作するために使用されます。
- 使用例：
- 仮想マシンの作成と管理
- Kubernetes クラスターの操作
- Cloud Storage バケットの管理
- プロジェクトの設定
- インストール：gcloudは Google Cloud SDK の一部として提供されています。
- 利点：
- コマンドラインからGCPリソースを迅速に操作できる
- スクリプトやCI/CDパイプラインに組み込みやすい
- GCPのほぼすべてのサービスにアクセス可能
- 認証：Google Cloud アカウントと連携して使用します。
gcloudは、GCPを利用する開発者や運用チームにとって重要なツールです。
asdfとは
asdfは、複数のプログラミング言語やツールのバージョン管理を一元化するツールです。主な特徴と用途は以下の通りです：
- 機能：
- 複数の言語やツールのバージョンを管理
- プロジェクトごとに異なるバージョンを簡単に切り替え
- プラグイン方式で様々な言語やツールをサポート
- 使用例：
- Node.js, Ruby, Python, Goなど、複数の言語のバージョンを管理
- データベースやKubernetesなどのツールのバージョン管理
- 主要コマンド：
asdf plugin add <名前>: プラグインの追加asdf install <名前> <バージョン>: 特定のバージョンをインストールasdf global <名前> <バージョン>: グローバルバージョンの設定asdf local <名前> <バージョン>: ローカル（プロジェクト）バージョンの設定
- 利点：
- 単一のツールで複数の言語やツールを管理できる
- プロジェクトごとに簡単にバージョンを切り替えられる
- コミュニティドリブンで多くのプラグインが利用可能
- 設定：
.tool-versionsファイルを使用してプロジェクトごとのバージョンを指定
asdfは、特に複数の言語やツールを使用する開発者にとって便利なツールです。異なる環境や要件に応じて簡単にバージョンを切り替えられる点が大きな特徴です。
インストール方法については下記の記事を御覧ください。
インストール方法
ターミナル等で下記のコマンドを入力します。
# プラグインが存在することを確認
asdf plugin list all | grep gcloud
# プラグイン追加
asdf plugin add gcloud
# 最新バージョンの確認
asdf latest gcloud
# 最新バージョン(上記の結果を利用、今回は482.0.0でした)のインストール
asdf install gcloud 482.0.0
トラブルシューティング
インストール後に下記のような文言が出力された場合は、pythonもインストールしておきます。
Welcome to the Google Cloud CLI!
No version is set for command python3
Consider adding one of the following versions in your config file at /Users/xxx/.tool-versions
python 3.11.3
python 3.12.4pythonのインストール
# プラグインが存在することを確認
asdf plugin list all | grep python
# プラグイン追加
asdf plugin add python
# 最新バージョンの確認
asdf latest python
# 最新バージョン(上記の結果を利用、今回は3.12.4でした)のインストール
asdf install python 3.12.4
# 最新バージョンを使用できる状態に設定
asdf local python 3.12.4gcloudのインストール
pythonがインストールできたら、再度、下記のコマンドを実行します。
# 最新バージョン(上記の結果を利用、今回は482.0.0でした)のインストール
asdf install gcloud 482.0.0動作確認
下記のような出力になっていれば、インストールは成功です。
✅ gcloud 482.0.0 installed!
ℹ️ Check by Default SDK Components at /Users/xxx/.default-cloud-sdk-components下記のコマンドを実行して、インストールしたバージョンを使用できるようにします。
# 最新バージョンを使用できる状態に設定
asdf local gcloud 482.0.0
# バージョン確認
gcloud --version下記のような出力になっていれば、成功です。
% gcloud --version
Google Cloud SDK 482.0.0
bq 2.1.6
core 2024.06.24
gcloud-crc32c 1.0.0
gsutil 5.30
Updates are available for some Google Cloud CLI components. To install them,
please run:
$ gcloud components update下記のコマンドを実行しておきます。
gcloud components update注意点
asdf localを使用する際の主な注意点は以下の通りです：
- .tool-versionsファイルの管理:
- asdf localコマンドを実行すると、カレントディレクトリに.tool-versionsファイルが作成されます。
- このファイルをバージョン管理システム（Git等）に含めるかどうかを慎重に検討する必要があります。
- プロジェクト固有の設定:
- asdf localはプロジェクト固有の設定になるため、チームメンバー全員が同じバージョンを使用することを確認する必要があります。
- インストール済みバージョンの確認:
- 指定したバージョンがローカルにインストールされていない場合、エラーが発生します。
- 事前に
asdf install <名前> <バージョン>でインストールしておく必要があります。
- 上位ディレクトリの影響:
- asdfは現在のディレクトリから上位に向かって.tool-versionsファイルを探索します。
- 意図しないバージョンが適用されないよう、ディレクトリ構造に注意が必要です。
- グローバル設定との競合:
- localの設定はglobal設定より優先されます。
- 異なる環境での動作に注意が必要です。
- シェルの再起動やリロード:
- 設定変更後、変更を反映させるためにシェルの再起動やリロードが必要な場合があります。
- 複数のバージョン指定:
- 1つのプロジェクトで複数の言語やツールのバージョンを指定する場合、.tool-versionsファイルの管理が複雑になる可能性があります。
- CI/CD環境での使用:
- CI/CD環境でasdf localを使用する場合、必要なバージョンが自動的にインストールされるよう設定する必要があります。
これらの点に注意しながらasdf localを使用することで、プロジェクト固有の環境を効果的に管理できます。
おわりに
今日は、 asdfによるgcloudのインストールについてについて解説しました。
何か質問や相談があれば、コメントをお願いします。また、エンジニア案件の相談にも随時対応していますので、お気軽にお問い合わせください。
それでは、また明日お会いしましょう(^^)
コメント