Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

مرجع واجهة برمجة تطبيقات ClickHouse Operator

View as MarkdownEdit this pageReport an issueSet up docs MCP

يوفر هذا المستند مرجعًا تفصيليًا لواجهة برمجة تطبيقات الموارد المخصصة في ClickHouse Operator.

AdditionalPort

يحدّد AdditionalPort منفذ TCP إضافيًا واحدًا لكشفه على كبسولة ClickHouse والخدمة العامة عديمة الرأس.

الحقل النوع الوصف مطلوب الافتراضي
name string يعرّف الاسم المنفذ بشكل فريد داخل القائمة. ويُستخدم كاسم منفذ الحاوية واسم منفذ الخدمة معًا.
يجب أن تكون هذه القيمة DNS_LABEL.		 true
port integer هو رقم منفذ TCP المراد كشفه. true

يظهر في:

CABundleSelector

يختار CABundleSelector مفتاحًا يحتوي على حزمة CA من Secret ضمن مساحة اسم العنقود.

الحقل النوع الوصف مطلوب الافتراضي
name سلسلة نصية اسم الـ Secret ضمن مساحة اسم العنقود الذي يتم الاختيار منه. true
key سلسلة نصية مفتاح الـ Secret الذي يتم الاختيار منه. يجب أن يكون مفتاح Secret صالحًا. false ca.crt

يظهر في:

ClickHouseCluster

ClickHouseCluster هو المخطط الخاص بواجهة برمجة تطبيقات clickhouseclusters.

إصدار واجهة برمجة التطبيقات وKind

apiVersion: clickhouse.com/v1alpha1
kind: ClickHouseCluster
الحقل النوع الوصف مطلوب الافتراضي
spec ClickHouseClusterSpec true
status ClickHouseClusterStatus true

يرد في:

ClickHouseClusterList

يتضمن ClickHouseClusterList قائمةً من عناصر ClickHouseCluster.

إصدار واجهة برمجة التطبيقات وKind

apiVersion: clickhouse.com/v1alpha1
kind: ClickHouseClusterList
الحقل النوع الوصف مطلوب الافتراضي
items ClickHouseCluster مصفوفة true

ClickHouseClusterSpec

يحدّد ClickHouseClusterSpec الحالة المطلوبة لـ ClickHouseCluster.

الحقل النوع الوصف مطلوب الافتراضي
replicas integer عدد النسخ المتماثلة في الشظية الواحدة. false 3
shards integer عدد الشظايا في العنقود. false 1
keeperClusterRef KeeperClusterReference مرجع إلى KeeperCluster المستخدَم لتنسيق ClickHouse.
عند عدم تحديد مساحة الاسم، تُستخدم مساحة اسم ClickHouseCluster.		 true
podTemplate PodTemplateSpec المعلمات التي تُمرَّر إلى مواصفة الكبسولة الخاصة بـ ClickHouse. false
containerTemplate ContainerTemplateSpec المعلمات التي تُمرَّر إلى مواصفة الحاوية الخاصة بـ ClickHouse. false
dataVolumeClaimSpec PersistentVolumeClaimSpec مواصفة التخزين الدائم لبيانات ClickHouse. false
additionalVolumeClaimTemplates PersistentVolumeClaimTemplate array قوالب PVC إضافية لكل كبسولة لتخزين JBOD / متعدد الأقراص.
يُمرَّر كل مُدخل إلى volumeClaimTemplate في StatefulSet، ويُربط عند /var/lib/clickhouse/disks/<name> كما
يُضاف إلى سياسة تخزين JBOD المُنشأة.
تكون مجموعة الأقراص ثابتة عند الإنشاء.		 false
labels object (keys:string, values:string) وسوم إضافية تُضاف إلى الموارد. false
annotations object (keys:string, values:string) تعليقات توضيحية إضافية تُضاف إلى الموارد. false
podDisruptionBudget PodDisruptionBudgetSpec يضبط PodDisruptionBudget مورد PDB الذي يُنشأ لكل شظية.
عند عدم تعيينه، يستخدم المشغّل افتراضيًا maxUnavailable=1 للشظايا
أحادية النسخة المتماثلة و minAvailable=1 للشظايا متعددة النسخ المتماثلة.		 false
networkPolicy ClickHouseNetworkPolicySpec يهيّئ NetworkPolicy سياسة NetworkPolicy المُدارة للعنقود. false
settings ClickHouseSettings معلمات تهيئة خادم ClickHouse. false { }
clusterDomain string ClusterDomain هي لاحقة نطاق عنقود Kubernetes المستخدمة في حلّ أسماء DNS. false cluster.local
upgradeChannel string يحدّد UpgradeChannel قناة الإصدار المستخدمة للتحقق من ترقيات الإصدارات الرئيسية.
وعند تركه فارغًا، لن تُقترح إلا التحديثات الثانوية. القيم المسموح بها هي: stable أو lts أو إصدار major.minor محدد (مثل 25.8).		 false
versionProbeTemplate VersionProbeTemplate تجاوزات VersionProbeTemplate الخاصة بـ Job اكتشاف الإصدار. false
externalSecret ExternalSecret ExternalSecret مرجع اختياري إلى Secret مُدار خارجيًا ويحتوي على أسرار العنقود.
يجب أن يكون الـ Secret موجودًا في مساحة الاسم نفسها الخاصة بالعنقود.		 false
additionalPorts AdditionalPort array يعرّف AdditionalPorts منافذ TCP إضافية لكشفها على كبسولة ClickHouse و الخدمة عديمة الرأس العامة.
يقتصر دور المشغّل على إضافة المنافذ إلى موارد Kubernetes، ولا يهيّئ خادم ClickHouse للاستماع عليها.		 false

يظهر في:

ClickHouseClusterStatus

يحدّد ClickHouseClusterStatus الحالة المرصودة لـ ClickHouseCluster.

الحقل النوع الوصف مطلوب الافتراضي
conditions مصفوفة Condition false
readyReplicas integer يشير ReadyReplicas إلى العدد الإجمالي للنسخ المتماثلة الجاهزة للتعامل مع الطلبات. false
configurationRevision string يشير ConfigurationRevision إلى مراجعة الإعدادات المستهدفة لكل نسخة متماثلة. true
statefulSetRevision string يشير StatefulSetRevision إلى مراجعة StatefulSet المستهدفة لكل نسخة متماثلة. true
currentRevision string يشير CurrentRevision إلى أحدث مراجعة مطبّقة لمواصفة ClickHouseCluster. true
updateRevision string يشير UpdateRevision إلى أحدث مراجعة مطلوبة لمواصفة ClickHouseCluster. true
observedGeneration integer يشير ObservedGeneration إلى أحدث جيل رصدته وحدة التحكم. true
version string يشير Version إلى الإصدار الذي أبلغت عنه image الحاوية. false
versionProbeRevision string تمثل VersionProbeRevision تجزئة image لآخر فحص إصدار ناجح.
وعندما تتطابق هذه مع تجزئة image الحالية، يُستخدم Version المخزّن مؤقتًا مباشرةً.		 false

يظهر في:

ClickHouseNetworkPolicySpec

يُهيّئ ClickHouseNetworkPolicySpec مورد NetworkPolicy الذي يديره مشغّل عنقود ClickHouse. تغطي السياسة المُدارة حركة المرور الداخلية ضمن العنقود:

  • الاتصال بين النسخ المتماثلة
  • الوصول من المشغّل إلى العنقود يتطلب أي دخول آخر، بما في ذلك اتصالات العميل وكشط المقاييس، موارد NetworkPolicy يعرّفها المستخدم.
الحقل النوع الوصف مطلوب الافتراضي
policy NetworkPolicyPolicy تتحكم السياسة في ما إذا كان المشغّل يدير مورد NetworkPolicy يقيّد الدخول إلى كبسولات العنقود.
تكون القيمة الافتراضية "Disabled" عند عدم تعيينها.		 false Disabled

يظهر في:

ClickHouseSettings

يعرّف ClickHouseSettings خيارات إعدادات خادم ClickHouse.

الحقل النوع الوصف مطلوب الافتراضي
defaultUserPassword DefaultPasswordSelector يحدد مصدر كلمة المرور ونوعها لمستخدم ClickHouse default. false
logger LoggerConfig إعدادات تسجيل خادم ClickHouse. false
tls ClusterTLSSpec إعدادات TLS، وتتيح تكوين نقاط نهاية آمنة والتحقق من الشهادات لخادم ClickHouse. false
encryption EncryptionSettings التشفير: عند تعيينه، يفعّل تشفير البيانات المخزنة لبيانات الجداول من خلال سياسة تخزين مخصصة.
يمكن تفعيله لكل جدول باستخدام SETTINGS storage_policy = '<policyName>'.		 false
enableDatabaseSync boolean يفعّل مزامنة قواعد بيانات ClickHouse مع النسخ المتماثلة المُنشأة حديثًا، وتنظيف النسخ المتماثلة القديمة
بعد تقليص العدد.
يدعم فقط قواعد بيانات Replicated وintegration.		 false true
extraConfig RawExtension إعدادات ClickHouse إضافية ستُدمج مع الإعدادات الافتراضية. false
extraUsersConfig RawExtension إعدادات إضافية لمستخدمي ClickHouse ستُدمج مع الإعدادات الافتراضية. false

يظهر في:

ClusterTLSSpec

يحدّد ClusterTLSSpec تهيئة TLS للمجموعة.

الحقل النوع الوصف مطلوب الافتراضي
enabled boolean يشير Enabled إلى ما إذا كان TLS مُمكّنًا، وبناءً عليه يتحدد ما إذا كان يجب فتح المنافذ الآمنة. false false
required boolean يحدّد Required ما إذا كان يجب فرض TLS على جميع الاتصالات. ويعطّل المنافذ غير الآمنة. false false
serverCertSecret LocalObjectReference ServerCertSecret هو مرجع إلى Secret لـ TLS يحتوي على شهادة الخادم.
ويُفترض أن تكون بنية الـ Secret مطابقة لبنية الشهادات التي يُنشئها cert-manager،
مع تخزين الشهادة والمفتاح الخاص تحت المفتاحين "tls.crt" و"tls.key" على التوالي.		 false
caBundle CABundleSelector CABundle هو مرجع إلى مفتاح في Secret يحتوي على حزمة CA تُستخدم للتحقق من شهادات الأقران.
إذا كان فارغًا، فستُستخدم حزمة CA الموثوقة الخاصة بالنظام.
تكون قيمة المفتاح الافتراضية "ca.crt" إذا لم يتم تحديده.		 false

يظهر في:

ConfigMapKeySelector

يحدِّد ConfigMapKeySelector مفتاحًا من ConfigMap.

الحقل النوع الوصف مطلوب الافتراضي
name سلسلة نصية اسم ConfigMap ضمن مساحة اسم العنقود المراد الاختيار منه. true
key سلسلة نصية مفتاح ConfigMap المراد الاختيار منه. يجب أن يكون مفتاحًا صالحًا. true

يظهر في:

ContainerImage

يُعرِّف ContainerImage صورة حاوية تتضمن repository وtag أو hash.

الحقل النوع الوصف مطلوب الافتراضي
repository string اسم سجل صورة الحاوية
Example: docker.io/clickhouse/clickhouse		 false
tag string وسم صورة الحاوية، ويتعارض مع hash.
Example: 25.3		 false
hash string hash لصورة الحاوية، ويتعارض مع tag. false

يظهر في:

ContainerTemplateSpec

يصف ContainerTemplateSpec تجاوزات تهيئة الحاوية الخاصة بحاويات المجموعة.

Field Type Description Required Default
image ContainerImage Image هي صورة الحاوية المطلوب نشرها. true
imagePullPolicy PullPolicy ImagePullPolicy الخاصة بالصورة، وتكون افتراضيًا IfNotPresent. false
resources ResourceRequirements Resources هي متطلبات الموارد الخاصة بحاوية الخادم.
تُطبَّق كوحدة كاملة: لا تُستخدم القيم الافتراضية الخاصة بـ مشغّل إلا إذا كانت جميع حقول الموارد فارغة.		 false
volumeMounts VolumeMount array VolumeMounts هي قائمة نقاط ربط وحدات التخزين للحاوية.
تُضاف إلى نقاط الربط التي يُنشئها مشغّل. وتُدمج الإدخالات التي تشترك في mountPath مع
نقطة ربط خاصة بـ مشغّل ضمن وحدة تخزين مُسقطة.		 false
env EnvVar array Env هي قائمة متغيرات البيئة المطلوب ضبطها في الحاوية.
تُدمج حسب الاسم مع القيم الافتراضية الخاصة بـ مشغّل.		 false
securityContext SecurityContext يحدّد SecurityContext خيارات الأمان التي يجب تشغيل الحاوية بها.
يؤدي SecurityContext غير الصفري (non-nil) إلى استبدال القيم الافتراضية الخاصة بـ مشغّل بالكامل؛ ويصبح المستخدم مسؤولًا عن
الـ struct بالكامل. وعند كونه nil، تُحفَظ القيم الافتراضية الخاصة بـ مشغّل.
لمزيد من المعلومات: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/		 false
livenessProbe Probe يتجاوز LivenessProbe مسبار الحيوية الافتراضي الخاص بـ مشغّل. false
readinessProbe Probe يتجاوز ReadinessProbe مسبار الجاهزية الافتراضي الخاص بـ مشغّل. false

يظهر في:

DefaultPasswordSelector

يحدّد DefaultPasswordSelector مصدر كلمة مرور المستخدم default.

الحقل النوع الوصف مطلوب الافتراضي
passwordType string نوع كلمة المرور المقدَّمة. راجع الوثائق لمعرفة القيم الممكنة https://clickhouse.com/docs/operations/settings/settings-users#user-namepassword true password
secret SecretKeySelector اختر قيمة كلمة المرور من مفتاح في Secret false
configMap ConfigMapKeySelector اختر قيمة كلمة المرور من مفتاح في ConfigMap false

يظهر في:

EncryptionSettings

يتيح EncryptionSettings تشفير بيانات الجداول أثناء التخزين. عند تحديده، ينشئ المشغّل سياسة تخزين مشفّرة في ClickHouse تغلّف كل قرص بيانات؛ ويمكن للجداول تفعيلها عبر SETTINGS storage_policy. لا يمكن تعطيل التشفير بعد تمكينه.

الحقل النوع الوصف مطلوب الافتراضي
policyName string ‏PolicyName هو اسم سياسة التخزين المشفّرة التي يتم إنشاؤها. false encrypted

يظهر في:

ExternalSecret

ExternalSecret هو مرجع إلى كائن Secret في مساحة الاسم نفسها.

الحقل النوع الوصف مطلوب الافتراضي
name string اسم كائن Secret. نعم
policy ExternalSecretPolicy تتحكم السياسة في كيفية تعامل المشغِّل مع محتوى الـ Secret.
Observe (الافتراضي): يمنع عملية المواءمة إذا كان أي مفتاح مطلوب مفقودًا.
Manage: يُنشئ المفاتيح المطلوبة المفقودة في كائن Secret الحالي.		 لا Observe

يظهر في:

ExternalSecretPolicy

يتحكم ExternalSecretPolicy في كيفية تعامل المشغّل مع محتوى الـ Secret الخارجي.

الحقل الوصف
Observe ‏ExternalSecretPolicyObserve هي السياسة الافتراضية: يقرأ المشغّل الـ Secret ويتحقق من صحته؛
تُمنع عملية المواءمة إذا كان أي مفتاح مطلوب غير موجود.
ويتم الإبلاغ عن المفاتيح المطلوبة المفقودة وتنسيقاتها المتوقعة عبر شرط الحالة ExternalSecretValid في وقت التشغيل.
Manage ‏ExternalSecretPolicyManage هي السياسة التي يُكمِل فيها المشغّل أي مفاتيح مطلوبة مفقودة من خلال إنشاء
قيم لها. يتم تحديث الـ Secret، لكن المشغّل لا يمتلكه ولا يحذفه مطلقًا.

يظهر في:

KeeperCluster

يمثل KeeperCluster مخطط واجهة برمجة تطبيقات keeperclusters.

إصدار واجهة برمجة تطبيقات وKind

apiVersion: clickhouse.com/v1alpha1
kind: KeeperCluster
الحقل النوع الوصف مطلوب القيمة الافتراضية
spec KeeperClusterSpec true
status KeeperClusterStatus true

يظهر في:

KeeperClusterList

يحتوي KeeperClusterList على قائمة بـ KeeperCluster.

إصدار واجهة برمجة التطبيقات وKind

apiVersion: clickhouse.com/v1alpha1
kind: KeeperClusterList
الحقل النوع الوصف مطلوب القيمة الافتراضية
items KeeperCluster مصفوفة true

KeeperClusterReference

يُعرِّف KeeperClusterReference مورد KeeperCluster الذي يستخدمه ClickHouseCluster.

الحقل النوع الوصف مطلوب الافتراضي
name سلسلة نصية اسم مورد KeeperCluster. true
namespace سلسلة نصية مساحة الاسم لمورد KeeperCluster.
عند إغفالها، تُستخدم مساحة اسم ClickHouseCluster.		 false

يظهر في:

KeeperClusterSpec

يحدّد KeeperClusterSpec الحالة المطلوبة لـ KeeperCluster.

الحقل النوع الوصف مطلوب الافتراضي
replicas عدد صحيح عدد النسخ المتماثلة في العنقود false 3
podTemplate PodTemplateSpec المعلمات التي تُمرَّر إلى مواصفة كبسولة الخاصة بـ Keeper. false
containerTemplate ContainerTemplateSpec المعلمات التي تُمرَّر إلى مواصفة الحاوية الخاصة بـ Keeper. false
dataVolumeClaimSpec PersistentVolumeClaimSpec مواصفة التخزين الدائم لبيانات ClickHouse Keeper. false
labels كائن (المفاتيح:string، القيم:string) وسوم إضافية تُضاف إلى الموارد. false
annotations كائن (المفاتيح:string، القيم:string) تعليقات توضيحية إضافية تُضاف إلى الموارد. false
podDisruptionBudget PodDisruptionBudgetSpec يضبط PodDisruptionBudget مورد PDB الذي يتم إنشاؤه لعنقود Keeper.
عند عدم تعيينه، يستخدم المشغّل افتراضيًا maxUnavailable=replicas/2
(مع الحفاظ على النصاب لعنقود 2F+1)؛ أما العناقيد ذات النسخة المتماثلة الواحدة فتستخدم maxUnavailable=1.		 false
networkPolicy KeeperNetworkPolicySpec يضبط NetworkPolicy مورد NetworkPolicy المُدار لعنقود Keeper. false
settings KeeperSettings معلمات التهيئة لخادم ClickHouse Keeper. false
clusterDomain string ClusterDomain هي لاحقة نطاق عنقود Kubernetes المستخدمة لحلّ أسماء DNS. false cluster.local
upgradeChannel string يحدد UpgradeChannel قناة الإصدار لعمليات التحقق من ترقية الإصدارات الرئيسية.
وعندما تكون فارغة، لن تُقترح إلا التحديثات الثانوية. القيم المسموح بها هي: stable أو lts أو إصدار major.minor محدد (مثل 25.8).		 false
versionProbeTemplate VersionProbeTemplate تجاوزات VersionProbeTemplate الخاصة بـ Job اكتشاف الإصدار.
مهمل: لم تعد Jobs فحص إصدار Keeper مستخدمة؛ وقد تم الإبقاء على هذا الحقل للتوافق مع الإصدارات السابقة.		 false

يظهر في:

KeeperClusterStatus

يحدّد KeeperClusterStatus الحالة المرصودة لـ KeeperCluster.

الحقل النوع الوصف مطلوب الافتراضي
conditions مصفوفة Condition false
readyReplicas integer ReadyReplicas هو إجمالي عدد النسخ المتماثلة الجاهزة لمعالجة الطلبات. false
configurationRevision string يشير ConfigurationRevision إلى مراجعة التهيئة المستهدفة لكل نسخة متماثلة. true
statefulSetRevision string يشير StatefulSetRevision إلى مراجعة StatefulSet المستهدفة لكل نسخة متماثلة. true
currentRevision string يشير CurrentRevision إلى أحدث مراجعة مطبّقة لمواصفة KeeperCluster. true
updateRevision string يشير UpdateRevision إلى أحدث مراجعة مطلوبة لمواصفة KeeperCluster. true
observedGeneration integer يشير ObservedGeneration إلى أحدث رقم جيل رصدته وحدة التحكم. true
version string يشير Version إلى الإصدار الذي أبلغ عنه خادم Keeper. false
versionProbeRevision string VersionProbeRevision هو بصمة الصورة لآخر فحص إصدار ناجح.
مهمل: لا تُستخدم Jobs فحص إصدار Keeper؛ وقد تم الإبقاء على هذا الحقل للحفاظ على التوافق مع الإصدارات السابقة.		 false

يظهر في:

KeeperNetworkPolicySpec

تُهيّئ KeeperNetworkPolicySpec مورد NetworkPolicy المُدار لعنقود Keeper. تغطي السياسة المُدارة حركة المرور الداخلية للعنقود:

  • الاتصال بين النسخ المتماثلة
  • الوصول من المشغّل إلى العنقود
  • الوصول من عناقيد ClickHouse التي تشير إلى عنقود Keeper هذا يتطلب أي دخول آخر، بما في ذلك جمع المقاييس، سياسات NetworkPolicy يعرّفها المستخدم.
الحقل النوع الوصف مطلوب الافتراضي
policy NetworkPolicyPolicy تحدد السياسة ما إذا كان المشغّل يدير مورد NetworkPolicy يقيّد حركة الدخول إلى كبسولات Keeper.
تكون القيمة الافتراضية "Disabled" إذا لم تُعيَّن.		 false Disabled

يظهر في:

KeeperSettings

تُعرّف KeeperSettings إعدادات خادم ClickHouse Keeper.

الحقل النوع الوصف مطلوب الافتراضي
logger LoggerConfig إعدادات تسجيل السجلات لخادم ClickHouse Keeper. false
tls ClusterTLSSpec إعدادات TLS، وتتيح تهيئة نقاط النهاية الآمنة والتحقق من الشهادات لخادم ClickHouse Keeper. false
extraConfig RawExtension إعدادات ClickHouse Keeper إضافية سيتم دمجها مع الإعدادات الافتراضية. false

يظهر في:

LoggerConfig

يحدّد LoggerConfig إعدادات تسجيل الخادم.

الحقل النوع الوصف مطلوب الافتراضي
logToFile منطقي إذا كانت القيمة false، فسيتم تعطيل كل عمليات التسجيل إلى ملف. false true
jsonLogs منطقي إذا كانت القيمة true، فسيتم التسجيل بتنسيق JSON. false false
level سلسلة نصية مستوى تفصيل مسجل الخادم. false trace
size سلسلة نصية الحد الأقصى لحجم ملف السجل. false 1000M
count عدد صحيح الحد الأقصى لعدد ملفات السجل المطلوب الاحتفاظ بها. false 50

يظهر في:

NamedTemplateMeta

يحدّد NamedTemplateMeta إعدادات البيانات الوصفية المدعومة لكائنات القوالب التي تتطلب اسمًا.

الحقل النوع الوصف مطلوب الافتراضي
name string الاسم هو معرّف المورد. true
labels كائن (المفاتيح:string، القيم:string) Labels هي التسميات المطبّقة على كائنات القوالب. false
annotations كائن (المفاتيح:string، القيم:string) Annotations هي التعليقات التوضيحية المطبّقة على كائنات القوالب. false

يظهر في:

NetworkPolicyPolicy

يتحكم NetworkPolicyPolicy في ما إذا كان المشغّل يدير NetworkPolicy للعنقود.

الحقل الوصف
Enabled يجعل NetworkPolicyEnabled المشغّل يدير NetworkPolicy يقيّد حركة المرور الواردة إلى Pods العنقود.
Disabled يعطّل NetworkPolicyDisabled ‏NetworkPolicy المُدار، ويحذفه المشغّل إذا كان موجودًا.

يظهر في:

PDBPolicy

تتحكم PDBPolicy في ما إذا كان سيتم إنشاء PodDisruptionBudgets.

الحقل الوصف
Enabled يتيح PDBPolicyEnabled للمشغّل إنشاء PodDisruptionBudgets.
Disabled يعطّل PDBPolicyDisabled ‏PodDisruptionBudgets، وسيحذف المشغّل المورد الذي يحمل التسميات المطابقة.
Ignored يتجاهل PDBPolicyIgnored ‏PodDisruptionBudgets، ولن يُنشئ المشغّل أي PDBs أو يحذفها، وستبقى PDBs الحالية دون تغيير.

يظهر في:

PersistentVolumeClaimTemplate

PersistentVolumeClaimTemplate هو قالب مُسمّى لـ PersistentVolumeClaim لكل نسخة متماثلة.

الحقل النوع الوصف مطلوب الافتراضي
metadata NamedTemplateMeta ارجع إلى وثائق واجهة برمجة تطبيقات Kubernetes للتعرّف على حقول metadata. true
spec PersistentVolumeClaimSpec يحدّد Spec الخصائص المطلوبة لوحدة تخزين يطلبها منشئ الجراب.
مزيد من المعلومات: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims		 true

يظهر في:

PodDisruptionBudgetSpec

يُهيّئ PodDisruptionBudgetSpec مورد PDB الذي يتم إنشاؤه للعنقود. يمكن تعيين واحد فقط من MinAvailable أو MaxUnavailable. إذا لم يتم تعيين أيٍّ منهما، يختار المشغّل قيمة default آمنة استنادًا إلى عدد النُسخ المتماثلة.

الحقل النوع الوصف مطلوب الافتراضي
policy PDBPolicy تحدد السياسة ما إذا كان المشغّل سينشئ PodDisruptionBudgets.
تكون القيمة الافتراضية "Enabled" عند عدم تعيينها. اضبطها على "Disabled" لتخطي إنشاء PDB (على سبيل المثال، لبيئات التطوير).		 false Enabled
minAvailable IntOrString MinAvailable هو الحد الأدنى لعدد البودات التي يجب أن تظل متاحة أثناء الانقطاع. false
maxUnavailable IntOrString MaxUnavailable هو الحد الأقصى لعدد البودات التي يمكن أن تصبح غير متاحة أثناء الانقطاع. false
unhealthyPodEvictionPolicy UnhealthyPodEvictionPolicyType يحدد UnhealthyPodEvictionPolicy المعايير الخاصة بالحالات التي
ينبغي فيها اعتبار البودات غير السليمة
مؤهلةً للإخلاء.
القيم الصالحة هي "IfReady" و "AlwaysAllow".		 false

يظهر في:

PodTemplateSpec

يصف PodTemplateSpec تجاوزات إعدادات الكبسولات الخاصة بالعنقود.

الحقل النوع الوصف مطلوب القيمة الافتراضية
terminationGracePeriodSeconds عدد صحيح مدة اختيارية بالثواني تحتاجها الكبسولة لإنهاء التشغيل بشكل سليم. ويمكن تقليلها في طلب الحذف.
يجب أن تكون القيمة عددًا صحيحًا غير سالب. وتشير القيمة صفر إلى التوقف الفوري عبر
إشارة kill (من دون إتاحة فرصة لإيقاف التشغيل).
إذا كانت هذه القيمة nil، فستُستخدم فترة السماح الافتراضية بدلًا منها.
وفترة السماح هي المدة بالثواني بين إرسال
إشارة إنهاء إلى العمليات التي تعمل داخل الكبسولة وبين الوقت الذي تُوقَف فيه هذه العمليات قسرًا بإشارة kill.
اضبط هذه القيمة بحيث تكون أطول من وقت التنظيف المتوقع لعمليتك.
القيمة الافتراضية هي 30 ثانية.		 لا
topologySpreadConstraints TopologySpreadConstraint مصفوفة يصف TopologySpreadConstraints كيفية توزيع مجموعة من الكبسولات عبر نطاقات
الطوبولوجيا. سيُجدول المُجدول الكبسولات بطريقة تلتزم بالقيود.
تُطبَّق جميع topologySpreadConstraints بعامل AND.
تُدمَج مع القيم الافتراضية الخاصة بالمُشغِّل بحسب topologyKey.		 لا
imagePullSecrets LocalObjectReference مصفوفة ImagePullSecrets هي قائمة اختيارية من المراجع إلى الأسرار الموجودة في مساحة الاسم نفسها، تُستخدم لسحب أي صور يستخدمها PodSpec هذا.
عند تحديدها، تُمرَّر هذه الأسرار إلى كل آلية سحب على حدة لاستخدامها.
مزيد من المعلومات: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
تُدمج مع القيم الافتراضية للمُشغِّل حسب الاسم.		 false
nodeSelector كائن (المفاتيح:string, القيم:string) NodeSelector هو محدِّد يجب أن يتحقق لكي يمكن وضع الجراب على عقدة.
محدِّد يجب أن يطابق تسميات العقدة لكي تتم جدولة الجراب على تلك العقدة.
مزيد من المعلومات: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/		 false
affinity التقارب إذا تم تحديدها، فهي قيود جدولة الكبسولة.
تُلحَق بالقيم الافتراضية للمُشغِّل: تُدمَج قوائم شروط الجدولة.		 false
tolerations مصفوفة من Toleration إذا تم تحديدها، فهي قيم Tolerations الخاصة بالكبسولة. false
schedulerName string إذا تم تحديده، فستُسنَد الكبسولة إلى المُجدول المحدد.
إذا لم يتم تحديده، فستُسنَد الكبسولة إلى المُجدول الافتراضي.		 false
serviceAccountName string ServiceAccountName هو اسم ServiceAccount المستخدم لتشغيل هذا الجراب.
مزيد من المعلومات: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/		 false
priorityClassName string PriorityClassName هو اسم PriorityClass المُراد استخدامه للكبسولة. خطأ
runtimeClassName سلسلة نصية RuntimeClassName هو اسم RuntimeClass المُراد استخدامه للكبسولة. خطأ
volumes Volume مصفوفة يحدّد Volumes قائمة وحدات التخزين التي يمكن للحاويات التابعة للكبسولة ربطها.
مزيد من المعلومات: https://kubernetes.io/docs/concepts/storage/volumes
تُدمج مع القيم الافتراضية للمشغّل حسب الاسم؛ وتستبدل أي وحدة تخزين يضيفها المستخدم أي وحدة تخزين للمشغّل تحمل الاسم نفسه.		 false
securityContext PodSecurityContext يحتوي SecurityContext على سمات الأمان على مستوى الـ pod وإعدادات الحاويات المشتركة.
يستبدل SecurityContext غير المعيَّن بالقيمة nil الإعدادات الافتراضية للمشغّل بالكامل؛ ويكون المستخدم مسؤولًا عن
البنية بالكامل. وعند تعيينه بالقيمة nil، تُحفَظ الإعدادات الافتراضية للمشغّل.		 false
topologyZoneKey String TopologyZoneKey هو مفتاح وسوم العُقد.
تُعدّ العُقد التي تحمل وسمًا بهذا المفتاح وقيمًا متطابقة ضمن النطاق الطوبولوجي نفسه،
مثل منطقة التوافر نفسها بالنسبة إلى "topology.kubernetes.io/zone" أو العقدة نفسها بالنسبة إلى "kubernetes.io/hostname".
اضبطه لتحقيق توازن بين الكبسولات التي تحتفظ بالبيانات نفسها (النسخ المتماثلة لجزء واحد في ClickHouse، وجميع النسخ المتماثلة في Keeper)
عبر النطاقات: قيد TopologySpreadConstraint مطلوب (بقيمتَي maxSkew=1 وDoNotSchedule) بالإضافة إلى قاعدة PodAntiAffinity مُفضَّلة.
قد تتشارك كبسولات الأجزاء المختلفة نطاقًا واحدًا، لذا يُسمح بوجود عدة كبسولات في كل نطاق.
عند وجود نطاقات أقل من النسخ المتماثلة، ستتشارك عدة نسخ متماثلة نطاقًا واحدًا، مع بقاء التوازن متساويًا.
تُفضِّل كبسولات ClickHouse أيضًا النطاقات التي تستضيف كبسولات Keeper التي تستخدمها.
يُوصى بضبطه على "topology.kubernetes.io/zone".		 false
nodeHostnameKey String NodeHostnameKey هو مفتاح وسوم العقد.
تُعدّ العقد التي تحمل وسمًا بهذا المفتاح وبالقيمة نفسها موجودة على العقدة نفسها.
اضبطه لفرض إشغال حصري للعقدة: قاعدة PodAntiAffinity مطلوبة على مستوى جميع الكبسولات في العنقود،
بحيث لا توجد أكثر من كبسولة واحدة لكل عقدة بغض النظر عن الجزء. ويتطلب ذلك عددًا من العقد لا يقل عن عدد الكبسولات؛
ومع وجود عدد أقل من العقد، تبقى الكبسولات الزائدة في حالة Pending.
ولتوزيع النسخ المتماثلة للجزء نفسه عبر العقد مع وضع عدة كبسولات في كل عقدة،
اضبط TopologyZoneKey على "kubernetes.io/hostname" بدلًا من ذلك.
يُنصح بضبطه على "kubernetes.io/hostname".		 false
initContainers مصفوفة من حاوية InitContainers هي قائمة حاويات التهيئة التي تُشغَّل قبل بدء تشغيل حاوية الخادم الرئيسية.
وتُدمَج مع الإعدادات الافتراضية الخاصة بالمُشغِّل بحسب الاسم،
إذا كان الاسم نفسه.		 false

يرد في:

SecretKeySelector

يحدّد SecretKeySelector مفتاحًا من مورد Secret.

الحقل النوع الوصف مطلوب الافتراضي
name string اسم الـ Secret في مساحة اسم الـ cluster المطلوب الاختيار منه. true
key string مفتاح الـ Secret المطلوب الاختيار منه. يجب أن يكون مفتاح Secret صالحًا. true

يظهر في:

TemplateMeta

يحدّد TemplateMeta إعدادات البيانات الوصفية المدعومة لكائنات القوالب.

الحقل النوع الوصف مطلوب الافتراضي
labels object (keys:string, values:string) الملصقات هي ملصقات تُطبَّق على كائنات القوالب. false
annotations object (keys:string, values:string) التعليقات التوضيحية هي تعليقات توضيحية تُطبَّق على كائنات القوالب. false

يظهر في:

VersionProbeContainer

يحدّد VersionProbeContainer عمليات تجاوز على مستوى الحاوية لمسبار الإصدار. تتطابق أسماء الحقول ووسوم JSON مع corev1.Container لكي تُجري SMP عمليات الدمج حسب الاسم.

الحقل النوع الوصف مطلوب الافتراضي
name سلسلة نصية اسم الحاوية. إذا كان فارغًا، يضبطه المشغّل على اسم حاوية مسبار الإصدار. true version-probe
resources ResourceRequirements الموارد هي متطلبات موارد الحوسبة لحاوية مسبار الإصدار.
تُدمَج دمجًا عميقًا مع القيم الافتراضية للمشغّل عبر SMP.		 false
securityContext SecurityContext يحدّد SecurityContext خيارات الأمان لحاوية مسبار الإصدار.
تُدمَج دمجًا عميقًا مع القيم الافتراضية للمشغّل عبر SMP.		 false

يظهر في:

VersionProbeJobSpec

يحدّد VersionProbeJobSpec عمليات التجاوز على مستوى Job لمسبار الإصدار.

Field Type Description Required Default
ttlSecondsAfterFinished integer يحدّ TTLSecondsAfterFinished من مدة بقاء Job مكتملة. false
template VersionProbePodTemplate يصف القالب الكبسولة التي ستُنشأ لمهمة مسبار الإصدار. false

يظهر في:

VersionProbePodSpec

يحدّد VersionProbePodSpec التجاوزات على مستوى الكبسولة لمسبار الإصدار. تتطابق أسماء الحقول ووسوم JSON مع corev1.PodSpec لضمان التوافق مع strategic merge patch.

Field Type Description Required Default
nodeSelector object (keys:string, values:string) يقيّد NodeSelector كبسولة مسبار الإصدار بالعُقد ذات labels المطابقة. false
tolerations Toleration array قيم Tolerations لكبسولة مسبار الإصدار. false
securityContext PodSecurityContext يحتوي SecurityContext على سمات الأمان على مستوى الكبسولة لكبسولة مسبار الإصدار. false
containers VersionProbeContainer array تجاوزات الحاويات لكبسولة مسبار الإصدار.
حقل الاسم اختياري — يملؤه المشغّل بالحاوية default.
يمكن تحديد حاوية إضافية باسم مختلف.		 false

يظهر في:

VersionProbePodTemplate

يصف VersionProbePodTemplate إعدادات التجاوز الخاصة بكبسولة مسبار الإصدار.

الحقل النوع الوصف مطلوب الافتراضي
metadata TemplateMeta راجع وثائق واجهة برمجة تطبيقات Kubernetes للتعرّف على حقول metadata. false
spec VersionProbePodSpec مواصفات السلوك المطلوب لكبسولة مسبار الإصدار. false

يظهر في:

VersionProbeTemplate

يحدّد VersionProbeTemplate التجاوزات الخاصة بـ Job اكتشاف الإصدار. ويحاكي هذا التركيب batchv1.JobTemplateSpec، مع إتاحة الحقول المدعومة فقط.

الحقل النوع الوصف مطلوب الافتراضي
metadata TemplateMeta راجع وثائق Kubernetes API للتعرّف على حقول metadata. false
spec VersionProbeJobSpec مواصفة السلوك المطلوب لـ Job مسبار الإصدار. false

يظهر في:

Navigation