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

kubectl-get - نمایش یک یا چند منبع

kubectl get [OPTIONS]

نمایش یک یا چند منبع.

جدولی از مهم‌ترین اطلاعات دربارهٔ منابع مشخص‌شده را چاپ می‌کند. می‌توانید با استفاده از سلکتور برچسب و فلگ --selector فهرست را فیلتر کنید. اگر نوع منبع مورد نظر دارای فضای نام (namespaced) باشد و هیچ فضای نامی را مشخص نکنید، تنها نتایج درون فضای نام فعلی را مشاهده خواهید کرد.

با مشخص کردن خروجی به عنوان 'template' و ارائه یک الگوی Go به عنوان مقدار فلگ --template، می‌توانید ویژگی‌های منابع دریافتی را فیلتر کنید.

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

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

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

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

--field-selector="" سلکتور (پرس‌وجوی فیلد) برای فیلتر کردن؛ از '='، '==' و '!=' پشتیبانی می‌کند (مانند --field-selector key1=value1,key2=value2). سرور تنها تعداد محدودی پرس‌وجوی فیلد را برای هر نوع پشتیبانی می‌کند.

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

--ignore-not-found=false در صورت تنظیم روی true، خطای NotFound برای اشیاء مشخصی که وجود ندارند نادیده گرفته می‌شود. استفاده از این فلگ همراه با دستوراتی که مجموعه‌ای از منابع را پرس‌وجو می‌کنند، در صورت پیدا نشدن منبع هیچ تاثیری ندارد.

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

-L, --label-columns=[] فهرستی از برچسب‌های جداشده با کاما را می‌پذیرد که به صورت ستون نمایش داده خواهند شد. نام‌ها به حروف بزرگ و کوچک حساس هستند. همچنین می‌توانید از چندین فلگ مانند -L label1 -L label2... استفاده کنید.

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

-o, --output="" قالب خروجی. یکی از: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file, custom-columns, custom-columns-file, wide). به بخش ستون‌های سفارشی [https://kubernetes.io/docs/reference/kubectl/#custom-columns]، الگوی golang [http://golang.org/pkg/text/template/#pkg-overview] و الگوی jsonpath [https://kubernetes.io/docs/reference/kubectl/jsonpath] مراجعه کنید.

--output-watch-events=false خروجی دادن اشیاء رویداد پایش (watch event) هنگام استفاده از --watch یا --watch-only. اشیاء موجود به عنوان رویدادهای اولیهٔ ADDED خروجی داده می‌شوند.

--raw="" نشانی URI خام برای درخواست از سرور. از انتقال مشخص‌شده توسط فایل kubeconfig استفاده می‌کند.

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

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

--server-print=true در صورت true بودن، سرور خروجی جدول مناسب را برمی‌گرداند. از APIهای توسعه‌یافته و CRDها پشتیبانی می‌کند.

--show-kind=false در صورت وجود، نوع منبع را برای شیء یا اشیاء درخواستی فهرست می‌کند.

--show-labels=false هنگام چاپ، تمام برچسب‌ها را به عنوان آخرین ستون نمایش می‌دهد (پیش‌فرض پنهان کردن ستون برچسب‌ها است).

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

--sort-by="" در صورت غیرخالی بودن، انواع فهرست را با استفاده از مشخصات این فیلد مرتب می‌کند. مشخصات فیلد به صورت یک عبارت JSONPath بیان می‌شود (مانند '{.metadata.name}'). فیلد مشخص‌شده با این عبارت JSONPath در منبع API باید عدد صحیح یا رشته باشد.

--subresource="" در صورت مشخص شدن، زیرمنبع (subresource) شیء درخواستی را دریافت می‌کند.

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

-w, --watch=false پس از فهرست کردن/دریافت شیء درخواستی، تغییرات آن را پایش می‌کند (watch).

--watch-only=false پایش تغییرات شیء یا اشیاء درخواستی، بدون فهرست کردن/دریافت اولیه.

--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 در نظر گرفتن هشدارهای دریافتی از سرور به عنوان خطا و خروج با کد وضعیت غیر صفر

# فهرست کردن تمام پادها در قالب خروجی ps
kubectl get pods
# فهرست کردن تمام پادها در قالب خروجی ps با اطلاعات بیشتر (مانند نام گره)
kubectl get pods -o wide
# فهرست کردن یک replication controller تکی با نام مشخص‌شده در قالب خروجی ps
kubectl get replicationcontroller web
# فهرست کردن استقرارها در قالب خروجی JSON، در نسخه "v1" از گروه API به نام "apps"
kubectl get deployments.v1.apps -o json
# فهرست کردن یک پاد تکی در قالب خروجی JSON
kubectl get -o json pod web-pod-13je7
# فهرست کردن یک پاد شناسایی‌شده با نوع و نام تعیین‌شده در "pod.yaml" در قالب خروجی JSON
kubectl get -f pod.yaml -o json
# فهرست کردن منابع از یک دایرکتوری حاوی kustomization.yaml - مانند dir/kustomization.yaml
kubectl get -k dir/
# بازگرداندن تنها مقدار phase از پاد مشخص‌شده
kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}
# فهرست کردن اطلاعات منبع در ستون‌های سفارشی
kubectl get pod test-pod -o custom-columns=CONTAINER:.spec.containers[0].name,IMAGE:.spec.containers[0].image
# فهرست کردن تمام کنترلرهای تکثیر و سرویس‌ها با هم در قالب خروجی ps
kubectl get rc,services
# فهرست کردن یک یا چند منبع بر اساس نوع و نام آن‌ها
kubectl get rc/web service/frontend pods/web-pod-13je7
# فهرست کردن زیرمنبع 'status' برای یک پاد تکی
kubectl get pod web-pod-13je7 --subresource status
# فهرست کردن تمام استقرارها در فضای نام 'backend'
kubectl get deployments.apps --namespace backend
# فهرست کردن تمام پادهای موجود در تمام فضاهای نام
kubectl get pods --all-namespaces

kubectl(1)

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

Jan 2015 Eric Paris