Функції etcd

Цей документ надає огляд функцій etcd, щоб допомогти користувачам краще зрозуміти функції та повʼязаний процес їх застарівання. Якщо вас цікавить, як функції розробляються в etcd, будь ласка, перегляньте ці керівні принципи розробки.

Функції etcd поділяються на три стадії: експериментальні, стабільні та небезпечні. Ви можете отримати список функцій, запустивши etcd --help.

Експериментальні

Щоб отримати ранній зворотний звʼязок, будь-яка нова функція зазвичай додається як експериментальна. Експериментальну функцію можна визначити за назвою прапорця, яка повинна мати префікс --experimental. Будь ласка, врахуйте наступні моменти під час використання експериментальної функції:

• Вона може бути з помилками через відсутність користувацького тестування. Увімкнення функції може не працювати як очікується.
• Вона стандартно вимкнена.
• Підтримка такої функції може бути припинена в будь-який час без попередження.
  • Вона може бути видалена в наступному мінорному або мажорному випуску без дотримання політики застарівання функцій, якщо вона не перейде до стабільної фази.
  • Команда проєкту буде вдячна користувачам за повідомлення про будь-які проблеми, повʼязані з експериментальними функціями. Однак такі проблеми можуть мати нижчий пріоритет порівняно з проблемами, повʼязаними зі стабільними функціями.
• Експериментальний прапорець функції прибирається, коли вона переходить до стабільної стадії. Користувачі повинні почати використовувати стабільний прапорець функції якомога швидше.

Стабільні

Це найпоширеніша стадія функцій в etcd. Стабільна функція характеризується наступним:

• Підтримується як частина підтримуваних випусків etcd.
• Може бути стандартно увімкнена.
• Припинення підтримки повинно відповідати політиці застарівання функцій.

Небезпечні

Небезпечні функції рідкісні та перераховані в розділі Unsafe feature: в документації з використання etcd. Стандартно вони вимкнені. Їх слід використовувати з обережністю, дотримуючись документації. Небезпечна функція може бути видалена в наступному мінорному або мажорному випуску без дотримання політики застарівання функцій.

Застарівання функцій

Експериментальні

Експериментальна функція застаріває, коли вона переходить до стабільної стадії.

• Документація експериментальної функції буде містити повідомлення про застарівання з рекомендацією використовувати повʼязаний стабільний прапорець функції, наприклад, DEPRECATED. Use <feature-name> instead.
• Застаріла функція буде видалена в наступному випуску.

Стабільні

У міру розвитку проєкту стабільна функція іноді може потребувати застарівання та видалення. Коли це відбувається,

• Документація функції буде містити попереджувальне повідомлення перед запланованим випуском про застарівання, наприклад, To be deprecated in <release>.. Якщо нова функція вже запланована для заміни функції, що застаріває, то документація також надасть повідомлення про це, наприклад, Use <feature-name> instead.
• Функція буде визнаня застарілою в запланованому випуску. У цей час документація функції буде містити повідомлення про застарівання з рекомендацією використовувати повʼязану стабільну функцію, наприклад, DEPRECATED. Use <feature-name> instead.
• Застаріла функція буде видалена в наступному випуску.