Singleton-mallin soveltaminen globaaliin konfiguraatiohallintaan Kubernetes-operaattoreissa

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
}

Miksi on mieluisaa

Käyttämällä takaa, että alustustoiminto toimii []täsmällisesti kerran[], jopa raskaan valuutan alla. [-menetelmä estää kaikki soittajat kunnes toiminto valmistuu, varmistaen, että singleton on täysin rakennettu ennen kuin mikään gorutiini voi lukea sen.

Singletonin testaus

Yksinkertainen huoli singletonsien kanssa on testauskelpoisuus. Käyttäjäyksikön testeissä halutaan usein antaa mallikokoonpano. Yksinkertainen työ on paljastaa ]testikoukku[], joka palauttaa instanssin:

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

Sitten testeissä voit soittaa , asettaa ympäristömuuttujia, ja soittaa uudelleen saadaksesi uuden instanssin. Tätä mallia käytetään näkyvissä projekteissa kuten cert-manager[] ja [ Prometheus Operaattori[.

Vaihtoehtoiset lähestymistavat: ConfigMaps and Environment Muuttujat

Ennen kuin se hyväksyy Singleton, se ... kannattaa ymmärtää vaihtoehtoja saatavilla Kubernetes ekosysteemi:

1. Ympäristömuuttujat

Nämä ovat yksinkertaisin ja yleisin menetelmä. Operaattorin käyttöönottoluettelossa määritellään [ merkinnät, ja operaattori lukee ne [] kautta. Singletonia ei tarvita, jos jokainen komponentti lukee mitä se tarvitsee itsenäisesti. Tämä tulee kuitenkin ongelmaksi, kun:

• Useat komponentit tarvitsevat saman arvon .........................................................................................................................................................................................................................................................
• Haluat muuttaa lähde (esim., env tiedosto) ... sinun täytyy päivittää jokainen puhelusivusto.

2. Kubernetes-asetukset

Operaattorit usein katsella ConfigMap mahdollistaa [live asetukset päivitykset[. Yksinkertainen, joka pitää uusimman config ja päivittää sen kautta kello on luonnollinen istuvuus. Esimerkiksi:

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-kuvio täydentää ConfigMaps-tiedostoja: katsella rutiinipäivittää yhden instanssin ja kaikki muut goroutiinit yksinkertaisesti lukea siitä.

3. Riippuvuus injektiosta

Joustavin vaihtoehto on siirtää konfiguraatio erikseen kullekin ohjaimelle tai rakennukselle. Tämä parantaa testaavuutta ja tekee riippuvuussuhteista selkeitä. Suuressa operaattorissa, jossa on monia ohjaimia, johdotus kaikki riippuvuudet voivat tulla verbose.

Singletonin vertaaminen riippuvuusinjektioon

Monille operaattoreille Singleton-malli on -oletusvalinta[, koska se yksinkertaistaa koodikantaa uhraamatta luotettavuutta. Testipuhtautta painottavat ryhmät saattavat suosia DI-testiä, mutta yleiskustannukset eivät useinkaan ole perusteltuja pienille ja keskisuurille toimijoille.

Parhaat käytännöt operaattorien konfigurointien johtamisessa

• Valitaan asetukset innokkaasti [ . . . Call kerran käynnistyksen aikana ja validoi kaikki kentät. Epäonnistu nopeasti kaatumisen sijaan.
• Käytä ympäristömuuttujia olettamina[ ... ....................................................................................................................................................................................................................................
• Elistä konfiguraatio sovittimen [ kautta ... .................................................................................................................................................................................................................................
• Vältä singletonin muuttamista alustamisen jälkeen[ (ellet toteuta hallittua päivitysmekanismia). Useiden goroutiinien hallitsemattomat kirjoitukset rikkovat lankaturvallisuuden.
• Asiakirja singleton...................................................................................................................................................................................................................................................
• Myönnä muuttumattomuus[] . Palauta kopio tai vain luettava kääre, jotta vältytään vahingossa tapahtuvalta mutaatiolta.