Linux パッケージの非推奨ポリシー

Linuxパッケージには様々なライブラリやサービスが付属しており、ユーザーに多くの設定オプションを提供しています。

ライブラリやサービスが更新されると、それらの設定オプションは変更され、時代遅れになります。メンテナーを向上させ、動作するセットアップを維持するためには、様々な設定を削除する必要があります。

設定の廃止

ポリシー

Linux パッケージは少なくとも一つのメジャーバージョンの設定を保持します。非推奨の設定が次のメジャーリリースで利用できることを保証することはできません。詳細は例を参照してください。

注意

設定が古くなった場合は、非推奨となることをお知らせします:

  • リリースのブログ記事https://about.gitlab.com/blog/ をご覧ください。ブログの投稿項目には、非推奨の通知と削除予定日が含まれています。
  • インストール/再設定出力経由(該当する場合)。
  • https://docs.gitlab.com/ の公式ドキュメントを参照してください。ドキュメントの更新には、修正された構文 (該当する場合) または設定の削除日が含まれます。

手順

このセクションでは、設定の廃止と削除に必要な手順を示します。

設定には2つの種類があります:

  • 機密:重大なサービス停止を引き起こす可能性のある設定 (データの完全性、インストールの完全性、ユーザーがインストールに到達できないようにする設定など)
  • 通常:機能を使用できなくする可能性があるが、インストールは使用可能な設定 (デフォルトのプロジェクト/グループ設定の変更、他のコンポーネントとの誤通信など)

非推奨と削除の手順も区別しなければなりません。

非推奨設定

非推奨の手順は、sensitiveregular のどちらの設定でも同様です。唯一の違いは削除目標日です。

共通の手順

  1. omnibus-gitlab のイシュー・トラッカー に、非推奨タイプの詳細やその他必要な情報を添えてイシューを作成してください。ラベルを適用deprecation
  2. 非推奨設定の削除対象を決定します。
  3. 各項目について、「通知」セクションに記載された非推奨通知を策定

削除対象

通常の設定の場合、削除対象は常に次のメジャーリリースの日付であるべきです。日付がわからない場合は、次のメジャーバージョンを参照することができます。

センシティブ設定の場合は少し複雑です。次のメジャーリリースが2マイナーリリース先である場合、次のメジャーリリースでは機密設定を削除しないことを目標にすべきです (この数字はセキュリティバックポートのリリースポリシーと一致するように選択されています)。

いくつかの例については以下の表を参照してください:

設定タイプ廃止のお知らせ最終マイナーリリース削除
センシティブ10.1.010.9.011.0.0
センシティブ10.7.010.9.012.0.0
レギュラー10.1.010.9.011.0.0
レギュラー10.8.010.9.011.0.0

設定の削除

非推奨化が発表され、削除対象が設定された場合、イシューのマイルストーンは削除対象のバージョンに合わせて変更されるべきです。

イシューの最終コメントには

  1. リリース・ブログ記事セクションのテキスト・スニペット
  2. 変更を紹介するドキュメントMR ( またはスニペット )
  3. 設定を削除する MR (草案)、または何をしなければならないかの詳細。これについては非推奨メッセージの追加 を参照してください。

物件例

/etc/gitlab/gitlab.rb で利用可能なユーザー設定はGitLabバージョン10.0で導入されたgitlab_rails['configuration'] = true 。 GitLabバージョン10.4.0では、この設定オプションの名前を変更する必要がある新しい変更が導入されました。新しい設定オプションはgitlab_rails['better_configuration'] = trueです。開発者は古い設定を新しい設定に変換し、非推奨化手続きを開始します。

つまり、これら2つの設定オプションはGitLabバージョン10まで有効です。言い換えると、GitLab 10.8.0でもgitlab_rails['configuration'] = truegitlab_rails['better_configuration'] = true 。この機能は、 を設定した場合と同じように機能し続けます。しかし、古いバージョンの設定をすると、インストール/アップグレード/再設定の最後に非推奨の通知が出力されます。

GitLab 11 では、gitlab_rails['configuration'] = true が機能しなくなったため、/etc/gitlab/gitlab.rb の設定を手動で新しい有効な設定に変更する必要があります。注意この設定オプションが機密性の高いもので、インテグレーションやデータの完全性を危険にさらす可能性がある場合、インストールやアップグレードは中断されます。