Kubernetes Operator ໃນ Python ໂດຍບໍ່ມີກອບແລະ SDK

ປະຈຸບັນ Go ມີການຜູກຂາດກ່ຽວກັບພາສາການຂຽນໂປລແກລມທີ່ປະຊາຊົນເລືອກທີ່ຈະຂຽນຄໍາຖະແຫຼງການສໍາລັບ Kubernetes. ມີເຫດຜົນສໍາລັບເລື່ອງນີ້, ເຊັ່ນ:

1. ມີກອບທີ່ມີປະສິດທິພາບສໍາລັບການພັດທະນາຜູ້ປະກອບການໃນ Go - ຜູ້ປະກອບການ SDK.
2. ແອັບພລິເຄຊັນປ່ຽນເກມເຊັ່ນ Docker ແລະ Kubernetes ແມ່ນຂຽນໃນ Go. ການຂຽນຕົວປະຕິບັດການຂອງທ່ານໃນ Go ຫມາຍເຖິງການເວົ້າພາສາດຽວກັນກັບລະບົບນິເວດ.
3. ປະສິດທິພາບສູງຂອງຄໍາຮ້ອງສະຫມັກ Go ແລະເຄື່ອງມືທີ່ງ່າຍດາຍສໍາລັບການເຮັດວຽກຮ່ວມກັບ concurrency ອອກຈາກກ່ອງ.

NB: ໂດຍວິທີທາງການ, ວິທີການຂຽນຄໍາຖະແຫຼງຂອງຕົນເອງໃນ Go, ພວກເຮົາ ອະທິບາຍແລ້ວ ໃນຫນຶ່ງຂອງການແປພາສາຂອງພວກເຮົາໂດຍຜູ້ຂຽນຕ່າງປະເທດ.

ແຕ່ຈະເປັນແນວໃດຖ້າທ່ານຖືກຂັດຂວາງຈາກການຮຽນຮູ້ Go ໂດຍຂາດເວລາຫຼື, ເວົ້າງ່າຍໆ, ແຮງຈູງໃຈ? ບົດຄວາມໃຫ້ຕົວຢ່າງຂອງວິທີທີ່ທ່ານສາມາດຂຽນຄໍາຖະແຫຼງທີ່ດີໂດຍໃຊ້ຫນຶ່ງໃນພາສາທີ່ນິຍົມຫຼາຍທີ່ສຸດທີ່ເກືອບທຸກວິສະວະກອນ DevOps ຮູ້ - Python.

ພົບກັບ: ກັອບປີ້ - copy operator!

ເປັນຕົວຢ່າງ, ພິຈາລະນາການພັດທະນາຄໍາຖະແຫຼງທີ່ງ່າຍດາຍທີ່ຖືກອອກແບບມາເພື່ອຄັດລອກ ConfigMap ບໍ່ວ່າຈະໃນເວລາທີ່ namespace ໃຫມ່ປາກົດຫຼືໃນເວລາທີ່ຫນຶ່ງໃນສອງຫນ່ວຍງານມີການປ່ຽນແປງ: ConfigMap ແລະຄວາມລັບ. ຈາກທັດສະນະຂອງການປະຕິບັດ, ຜູ້ປະຕິບັດການສາມາດເປັນປະໂຫຍດສໍາລັບການອັບເດດການຕັ້ງຄ່າຂອງແອັບພລິເຄຊັນ (ໂດຍການປັບປຸງ ConfigMap) ຫຼືສໍາລັບການປັບປຸງຂໍ້ມູນລັບ - ຕົວຢ່າງ, ປຸ່ມສໍາລັບການເຮັດວຽກກັບ Docker Registry (ເມື່ອເພີ່ມຄວາມລັບກັບ namespace).

ດັ່ງ​ນັ້ນ ສິ່ງທີ່ຜູ້ປະກອບການທີ່ດີຄວນມີ:

1. ປະຕິສໍາພັນກັບຜູ້ປະຕິບັດງານແມ່ນດໍາເນີນການໂດຍໃຊ້ ຄໍານິຍາມຊັບພະຍາກອນທີ່ກໍາຫນົດເອງ (ຕໍ່ໄປນີ້ເອີ້ນວ່າ CRD).
2. ຜູ້ປະກອບການສາມາດຖືກຕັ້ງຄ່າໄດ້. ເພື່ອເຮັດສິ່ງນີ້, ພວກເຮົາຈະນໍາໃຊ້ທຸງສາຍຄໍາສັ່ງແລະຕົວແປສະພາບແວດລ້ອມ.
3. ການສ້າງ Docker container ແລະ Helm chart ຖືກອອກແບບມາເພື່ອໃຫ້ຜູ້ໃຊ້ສາມາດ (ຮູ້ຫນັງສືດ້ວຍຄໍາສັ່ງດຽວ) ຕິດຕັ້ງຕົວປະຕິບັດການເຂົ້າໄປໃນກຸ່ມ Kubernetes ຂອງເຂົາເຈົ້າໄດ້ຢ່າງງ່າຍດາຍ.

CRD

ເພື່ອໃຫ້ຜູ້ປະຕິບັດການຮູ້ວ່າຊັບພະຍາກອນໃດທີ່ຈະຊອກຫາແລະບ່ອນທີ່ຈະຊອກຫາ, ພວກເຮົາຈໍາເປັນຕ້ອງກໍານົດກົດລະບຽບສໍາລັບລາວ. ແຕ່ລະກົດລະບຽບຈະຖືກສະແດງເປັນວັດຖຸ CRD ດຽວ. CRD ນີ້ຄວນມີສາຂາໃດແດ່?

1. ປະເພດຊັບພະຍາກອນ, ທີ່ພວກເຮົາຈະຊອກຫາ (ConfigMap ຫຼືລັບ).
2. ບັນຊີລາຍຊື່ຂອງ namespaces, ໃນທີ່ຊັບພະຍາກອນຄວນຈະຕັ້ງຢູ່.
3. Selector, ໂດຍທີ່ພວກເຮົາຈະຄົ້ນຫາຊັບພະຍາກອນໃນ namespace.

ຂໍອະທິບາຍ CRD:

apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: copyrator.flant.com
spec:
  group: flant.com
  versions:
  - name: v1
    served: true
    storage: true
  scope: Namespaced
  names:
    plural: copyrators
    singular: copyrator
    kind: CopyratorRule
    shortNames:
    - copyr
  validation:
    openAPIV3Schema:
      type: object
      properties:
        ruleType:
          type: string
        namespaces:
          type: array
          items:
            type: string
        selector:
          type: string

ແລະພວກເຮົາຈະສ້າງມັນທັນທີ ກົດລະບຽບງ່າຍດາຍ — ການ​ຄົ້ນ​ຫາ​ໃນ namespace ທີ່​ມີ​ຊື່​ default ConfigMap ທັງຫມົດທີ່ມີປ້າຍຊື່ເຊັ່ນ copyrator: "true":

apiVersion: flant.com/v1
kind: CopyratorRule
metadata:
  name: main-rule
  labels:
    module: copyrator
ruleType: configmap
selector:
  copyrator: "true"
namespace: default

ພ້ອມແລ້ວ! ໃນປັດຈຸບັນພວກເຮົາຈໍາເປັນຕ້ອງ somehow ໄດ້ຮັບຂໍ້ມູນກ່ຽວກັບກົດລະບຽບຂອງພວກເຮົາ. ໃຫ້ຂ້ອຍຈອງທັນທີວ່າພວກເຮົາຈະບໍ່ຂຽນຄໍາຮ້ອງຂໍໃຫ້ກັບ cluster API Server ຕົວເຮົາເອງ. ເພື່ອເຮັດສິ່ງນີ້, ພວກເຮົາຈະນໍາໃຊ້ຫ້ອງສະຫມຸດ Python ທີ່ກຽມພ້ອມ kubernetes-ລູກຄ້າ:

import kubernetes
from contextlib import suppress


CRD_GROUP = 'flant.com'
CRD_VERSION = 'v1'
CRD_PLURAL = 'copyrators'


def load_crd(namespace, name):
    client = kubernetes.client.ApiClient()
    custom_api = kubernetes.client.CustomObjectsApi(client)

    with suppress(kubernetes.client.api_client.ApiException):
        crd = custom_api.get_namespaced_custom_object(
            CRD_GROUP,
            CRD_VERSION,
            namespace,
            CRD_PLURAL,
            name,
        )
    return {x: crd[x] for x in ('ruleType', 'selector', 'namespace')}

ເປັນຜົນມາຈາກການແລ່ນລະຫັດນີ້, ພວກເຮົາໄດ້ຮັບດັ່ງຕໍ່ໄປນີ້:

{'ruleType': 'configmap', 'selector': {'copyrator': 'true'}, 'namespace': ['default']}

ຍິ່ງໃຫຍ່: ພວກເຮົາຈັດການເພື່ອໃຫ້ໄດ້ກົດລະບຽບສໍາລັບຜູ້ປະກອບການ. ແລະສໍາຄັນທີ່ສຸດ, ພວກເຮົາໄດ້ເຮັດສິ່ງທີ່ເອີ້ນວ່າວິທີ Kubernetes.

ຕົວແປສະພາບແວດລ້ອມຫຼືທຸງ? ພວກເຮົາເອົາທຸກສິ່ງທຸກຢ່າງ!

ໃຫ້ກ້າວໄປສູ່ການຕັ້ງຄ່າຕົວປະຕິບັດການຕົ້ນຕໍ. ມີສອງວິທີພື້ນຖານໃນການຕັ້ງຄ່າແອັບພລິເຄຊັນ:

1. ໃຊ້ຕົວເລືອກເສັ້ນຄໍາສັ່ງ;
2. ໃຊ້ຕົວແປສະພາບແວດລ້ອມ.

ຕົວເລືອກແຖວຄໍາສັ່ງຊ່ວຍໃຫ້ທ່ານສາມາດອ່ານການຕັ້ງຄ່າທີ່ມີຄວາມຍືດຫຍຸ່ນຫຼາຍ, ດ້ວຍການສະຫນັບສະຫນູນປະເພດຂໍ້ມູນແລະການກວດສອບ. ຫ້ອງສະຫມຸດມາດຕະຖານຂອງ Python ມີໂມດູນ argparser, ທີ່ພວກເຮົາຈະນໍາໃຊ້. ລາຍລະອຽດແລະຕົວຢ່າງຂອງຄວາມສາມາດຂອງມັນແມ່ນມີຢູ່ໃນ ເອກະສານທາງການ.

ສໍາ​ລັບ​ກໍ​ລະ​ນີ​ຂອງ​ພວກ​ເຮົາ​, ນີ້​ແມ່ນ​ຕົວ​ຢ່າງ​ຂອງ​ການ​ຕັ້ງ​ຄ່າ​ການ​ອ່ານ​ທຸງ​ບັນ​ດາ​ຄໍາ​ສັ່ງ​ຈະ​ເບິ່ງ​ຄື​:

   parser = ArgumentParser(
        description='Copyrator - copy operator.',
        prog='copyrator'
    )
    parser.add_argument(
        '--namespace',
        type=str,
        default=getenv('NAMESPACE', 'default'),
        help='Operator Namespace'
    )
    parser.add_argument(
        '--rule-name',
        type=str,
        default=getenv('RULE_NAME', 'main-rule'),
        help='CRD Name'
    )
    args = parser.parse_args()

ໃນທາງກົງກັນຂ້າມ, ການນໍາໃຊ້ຕົວແປສະພາບແວດລ້ອມໃນ Kubernetes, ທ່ານສາມາດໂອນຂໍ້ມູນການບໍລິການກ່ຽວກັບຝັກພາຍໃນຖັງໄດ້ຢ່າງງ່າຍດາຍ. ຕົວຢ່າງ, ພວກເຮົາສາມາດໄດ້ຮັບຂໍ້ມູນກ່ຽວກັບ namespace ທີ່ pod ເຮັດວຽກກັບການກໍ່ສ້າງດັ່ງຕໍ່ໄປນີ້:

env:
- name: NAMESPACE
  valueFrom:
     fieldRef:
         fieldPath: metadata.namespace 

ເຫດຜົນຂອງຜູ້ປະຕິບັດງານ

ເພື່ອເຂົ້າໃຈວິທີການແຍກວິທີການເຮັດວຽກກັບ ConfigMap ແລະຄວາມລັບ, ພວກເຮົາຈະນໍາໃຊ້ແຜນທີ່ພິເສດ. ຫຼັງຈາກນັ້ນ, ພວກເຮົາສາມາດເຂົ້າໃຈວິທີການທີ່ພວກເຮົາຕ້ອງການເພື່ອຕິດຕາມແລະສ້າງວັດຖຸ:

LIST_TYPES_MAP = {
    'configmap': 'list_namespaced_config_map',
    'secret': 'list_namespaced_secret',
}

CREATE_TYPES_MAP = {
    'configmap': 'create_namespaced_config_map',
    'secret': 'create_namespaced_secret',
}

ຕໍ່ໄປ, ທ່ານຈໍາເປັນຕ້ອງໄດ້ຮັບເຫດການຈາກເຄື່ອງແມ່ຂ່າຍ API. ໃຫ້​ປະ​ຕິ​ບັດ​ມັນ​ດັ່ງ​ຕໍ່​ໄປ​ນີ້​:

def handle(specs):
    kubernetes.config.load_incluster_config()
    v1 = kubernetes.client.CoreV1Api()

    # Получаем метод для слежения за объектами
    method = getattr(v1, LIST_TYPES_MAP[specs['ruleType']])
    func = partial(method, specs['namespace'])

    w = kubernetes.watch.Watch()
    for event in w.stream(func, _request_timeout=60):
        handle_event(v1, specs, event)

ຫຼັງຈາກໄດ້ຮັບເຫດການ, ພວກເຮົາກ້າວໄປສູ່ເຫດຜົນຕົ້ນຕໍຂອງການປຸງແຕ່ງມັນ:

# Типы событий, на которые будем реагировать
ALLOWED_EVENT_TYPES = {'ADDED', 'UPDATED'}


def handle_event(v1, specs, event):
    if event['type'] not in ALLOWED_EVENT_TYPES:
        return

    object_ = event['object']
    labels = object_['metadata'].get('labels', {})

    # Ищем совпадения по selector'у
    for key, value in specs['selector'].items():
        if labels.get(key) != value:
            return
    # Получаем активные namespace'ы
    namespaces = map(
        lambda x: x.metadata.name,
        filter(
            lambda x: x.status.phase == 'Active',
            v1.list_namespace().items
        )
    )
    for namespace in namespaces:
        # Очищаем метаданные, устанавливаем namespace
        object_['metadata'] = {
            'labels': object_['metadata']['labels'],
            'namespace': namespace,
            'name': object_['metadata']['name'],
        }
        # Вызываем метод создания/обновления объекта
        methodcaller(
            CREATE_TYPES_MAP[specs['ruleType']],
            namespace,
            object_
        )(v1)

ເຫດຜົນຕົ້ນຕໍແມ່ນກຽມພ້ອມ! ໃນປັດຈຸບັນພວກເຮົາຈໍາເປັນຕ້ອງໄດ້ຫຸ້ມຫໍ່ທັງຫມົດນີ້ເຂົ້າໄປໃນຊຸດ Python ດຽວ. ພວກເຮົາກະກຽມເອກະສານ setup.py, ຂຽນຂໍ້ມູນ meta ກ່ຽວກັບໂຄງການຢູ່ທີ່ນັ້ນ:

from sys import version_info

from setuptools import find_packages, setup

if version_info[:2] < (3, 5):
    raise RuntimeError(
        'Unsupported python version %s.' % '.'.join(version_info)
    )


_NAME = 'copyrator'
setup(
    name=_NAME,
    version='0.0.1',
    packages=find_packages(),
    classifiers=[
        'Development Status :: 3 - Alpha',
        'Programming Language :: Python',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
    ],
    author='Flant',
    author_email='[email protected]',
    include_package_data=True,
    install_requires=[
        'kubernetes==9.0.0',
    ],
    entry_points={
        'console_scripts': [
            '{0} = {0}.cli:main'.format(_NAME),
        ]
    }
)

NB: ລູກຄ້າ kubernetes ສໍາລັບ Python ມີເວີຊັນຂອງຕົນເອງ. ຂໍ້ມູນເພີ່ມເຕີມກ່ຽວກັບຄວາມເຂົ້າກັນໄດ້ລະຫວ່າງລຸ້ນລູກຂ່າຍ ແລະລຸ້ນ Kubernetes ສາມາດພົບໄດ້ໃນ ຄວາມເຂົ້າກັນໄດ້ matrices.

ໃນປັດຈຸບັນໂຄງການຂອງພວກເຮົາເບິ່ງຄືວ່ານີ້:

copyrator
├── copyrator
│   ├── cli.py # Логика работы с командной строкой
│   ├── constant.py # Константы, которые мы приводили выше
│   ├── load_crd.py # Логика загрузки CRD
│   └── operator.py # Основная логика работы оператора
└── setup.py # Оформление пакета

Docker ແລະ Helm

Dockerfile ຈະງ່າຍດາຍຢ່າງບໍ່ຫນ້າເຊື່ອ: ເອົາຮູບ python-alpine ພື້ນຖານແລະຕິດຕັ້ງຊຸດຂອງພວກເຮົາ. ຂໍໃຫ້ເລື່ອນການເພີ່ມປະສິດທິພາບຂອງມັນອອກໄປຈົນຮອດເວລາທີ່ດີກວ່າ:

FROM python:3.7.3-alpine3.9

ADD . /app

RUN pip3 install /app

ENTRYPOINT ["copyrator"]

ການປະຕິບັດສໍາລັບຜູ້ປະກອບການແມ່ນຍັງງ່າຍດາຍຫຼາຍ:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .Chart.Name }}
spec:
  selector:
    matchLabels:
      name: {{ .Chart.Name }}
  template:
    metadata:
      labels:
        name: {{ .Chart.Name }}
    spec:
      containers:
      - name: {{ .Chart.Name }}
        image: privaterepo.yourcompany.com/copyrator:latest
        imagePullPolicy: Always
        args: ["--rule-type", "main-rule"]
        env:
        - name: NAMESPACE
          valueFrom:
            fieldRef:
              fieldPath: metadata.namespace
      serviceAccountName: {{ .Chart.Name }}-acc

ສຸດທ້າຍ, ທ່ານຈໍາເປັນຕ້ອງສ້າງບົດບາດທີ່ເຫມາະສົມສໍາລັບຜູ້ປະຕິບັດງານທີ່ມີສິດທິທີ່ຈໍາເປັນ:

apiVersion: v1
kind: ServiceAccount
metadata:
  name: {{ .Chart.Name }}-acc

---
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRole
metadata:
  name: {{ .Chart.Name }}
rules:
  - apiGroups: [""]
    resources: ["namespaces"]
    verbs: ["get", "watch", "list"]
  - apiGroups: [""]
    resources: ["secrets", "configmaps"]
    verbs: ["*"]
---
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRoleBinding
metadata:
  name: {{ .Chart.Name }}
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: {{ .Chart.Name }}
subjects:
- kind: ServiceAccount
  name: {{ .Chart.Name }}

ຜົນໄດ້ຮັບ

ນັ້ນແມ່ນ, ໂດຍບໍ່ມີການຢ້ານກົວ, ຕໍາຫນິ, ຫຼືການຮຽນຮູ້ Go, ພວກເຮົາສາມາດສ້າງຕົວປະຕິບັດການຂອງພວກເຮົາເອງສໍາລັບ Kubernetes ໃນ Python. ແນ່ນອນ, ມັນຍັງມີພື້ນທີ່ທີ່ຈະເຕີບໂຕ: ໃນອະນາຄົດມັນຈະສາມາດປຸງແຕ່ງກົດລະບຽບຫຼາຍ, ເຮັດວຽກໃນຫຼາຍກະທູ້, ເປັນເອກະລາດຕິດຕາມການປ່ຽນແປງໃນ CRDs ຂອງມັນ ...

ເພື່ອເຮັດໃຫ້ທ່ານເບິ່ງໃກ້ຊິດກ່ຽວກັບລະຫັດ, ພວກເຮົາໄດ້ໃສ່ມັນ ຄັງ​ເກັບ​ຮັກ​ສາ​ສາ​ທາ​ລະ​ນະ​. ຖ້າທ່ານຕ້ອງການຕົວຢ່າງຂອງຕົວປະຕິບັດການທີ່ຮ້າຍແຮງກວ່າທີ່ປະຕິບັດໂດຍໃຊ້ Python, ທ່ານສາມາດຫັນຄວາມສົນໃຈຂອງທ່ານໄປຫາສອງຕົວປະຕິບັດການສໍາລັບການປະຕິບັດ mongodb (ຄັ້ງທໍາອິດ и ຄັ້ງທີສອງ).

PS ແລະຖ້າທ່ານຂີ້ຄ້ານເກີນໄປທີ່ຈະຈັດການກັບເຫດການ Kubernetes ຫຼືທ່ານມີຄວາມຄຸ້ນເຄີຍກັບການນໍາໃຊ້ Bash, ເພື່ອນຮ່ວມງານຂອງພວກເຮົາໄດ້ກະກຽມການແກ້ໄຂທີ່ກຽມພ້ອມໃນຮູບແບບ. shell-operator (ພວກເຮົາ ປະ​ກາດ ໃນເດືອນເມສາ).

PPS

ອ່ານຍັງຢູ່ໃນ blog ຂອງພວກເຮົາ:

• «ມັນງ່າຍ ແລະສະດວກໃນການກະກຽມກຸ່ມ Kubernetes ບໍ? ປະກາດ addon-operator"
• «ແນະນຳ Shell-operator: ການສ້າງຕົວປະຕິບັດການສຳລັບ Kubernetes ງ່າຍຂຶ້ນ"
• «ການ​ຂະ​ຫຍາຍ​ແລະ​ເສີມ Kubernetes (ການ​ທົບ​ທວນ​ຄືນ​ແລະ​ລາຍ​ງານ​ວິ​ດີ​ໂອ​)"
• «ການຂຽນຕົວປະຕິບັດການສໍາລັບ Kubernetes ໃນ Golang"
• «ຜູ້ປະກອບການສໍາລັບ Kubernetes: ວິທີການດໍາເນີນການຄໍາຮ້ອງສະຫມັກຂອງລັດ".

ແຫຼ່ງຂໍ້ມູນ: www.habr.com