Rancherコードリーディング入門（1/3）

Rancherのアプリケーションコード

続いて本題であるRancherのアプリケーションコードについて紹介します。

.
├── main.go
├── app
├── server
├── k8s
├── pkg

main.go

Rancher Serverのエントリーポイントとなるコードです。コマンドライン引数の処理や、Logレベルの設定、Rancherが利用するKubernetes Clientの初期化など基本的な処理を実施し、その後のMainとなるRancher Serverのロジックの呼び出しをapp/app.goを通して実施します。

app

app/
├── app.go
├── authconfig_data.go
├── catalog_data.go
├── cluster_data.go
├── ensure_admin_user.go
├── listenconfig_data.go
├── machinedriver_data.go
├── podsecuritypolicytemplate_data.go
├── resetpassword.go
├── role_data.go
├── rolebuilder.go
└── setting.go

このappパッケージは、main.goから呼ばれるRancher Serverのコアロジックの初期化を含みます。app/app.goのRun関数がmain.goから呼ばれ、Run関数内で下記のような初期化処理を実施します

• Kontainer EngineのDriverごとのGrpc Serverの起動（Rancher内部で利用するためLoopback IPでListen）
  • GKE
  • AKS
  • EKS
  • Import
  • RKE
• Rancher API Serverの起動
• Rancherが利用するCRDの作成
• Rancher API Controllerの起動
• ConfigMapベースのLeader Election
• Leaderの場合
  • Telemery API Serverの起動
  • Management Controllerの起動
  • 初期データ（Catalog、ListenConfig、Roleリソース……）の作成

app/app.go以外のファイルは、基本的にapp.goから呼び出される関数が入っているだけで、すべてのロジックの始まりは、app.goからになります。

server

server/
├── capabilities
├── health.go
├── responsewriter
├── server.go
├── ui
└── whitelist

このserverパッケージは主にapp/app.goから呼ばれ、Rancher API処理の初期化とAPI Serverの起動の責任を持ちます。中でもこのパッケージの中心となるファイルは、server/server.goです。server/server.goは、app/app.goから呼ばれるStart関数を実装しており、該当関数内で、RancherのすべてのHTTP Handlerを収集し、どのAPIのPathに対して、どのHandlerを紐付けるべきなのか、どのHandlerのAuthenticationが必須なのかというマッピングを設定しています。

Rancher APIのメインとなるManagement APIについては、このserver.goからpkg/api/server/server.goを呼び出すことで、CRDの作成、API Controllerの初期化など実施しています。

server.go以外のファイルは、基本的にserver.goから呼び出される関数を定義しています。

k8s

k8s/
├── config.go
├── embedded.go
├── embedded_none.go
├── k3s.go
└── k3s_context.go

このpackageは、main.goで参照されているRancherが利用するKubernetes Clientの初期化を実施するコードです。しかし、利用できるKubernetesが発見できなかった場合は、Embedded Kubernetesを起動し、そのEmbedded KubernetesのClientをmain.goに返します。

pkg

pkg/
├── agent
├── api
├── audit
├── auth
├── catalog
├── cert
├── clustermanager
├── clusterprovisioninglogger
├── clusterrouter
├── configfield
├── controllers
├── dialer
├── dynamiclistener
├── embedded
├── encryptedstore
├── filter
├── httpproxy
├── hyperkube
├── image
├── k8scheck
├── k8slookup
├── k8sproxy
├── kubeconfig
├── kubectl
├── librke
├── logserver
├── namespace
├── node
├── nodeconfig
├── pipeline
├── project
├── randomtoken
├── rbac
├── ref
├── remotedialer
├── resourcequota
├── rkecerts
├── rkedialerfactory
├── rkenodeconfigclient
├── rkenodeconfigserver
├── rkeworker
├── settings
├── systemaccount
├── systemtemplate
├── telemetry
├── templatecontent
├── ticker
├── tls
└── tunnelserver

pkgディレクトリには、Rancherの大部分のロジックが保存されています。main.go、app/app.go、server/server.goなどは、このpkgディレクトリ配下のプログラムを適宜呼び出すことで、初期化や起動を実施しています。

各ディレクトリごとの概要については、上記で書いた通りです。すべてを見ていくことは、ボリューム的に難しいですが、いくつか重要なパッケージとファイルについて、次回以降でもう少し詳しく紹介します。

まとめ

本連載では、rancher/rancherレポジトリ内の各ディレクトリ、ファイルの役割について一通り紹介しました。Rancherを実際に利用されている方は、ここまででもざっくりどういうロジックがどのディレクトリ、ファイルで実装／実現されているか、ある程度イメージがつかめたかと思います。

次回からは、Rancher Agent（pkg/agent）、Rancher API（pkg/api）、Rancher Controller（pkg/controllers）について、もう少し詳細にどのように実装されているか紹介していきます。