stackabletech / stackabletech/documentation

Add a generic section on how to mount extra data into our images

オープン
#779 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
CSS
スター
13
フォーク
14
平均マージ
4日 8時間
マージ済み PR(30日)
10

説明

We regularly get questions about how to add binaries or other files into our images at runtime.
There are a few options that we recommend and it differs per operator because not all of them support extra_volumes, but we never wrote this down in a structured fashion and picked a recommended option.

Lets add a section to the docs and spell out the main three or four options along with pros and cons and also mention what not to do.

Possible ways:

  • mount OCI artifact
  • copy to PV and mount that
  • init container to download and copy
  • gitsync

Not recommended:

  • stick binary data into a ConfigMap or Secret

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

適切な共有ドキュメントセクションを特定し、既存の operator ページでランタイムデータと volume オプションがどのように説明されているかを確認します。OCI artifacts、persistent volume へのコピー、init container、gitsync を扱う構造化されたセクションを追加し、それぞれの利点と欠点、およびバイナリデータを ConfigMaps や Secrets に置かないよう警告する内容を含めます。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
kubernetes
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。