おおくまねこ

職業プログラマーです。興味のある話題を書いています。

Docker管理のためにRancher Desktopをインストールして使う

はじめに

Dockerを管理するツールとしてRancher Desktopを使えるようにする方法を説明します。

Rancher Desktopを使う理由

  1. Docker Desktopの有料化の影響

Dockerの管理ツールとしての候補としては Docker Desktop があります。

公式ツールなので、機能が十分であったり、サポートプランがありますが、

ただ、Docker Desktopをつかう場合には、条件次第でライセンス費用1が発生します。

比較的大きめの事業をされている企業での利用や、所属企業でRancherを利用しているので環境を揃えたい場合などに利用する理由になりえます。

  1. Dockerの管理操作のための十分な機能

Dockerの管理のための機能が十分に備わっています。

  • GUIによる直感的な操作
  • docker コマンドなどが付属されており、CLI操作も利用可能になる
  • コンテナイメージの管理操作、kubernetesの操作・環境利用

インストール

Docker Desktopなど他管理ツールの削除（インストール済みの場合）

Docker Desktopなど、他の管理ツールをインストール済みの場合に必要です。

事前に削除するのをお勧めします。

Docker Desktopに付属しているdockerコマンドと重複したり、機能の衝突で正しく動かなくなる可能性があるためです。

Windowsの場合

コントロールパネルからプログラムのアンインストールをしてください。

コントロールパネル=>プログラム=>プログラムのアンインストール を選択します。

ダイアログが開き、中にアプリケーションの一覧があるので、その中からDocker Desktopを選択し「アンインストール」をクリックします。

さらに表示されるダイアログから削除の確認をされるので「はい」を選択して削除を実行します。

Macの場合

Docker DesktopのアプリをMacのアプリ一覧からゴミ箱に移動させます。

Finderを開き、左側の一覧から「アプリケーション」を選択します。

アプリケーションの一覧から「Docker Desktop」を選択肢、ゴミ箱み移動させます。

不要であればゴミ箱を空にしてファイルを削除してください。

インストーラーをダウンロード

以下のサイトからインストーラーを取得し、アプリケーションをインストールします。

Rancher Desktop by SUSE

自分の環境（Mac、Windowsなど）にあったインストーラーを選択し、ダウンロードを開始します。

インストーラーの実行

ダウンロードが完了後、インストーラーを実行します。

承認や設定を確認後、インストールを開始します。完了するまで待ちます。

システム変更の確認が出る可能性がありますが、基本的には承認して継続します。

（管理者権限の確認や、WIndowsサブシステムの権限変更のため。その他の不審な確認があった場合は注意や中断をしてください）

完了した後、設定反映のための再起動を促されますので、準備してから再起動します。2

起動、初期設定

アプリケーションを起動します。

以下のような画面が出てくると思います。

インストール時、Macの場合
インストール時、Windowsの場合

初期設定のまま問題ないので今回はこのまま進みます。

（必要がある場合は応じて変更してください。）

以下の画面になれば起動完了です。

Dockerを動かすための環境としてRancher Desktopの起動している状態が必要になります。この状態で完了です。

動作確認

Dockerが使えるようになっていることを確認します。

以下のコマンドは例です。LinuxのDockerが起動できるようになったことを確認します。

docker run --rm rockylinux:9.3-minimal echo hello rancher
Unable to find image 'rockylinux:9.3-minimal' locally
9.3-minimal: Pulling from library/rockylinux
8ec988941d66: Pull complete
Digest: sha256:305de618a5681ff75b1d608fd22b10f362867dff2f550a4f1d427d21cd7f42b4
Status: Downloaded newer image for rockylinux:9.3-minimal
hello rancher

dockerコマンドが正常に実行できたので成功です。

補足:

Rancher Desktopが起動していないと、以下のようにエラーになります（docker daemonに接続できないエラー）。

>docker run --rm rockylinux:9.3-minimal echo hello rancher
docker: error during connect: in the default daemon configuration on Windows, the docker client must be run with elevated privileges to connect: Head "http://%2F%2F.%2Fpipe%2Fdocker_engine/_ping": open //./pipe/docker_engine: The system cannot find the file specified.
See 'docker run --help'.

[option] 詳細設定

Macの場合、設定に「Virtual Machine」という項目があります。

VM設定:HW
VM設定:volumes
VM設定:Emulation

環境に応じて設定を変更してください。

設定の推奨や意図については以下の通り。

設定タブ名 設定値 説明
Hardware Memory: 8, CPU: 4 dockerを使用するときに使うリソースの上限。利用状況やホストPCの性能と相談
Volumes virtiofs Apple仮想化を利用してファイルパスを共有ディレクトリとしてマウント。EmurationでVZを利用しているからも理由。
reverse-sshfsだとssh経由でのマウントのため、セキュアだがファイル操作に制限がある（権限変更など）。特に操作が不要なら他の設定でも可
Emuration VZ Apple仮想化システムを使う設定。
古いMacOS（12.3以下）を使っていた時にQEMUを使うとメモリ不足に陥る事象があった時の名残3

最後に

以上で設定は完了です

  1. 2025年時点では250名以上または年間収益$10,000,000以上の商用利用の場合に適応。2021年8月31日から有効（2022年1月31日まで猶予）。 https://www.docker.com/ja-jp/legal/docker-subscription-service-agreement/↩
  2. 何も考えずに再起動実行をOKしてしまうと、別アプリやブラウザの作業中のデータが消える恐れがあります。私のように。↩
  3. https://github.com/lima-vm/lima/issues/795↩

Android Projectでエラー「Unresolved reference: libs」の解決

以下の書き方でbuild.gradle.ktsを書いた場合に、「Unresolved reference: libs」というエラーが出てprojectを読み込めない場合がある。

plugins {
    alias(libs.plugins.android.application)
    alias(libs.plugins.jetbrains.kotlin.android)
}

原因の一つはgradle/libs.versions.tomlがないか、設定が誤っている。 ※以上のファイルはAndroid Project作成時に生成される。存在しない場合は誤って消してしまったなどの可能性がある。

対処方法としては、新規でAndtoid StudioからProjectを生成し、gradle/libs.versions.tomlを作成してコピーする。 もしくは、以下のファイルを該当ディレクトリに置く。

[versions]
agp = "8.5.1"
kotlin = "1.9.0"
coreKtx = "1.13.1"
junit = "4.13.2"
junitVersion = "1.2.1"
espressoCore = "3.6.1"
lifecycleRuntimeKtx = "2.8.4"
activityCompose = "1.9.1"
composeBom = "2024.06.00"

[libraries]
androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
junit = { group = "junit", name = "junit", version.ref = "junit" }
androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" }
androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" }
androidx-lifecycle-runtime-ktx = { group = "androidx.lifecycle", name = "lifecycle-runtime-ktx", version.ref = "lifecycleRuntimeKtx" }
androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version.ref = "activityCompose" }
androidx-compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "composeBom" }
androidx-ui = { group = "androidx.compose.ui", name = "ui" }
androidx-ui-graphics = { group = "androidx.compose.ui", name = "ui-graphics" }
androidx-ui-tooling = { group = "androidx.compose.ui", name = "ui-tooling" }
androidx-ui-tooling-preview = { group = "androidx.compose.ui", name = "ui-tooling-preview" }
androidx-ui-test-manifest = { group = "androidx.compose.ui", name = "ui-test-manifest" }
androidx-ui-test-junit4 = { group = "androidx.compose.ui", name = "ui-test-junit4" }
androidx-material3 = { group = "androidx.compose.material3", name = "material3" }

[plugins]
android-application = { id = "com.android.application", version.ref = "agp" }
jetbrains-kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }

コピーした後は追加ライブラリの情報など、Syncして追加してあげてください

Visual Studio Code (VSCode) で SpringBoot の実行時に Active Profile を指定する

はじめに

VSCode で Active Profile を設定する場合、どうするのが良いだろうと調査したので書いておきたいと思います。

SpringBoot には Active Spring Profile という機能が存在します。

開発環境、本番環境で使うDBの種類やリクエスト先のサーバーURLが異なる場合に、設定値で切り替えると思いますが、

この機能で環境毎に設定ファイル自体を切り替えることができるようになります。

方法

デバッグ実行の設定から Active Profile を指定して起動するものを追加するのが良さそうです。

Active Profile を有効にして起動するには以下の方法があります。 - コマンドライン引数にして渡す。起動時のオプション指定に --spring.profiles.active を指定する。 - Java System Option に渡す方法。起動時のオプション引数に -Dspring.profiles.activeを指定する。

「Run and Debug」から設定を追加します。

左サイドメニューから「Run and Debug」のボタンをクリックし、

歯車マークを押すことでlaunch.jsonファイルを開くことができます。

launch.json の configurations に、argsに --spring.profiles.active=<環境名>を指定した設定を追加します1。

今回追加した設定は以下になります（product 毎に変化する場所は必要に応じて変更してください）。

        {
            "type": "java",
            "name": "Launch SpringTutorialApplication Local",
            "request": "launch",
            "mainClass": "jp.co.who.spring_tutorial.SpringTutorialApplication",
            "projectName": "spring_tutorial",
            "args": "--spring.profiles.active=local"
        },

この設定を保存後、Debug Run の項目から、追加したRunタスクを選択できるようになります。

今回の例だと「Launch SpringTutorialApplication Local」になります2。

application-local.property 、application-local.yaml を使って SpringBoot が起動されます。

参考

  1. 「Add Configration…」から追加することもできます。↩

  2. 追加した設定の「name」の値になります。↩

Visual Studio Code (VSCode) でJavaの開発環境を用意する

はじめに

動機

私は普段Javaなどの開発をするとき、IntelliJ IDEA Ultimateを使って開発しています1。

しかし、私の周りの環境ではVisual Studio Code (VSCode)を使われるケースが多く、

Javaの開発もVisual Studio Codeで整えたいという要望があるのですが、

私に知見がなく、説明するのが困難で合ったため、

一度真剣に開発環境を構築し、その時の情報を保存しておこうとしました。

Visual Studio Code が望まれる理由

Visual Studio Code を使う場合のメリットについても少し考えてみました。

これは私の観測範囲ベースも含まれていますが、

Visual Studio Codeの長所であったり、

こちらの方が（少なくとも IntelliJ IDEA よりも）望まれている理由としては以下があります。

  • 豊富や拡張パックで柔軟に機能をカスタマイズできる
  • 他言語の開発を扱う現場で、ワンツールで完結する
  • 無料で使うことができる

もしこの中で魅力に感じる部分があれば

Visual Studio CodeでのJava開発環境に挑戦して見ても良いかもしれません。

Visual Studio Code 設定

Visual Studio Code のインストール

以下のダウンロードサイトから環境に合った圧縮ファイル、またはインストーラーをダウンロードし、
開発環境にインストールします。

Visual Studio Code ダウンロードサイト

  • Windows の場合、インストーラー、またはzipファイルをダウンロードします。
    インストーラーからインストールする場合は、手順に従ってインストールしてください。
  • zipファイルをダウンロードし、解凍すると実行ファイルが含まれています。
    実行ファイルを適切な場所に移動すると良いと思います。
    Mac の場合、必要に応じてAppにコピーします。

JDK のインストール

JDKをダウンロードし、開発環境から使用できるように準備が必要です。

Java は複数の組織がバイナリを提供しているため、提供元が複数存在します。

Java は互換性があるため、多くの場合では違いを意識する必要はありません、

環境毎で指定のJDKがあれば、指定のものをダウンロードして利用してください。

特に指定やこだわりがなければ Oracle、もしくは Adoptium あたりを使われる場合が多い印象があります。

SDKMAN を用いたインストール

SDKMAN を用いてJDKのインストールすることが可能です。

Windows 以外であればこの方法が一番おすすめです。

ディストリビューションの一覧やダウンロードまで実施できますし、

利用に必要な設定や管理も行えます。

SDKMANのインストール方法・使用方法は以下を参考にしてください。

SDKMAN インストール方法

SDKMAN を用いたJDKのインストールの例を以下に示します（java.net OpenJDK 18 の場合）。

sdk install java 18.0.1.1-open

実行すると、以下のような出力がされ、インストールが実行されていきます。

Downloading: java 18.0.1.1-open

In progress...

################################################################################################################### 100.0%

Repackaging Java 18.0.1.1-open...

Done repackaging...
Cleaning up residual files...

Installing: java 18.0.1.1-open
Done installing!

Do you want java 18.0.1.1-open to be set as default? (Y/n): Y

Setting java 18.0.1.1-open as default.

Java Extension Pack の Getting Start の機能からダウンロードする

後述する「Java Extension Pack」インストール後であれば、Visual Studio Code 上の操作から JDK をダウンロードすることが可能です。

Java Extension Pack の「Get Start with Java Development」の機能からもJDKをインストールすることができます。

Visuial Code Studio を開き、「Help」->「Get Start」を選択します。

「Walkthroughs」の「More...」をクリックし、「Open Walkthroughs...」という検索ボックスが出るので「Get STarted with Java Development」を入力し実行する。

「Get STarted with Java Development」の画面に遷移するので、「Get your runtime ready」という項目から「Install JDK」をクリックします。

「Install New JDK」という画面が表示されるので、必要なJDKをインストールすることができます。

各JDKディストリビューションのダウンロードサイトから取得する

各JDKのディストリビューションのダウンロードサイトから取得する方法があります。

何箇所かのディストリビューションとダウンロード先は以下になります。

Visual Studio Code の設定

拡張パックの追加

Javaの開発で必要となる拡張パックをインストールします。

必要となる主な拡張パックは以下になります。

拡張パック名 パッケージURL 概要
Extension Pack for Java https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack Java の開発用拡張パックです。
Javaのコード補完、ビルド、GUIからのJUnit（ユニットテスト）実行などが可能になります。
Spring Boot Extension Pack https://marketplace.visualstudio.com/items?itemName=Pivotal.vscode-boot-dev-pack SpringBoot 開発用拡張パックです。
SpringBoot由来のアノテーションの解決や機能と参照できるようになります。
SpringBootを使用しない開発では不要です。
Lombok Annotations Support for VS Code https://marketplace.visualstudio.com/items?itemName=GabrielBB.vscode-lombok Lombok 用の拡張パックです。
@Getter, @Setter, @Slf4jなどのLombok由来のアノテーションの解決ができるようになります。
Lombokを使用しない開発では不要です。

Java用の設定追加

設定ファイルにJavaを実行するための設定を追加します。

setting.json にJDKへのパスを指定する java.jdt.ls.home を設定します2。

{
  "java.jdt.ls": "/Users/<user_name>/.sdkman/candidates/java/current/"
}

<user_name> は環境に応じて読み替えてください。

java.home のパス自体も環境に応じて変更してください。

settings.json を表示させる方法は設定画面から、右上の方にある「Open Settings」の画像をクリックして表示することができます

設定画面の出し方は以下のいずれか

OS 画面での操作 ショートカットキー
Mac 「Code」-> 「Preferences」->「Settings」 「Command」+「,」
Windows 「File」-> 「Preferences」->「Settings」 「Ctrl」+「,」

設定の完了

以上で設定は完了です。

開発が必要なレポジトリーを使って確認してみてください。

開発対象のレポジトリーがない、Javaプロジェクトの作成方法がピンとこない。という方がいましたら、

動作確認用に以下のレポジトリーを用意しましたので、お試しください。

Java-Gradle の動作練習用レポジトリ

ご参考までに。

最後に

結び

Visual Studio Code でJavaの開発ができるようになりました。

開発ツール自体の初期設定やJDKのダウンロードなどが必要でしたが、

手順を進めれば開発環境が作れることが実証できました。

参考

  1. IntelliJ IDEA のインストール、設定方法。および使い方が気になる方は プロになるJava を参考にしてみてください↩

  2. 古いバージョンだと “java.home” になりますが、現行（2022年6月時点）では非推奨になっています。↩

Intellij IDEA の GUI から force push したい

JetBrain IDE から remote branch に対して force push をするための方法について
git push -f 相当をしたい場合です。
どこかに書くほどではないのですが、最初わからず彷徨っていたので備忘録も兼ねて記載します。

環境については以下

以下の記事で設定変更をする方法が説明されているのですが、現行（2022現在）では設定変更は不要です。

IntelliJ の GUI から git push -f したい - Qiita

local branch でamend commit や rebaseを行った際、
remote branch と差が出てしまい、デフォルトの設定のままでは push しても失敗します。

※２種類の矢印で差分があることがわかる。rebase や merge をして push しても、reject される。

この対処方法として、コマンドラインから Git を使う場合は、git push -f で強制 Push する方法がありますが、
JetBrain IDE では Push するときに「Force Push」を選択して実行することが可能です。

Commnad + Shift + K で Push ダイアログを表示。
「Push」ボタンの右下のプルダウンから「Force Push」を選択し、強制Pushを行うことが可能。

追記:

masterへの force push はデフォルト設定では無効になっています。

もし master へ force push したい場合は設定変更が必要になります。

（業務ではほぼないと思いますが）

[Preference]から設定ダイアログを開き、[Version Controle]->[Git]で設定。

[Push] の[Protected branches]の設定を変更。

保護するブランチ名を変更、もしくは空白にします。

「良いコード／悪いコードで学ぶ設計入門―保守しやすい　成長し続けるコードの書き方」を読みました

はじめに

技術書を読みました。 読んだのは以下の本、「良いコード／悪いコードで学ぶ設計入門―保守しやすい　成長し続けるコードの書き方」です。

良いコード／悪いコードで学ぶ設計入門―保守しやすい　成長し続けるコードの書き方

良いコード／悪いコードで学ぶ設計入門―保守しやすい　成長し続けるコードの書き方

Amazon

設計について有名なミノ駆動さんが書かれた本ということで発売前から注目度の高かった本なので、 ご存知の方も多いと思います。 逆張り思考の私としては「読んでなるものか」と思っていたのに、誘惑には勝てず購入をしてしまい、 読んだ後には充実感を得るほどの満足できる内容の本だったため、ブログに記載してみようと思いました。

該当書籍を読んでみて

おすすめしたい部分

実際に読んで感じた、おすすめできる部分として以下の部分を感じました。 - 構成が構造的、表現も理解しやすい内容の文章で読みやすい - 悪い設計の例がかなり具体的（あるあるすぎて共感する） - 悪い例の後に、良い例を説明している。悪い例の課題への対処方法が書かれている。 - 経験があるエンジニアの持っている「設定をするときの当たり前」をしっかり言語化されている

もう少し

まず、かなり「読みやすかった」というのが第一印象です。 構成がしっかりされていて、課題の説明から入り、解決方法について、解説という流れが全体にあるので、 納得しながら読み進められました印象です。 表現も理解しやすいもので説明されている印象だったため、解釈がとてもわかりやすかった印象です。

内容で説明されているリファクタリングテクニックもかなり具体的かつ実用的なものが多いと感じました。 悪い設計・実装例について、例文がソースコードとして載っていますし、 問題点だけでなく、しっかりその対応方法についても説明されているのがとても好印象を受けました。 どういう風に当てはめれば良いか、という点についても前述した課題の説明からされているので、想像しやすいと思います。

この手の本や資料は「課題だけ」や「テクニックだけ」となるものも少なくない印象ですが、両方説明されているのが良いと感じました。 「理想像をイメージする大切さ」について、著者が取り組んできた空手の経験から説明もされていましたので、 そういった部分を意識し、意図した内容になっているのかなと想像しています。

発売記念勉強会1で話されていた時、「プログラムの入門を終え、設計の専門書に挑む前に読むエントリー本のイメージ」という旨の発言をされていたと記憶しているのですが、 まさにその表現の通りの内容になっていると感じました。

一度設計について学んだ人でも、再確認や復習として、とても参考になるのではないかと思います。

さらに勉強を進めたい人用に参考書籍の紹介や取り組み方も最終章に記載されているので、どこまでもフォローが行き届いているという充実ぶりでした。

  1. 『良いコード/悪いコードで学ぶ設計入門』著者トーク - connpass↩

M1 Macと docker compose の付き合い方について考えた

はじめに

背景

Mac Book Air 2020 年モデル、いわゆるM1 Macを買いました。 今まで使っていた Dockerを動かすとき、docker composeの使い方が変わったので、その内容について記載します。

まえがき

CPUが Apple Silicon と呼ばれるもので、ARMプロセッサーのCPUになります。 以前までのIntell製のCPUと違う点がよく挙げられるのですが、 ソフトウェア開発者視点で遭遇するものの一つにDockerがあります。

今までIntel製で動いていたDockerファイルが動かない。と言われたり、実際になったりすることがあります。 というか、なりました。

その時の Docker、docker compose の使い方についてをまとめようと思います。

環境

今回試した環境は以下 - OS: macOS Monterey - CPU: AppleM1 - メモリ: 16GB

方法

具体的な対応方法について、知っている範囲で説明を記載していこうかと思います。

ARM CPU 対応版の Docker ファイルを利用する

既存のDockerファイルがあり、コミュニティの方でDockerファイルを管理されている場合、 ARM CPU 対応されたイメージがある場合があります。

cassandra を例にすると、Intel CPU で動く cassandra、 ARM 対応した arm64v8/cassandra があります。 そういった対応版を使うとよさそうです。

その他：アーキテクチャを指定する

Docker の起動時、プラットフォームを指定する方法です。 マルチ CPU アーキテクチャのサポートを活用 — Docker-docs-ja 19.03 ドキュメント

1年ほど前（2021年）の時点では、mysql などはM1 Mac で起動すると起動が失敗するケースがあったようです。 （いま手元で試したら mysql は起動したので、Docker側で対応されている気がする）

その際は docker で起動した時にアーキテクチャ指定を行うことで起動していました。 起動時のオプションに--platform linux/x86_64を指定します。

docker compose について

Intel CPU、arm CPU が混在する環境、チームではどうすると良いかと考えた時について。 個人的な解決しては「docker composeファイルの差分ファイルを作って、読み込むようにする」という結論に落ち着きました。

docker-compose.yaml は複数指定すると、差分を上書きして実行してくれます。

ファイル間、プロジェクト間での Compose 設定の共有 — Docker-docs-ja 19.03 ドキュメント

これを利用して、開発者ごとに差分を読み込むようにします。

共通の docker compose ファイル。docker-compose.yamlとする。

version: '3'
services:
  sandbox-service:
    build:
      context: .
      dockerfile: ./Dockerfile
    tty: true
    volumes:
      - ../:/app
    working_dir: /app
    ports:
      - 8080:8080
  cassandra:
    image: cassandra:4.0
    tty: true
    ports:
      - 9042:9042

差分の docker compose ファイル。m1mac.yamlとする。

version: '3'
services:
  cassandra:
    image: arm64v8/cassandra:4.0

それぞれの環境ごとでコマンド実行時に読み込みを行います。

docker compose -f docker-compose.yaml up -d
  • ARM CPU ユーザー
docker compose -f docker-compose.yaml -f m1mac.yaml up -d

アーキテクチャ指定で起動する場合でも、docker-compose ファイル、環境差分ファイルにも起動オプションに上記を指定すれば問題ないのかなと思います。

終わりに

無事にM1Mac でも Docker、docker composeが使える目処がたちました。 まだ触れ出したばかりなので、色々試していきたいと思います。