Застосування однотонного візерунка для управління глобальними конфігураціями в операторів Kubernetes

package config

import (
 "os"
 "sync"
)

// Config holds all operator configuration.
type Config struct {
 LogLevel string
 DatabaseURL string
 // ... other fields
}

var (
 instance *Config
 once sync.Once
)

// GetConfig returns the singleton Config, initializing it on the first call.
func GetConfig() *Config {
 once.Do(func() {
 instance = &Config{
 LogLevel: getEnv("LOG_LEVEL", "info"),
 DatabaseURL: getEnv("DATABASE_URL", "localhost:5432"),
 }
 // Optionally validate or parse from a file / ConfigMap.
 })
 return instance
}

func getEnv(key, fallback string) string {
 if value, ok := os.LookupEnv(key); ok {
 return value
 }
 return fallback
}

Чому є обов'язковим

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

Тестування однотонної

Ви можете використовувати одинички, щоб виставити на екрані, щоб ви могли використовувати один з одним. Якщо ви хочете, щоб надати конфігурацію для шоку. Простота робота полягає в тому, щоб виставити , який скидає екземпляр:

// ResetForTest clears the singleton – only for use in test files.
func ResetForTest() {
 once = sync.Once{}
 instance = nil
}

Потім в тестах ви можете викликати , встановити змінні середовища та викликати знову отримати свіжу екземпляр. Цей шаблон використовується як , атест-менеджер та Оператора Прометеуса.

Альтернативні підходи: Конфігурація та навколишнє середовище мінливі

Перед прийняттям Єдиного, варто розуміти альтернативи екосистеми Кубернеця:

1. Вимірювані умови

Це найпростіший і найбільш поширений метод. Розгортання оператора проявляється записів, а оператор читає їх через . Немає необхідності, якщо кожен компонент читає, що він потребує самостійно. Однак це стає проблемою при:

• Кілька компонентів потрібно однакове значення – ви повторите всюди.
• Ви хочете змінити джерело (наприклад, від env до файлу) – ви повинні оновити кожен сайт виклику.

2. Кубернети Конфігурації

Оператори часто дивляться на ConfigMap для того, щоб оновлення лівої конфігурації . Одинтон, який має останню конфігурацію і оновлення його через годинник є природним придатним. Наприклад:

func WatchConfigMap(ctx context.Context, client kubernetes.Interface, namespace, name string) {
 watcher, _ := client.CoreV1().ConfigMaps(namespace).Watch(ctx, metav1.ListOptions{FieldSelector: "metadata.name=" + name})
 for event := range watcher.ResultChan() {
 cm := event.Object.(*v1.ConfigMap)
 updateFromConfigMap(cm)
 }
}

func updateFromConfigMap(cm *v1.ConfigMap) {
 // Write to a global singleton.
 configSingleton.Update(cm.Data)
}

У єдиному шаблоні доповнюється ConfigMaps: годинник рутальні оновлення одиночної екземпляри, а всі іншігорутини просто читають з неї.

3. В'язкість

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

Порівняти однотон з ін'еккцією залежностей

Для багатьох операторів, одинокий візерунок є вибір дерев'я, оскільки він спрощує базу коду без шкоди надійності. Команди, які передовітні тести чистоти можуть віддавати перевагу DI, але наклад часто не вирівняні для малих операторів ‐to‐medium.

Кращі практики управління конфігурацією операторів

• Validateconfig eagerly – Call одноразово під час запуску та перевірки всіх полів. Швидко перенесіть замість аварійного завершення.
• Використовувати змінні середовища як за замовчуванням] – Додайте настройку на перенапругу їх у режимі runtime. Одинок може об'єднати обидва джерела.
• Експозальна конфігурація через конденсатор – Деякі оператори зберігають ефективну конфігурацію в користувальницьких ресурсах для відбілювання.
• Авоі модифікації єдинона після ініціалізації (не вдається в дію керованого механізму оновлення). Неконтрольовані записи з декількох горутин буде розірвати безпеку ниток.
• Документ життєвого циклу єдинонатона – Тим більше, як він ініціюється, і при скиданнях дозволено (зазвичай тільки в тестах).
• Consider immutability – Повернути копію або читання-на-тільки обгортач для запобігання випадковому мутації.

Питпади, щоб уникнути

• Узинг init() функції] – працює в режимі завантаження пакета, перед тим як конфігурувати джерела (як змінні середовища або ConfigMaps) може бути готовим. Завжди використовуйте ініціалізація з лінзи .
• Форгування безпеки ниток – Якщо ви впровадите свій власний подвійно-зчепний замок, ви ризикуєте тонкими гонками даних. Наклейка .
• Over‐complicating with Global mutexes – Читать мутекс для кожного налаштування, непотрібно, якщо налаштування встановлюється один раз і ніколи не змінено (або змінено через виділений канал оновлення).
• Забезпечити стан тесту] – Забезпечити функція не піддається виробці бункерів. Використовуйте будувати теги або окремий тестовий пакет.

Висновок

Патерн "Сучасний" не] - срібна куля, але для глобальної конфігурації в операторах Kubernetes вона пропонує збалансовану суміш простоти, продуктивності та надійності. Використовуючи Go's і парі з однотонним годинником ConfigMap, ви створюєте конфігурацію системи, яка легко використовувати і надійно під вагою.

В кінцевому підсумку вибір між однотонним і залежностям ін'єкції залежить від пріоритетів команди. Якщо ви цінуєте прямий код і швидкий на борту, то однотонний підхід буде служити вам добре. Для команд, які потребують великого тестування блоку і готові інвестувати в DI-фреймворк, що шлях також діє. Більшість операторів виробництва - включаючи Кубернети Prometheus Operator і Ingress NGINX Controller - Використовуйте одинонтон для їх основного налаштування. Прийняти цей шаблон може призвести до більш стійких і послідовних операторів.