【自主学習の記録 part2】Git LFSの使い方

LFSとは

GitにおけるLFSとはLarge File Storageの略で、通常であればGitで取り扱うことができない1GB以上の大きなファイルや画像や動画ファイル等のバイナリファイルを管理する事が出来る様になる機能です。
LFSを有効化する事により通常のGit系で扱えない上記ファイルも対応できます。
仕組みとして、LFS管理対象のファイルはプロジェクトとは別の専用ディレクトリに格納され、元のプロジェクト内にはそのファイルへのポインタが格納されるとの事です。
ポインタはwindowsで言うところのショートカットのようなものです。

GitLabでLFSを使用する為の準備

GitLabでもLFSを使用する事が出来るので、有効化して試してみたいと思います。

サーバー側の設定

GitLabでLFSを使用するためには、GitLabの設定ファイルを編集し、LFSを有効化する必要があります。
サーバーにCLIでログインし、GitLabの設定ファイル/etc/gitlab/gitlab.rbの中身をlfsで絞ってみると、LFS関連の設定がコメントアウトされていました。
以下はgitlab.rbファイルをlfsでグレップした結果の一部です。

cat /etc/gitlab/gitlab.rb | grep lfs
# gitlab_rails['lfs_enabled'] = true
# gitlab_rails['lfs_storage_path'] = "/var/opt/gitlab/gitlab-rails/shared/lfs-objects"

「lfs_enabled」がLFSの有効化となり、「lfs_storage_path」がLFSの管理対象ファイルの元ファイルを格納するディレクトリ設定の様です。
この2点を有効化してみたいと思います。
以下は設定後のgitlab.rbファイルをlfsでグレップした結果の一部です。

cat /etc/gitlab/gitlab.rb | grep lfs
gitlab_rails['lfs_enabled'] = true
gitlab_rails['lfs_storage_path'] = "/var/opt/gitlab/gitlab-rails/shared/lfs-objects"

なお、デフォルトで記載されていたlfs_storage_pathのパスは存在していましたので、特に変更はしていません。
パスが存在しない場合はエラーが返ってきますが、以下の結果の通りエラーは返ってきていませんでした。
実際に運用する場合、大きなファイルを管理する訳ですから専用のストレージを用意し、そのパスをlfs_storage_pahtに記載するのだと思います。

ll /var/opt/gitlab/gitlab-rails/shared/lfs-objects
合計 0

設定が完了しましたので、GitLabのサービスを再起動します。
以下のコマンド投入後、gitlab Reconfigured!と表示されれば設定完了です。

gitlab-ctl reconfigure

参考サイト様
https://takuya-1st.hatenablog.jp/entry/2018/09/07/102058

クライアント側の設定

上記でGitLabのサーバー側の設定を行いましたが、LFSを使用するにはクライアント側も設定が必要となります。
まずはGitBashにて以下のコマンドを実行します。

git lfs install

以下画像の様な結果が返ってきましたら完了です。

上記コマンドにより最低限クライアントからLFSが有効化されました。
次は実際にGitLabのプロジェクト上に画像ファイルをPushしてみたいと思います。
その前にLFSでファイルを管理する場合は、管理対象ファイルの拡張子を登録する必要があります。
拡張子を登録するコマンドは以下です。

git lfs track "*.＜拡張子＞"

今回はPNGファイルを使用したいと思いますので、実際のコマンドは以下の通りとなります。

git lfs track "*.png"

以下がコマンド投入の結果です。
なお、デフォルトのカレントディレクトリが正しくないので、事前に前回使用した作業ディレクトリへ移動しています。

以上で事前準備は完了です。
ちなみに上記設定を投入後、カレントディレクトリ内に.gitattributesというファイルが作成されます。
中身は以下の通りとなっています。
先程追加したLFS管理対象ファイルの拡張子のエントリが記載されているようです。

LFSを試す

事前準備が完了しましたので、実際にLFSを使用した状態でGitLabプロジェクトへPushしてみたいと思います。
LFSで管理するファイルはこの記事に貼り付けしたファイルを使用します。ファイル名は「GitLab01.png」です。

以下の通り追加した「GitLab01.png」ファイルをプッシュします。

プッシュ実行時に、以下の青枠内の様にLFS関連と思われるメッセージが追加されていました。
LFS管理対象のオブジェクトをアップロードしたというメッセージの様です。

プッシュ完了後にGitLabのプロジェクトへアクセスしました所、LFSというアイコンが表示されたPNGファイルが追加されていました。
LFS管理対象のファイルには分かりやすいようにファイル名の後ろにLFSというアイコンが表示される様になっているのですね。

次にこのプロジェクトを新しくクローンしてみたいと思います。
クローン前にmasterブランチにマージを実行していますが、本記事では省略させて頂いております。
以下の通り新しいディレクトリを作成して移動しています。

クローンを実施します。
特にLFSに関するメッセージは表示されていません。

クローン後のファイルを確認したのですが、ここで異変に気づきました。
クローン前とクローン後でPNGファイルのファイルサイズが異なっていました。
上がクローン後のファイルサイズで、下がクローン前のファイルサイズとなります。

原因はLFSの管理対象ファイルの定義ファイルである.gitattributesファイルをプッシュしていなかった事でした。
おそらく129バイトのGitLab01.pngファイルは元のPNGファイルではなく、PNGファイルの場所を示すポインタだと思われます。
LFSの定義ファイル.gitattributesファイルをプッシュするため、一旦クローン元のディレクトリに移動します。

その後、以下画像の要領で.gitattributesファイルをプッシュしています。

プッシュが完了すると、GitLabのプロジェクトページ上で以下のように.gitattributesファイルが表示されました。

GitLab上でdebugブランチからmasterブランチへマージを実施し、クローンする準備が完了しました。
以下、クローンを実施するためにディレクトリ移動しています。

それから再度クローンを実施してみた所、クローン前と同じファイルサイズのファイルがクローンされている事を確認できました。

以上でLFSについての学習は完了です。
ですが、LFSについて試してみたい事があるので、次回も引き続きLFSについて学習していきたいと思います。