Kubernetes 연산자의 Global Configuration Management에 대한 Singleton Pattern 적용

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
}

왜 가 예열

]는 초기화 함수가 ]]가 한 번]를, 무거운 통화의 밑에 조차 보장한다. 함수가 완료될 때까지 모든 호출자를 막아, 어떤 고라틴이 그것을 읽을 수 있기 전에 단일 톤이 완전히 건설된다는 것을 보증한다.

Singleton 테스트

단일 톤과 일반적인 우려는 테스트 가능입니다. 연산자 단위 테스트에서, 당신은 종종 모조 구성을 공급하고 싶습니다. 간단한 작업은 test Hook을 노출하는 것입니다.

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

그런 다음 테스트에서 , 설정 환경 변수, 그리고 호출 ] 신선한 인스턴스를 얻기 위해 다시. 이 패턴은 ]cert-manager과 ]Prometheus 연산자]와 같은 저명한 프로젝트에 의해 사용됩니다.

대체 접근법: ConfigMaps 및 환경변수

Singleton을 채택하기 전에 Kubernetes 생태계에서 사용할 수있는 대안을 이해하는 것이 좋습니다.

1. 환경 변수

이 간단한 가장 일반적인 방법은. 연산자의 배포는 정의 항목, 연산자는 그들을 통해 읽었다 ]. 각 구성 요소가 독립적으로 필요로하는 것을 읽는 경우 단일 톤이 필요 없습니다. 그러나,이 때 문제가 발생합니다:

• 여러 구성 요소는 동일한 값이 필요합니다. ]을 어디에나 반복합니다.
• 소스를 변경하려면 (예를 들어, env에서 파일로) – 당신은 모든 호출 사이트를 업데이트해야합니다.

2. 쿠버네티스 ConfigMaps

연산자는 종종 ConfigMap을 볼 수 있습니다. ]live configuration update]. 최신 구성을 보유하고 시계를 통해 업데이트하는 싱글톤은 자연적 적합합니다. 예를 들어:

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)
}

Singleton 패턴은 ConfigMaps를 보완합니다. 시계 routine는 단일 인스턴스를 업데이트하고 다른 모든 goroutines는 단순히 읽어줍니다.

3. 의존성 주입

가장 유연한 대안은 각 컨트롤러 또는 struct에 명시적으로 구성을 통과하는 것입니다. 이것은 테스트 기능을 개선하고 종속성을 명확하게 만듭니다. 그러나 많은 컨트롤러와 대형 연산자에서 모든 의존성을 배선 할 수 있습니다. 단일 톤은 pragmatic 중간 접지를 제공합니다.

Dependency 주입을 가진 Singleton를 비교하십시오

많은 연산자의 경우, Singleton 패턴은 default select]] 이므로 신뢰성을 희생하지 않고 코드베이스를 단순화합니다. 우선염 테스트 순도가 DI를 선호하는 팀, 그러나 오버 헤드는 종종 작은 ‐ 중간 연산자에 대해 정당화되지 않습니다.

작업자의 구성 관리에 대한 모범 사례

• Validate 구성은 eagerly] - 시작 중에 ]]를 호출하고 모든 필드를 검증합니다. 나중에 충돌하지 않는 대신 실패.
• ]기본]로 환경변수를 사용한다. ConfigMap이 실행시에 덮어들게 된다. 단 하나톤은 두 소스를 병합할 수 있다.
• Reconciler]를 통해 구성을 확장하여 디버깅을 위한 사용자 정의 리소스 상태에 효과적인 구성을 저장합니다.
• 초기화 후 싱글톤을 수정하는 것은] (제어된 업데이트 메커니즘을 구현하지 못함). 여러 goroutines에서 제어된 쓰기는 실 안전을 깰 것입니다.
• 싱글톤의 수명주기 – 특히 초기화되고 재시작할 때(보통 테스트에만 해당).
• 지침의 불균형 - 사고의 막을 방지하기 위해 복사 또는 읽기 전용 래퍼를 돌려줍니다.

피하기 위해 Pitfalls

• Using init() 함수 – ] 패키지로드 시간에서 실행, 구성 소스 이전 (환경 변수 또는 ConfigMaps와 같은) 준비 될 수 있습니다. 항상 와 함께 게으른 초기화를 사용합니다.
• 실험실안전] – 당신이 당신의 자신의 이중 검사 잠금을 구현하는 경우, 당신은 미묘한 데이터 경주를 위험. 와 스틱.
• ]글로벌 뮤텍스 - config가 한 번 설정하고 절대로 변경되는 경우, 읽힌 뮤텍스는 불필요합니다. (또는 전용 업데이트 채널을 통해 변경).
• 시험상태 – ]] 함수를 노출하지 않는 생산의 궤적. 빌드 태그 또는 별도의 테스트 패키지를 사용.

관련 기사

Singleton 패턴은 not]은 탄알이지만, 쿠버네티스 연산자의 글로벌 구성을 위해 단순성, 성능, 신뢰성의 균형을 잡은 블렌드를 제공합니다. Go’s 를 이용하여 ConfigMap watcher를 가진 싱글톤을 페어링하면, concurrency에서 사용하기 쉽고 견고하게 구성 시스템을 만듭니다.

단 하나톤과 종속성 주입 사이의 궁극적으로, 선택은 팀의 우선 순위에 달려 있습니다. 당신이 직선 코드와 빠른 내장을 값한다면, 단일 톤 접근은 당신에게 잘 봉사 할 것입니다. 광범위한 단위 테스트를 필요로하는 팀에 대한이 경로는 DI 프레임 워크에 투자 할 것입니다. 대부분의 생산 운영자는 ]Kubernetize Prometheus 연산자 및 ] [[[FLT:]]]]][[FLT:]]]][[FLT:]]]]][[[FLT:]]]]]]][[[FLT:]]]]]]]]]]]]]]]]]]]]]]]]]]]][[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[]]]]]]]]]]]]