KUBERNETES(1) راهنمای کاربر kubernetes KUBERNETES(1)

kubectl-cluster-info-dump - استخراج اطلاعات مرتبط جهت اشکال‌زدایی و عیب‌یابی کلاستر

kubectl cluster-info dump [OPTIONS]

اطلاعات کلاستر را به صورتی مناسب برای اشکال‌زدایی و عیب‌یابی مشکلات کلاستر استخراج می‌کند. به طور پیش‌فرض، همه چیز را در خروجی استاندارد (stdout) می‌نویسد. می‌توانید به دلخواه با استفاده از --output-directory یک دایرکتوری را مشخص کنید. اگر یک دایرکتوری مشخص کنید، کوبرنتیز مجموعه‌ای از فایل‌ها را در آن دایرکتوری ایجاد خواهد کرد. به طور پیش‌فرض، فقط اطلاعات موجود در فضای نام جاری و فضای نام 'kube-system' استخراج می‌شوند، اما می‌توانید با فلگ --namespaces به یک فضای نام دیگر بروید، یا با مشخص کردن --all-namespaces اطلاعات تمام فضاهای نام را استخراج کنید.

این دستور همچنین لاگ‌های تمام پادهای موجود در کلاستر را تخلیه می‌کند؛ این لاگ‌ها بر اساس فضای نام و نام پاد در دایرکتوری‌های متفاوتی قرار می‌گیرند.

-A, --all-namespaces=false در صورت true بودن، استخراج اطلاعات تمام فضاهای نام. در صورت true بودن، --namespaces نادیده گرفته می‌شود.

--allow-missing-template-keys=true در صورت true بودن، نادیده گرفتن هرگونه خطا در الگوها زمانی که یک فیلد یا کلید نگاشت (map key) در الگو وجود ندارد. فقط برای قالب‌های خروجی golang و jsonpath اعمال می‌شود.

--namespaces=[] فهرستی از فضاهای نام که با کاما از هم جدا شده‌اند برای استخراج.

-o, --output="json" قالب خروجی. یکی از موارد: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).

--output-directory="" محل ذخیره فایل‌های خروجی. در صورت خالی بودن یا '-' از stdout استفاده می‌کند، در غیر این صورت سلسله‌مراتبی از دایرکتوری‌ها را در آن دایرکتوری ایجاد می‌کند.

--pod-running-timeout=20s مدت زمان انتظار (مانند 5s، 2m یا 3h، بزرگ‌تر از صفر) تا زمانی که حداقل یک پاد در حال اجرا باشد.

--show-managed-fields=false در صورت true بودن، هنگام چاپ اشیاء در قالب JSON یا YAML، فیلدهای managedFields حفظ می‌شوند.

--template="" رشته الگو یا مسیر فایل الگو برای استفاده در زمانی که -o=go-template یا -o=go-template-file باشد. قالب الگو از نوع الگوهای golang است [http://golang.org/pkg/text/template/#pkg-overview].

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

--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 برای استفاده در ترجیحات (preferences). این قابلیت می‌تواند با export کردن feature gate به صورت 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). مقدار صفر یعنی درخواست‌ها هرگز دچار وقفه زمانی (timeout) نشوند.

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

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

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

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

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

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

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

# استخراج وضعیت جاری کلاستر در خروجی استاندارد (stdout)
kubectl cluster-info dump
# استخراج وضعیت جاری کلاستر در مسیر /path/to/cluster-state
kubectl cluster-info dump --output-directory=/path/to/cluster-state
# استخراج تمام فضاهای نام در خروجی استاندارد (stdout)
kubectl cluster-info dump --all-namespaces
# استخراج مجموعه‌ای از فضاهای نام در مسیر /path/to/cluster-state
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state

kubectl-cluster-info(1),

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

Jan 2015 Eric Paris