Envoy：CNCFがホストするC++製のエッジ・ミドル・サービスプロキシ

CNCFがホストするエッジ・ミドル・サービスプロキシ

READMEはプロジェクトの一言説明で始まります："Cloud-native high-performance edge/middle/service proxy"。続いてEnvoyがCloud Native Computing Foundation（CNCF）にホストされていると述べ、2017年9月にCNCFがEnvoyをホストすると発表したアナウンスへのリンクを掲載しています。リポジトリのメタデータは主要言語をC++とし、ホームページをenvoyproxy.ioとしています。README自体は"edge/middle/service"が運用上何を意味するかを定義しておらず、性能数値や採用者リストも示していません。これらの詳細はREADMEの範囲外であり、他の情報源で確認する必要があります。

ドキュメント、例、関連リポジトリ

「ドキュメント」のセクションでは、envoyproxy.ioの公式ドキュメント、FAQ、別のenvoyproxy/examplesリポジトリにあるサンプルドキュメント、そして5つのブログ投稿へのリンクがあります。ブログはEnvoyのスレッドモデル、ホットリスタート、統計アーキテクチャ、ユニバーサルデータプレーンAPI、LyftのEnvoyダッシュボードを扱っています。「関連」セクションには3つのリポジトリがあります：data-plane-api（v2 API定義のためのapiディレクトリの読み取り専用ミラー）、envoy-perf（パフォーマンステストフレームワーク）、envoy-filter-example（新しいフィルタを追加してメインリポジトリにリンクする例）。README自体にはバージョン番号やAPIの詳細はありません。

メーリングリスト、Slack、月2回のミーティング

連絡セクションには4つのGoogleグループがあります：envoy-announce（低頻度のお知らせ用）、envoy-security-announce（セキュリティ関連のお知らせ専用）、envoy-users（一般的なユーザー議論）、envoy-dev（開発者議論）。コアメンテナーに連絡するためのenvoy-maintainersリストもあります。READMEはSlackが利用可能であると述べていますが、Slackでのユーザー質問への返信はベストエフォートであり、「保証された」返信にはenvoy-usersへのメールが必要だとしています。コミュニティミーティングは毎月2回、火曜日の午前9時（太平洋時間）に予定されていますが、公開されている議事録に議題がある場合のみ開催されます。次回の会議がいつか、通常誰が参加するかはREADMEには書かれていません。EnvoyProxyのTwitterアカウントへのリンクもあります。

コントリビューション：dockerを使ったビルドと初心者向けイシュー

コントリビューションセクションは、コントリビュートは「楽しい」ものであり、現代のC++は経験がなくても思うほど怖くないと述べています。コントリビューティングガイド、初心者向けのイシューリスト、dockerを使ったビルド/テストのクイックスタート（ciディレクトリへのリンク）、開発者ガイド、開発サポートツールチェーンへのリンクがあります。また、重複作業を避けるために、イシューに取り組んでいることをメンテナーに知らせるよう求めています。READMEには実際のdockerコマンドや段階的なビルド手順は含まれておらず、それらはリンクされたciと開発者ガイドのファイルにあります。リポジトリのメタデータは現在28,716スターと5,536フォークを示していますが、README自体は統計に言及していません。

セキュリティ監査、脆弱性報告、ppc64leの例外

セキュリティセクションには、2つの第三者による取り組みが記録されています：2018年にCure53が実施したセキュリティ監査（完全なレポートはdocs/security/audit_cure53_2018.pdf）と、2021年にAda Logicsがファジングインフラストラクチャについて実施し推奨事項を伴う監査（これも完全なレポートあり）。脆弱性を報告するには、READMEはGitHub Security Advisoryを開くか、envoy-security@googlegroups.comにメールするよう指示し、SECURITY.mdの完全なセキュリティリリースプロセスを参照しています。また、ppc64leアーキテクチャのビルドはセキュリティポリシーの対象外であり、ベストエフォートで、Envoyメンテナーが保守していないと述べています。監査が最新であるか、見つかった問題がすべて修正されたかは書かれておらず、レポートを読む必要があります。セキュリティセクションの後には「OSS fuzzing」と「Other builds」という見出しもありますが、本文はありません。

ライセンス、リポジトリのメタデータ、READMEが触れていないこと

このリポジトリはApache-2.0ライセンスで提供されており、ライセンスファイルとメタデータがそれを示しています。Apache License 2.0は、作品を複製し、派生作品を作成し、公に表示・上演し、再ライセンスし、配布するための永続的、世界的、非独占的、無償、ロイヤリティフリーの著作権ライセンスを付与し、条件付きの特許ライセンスを含みます。ライセンス本文は、セキュリティ、サポート、保証について一切約束していません。READMEにはインストール手順、機能リスト、パフォーマンスベンチマークはありません。リポジトリはアーカイブされておらず、デフォルトブランチはmainで、メタデータによると未解決のイシューが1,825件あります。インストール、設定、運用の詳細は、公式ドキュメントとサンプルリポジトリを参照する必要があります。

編集部の結論

READMEは、EnvoyがCNCFエコシステムのどこに位置するか、ドキュメントや関連リポジトリの見つけ方、コミュニティへの連絡方法、コントリビューションの方法、セキュリティ問題の報告方法を明確に示しています。インストールコマンド、ベンチマーク、本番採用の主張は含まれておらず、Apache-2.0ライセンスはいかなる保証やサポートの約束もしていません。これらの詳細は、公式ドキュメントとリンクされたレポートで確認する必要があります。

公式情報源

1. Official documentation
2. Official README
3. Project repository
4. Release notes