etcdの機能

このドキュメントでは、etcdの機能と、それに関連する非推奨化の手続きを理解できるよう、機能の概要を説明します。etcdで機能を開発する方法については、開発ガイドライン を参照してください。

etcdの機能には、「実験的」「安定」「安全でない」の3つの段階があります。etcd --helpを実行すると、機能の一覧を確認できます。

実験的

早期にフィードバックを得るため、新機能は通常、実験的機能として追加されます。実験的機能はフラグ名で識別でき、その名前には--experimentalという接頭辞が付くはずです。実験的機能を使うときは、次の点を考慮してください。

• ユーザーによるテストが不足しているため、バグが残っている可能性があります。有効にしても、期待どおりに動作しない場合があります。
• デフォルトでは無効です。
• 予告なく、いつでもサポートが打ち切られる可能性があります。
  • 安定した機能に昇格しない限り、機能の非推奨化 ポリシーに従わず、次のマイナーリリースまたはメジャーリリースで削除されることがあります。
  • プロジェクトチームは、実験的機能に関する問題の報告を歓迎します。ただし、安定した機能の問題より優先順位が低くなる場合があります。
• 実験的機能が安定した段階に昇格すると、その機能フラグは非推奨になります 。できるだけ早く、安定した機能のフラグに切り替えてください。

安定

etcdの機能で最も一般的な段階です。安定した機能には、次の特徴があります。

• サポート対象のetcdリリースの一部としてサポートされます。
• デフォルトで有効になっている場合があります。
• サポートを終了する際は、機能の非推奨化 ポリシーに従う必要があります。

安全でない

安全でない機能は少数で、etcdの使用法ドキュメントのUnsafe feature:セクションに記載されています。デフォルトでは無効です。ドキュメントに従い、慎重に使用してください。安全でない機能は、機能の非推奨化ポリシーに従わず、次のマイナーリリースまたはメジャーリリースで削除されることがあります。

機能の非推奨化

実験的

実験的機能は、安定した段階に昇格すると非推奨になります。

• 実験的機能のドキュメントには、関連する安定した機能のフラグを使うよう推奨する非推奨メッセージが表示されます。例：DEPRECATED. Use <feature-name> instead.
• 非推奨になった機能は、次のリリースで削除されます。

安定

プロジェクトの発展に伴い、安定した機能を非推奨にして削除する必要が生じることがあります。その場合は、次のように対応します。

• 非推奨化を予定しているリリースの前に、機能のドキュメントに警告メッセージを表示します。例：To be deprecated in <release>.。To be deprecatedとされた機能を置き換える新機能がすでに計画されている場合は、その旨もドキュメントに記載します。例：Use <feature-name> instead.。
• 予定されたリリースで機能を非推奨にします。この時点で、機能のドキュメントには、関連する安定した機能を使うよう推奨する非推奨メッセージが表示されます。例：DEPRECATED. Use <feature-name> instead.
• 非推奨になった機能は、次のリリースで削除されます。