第2章 API 互換性ガイドラインについて
このガイダンスでは、レイヤー化された OpenShift Container Platform オファリングを説明しません。
2.1. API 互換性ガイドライン リンクのコピーリンクがクリップボードにコピーされました!
Red Hat は、OpenShift Container Platform との互換性を向上させるために、アプリケーション開発者が以下の原則を採用することを推奨しています。
- アプリケーションのニーズに一致するサポート層を備えた API とコンポーネントを使用します。
- 可能な場合は、公開されたクライアントライブラリーを使用してアプリケーションを構築します。
- アプリケーションが正しく実行されることが保証されるのは、そのアプリケーションが実行対象として構築された環境と同じくらい新しい環境で実行された場合に限ります。OpenShift Container Platform 4.14 用にビルドされたアプリケーションが OpenShift Container Platform 4.13 で正常に機能することは保証されません。
- システムパッケージまたは他のコンポーネントにより提供される設定ファイルに依存するアプリケーションを設計しないでください。アップストリームコミュニティーが、それを保存するように明示的にコミットしない限り、このファイルはバージョン間で変更する場合があります。必要に応じて、前方互換性を維持するために、この設定ファイルに対して Red Hat が提供するインターフェイス抽象化に依存します。設定ファイルを直接ファイルシステムで変更することは推奨しません。デュアルライターの競合を回避するために、利用可能な場合は、Operator が提供する API と統合することが強く推奨されます。
-
unsupported<FieldName>の接頭辞が付いた API フィールドや、製品ドキュメントに明示的に記載されていないアノテーションに依存しないでください。 - お使いのアプリケーションより互換性の保証が短いコンポーネントには依存しないでください。
- etcd サーバーで直接ストレージ操作を実行しないでください。すべての etcd アクセスは、api-server を介して、または文書化されたバックアップと復元の手順を介して実行する必要があります。
Red Hat は、アプリケーション開発者が Red Hat Enterprise Linux (RHEL) によって定義された 互換性ガイドライン に従うことを推奨しています。OpenShift Container Platform は、プラットフォーム上でアプリケーションを構築またはホストする際に、以下のガイドラインを強く推奨します。
- 特定の Linux カーネルまたは OpenShift Container Platform のバージョンに依存しないでください。
-
proc、sys、およびdebugファイルシステム、または他の擬似ファイルシステムから読み込みは避けてください。 -
ioctlsは使用せず、ハードウェアと直接対話してください。 -
コンテナー実行環境を提供する OpenShift Container Platform ホストエージェントと競合しないように、
cgroupとの直接の対話を避けてください。
リリースのライフサイクルの間、Red Hat は、すべてのマイナーリリースと z-stream リリース間で API とアプリケーションオペレーティング環境 (AOE) の互換性を維持するために商業的に合理的な努力をします。ただし、必要に応じて、重大影響を及ぼすセキュリティー問題や、その他の重要な問題に対処するために、この互換性維持の目標に Red Hat が例外を設けることがあります。
2.2. API の互換性例外 リンクのコピーリンクがクリップボードにコピーされました!
以下は、OpenShift Container Platform での互換性の例外です。
2.2.1. サポートされている Operator で行われていない RHEL CoreOS ファイルシステムの変更 リンクのコピーリンクがクリップボードにコピーされました!
現時点では、ホストオペレーティングファイルシステムに加えられた変更がマイナーリリース間で保持されるという保証はありません。ただし、その変更が、Machine Config Operator や Node Tuning Operator などのサポートされている Operator を介して公開されたパブリックインターフェイスを介して行われる場合を除きます。
2.2.2. クラウドまたは仮想化環境でのクラスターインフラストラクチャーの変更 リンクのコピーリンクがクリップボードにコピーされました!
現時点では、クラスターをサポートするクラウドホスティング環境への変更が保持されるという保証はありません。ただし、その変更が製品で公開されているパブリックインターフェイスを介して行われる場合、またはサポートされる設定として文書化されている場合を除きます。クラスターインフラストラクチャープロバイダーは、API を介して製品にその権限を委任する場合を除いて、クラウドまたは仮想化インフラストラクチャーを維持する責任があります。
2.2.3. アップグレードされたクラスターと新規インストールの間の機能のデフォルト リンクのコピーリンクがクリップボードにコピーされました!
現時点では、製品のマイナーリリースの新規インストールが、以前のマイナーリリースでインストールされ、同等のバージョンにアップグレードされた製品のバージョンと同じ機能デフォルトになるという保証はありません。たとえば、製品の今後のバージョンでは、以前のマイナーバージョンとは異なるデフォルト設定で、クラウドインフラストラクチャーがプロビジョニングされる可能性があります。さらに、選択されていたセキュリティーに関するデフォルトの内容は、今後の製品バージョンと、過去の製品バージョンで異なる場合があります。製品の過去のバージョンはアップグレードされますが、特に下位互換性を維持するために、必要に応じて従来の選択肢が保持されます。
2.2.4. "unsupported” または undocumented annotations の接頭辞を持つ API フィールドの使用 リンクのコピーリンクがクリップボードにコピーされました!
製品内の一部の API は、unsupported<FieldName> のプレフィックスが付いたフィールドを公開します。現時点では、このフィールドの使用がリリース間または同一リリース内でサポートされるという保証はありません。製品サポートは、特定の問題をデバッグする場合に、このフィールドで値を指定するようにお客様に依頼することはできますが、それ以外での使用はサポートされていません。明示的に文書化されていないオブジェクトでのアノテーションの使用に関しては、マイナーリリース間でのサポートは保証されていません。
2.2.5. 製品インストールトポロジーごとの API の可用性 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift ディストリビューションは、サポートされているインストールトポロジーを進化させ続け、あるインストールトポロジーのすべての API が必ずしも別のトポロジーに含まれるとは限りません。たとえば、特定のトポロジーでは、製品のインストールトポロジーと競合している場合、またはそのトポロジーに関連しておらず、特定の API がまったく含まれていない場合に、特定の API への読み取り/書き込みアクセスを制限できます。特定のトポロジーに存在する API は、上記で定義した互換性の階層に従ってサポートされます。
2.3. API の互換性の一般的な用語 リンクのコピーリンクがクリップボードにコピーされました!
この用語集では、API、Application Operating Environment (AOE)、リリースバージョンタイプ、サポート層など、OpenShift Container Platform API の互換性の一般的な用語を定義します。
2.3.1. アプリケーションプログラミングインターフェイス (API) リンクのコピーリンクがクリップボードにコピーされました!
API は、他のソフトウェアとの対話を可能にするソフトウェアプログラムにより実装されるパブリックインターフェイスです。OpenShift Container Platform では、API は中央の API サーバーから提供され、すべてのシステム対話のハブとして使用されます。
2.3.2. アプリケーションオペレーティング環境 (AOE) リンクのコピーリンクがクリップボードにコピーされました!
AOE は、エンドユーザーアプリケーションプログラムを実行する統合環境です。AOE は、ホストオペレーティングシステム (OS) からの分離を提供するコンテナー化された環境です。少なくとも、AOE を使用すると、アプリケーションはホスト OS のライブラリーやバイナリーから分離された状態で実行できますが、ホスト上の他のすべてのコンテナーと同じ OS カーネルを共有できます。AOE はランタイム時に適用され、アプリケーションとそのオペレーティングシステム間のインターフェイスを記述します。これには、プラットフォーム、オペレーティングシステム、および環境間の交差点が含まれ、ユーザーアプリケーションには、Downward API、DNS、リソースアカウンティング、デバイスアクセス、プラットフォームワークロード ID、コンテナー間の分離、コンテナーとホスト OS との間の分離が含まれます。
AOE には、Container Network Interface (CNI) プラグインの選択や、アドミッションフックをはじめとした製品の拡張機能など、インストールにより異なる可能性のあるコンポーネントは含まれていません。コンテナー環境より下層のクラスターと統合するコンポーネントは、バージョン間で追加のバリエーションが適用される場合があります。
2.3.3. 仮想化環境における互換性 リンクのコピーリンクがクリップボードにコピーされました!
仮想環境はベアメタル環境をエミュレートするため、ベアメタル環境で動作する非特権アプリケーションは、対応する仮想環境でも変更されずに実行されます。仮想環境は、物理リソースが抽象化された簡易ビューを表示するため、相違点がいくつか存在する場合があります。
2.3.4. クラウド環境での互換性 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform は、クラウドプロバイダー固有の統合を介してホスティングクラウド環境との統合ポイントを提供することを選択する場合があります。これらの統合ポイントの互換性は、ネイティブクラウドベンダーが提供する保証や、OpenShift Container Platform の互換性ウィンドウとの交差部分に固有のものです。OpenShift Container Platform がデフォルトのインストールの一部としてクラウド環境との統合をネイティブに提供する場合、Red Hat は安定したクラウド API エンドポイントに対して開発し、安定した非推奨ポリシーを含む将来を見据えた互換性を備えた商業的に合理的なサポートを提供します。クラウドプロバイダーと OpenShift Container Platform の統合の例には、動的ボリュームプロビジョニング、サービスロードバランサー統合、Pod ワークロード ID、コンピューティングの動的管理、初期インストールの一部としてプロビジョニングされるインフラストラクチャーが含まれますが、これらに限定されません。
2.3.5. major、minor、および z-stream リリース リンクのコピーリンクがクリップボードにコピーされました!
Red Hat メジャーリリースは、製品開発における重要なステップを表します。マイナーリリースは、メジャーリリースの範囲内でより頻繁に表示され、今後のアプリケーションの互換性に影響を与える可能性のある非推奨の境界を表します。z-stream リリースは、マイナーリリースへの更新で、関連するマイナーリリースに継続的な修正のストリームを提供します。予期しないセキュリティーの影響に対応するためにこのポリシーが明示的にオーバーライドされる場合を除いて、z-stream リリースで API と AOE の互換性が損なわれることはありません。
たとえば、リリース 4.13.2 では、以下のようになります。
- 4 は、メジャーリリースのバージョンです。
- 13 は、マイナーリリースのバージョンです。
- 2 は、z-stream リリースバージョンです。
2.3.6. 拡張ユーザーサポート (EUS) リンクのコピーリンクがクリップボードにコピーされました!
重大なバグ修正のための拡張サポートウィンドウを備えた OpenShift Container Platform メジャーリリースのマイナーリリース。ユーザーは、EUS リリース間でマイナーバージョンを段階的に採用することにより、EUS リリース間で移行できます。非推奨ポリシーは、EUS リリース間ではなくマイナーリリース間で定義されることに留意することが重要です。その結果、EUS ユーザーは、各マイナーリリースを順次アップグレードしながら将来の EUS に移行するときに、非推奨に対応しなければならない場合があります。
2.3.7. 開発者プレビュー リンクのコピーリンクがクリップボードにコピーされました!
Red Hat が正式にサポートしていないオプションの製品機能ですが、初期段階のテクノロジーを探索するメカニズムを提供することを目的としています。デフォルトでは、Developer Preview 機能はオプトインであり、いつでも削除される可能性があります。開発者プレビュー機能を有効にすると、機能のスコープによってクラスターがサポートされない可能性があります。
Red ()Hat のお客様またはパートナーで、これらの開発者プレビューバージョンに関するフィードバックがある場合は、OpenShift Bugs tracker を使用して問題を提出してください。公式の Red Hat サポートサービスチケットプロセスを使用しないでください。
2.3.8. テクノロジープレビュー リンクのコピーリンクがクリップボードにコピーされました!
機能をテストし、開発プロセス中にフィードバックを提供するために、今後の製品イノベーションへの早期アクセスを提供するオプションの製品機能。この機能は完全にはサポートされておらず、機能的に完全ではない可能性があり、実稼働での使用を目的としていません。テクノロジープレビューの機能を使用するには、明示的なオプトインが必要です。