インストール - Rancher Desktopのソースを表示

== 概要 ==
Rancher Desktopは、デスクトップ上でコンテナ管理、Kubernetesを提供するソフトウェアである。<br>
Mac（Intel、Apple Siliconの両方）、Windows、Linuxで利用できる。<br>
<br>
コンテナ管理において、Rancher Desktopでは、コンテナイメージをビルド、プッシュ、プルする機能と、コンテナを実行する機能が提供されている。<br>
これは、Docker CLI（エンジンにMoby / dockerdを選択した場合）またはnerdctl（エンジンにcontainerdを選択した場合）の両方で提供される。<br>
nerdctlは、containerdプロジェクトが提供するdocker-compatible CLI for containerdである。<br>
<br>
Kubernetesにおいて、Rancher Desktopには、Kubernetesが組み込まれている。<br>
Kubernetesは、軽量ディストリビューションであるk3sによって提供されている。<br>
Rancher Desktopでは、Kubernetesのバージョンを選択して、Kubernetesをリセットしたり、Kubernetesとコンテナランタイム全体をボタン1つでリセットする機能等がある。<br>
<br>
RancherとRancher Desktopは、Rancherという名前を共有しているが、それぞれ異なる動作を行う。<br>
Rancherは、Kubernetesクラスタを管理するための強力なソリューションであり、Rancher Desktopは、ローカルのKubernetesとコンテナ管理プラットフォームを提供する。<br>
この2つのソフトウェアは、互いに補完し合っている。<br>
<br>
ローカルシステムでRancherを実行する場合は、Rancher DesktopにRancherをインストールすることができる。<br>
<br>
Rancher Desktopの詳細を知りたい場合は、[https://docs.rancherdesktop.io Rancher Desktopの公式ドキュメント]を参照すること。<br>
<br><br>

== Rancher Desktopの動作に必要な条件 ==
Rancher Desktopの動作に必要な条件を、以下に示す。<br>
* DEBパッケージ、RPMパッケージ、AppImageのいずれかをインストールできる環境
* 持続的なインターネット接続
* AMD-VまたはVT-xを搭載したx86_64プロセッサ
* /dev/kvmへの読み書きアクセス
* 8[GB]以上のRAM
* 4CPUs
実行するワークロードによっては、追加のリソースが必要になる場合がある。<br>
<br>
GNOMEではシステムトレイをサポートしていないため、Rancher Desktopのトレイアイコンは表示されないことに注意する。<br>
<br><br>

== Rancher Desktopのインストール ==
[https://github.com/rancher-sandbox/rancher-desktop/releases Rancher DesktopのGithub]にアクセスして、Rancher Desktopをダウンロードする。<br>
ダウンロードしたファイルを解凍する。<br>
 unzip rancher-desktop-<バージョン>.zip
<br>
解凍したファイルを任意のディレクトリに配置する。<br>
<br>
Rancher Desktopのデスクトップエントリファイルを作成する。<br>
 vi ~/.local/share/applications/Ranchar_Desktop.desktop
<br>
 <syntaxhighlight lang="ini">
 # ~/.local/share/applications/Ranchar_Desktop.desktopファイル
 
 [Desktop Entry]
 Type=Application
 Name=Ranchar Desktop
 GenericName=Ranchar Desktop
 Comment=Kubernetes and Docker Management
 Exec=/<Rancher Desktopのインストールディレクトリ>/rancher-desktop %F
 Icon=/<Rancher Desktopのインストールディレクトリ>/ranchar-desktop.png
 StartupNotify=false
 StartupWMClass=Rancher
 Categories=Development;
 MimeType=;
 Keywords=rancher;kubernetes;docker;
 </syntaxhighlight>
<br>
Rancher Desktopを起動すると、~/.bashrcファイル、~/.tcshrcファイル、~/.zshrcファイルの最下行に、以下に示す設定が追記される。<br>
 <syntaxhighlight lang="sh">
 ### MANAGED BY RANCHER DESKTOP START (DO NOT EDIT)
 export PATH="/home/<ユーザ名>/.rd/bin:$PATH"
 ### MANAGED BY RANCHER DESKTOP END (DO NOT EDIT)
 </syntaxhighlight>
<br>
/dev/kvmへのアクセス権を設定する。<br>
一部の環境では、Rancher Desktopに必要な/dev/kvmを使用するための十分な権限がない。<br>
まず、必要な権限があるかどうかを確認する。<br>
 [ -r /dev/kvm ] && [ -w /dev/kvm ] || echo 'insufficient privileges'
<br>
十分な権限が出力されない場合は、ユーザをkvmグループに追加する必要がある。<br>
 sudo usermod -a -G kvm "$USER"
<br>
設定を反映させるため、PCを再起動または再ログインする。<br>
<br><br>

== Rancher Desktopのアンインストール ==
まず、Rancher Desktopのインストールディレクトリを削除する。<br>
 rm -r <Rancher Desktopのインストールディレクトリ>
<br>
次に、Rancher Desktopの設定ファイルおよびディレクトリを削除する。<br>
 rm -r ~/.config/"Rancher Desktop"
 rm -r ~/.local/share/rancher-desktop
 rm -r ~/.rd
 rm -r .tcshrc
 rm -r ~/.local/share/applications/Ranchar_Desktop.desktop
<br>
~/.bashrcファイル、~/.tcshrcファイル、~/.zshrcファイルの最下行にある、以下に示す設定を削除する。<br>
 <syntaxhighlight lang="sh">
 ### MANAGED BY RANCHER DESKTOP START (DO NOT EDIT)
 export PATH="/home/<ユーザ名>/.rd/bin:$PATH"
 ### MANAGED BY RANCHER DESKTOP END (DO NOT EDIT)
 </syntaxhighlight>
<br><br>

== Rancher Desktopの設定 ==
==== pass ====
<u><code>docker login</code>コマンド、<code>nerdctl login</code>コマンドを使用しない場合は、passの設定は不要である。</u><br>
デフォルトでは、Rancher Desktopは、passを使用して<code>docker login</code>コマンドと<code>nerdctl login</code>コマンド経由で渡された認証情報を安全に保存する。<br>
<br>
まず、passをインストールする。<br>
 # RHEL
 sudo dnf install pass
 
 # SUSE
 sudo zypper install password-store
<br>
Rancher Desktopをインストールした後、GPGキーを作成する。<br>
これはpassが秘密を保護するために使用する。<br>
 gpg --generate-key
 
 # 出力例
 8D818FB37A9279E341F01506ED96AD27A40C9C73
<br>
上記の出力例が、ユーザのキーIDである。<br>
このキーIDを渡すことで、passを初期化することができる。<br>
 pass init <キーID>
<br>
passの詳細を知りたい場合は、[https://www.passwordstore.org/ passの公式Webサイト]を参照すること。<br>
<br>
==== Kubernetesの有効 / 無効 ====
このオプションでは、Kubernetesの有効または無効にすることができる。<br>
Kubernetesを無効にすることにより、containerdやdockerdだけを単体で動作させて、リソースの消費を抑えることができる。<br>
初期設定では、Kubernetesは有効化されている。<br>
<br>
Kubernetesの有効 / 無効を切り替える場合、[Enable Kubernetes]チェックボックスをオン / オフする。<br>
有効 / 無効に切り替えると、Rancher Desktopは自動的に再起動される。<br>
<br>
Kubernetesを無効にしても既存のリソースは削除されずに、Kubernetesを有効に戻すと再び利用可能になる。<br>
<br>
==== Traefikを有効にする ====
このオプションでは、Traefikを有効または無効にすることができる。<br>
Traefikを無効にすることにより、80番ポートと443番ポートを別のイングレス設定用に解放することができる。<br>
初期設定では、Traefikは有効化されている。<br>
<br>
Traefikを有効 / 無効に切り替える場合、[Enable Traefik]チェックボックスをオン / オフする。<br>
有効 / 無効に切り替えると、Rancher Desktopを手動で再起動する必要がある。<br>
<br>
この動作は今後のリリースで変更される予定である。(プロンプトが表示されて、Rancher Desktopが自動的に再起動する)<br>
<br>
Traefikを無効にしても既存のリソースは削除されずに、Traefikを有効に戻すと再び利用可能になる。<br>
<br>
==== Traefikポートバインディングアクセス ====
Rancher Desktopは、デフォルトのイングレスコントローラとしてTraefikを使用している。<br>
Traefik ingressのポートアクセスが制限されているため、Rancher Desktopのデプロイ後に権限エラーに遭遇する可能性がある。<br>
<br>
多くのLinuxディストリビューションでは、非スーパーユーザが1024以下のTCPおよびUDPポートをリッスンすることを許可していない。<br>
そのため、Traefikがローカルホストの特権ポートをリッスンできるようにする。<br>
 sudo sysctl -w net.ipv4.ip_unprivileged_port_start=80
<br>
これにより、80番以上の全てのポートが非特権となり、Traefikは当該ポートに正常にアクセスできるようになる。<br>
<br>
再起動後も、この変更をカスタムカーネルパラメータとして設定を維持する場合、上記と同じコマンドを/etc/sysctl.confファイル内に追記する。<br>
<br><br>

== コンテナランタイム ==
Rancher Desktopのコンテナランタイムを設定することができる。<br>
<br>
ユーザは、コンテナの名前空間を提供して、Docker APIとDocker CLIの使用を可能にするnerdctlまたはdockerd（moby）の使用を提供するcontainerdのオプションがある。
1度に動作できるコンテナランタイムは1つだけであることに注意する。<br>
<br>
別のコンテナランタイムに切り替える場合、以下に示す制約がある。<br>
* Kubernetesの再起動が必要である。
* 既存のコンテナランタイムを使用してビルドまたはプルされたワークロードおよびイメージは、切り替え先のコンテナランタイムでは使用できない。
<br><br>

__FORCETOC__
[[カテゴリ:RHEL]][[カテゴリ:SUSE]][[カテゴリ:Raspberry_Pi]][[カテゴリ:Web]][[カテゴリ:コンテナ]]