openrundev/openrun:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく openrundev/openrun の導入と確認ガイドです。
プロジェクトの範囲
openrundev/openrun の README はプロジェクトを「Deployment platform for code-first internal tools. Deploy web apps declaratively, on a single-node or on Kubernetes, with OIDC/SAML auth and RBAC.」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「Overview」には次の説明があります。OpenRun is an Apache-2.0 licensed open source web app deployment platform for deploying internal tools. OpenRun makes it easy to declaratively deploy containerized web apps.。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「Overview」にある内容から、用途が合うかを先に判断できます。Easily upgrade from single-node to Kubernetes, with no config changes required。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。Create and manage apps declaratively, through GitOps。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「FAQ」など複数の箇所に分かれています。確認できる情報は次の通りです。> The main differences are: > > - OpenRun is declarative. After initial OpenRun setup. Instead of using CLI commands or UI operations, all operations including creating new app and updating config for existing apps can be doing by updating。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 architecture-beta service client(internet)[Client] group host(server)[Node] service openrun(server)[OpenRun Server] in host service sqlite(database)[SQLite Metadata] in host group cm(server)[Docker or Podman] in host junction split in cm service app1(server)[App1] in cm service app2(server)[App2] in cm client:R --> L:openrun openrun:B --> T:sqlite openrun:R -- L:split split:T --> B:app1 split:B --> T:app2 実行可能なコマンドがない場合は手順を作らず、「Overview」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「FAQ」には> Imperative CLI or UI operation are easy to start with, but they make it difficult to track changes and rollback updates. With a declarative config, all changes are version controlled.とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはDomain based or path based routing, with auto-TLSともあります。