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

kubectl-api-resources - چاپ منابع پشتیبانی‌شدهٔ API در سرور

kubectl api-resources [OPTIONS]

چاپ منابع پشتیبانی‌شدهٔ API در سرور.

--api-group="" محدود کردن به منابع موجود در گروه API (API group) مشخص‌شده.

--cached=false استفاده از فهرست کش‌شدهٔ منابع در صورت موجود بودن.

--categories=[] محدود کردن به منابعی که به دسته‌بندی‌های مشخص‌شده تعلق دارند.

--namespaced=true در صورت false بودن، منابع فاقد فضای نام (non-namespaced) بازگردانده می‌شوند، در غیر این صورت به طور پیش‌فرض منابع دارای فضای نام بازگردانده می‌شوند.

--no-headers=false هنگام استفاده از قالب خروجی پیش‌فرض یا ستون‌های سفارشی (custom-column)، سرستون‌ها چاپ نمی‌شوند (پیش‌فرض: چاپ سرستون‌ها).

-o, --output="" قالب خروجی. یکی از موارد: (json, yaml, kyaml, name, wide).

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

--sort-by="" در صورت خالی نبودن، فهرست منابع با استفاده از فیلد مشخص‌شده مرتب می‌شود. این فیلد می‌تواند 'name' یا 'kind' باشد.

--verbs=[] محدود کردن به منابعی که از فعل‌های (verbs) مشخص‌شده پشتیبانی می‌کنند.

--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 برای استفاده در ترجیحات (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="" نام سرور برای اعتبارسنجی گواهی سرور. در صورت عدم ارائه، از hostname استفاده‌شده برای برقراری ارتباط با سرور استفاده می‌شود

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

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

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

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

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

# چاپ منابع پشتیبانی‌شده API
kubectl api-resources
# چاپ منابع پشتیبانی‌شده API با جزئیات بیشتر
kubectl api-resources -o wide
# چاپ منابع پشتیبانی‌شده API مرتب‌شده بر اساس یک ستون
kubectl api-resources --sort-by=name
# چاپ منابع پشتیبانی‌شده دارای فضای نام
kubectl api-resources --namespaced=true
# چاپ منابع پشتیبانی‌شده بدون فضای نام
kubectl api-resources --namespaced=false
# چاپ منابع پشتیبانی‌شده API با یک APIGroup خاص
kubectl api-resources --api-group=rbac.authorization.k8s.io

kubectl(1),

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

Jan 2015 Eric Paris