نام (NAME)

puppet-catalog - کامپایل، ذخیره، مشاهده و تبدیل کاتالوگ‌ها

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

puppet catalog action [--terminus _TERMINUS]

توضیحات (DESCRIPTION)

این زیردستور با کاتالوگ‌ها (catalogs) سروکار دارد؛ کاتالوگ‌ها مصنوعات کامپایل‌شده به ازای هر گره هستند که از مجموعه‌ای از مانیفست‌های Puppet ایجاد می‌شوند. به‌طور پیش‌فرض، این زیردستور با زیرسیستم کامپایل تعامل کرده و یک کاتالوگ را با استفاده از مانیفست پیش‌فرض و certname کامپایل می‌کند، اما می‌توانید منبع کاتالوگ را با گزینهٔ --terminus تغییر دهید. همچنین می‌توانید با استفاده از '--render-as dot'، هر کاتالوگی را در قالب 'dot' چاپ کنید (برای مشاهده آسان گراف با OmniGraffle یا Graphviz).

گزینه‌ها (OPTIONS)

توجه داشته باشید هر تنظیمی که در فایل پیکربندی معتبر باشد، به عنوان یک آرگومان طولانی نیز معتبر است، هرچند ممکن است به عمل فعلی مرتبط باشد یا نباشد. برای نمونه، server و run_mode تنظیمات معتبری هستند، بنابراین می‌توانید --server <servername> یا --run_mode <runmode> را به عنوان آرگومان مشخص کنید.

برای فهرست کامل پارامترهای قابل قبول، مستندات فایل پیکربندی را در https://puppet.com/docs/puppet/latest/configuration.html ببینید. همچنین می‌توان با اجرای puppet به همراه --genconfig فهرستی حاوی توضیحات از تمام گزینه‌های پیکربندی تولید کرد.

--render-as FORMAT

قالبی که خروجی در آن ارائه (رندر) می‌شود. رایج‌ترین قالب‌ها json، s (رشته)، yaml و console هستند، اما گزینه‌های دیگری مانند dot نیز گاهی در دسترس هستند.

--verbose

ثبت گزارش‌ها با جزئیات کامل.

--debug

ثبت اطلاعات اشکال‌زدایی (debug).

--terminus _TERMINUS

رابط‌های Indirector (یا indirector faces) زیرسیستم‌های هدایت‌شده (indirected) در Puppet را در دسترس قرار می‌دهند. هر یک از این زیرسیستم‌ها می‌توانند نوع خاصی از داده‌ها را (با عمل‌های آشنای find، search، save و destroy) از تعداد دلخواهی از backendهای قابل اتصال بازیابی کرده و تغییر دهند. در اصطلاح Puppet، این backendها ترمینوس (terminuses) نامیده می‌شوند.

تقریباً تمام زیرسیستم‌های indirected دارای یک ترمینوس rest هستند که با داده‌های puppet master تعامل دارد. اکثر آن‌ها ترمینوس‌های دیگری نیز برای مدل‌های دادهٔ محلی مختلف دارند که به نوبهٔ خود توسط زیرسیستم indirected در puppet master هنگام دریافت درخواست از راه دور استفاده می‌شوند.

ترمینوس برای یک عمل معمولاً توسط زمینه تعیین می‌شود، اما گاهی اوقات لازم است به‌طور صریح تنظیم گردد. برای جزئیات بیشتر، بخش "نکات" در صفحه راهنمای این face را ببینید.

عمل‌ها (ACTIONS)

apply - یافتن و اعمال یک کاتالوگ.

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

puppet catalog apply [--terminus _TERMINUS]

توضیحات (DESCRIPTION)

یک کاتالوگ را یافته و اعمال می‌کند. این عمل هیچ آرگومانی نمی‌پذیرد، اما منبع کاتالوگ را می‌توان با گزینهٔ --terminus مدیریت کرد.

مقادیر بازگشتی (RETURNS)

هیچ چیز. در صورت استفاده از Ruby API، یک شیء Puppet::Transaction::Report بازمی‌گرداند.

compile - کامپایل یک کاتالوگ.

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

puppet catalog compile [--terminus _TERMINUS]

توضیحات (DESCRIPTION)

یک کاتالوگ را به‌صورت محلی برای یک گره کامپایل می‌کند، که نیازمند دسترسی به ماژول‌ها، رده‌بندی‌کننده گره (node classifier) و غیره است.

مقادیر بازگشتی (RETURNS)

یک کاتالوگ سریال‌شده.

download - بارگیری کاتالوگ این گره از کارساز puppet master.

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

puppet catalog download [--terminus _TERMINUS]

توضیحات (DESCRIPTION)

یک کاتالوگ را از puppet master بازیابی کرده و آن را در حافظهٔ موقت (cache) محلی yaml ذخیره می‌کند. این عمل همواره با puppet master ارتباط برقرار کرده و ترمینوس‌های جایگزین را نادیده می‌گیرد.

کاتالوگ ذخیره‌شده را می‌توان در هر عمل کاتالوگ بعدی با تعیین '--terminus yaml' برای آن عمل استفاده کرد.

مقادیر بازگشتی (RETURNS)

هیچ چیز.

نکات (NOTES)

هنگام استفاده از Ruby API، این عمل اثر جانبی دارد و Puppet::Resource::Catalog.indirection.terminus_class را روی yaml تنظیم‌شده باقی می‌گذارد. برای اعمال بعدی کاتالوگ، ترمینوس باید به‌طور صریح دوباره تنظیم شود.

find - بازیابی کاتالوگ برای گره‌ای که دستور از آن اجرا می‌شود.

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

puppet catalog find [--terminus _TERMINUS] [--facts_for_catalog] certname, facts

توضیحات (DESCRIPTION)

بازیابی کاتالوگ برای گره‌ای که دستور از آن اجرا می‌شود.

گزینه‌ها (OPTIONS) --facts_for_catalog - برای CLI پیاده‌سازی نشده است؛ facts به‌طور داخلی جمع‌آوری می‌شوند.

مقادیر بازگشتی (RETURNS)

یک کاتالوگ سریال‌شده. در صورت استفاده از Ruby API، یک شیء Puppet::Resource::Catalog بازمی‌گرداند.

info - چاپ کلاس ترمینوس پیش‌فرض برای این face.

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

puppet catalog info [--terminus _TERMINUS]

توضیحات (DESCRIPTION)

کلاس ترمینوس پیش‌فرض را برای این زیردستور چاپ می‌کند. توجه داشته باشید که حالت‌های مختلف اجرا ممکن است ترمینوس‌های پیش‌فرض متفاوتی داشته باشند؛ در صورت تردید، حالت اجرا را با گزینهٔ '--run_mode' مشخص کنید.

save - فقط برای API: ایجاد یا بازنویسی یک شیء.

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

puppet catalog save [--terminus _TERMINUS] key

توضیحات (DESCRIPTION)

فقط برای API: ایجاد یا بازنویسی یک شیء. از آنجا که چارچوب Faces در حال حاضر داده‌ها را از STDIN نمی‌پذیرد، در حال حاضر نمی‌توان عمل‌های save را از خط فرمان فراخوانی کرد.

select - بازیابی یک کاتالوگ و فیلتر کردن آن برای منابعی از یک نوع معین.

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

puppet catalog select [--terminus _TERMINUS] host resource_type

توضیحات (DESCRIPTION)

یک کاتالوگ را برای میزبان مشخص‌شده بازیابی کرده، سپس در آن به دنبال تمام منابع از نوع درخواست‌شده جستجو می‌کند.

مقادیر بازگشتی (RETURNS)

فهرستی از ارجاعات منبع ("Type[title]"). در صورت استفاده از API، آرایه‌ای از اشیاء Puppet::Resource استخراج‌شده از یک کاتالوگ را بازمی‌گرداند.

نکات (NOTES)

به‌طور پیش‌فرض، این عمل یک کاتالوگ را از زیرسیستم کامپایلر Puppet بازیابی می‌کند؛ اگر می‌خواهید کاتالوگی را از puppet master بازیابی کنید، باید این عمل را با --terminus rest فراخوانی کنید.

مشکلات قالب‌بندی: این عمل در حال حاضر نمی‌تواند yaml کاربردی ارائه دهد؛ در عوض، کل یک کاتالوگ را بازمی‌گرداند. به‌جای آن از json استفاده کنید.

مثال‌ها (EXAMPLES)

apply

اعمال کاتالوگ ذخیره‌شده در حافظهٔ موقت محلی:

$ puppet catalog apply --terminus yaml

بازیابی یک کاتالوگ از master و اعمال آن در یک مرحله:

$ puppet catalog apply --terminus rest

مثال API:

# ...
Puppet::Face[:catalog, '0.0.1'].download
# (Termini are singletons; catalog.download has a side effect of
# setting the catalog terminus to yaml)
report  = Puppet::Face[:catalog, '0.0.1'].apply
# ...

compile

کامپایل کاتالوگ برای گره 'mynode':

$ puppet catalog compile mynode --codedir ...

download

بازیابی و ذخیره یک کاتالوگ:

$ puppet catalog download

مثال API:

Puppet::Face[:plugin, '0.0.1'].download
Puppet::Face[:facts, '0.0.1'].upload
Puppet::Face[:catalog, '0.0.1'].download
# ...

select

درخواست فهرستی از منابع پرونده‌های مدیریت‌شده برای یک گره از puppet master:

$ puppet catalog select --terminus rest somenode.magpie.lan file

نکات (NOTES)

این زیردستور یک indirector face است که عمل‌های find، search، save و destroy را برای یک زیرسیستم هدایت‌شده (indirected) در Puppet ارائه می‌دهد. ترمینوس‌های معتبر برای این face عبارتند از:

• compiler
• json
• msgpack
• rest
• store_configs
• yaml

حق نشر و مجوز (COPYRIGHT AND LICENSE)

حق نشر ۲۰۱۱ متعلق به Puppet Inc.، مجوز Vox Pupuli Apache 2؛ پروندهٔ COPYING را ببینید