1.3. API の非推奨ポリシー

Red Hat build of MicroShift は、一連の構造化された API を介して、複数のコンポーネントがクラスターコントロールプレーンによって管理される共有状態と相互作用する分散システムです。Kubernetes の規則に従って、Red Hat build of MicroShift によって提示される各 API はグループ識別子に関連付けられ、各 API グループは個別にバージョン管理されます。各 API グループは、Kubernetes、Metal3、Multus、Operator Framework、Open Cluster Management、OpenShift 自体などを含む個別のアップストリームコミュニティーで管理されます。

各アップストリームコミュニティーは、特定の API グループおよびバージョンに対して固有の非推奨ポリシーを定義する場合がありますが、Red Hat はコミュニティー固有のポリシーを各アップストリームコミュニティーの統合と認識に基づいて定義された互換性レベルのいずれかに正規化し、エンドユーザーの消費やサポートを簡素化します。

API の非推奨ポリシーとスケジュールは、互換性レベルによって異なります。

非推奨ポリシーは、API のすべての要素を対象とします。以下に例を示します。

各グループの最新の API バージョンを除き、古い API バージョンは、次の期間以上、非推奨が発表された後にサポートされる必要があります。

次のルールは、すべての Tier1API に適用されます。

クライアント向けの CLI コマンドは、API と同じ方法でバージョン管理されていませんが、ユーザー向けのコンポーネントシステムです。ユーザーが CLI を操作する 2 つの主な方法は、コマンドまたはフラグを使用することです。これは、このコンテキストでは CLI 要素と呼ばれます。

特に明記されていない限り、または CLI が下位層の API に依存している場合を除き、すべての CLI 要素はデフォルトで API 層 1 になります。

コンポーネント全体を非推奨にする期間とスケジュールは、そのコンポーネントによって公開されている API の最上位 API 層に関連付けられている期間に直接マップされます。たとえば、ティア 1 とティア 2 の API を表面化したコンポーネントは、ティア 1 の非推奨スケジュールが満たされるまで削除できませんでした。