कुबेरनेट्स के अंदर और बाहर प्रोजेक्ट कॉन्फ़िगरेशन

मैंने हाल ही में लिखा है डॉकर में प्रोजेक्ट जीवन और उसके बाहर डिबगिंग कोड के बारे में उत्तर दें, जहां उन्होंने संक्षेप में उल्लेख किया कि आप अपना स्वयं का कॉन्फ़िगरेशन सिस्टम बना सकते हैं ताकि सेवा कुबेर में अच्छी तरह से काम करे, रहस्यों को उजागर करे, और स्थानीय रूप से सुविधाजनक रूप से चले, यहां तक ​​कि डॉकर के बाहर भी। कुछ भी जटिल नहीं है, लेकिन वर्णित "नुस्खा" किसी के लिए उपयोगी हो सकता है :) कोड पायथन में है, लेकिन तर्क भाषा से बंधा नहीं है।

प्रश्न की पृष्ठभूमि यह है: एक बार एक परियोजना थी, पहले यह उपयोगिताओं और स्क्रिप्ट के साथ एक छोटा सा मोनोलिथ था, लेकिन समय के साथ यह बढ़ता गया, सेवाओं में विभाजित हो गया, जो बदले में माइक्रोसर्विसेज में विभाजित होने लगा, और फिर बड़ा किया गया. सबसे पहले, यह सब नंगे वीपीएस पर किया गया था, जिस पर कोड स्थापित करने और तैनात करने की प्रक्रिया Ansible का उपयोग करके स्वचालित की गई थी, और प्रत्येक सेवा को आवश्यक सेटिंग्स और कुंजियों के साथ एक YAML कॉन्फ़िगरेशन के साथ संकलित किया गया था, और एक समान कॉन्फ़िगरेशन फ़ाइल का उपयोग किया गया था स्थानीय लॉन्च, जो बहुत सुविधाजनक था, क्योंकि .k यह कॉन्फ़िगरेशन एक वैश्विक ऑब्जेक्ट में लोड किया गया है, जो प्रोजेक्ट में कहीं से भी पहुंच योग्य है।

हालाँकि, माइक्रोसर्विसेज की संख्या, उनके कनेक्शन और में वृद्धि केंद्रीकृत लॉगिंग और निगरानी की आवश्यकता, कुबेर की ओर एक कदम का पूर्वाभास दिया, जो अभी भी जारी है। उल्लिखित समस्याओं को हल करने में सहायता के साथ, कुबेरनेट्स बुनियादी ढांचे के प्रबंधन सहित अपने दृष्टिकोण प्रदान करता है तथाकथित रहस्य и उनके साथ काम करने के तरीके. तंत्र मानक और विश्वसनीय है, इसलिए इसका उपयोग न करना वस्तुतः पाप है! लेकिन साथ ही, मैं कॉन्फ़िगरेशन के साथ काम करने के लिए अपने वर्तमान प्रारूप को बनाए रखना चाहूंगा: सबसे पहले, इसे प्रोजेक्ट के विभिन्न माइक्रोसर्विसेज में समान रूप से उपयोग करना, और दूसरा, एक सरल का उपयोग करके स्थानीय मशीन पर कोड चलाने में सक्षम होना कॉन्फ़िगरेशन फ़ाइल.

इस संबंध में, कॉन्फ़िगरेशन ऑब्जेक्ट के निर्माण के तंत्र को हमारी क्लासिक कॉन्फ़िगरेशन फ़ाइल और कुबेर के रहस्यों दोनों के साथ काम करने में सक्षम होने के लिए संशोधित किया गया था। तीसरे पायथन की भाषा में एक अधिक कठोर कॉन्फ़िगरेशन संरचना भी निर्दिष्ट की गई थी, जो इस प्रकार है:

डिक्ट[str, डिक्ट[str, यूनियन[str, int, फ्लोट]]]

अर्थात्, अंतिम कॉगफिग नामित अनुभागों वाला एक शब्दकोश है, जिनमें से प्रत्येक सरल प्रकारों के मूल्यों वाला एक शब्दकोश है। और अनुभाग एक निश्चित प्रकार के संसाधनों के कॉन्फ़िगरेशन और पहुंच का वर्णन करते हैं। हमारे कॉन्फ़िगरेशन के एक टुकड़े का एक उदाहरण:

adminka:
  django_secret: "ExtraLongAndHardCode"

db_main:
  engine: mysql
  host: 256.128.64.32
  user: cool_user
  password: "SuperHardPassword"

redis:
  host: 256.128.64.32
  pw: "SuperHardPassword"
  port: 26379

smtp:
  server: smtp.gmail.com
  port: 465
  email: [email protected]
  pw: "SuperHardPassword"

उसी समय, मैदान engine डेटाबेस को SQLite पर स्थापित किया जा सकता है, और redis करने के लिए सेट mock, सहेजने के लिए फ़ाइल का नाम भी निर्दिष्ट करना - इन मापदंडों को सही ढंग से पहचाना और संसाधित किया जाता है, जिससे डिबगिंग, यूनिट परीक्षण और किसी भी अन्य आवश्यकताओं के लिए स्थानीय रूप से कोड को चलाना आसान हो जाता है। यह हमारे लिए विशेष रूप से महत्वपूर्ण है क्योंकि कई अन्य ज़रूरतें हैं - हमारे कोड का हिस्सा विभिन्न विश्लेषणात्मक गणनाओं के लिए है, यह न केवल ऑर्केस्ट्रेशन वाले सर्वर पर चलता है, बल्कि विभिन्न स्क्रिप्ट के साथ, और विश्लेषकों के कंप्यूटर पर भी चलता है जिन्हें काम करने की आवश्यकता होती है और बैकएंड समस्याओं की चिंता किए बिना जटिल डेटा प्रोसेसिंग पाइपलाइनों को डीबग करें। वैसे, यह साझा करने में कोई हर्ज नहीं होगा कि कॉन्फिग लेआउट कोड सहित हमारे मुख्य उपकरण इसके माध्यम से इंस्टॉल किए गए हैं setup.py - साथ में यह हमारे कोड को एक एकल पारिस्थितिकी तंत्र में एकजुट करता है, जो प्लेटफ़ॉर्म और उपयोग की विधि से स्वतंत्र है।

कुबेरनेट्स पॉड का विवरण इस तरह दिखता है:

containers:
  - name : enter-api
    image: enter-api:latest
    ports:
      - containerPort: 80
    volumeMounts:
      - name: db-main-secret-volume
        mountPath: /etc/secrets/db-main

volumes:
  - name: db-main-secret-volume
    secret:
      secretName: db-main-secret

अर्थात् प्रत्येक रहस्य एक खण्ड का वर्णन करता है। रहस्य स्वयं इस प्रकार बनाये गये हैं:

apiVersion: v1
kind: Secret
metadata:
  name: db-main-secret
type: Opaque
stringData:
  db_main.yaml: |
    engine: sqlite
    filename: main.sqlite3

इसके परिणामस्वरूप पथ पर YAML फ़ाइलों का निर्माण होता है /etc/secrets/db-main/section_name.yaml

और स्थानीय लॉन्च के लिए, कॉन्फ़िगरेशन का उपयोग किया जाता है, जो प्रोजेक्ट की रूट निर्देशिका में या पर्यावरण चर में निर्दिष्ट पथ के साथ स्थित होता है। इन सुविधाओं के लिए जिम्मेदार कोड को स्पॉइलर में देखा जा सकता है।

config.py

__author__ = 'AivanF'
__copyright__ = 'Copyright 2020, AivanF'

import os
import yaml

__all__ = ['config']
PROJECT_DIR = os.path.abspath(__file__ + 3 * '/..')
SECRETS_DIR = '/etc/secrets'
KEY_LOG = '_config_log'
KEY_DBG = 'debug'

def is_yes(value):
    if isinstance(value, str):
        value = value.lower()
        if value in ('1', 'on', 'yes', 'true'):
            return True
    else:
        if value in (1, True):
            return True
    return False

def update_config_part(config, key, data):
    if key not in config:
        config[key] = data
    else:
        config[key].update(data)

def parse_big_config(config, filename):
    '''
    Parse YAML config with multiple section
    '''
    if not os.path.isfile(filename):
        return False
    with open(filename) as f:
        config_new = yaml.safe_load(f.read())
        for key, data in config_new.items():
            update_config_part(config, key, data)
        config[KEY_LOG].append(filename)
        return True

def parse_tiny_config(config, key, filename):
    '''
    Parse YAML config with a single section
    '''
    with open(filename) as f:
        config_tiny = yaml.safe_load(f.read())
        update_config_part(config, key, config_tiny)
        config[KEY_LOG].append(filename)

def combine_config():
    config = {
        # To debug config load code
        KEY_LOG: [],
        # To debug other code
        KEY_DBG: is_yes(os.environ.get('DEBUG')),
    }
    # For simple local runs
    CONFIG_SIMPLE = os.path.join(PROJECT_DIR, 'config.yaml')
    parse_big_config(config, CONFIG_SIMPLE)
    # For container's tests
    CONFIG_ENVVAR = os.environ.get('CONFIG')
    if CONFIG_ENVVAR is not None:
        if not parse_big_config(config, CONFIG_ENVVAR):
            raise ValueError(
                f'No config file from EnvVar:n'
                f'{CONFIG_ENVVAR}'
            )
    # For K8s secrets
    for path, dirs, files in os.walk(SECRETS_DIR):
        depth = path[len(SECRETS_DIR):].count(os.sep)
        if depth > 1:
            continue
        for file in files:
            if file.endswith('.yaml'):
                filename = os.path.join(path, file)
                key = file.rsplit('.', 1)[0]
                parse_tiny_config(config, key, filename)
    return config

def build_config():
    config = combine_config()
    # Preprocess
    for key, data in config.items():
        if key.startswith('db_'):
            if data['engine'] == 'sqlite':
                data['filename'] = os.path.join(PROJECT_DIR, data['filename'])
    # To verify correctness
    if config[KEY_DBG]:
        print(f'** Loaded config:n{yaml.dump(config)}')
    else:
        print(f'** Loaded config from: {config[KEY_LOG]}')
    return config

config = build_config()

यहां तर्क काफी सरल है: हम पर्यावरण चर द्वारा प्रोजेक्ट निर्देशिका और पथों से बड़े कॉन्फ़िगरेशन को जोड़ते हैं, और कुबेर रहस्यों से छोटे कॉन्फ़िगरेशन अनुभागों को जोड़ते हैं, और फिर उन्हें थोड़ा प्रीप्रोसेस करते हैं। साथ ही कुछ चर भी। मैं ध्यान देता हूं कि रहस्यों से फ़ाइलों की खोज करते समय, एक गहराई सीमा का उपयोग किया जाता है, क्योंकि K8s प्रत्येक रहस्य में एक छिपा हुआ फ़ोल्डर बनाता है जहां रहस्य स्वयं संग्रहीत होते हैं, और बस एक लिंक उच्च स्तर पर स्थित होता है।

मुझे आशा है कि जो वर्णित है वह किसी के लिए उपयोगी होगा :) सुरक्षा या सुधार के अन्य क्षेत्रों के संबंध में कोई भी टिप्पणी और सिफारिशें स्वीकार की जाती हैं। समुदाय की राय भी दिलचस्प है, शायद यह कॉन्फिगमैप्स के लिए समर्थन जोड़ने (हमारा प्रोजेक्ट अभी तक उनका उपयोग नहीं करता है) और GitHub / PyPI पर कोड प्रकाशित करने लायक है? व्यक्तिगत रूप से, मुझे लगता है कि परियोजनाओं के सार्वभौमिक होने के लिए ऐसी चीजें बहुत व्यक्तिगत हैं, और अन्य लोगों के कार्यान्वयन पर थोड़ा नज़र डालना, जैसा कि यहां दिया गया है, और बारीकियों, युक्तियों और सर्वोत्तम प्रथाओं की चर्चा है, जिसे मैं टिप्पणियों में देखने की उम्मीद करता हूं , काफी है 😉

केवल पंजीकृत उपयोगकर्ता ही सर्वेक्षण में भाग ले सकते हैं। साइन इन करेंकृपया।

क्या मुझे एक प्रोजेक्ट/लाइब्रेरी के रूप में प्रकाशित करना चाहिए?

• 0,0% तक हां, मैं /योगदान0 का उपयोग करूंगा

• 33,3% तक हाँ, यह बहुत अच्छा लगता है4

• 41,7% तक नहीं, किसे इसे अपने प्रारूप में और अपनी आवश्यकताओं के अनुरूप स्वयं करने की आवश्यकता है5

• 25,0% तक मैं उत्तर देने से बचूंगा3

12 उपयोगकर्ताओं ने मतदान किया। 3 उपयोगकर्ता अनुपस्थित रहे।

स्रोत: www.habr.com