نام (NAME)

kubectl-describe - نمایش جزئیات یک منبع مشخص یا گروهی از منابع

خلاصه دستور (SYNOPSIS)

kubectl describe [OPTIONS]

توضیحات (DESCRIPTION)

نمایش جزئیات یک منبع مشخص یا گروهی از منابع.

چاپ توضیحات دقیق درباره منابع انتخاب‌شده، شامل منابع مرتبط مانند رویدادها (events) یا کنترل‌کننده‌ها (controllers). شما می‌توانید یک شیء منفرد را بر اساس نام، تمام اشیاء از آن نوع، ارائه یک پیشوند نام یا انتخاب‌گر برچسب انتخاب کنید. برای مثال:

$ kubectl describe TYPE NAME_PREFIX

ابتدا تطابق دقیق بین TYPE و NAME_PREFIX را بررسی می‌کند. اگر چنین منبعی وجود نداشته باشد، جزئیات هر منبعی را که نام آن با NAME_PREFIX شروع شود در خروجی نمایش می‌دهد.

برای مشاهده فهرست کاملی از منابع پشتیبانی‌شده از دستور "kubectl api-resources" استفاده کنید.

گزینه‌ها (OPTIONS)

-A, --all-namespaces=false در صورت وجود، شیء یا اشیاء درخواستی را در تمام فضاهای نام (namespaces) فهرست می‌کند. فضای نام موجود در کانتکست فعلی حتی در صورت مشخص شدن با --namespace نادیده گرفته می‌شود.

--chunk-size=500 بازگرداندن فهرست‌های بزرگ به صورت تکه‌ای (chunk) به جای یکباره. برای غیرفعال کردن مقدار 0 را وارد کنید.

-f, --filename=[] نام فایل، دایرکتوری یا URL به فایل‌های حاوی منبع برای توصیف

-k, --kustomize="" پردازش دایرکتوری kustomization. این فلگ نمی‌تواند همزمان با -f یا -R استفاده شود.

-R, --recursive=false پردازش بازگشتی دایرکتوری استفاده‌شده در -f، --filename. زمانی مفید است که می‌خواهید مانیفست‌های مرتبط سازمان‌دهی‌شده در یک دایرکتوری را مدیریت کنید.

-l, --selector="" انتخاب‌گر (پرس‌وجوی برچسب) برای فیلتر کردن، از '='، '=='، '!='، 'in' و 'notin' پشتیبانی می‌کند (مانند ‎-l key1=value1,key2=value2,key3 in (value3)‎). اشیاء منطبق باید تمام محدودیت‌های برچسب مشخص‌شده را برآورده کنند.

--show-events=true در صورت true بودن، رویدادهای مربوط به شیء توصیف‌شده را نمایش می‌دهد. به طور پیش‌فرض برای یک شیء منفرد برابر با true و برای چندین شیء و تطابق پیشوند برابر با false است.

گزینه‌های به ارث رسیده از دستورات والد (OPTIONS INHERITED FROM PARENT COMMANDS)

--as="" نام کاربری برای جعل هویت (impersonate) در این عملیات. کاربر می‌تواند یک کاربر معمولی یا یک حساب خدمت (service account) در یک فضای نام (namespace) باشد.

--as-group=[] گروه برای جعل هویت در این عملیات؛ این فلگ می‌تواند برای تعیین چندین گروه تکرار شود.

--as-uid="" شناسه UID برای جعل هویت در این عملیات.

--as-user-extra=[] اطلاعات اضافی کاربر برای جعل هویت در این عملیات؛ این فلگ می‌تواند برای مشخص کردن چندین مقدار برای یک کلید یکسان تکرار شود.

--cache-dir="/home/username/.kube/cache" دایرکتوری پیش‌فرض کش

--certificate-authority="" مسیر فایل گواهینامه برای مرجع صدور گواهینامه (certificate authority)

--client-certificate="" مسیر فایل گواهینامه کلاینت برای TLS

--client-key="" مسیر فایل کلید کلاینت برای TLS

--cluster="" نام کلاستر kubeconfig برای استفاده

--context="" نام کانتکست kubeconfig برای استفاده

--disable-compression=false در صورت true بودن، از فشرده‌سازی پاسخ‌ها برای تمام درخواست‌ها به سرور صرف‌نظر می‌شود

--insecure-skip-tls-verify=false در صورت true بودن، اعتبار گواهینامه سرور بررسی نخواهد شد. این کار اتصالات HTTPS شما را ناامن می‌کند

--kubeconfig="" مسیر فایل kubeconfig برای استفاده در درخواست‌های CLI.

--kuberc="" مسیر فایل kuberc برای استفاده در تنظیمات ترجیحی. این قابلیت می‌تواند با export کردن ویژگی KUBECTL_KUBERC=false یا خاموش کردن ویژگی با KUBERC=off غیرفعال شود.

--match-server-version=false الزام به تطابق نسخه سرور با نسخه کلاینت

-n, --namespace="" در صورت وجود، دامنه فضای نام (namespace) برای این درخواست CLI

--password="" رمز عبور برای احراز هویت پایه (basic authentication) در سرور API

--profile="none" نام پروفایل برای ثبت. یکی از موارد (none|cpu|heap|goroutine|threadcreate|block|mutex|trace)

--profile-output="profile.pprof" نام فایلی که پروفایل در آن ذخیره می‌شود

--request-timeout="0" مدت زمان انتظار پیش از انصراف از یک درخواست به سرور. مقادیر غیر صفر باید شامل واحد زمانی متناظر باشند (مانند 1s، 2m، 3h). مقدار صفر یعنی درخواست‌ها هرگز منقضی نشوند (بدون وقفه زمانی).

-s, --server="" آدرس و پورت سرور Kubernetes API

--tls-server-name="" نام سرور برای اعتبارسنجی گواهینامه سرور. در صورت عدم ارائه، از hostname استفاده‌شده برای برقراری ارتباط با سرور استفاده می‌شود

--token="" توکن Bearer برای احراز هویت در سرور API

--user="" نام کاربر kubeconfig برای استفاده

--username="" نام کاربری برای احراز هویت پایه در سرور API

--version=false گزینه --version یا --version=raw اطلاعات نسخه را چاپ کرده و خارج می‌شود؛ --version=vX.Y.Z... نسخه گزارش‌شده را تنظیم می‌کند

--warnings-as-errors=false در نظر گرفتن هشدارهای دریافتی از سرور به عنوان خطا و خروج با کد وضعیت غیر صفر

مثال (EXAMPLE)

# Describe a node
kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
# Describe a pod
kubectl describe pods/nginx
# Describe a pod identified by type and name in "pod.json"
kubectl describe -f pod.json
# Describe all pods
kubectl describe pods
# Describe pods by label name=myLabel
kubectl describe pods -l name=myLabel
# Describe all pods managed by the 'frontend' replication controller
# (rc-created pods get the name of the rc as a prefix in the pod name)
kubectl describe pods frontend

همچنین ببینید (SEE ALSO)

kubectl(1),

تاریخچه (HISTORY)

ژانویه ۲۰۱۵، در ابتدا توسط Eric Paris (eparis at redhat dot com) بر پایه محتوای منبع kubernetes گردآوری شد، اما امید است که از آن زمان به بعد به طور خودکار تولید شده باشند!