このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソースの組織:
- Jenkins プロジェクト
- テクニカル ライター:
- Zaycodes
- プロジェクト名:
- Kubernetes での Jenkins
- プロジェクトの長さ:
- 標準の期間（3 か月）
プロジェクトの説明
Kubernetes は、Google が開発したプラットフォームに依存しないコンテナ オーケストレーション ツールで、Cloud Native Computing Foundation のプロジェクトとしてオープンソース コミュニティの支援を受けています。これにより、コンテナ インスタンスを使用して、スケーリングとフォールト トレラントで管理できます。また、リクエストのルーティング、コンテナ ディスカバリ、ヘルスチェック、ローリング アップデートなど、通常は個別のソリューションやカスタムコードを必要とする幅広い管理アクティビティも処理できます。
Kubernetes は、ほとんどの CI/CD ツールと互換性があるため、デベロッパーはテストの実行、Kubernetes へのビルドのデプロイ、ダウンタイムなしでのアプリケーションの更新を行うことができます。現在、最も人気のある CI/CD ツールの 1 つが Jenkins です。その理由は次のとおりです。オープンソースで無料です。2. 使いやすく、インストールも簡単で、追加のインストールやコンポーネントは必要ありません。3. Jenkins の構成、変更、拡張も非常に簡単です。 4. コードを即座にデプロイし、テストレポートを生成します。5. Jenkins は、継続的インテグレーションと継続的デリバリーの要件に応じて構成できます。6. Jenkins は、OS X、Windows、Linux など、すべてのプラットフォームとさまざまなオペレーティング システムで使用できます。7. また、豊富なプラグイン エコシステムも備えています。豊富なプラグイン プールにより、Jenkins は柔軟性があり、さまざまなプラットフォームでのビルド、デプロイ、自動化が可能です。8. インテグレーション作業のほとんどは自動化されています。そのため、統合に関する問題が少なくなります。これにより、プロジェクトのライフサイクル全体で時間と費用を節約できます。
次の理由から、Kubernetes 上の Jenkins は Jenkins ユーザーの間で人気のあるテーマになっています。ただし、現在、Kubernetes 上の Jenkins に関するドキュメントをまとめた一元的な場所がないため、Kubernetes 上の Jenkins ユーザーが情報を探し回るのは困難です。このプロジェクトでは、Jenkins を実行する Kubernetes ユーザー向けのコンセプト、手法、選択肢を説明する新しい Kubernetes ソリューション ページを作成します。
現在の状態
Kubernetes で Jenkins を実行する方法に関するプレゼンテーションや記事は多数ありますが、Kubernetes での Jenkins の説明を一元化した場所はありません。これにより、次のようなことが難しくなります。 1. Kubernetes 上の Jenkins ユーザーが情報をナビゲートして見つけることができる。Kubernetes 上の Jenkins に関する情報を追跡、更新、維持する
提案されたドキュメントが現在のドキュメントよりも優れている理由
Jenkins on Kubernetes のドキュメントに関する既存の問題を解決するため、作成したこの構造に沿って、Jenkins.io に Kubernetes ソリューション ページを作成します。この [ソリューション] ページには、既存の資料と関連プロジェクトが集約されます。このプロジェクトには次のような利点があります。
- Kubernetes 上での Jenkins に関する情報をワンストップ ショップで利用できるようにすることで、Kubernetes 上での Jenkins のユーザー エクスペリエンスを向上させます。
- ソリューション ページを使用して、Kubernetes 上の Jenkins に関する情報の追跡、更新、保守を容易にします。
デベロッパーとして、何か問題を抱えていると、1 つの情報を見つけるまでに何時間もかかるという苦労を強いられます。通常であれば、情報が適切に構造化されているかどうかを確認するのに数分かかっていたはずです。このプロジェクトに取り組んだのは、Kubernetes 上の Jenkins のソリューション ページを作成することで、Jenkins ユーザーのエクスペリエンスを改善できると考えたからです。
分析
Kubernetes ソリューション ページの構造を作成しました。Kubernetes での Jenkins に関する既存の資料の一部と、役立つリソースへのリンクをまとめています。また、「プロダクトを実際に使用している組織外のユーザーの声に耳を傾け、そのペインポイントを学び、できる限り対処しなければ、本当に優れたユーザー ドキュメントを作成することはできません」という点を念頭に置き、Kubernetes ソリューション ページの新しい構造を、組織の Interswitch の Kubernetes on Jenkins ユーザーと Jenkins コミュニティのユーザーと共有し、新しいドキュメントに何を掲載してほしいかについて意見をもらいました。そのコメントは、提案された新しい構造にも記載されています。ただし、実装を開始する前に、この構造をメンターが承認して変更する必要があります。
プロジェクトの目標
Jenkins のソリューション ページまたは Jenkins を実行する Kubernetes ユーザーのためのコンセプト、手法、選択肢について説明するボリュームについて、この構造に従って新しい Kubernetes ソリューション ページを作成します。