buildah-config(1) General Commands Manual buildah-config(1)

buildah-config - به‌روزرسانی تنظیمات پیکربندی تصویر

buildah config [گزینه‌ها] کانتینر

یک یا چند مورد از تنظیمات ذخیره‌شده برای یک کانتینر را به‌روزرسانی می‌کند.

--add-history

افزودن یک مدخل به تاریخچه تصویر که تغییرات اعمال‌شده بر روی تنظیمات مربوط به --cmd، --entrypoint، --env، --healthcheck، --label، --onbuild، --port، --shell، --stop-signal، --user، --volume و --workingdir را ثبت می‌کند. مقدار پیش‌فرض false است.

نکته: همچنین می‌توانید مقدار پیش‌فرض --add-history را با مقداردهی متغیر محیطی BUILDAH_HISTORY بازنویسی کنید. export BUILDAH_HISTORY=true

--annotation, -a annotation=annotation

افزودن یک یادداشت تصویر (annotation) (مانند annotation=annotation) به مانیفست تصویری هر تصویری که با استفاده از کانتینر مشخص‌شده ساخته خواهد شد. این گزینه می‌تواند چندین بار استفاده شود. اگر annotation با یک - پایانی همراه باشد، آن annotation از پیکربندی حذف می‌شود. اگر annotation برابر "-" تنظیم شود، تمام یادداشت‌ها از پیکربندی حذف می‌شوند.

--arch architecture

تنظیم معماری هدف (architecture) برای هر تصویری که با استفاده از کانتینر مشخص‌شده ساخته خواهد شد. به طور پیش‌فرض، اگر کانتینر بر پایه یک تصویر باشد، معماری هدف آن تصویر حفظ می‌شود، در غیر این صورت معماری میزبان ثبت می‌گردد.

--author author

تنظیم اطلاعات تماس پدیدآورنده (author) برای هر تصویری که با استفاده از کانتینر مشخص‌شده ساخته خواهد شد.

--cmd command

تنظیم دستور پیش‌فرض (command) برای اجرا در کانتینرهایی که بر پایه هر تصویری ساخته‌شده با کانتینر مشخص‌شده ایجاد می‌شوند. هنگامی که همراه با یک نقطه ورود (entry point) استفاده شود، پارامترهای پیش‌فرض را برای آن نقطه ورود تعیین می‌کند.

--comment comment

تنظیم توضیح سطح تصویر (comment) برای هر تصویری که با استفاده از کانتینر مشخص‌شده ساخته خواهد شد.

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--created-by created

تنظیم توضیح چگونگی ایجاد بالاترین لایه (created) برای هر تصویری که با استفاده از کانتینر مشخص‌شده ساخته خواهد شد.

--domainname domain

تنظیم نام دامنه (domain) برای کانتینرهایی که بر پایه هر تصویری ساخته‌شده با کانتینر مشخص‌شده اجرا می‌شوند.

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--entrypoint "command" | '["command", "arg1", ...]'

تنظیم نقطه ورود (entry point) برای کانتینرهایی که بر پایه هر تصویری ساخته‌شده با کانتینر مشخص‌شده اجرا خواهند شد. ابزار buildah از دو قالب برای نقطه ورود پشتیبانی می‌کند. این مقدار می‌تواند به صورت یک رشته ساده یا به صورت آرایه‌ای از دستورات مشخص شود.

نکته: هنگامی که نقطه ورود به صورت یک رشته مشخص شود، موتورهای اجرای کانتینر مقدار cmd تصویر کانتینر را نادیده می‌گیرند. با این حال اگر از قالب آرایه‌ای استفاده کنید، مقدار cmd به انتهای دستور نقطه ورود افزوده شده و همراه با آن اجرا خواهد شد.

نکته: قالب رشته‌ای به عنوان نقطه ورود به دستور sh -c ضمیمه می‌شود. قالب آرایه‌ای نقطه ورود را به طور کامل جایگزین می‌کند.

قالب رشته‌ای:

$ buildah from scratch
$ buildah config --entrypoint "/usr/bin/notashell" working-container
$ buildah inspect --format '{{ .OCIv1.Config.Entrypoint }}' working-container
[/bin/sh -c /usr/bin/notshell]
$ buildah inspect --format '{{ .Docker.Config.Entrypoint }}' working-container
[/bin/sh -c /usr/bin/notshell]

قالب آرایه‌ای:

$ buildah config --entrypoint '["/usr/bin/notashell"]' working-container
$ buildah inspect --format '{{ .OCIv1.Config.Entrypoint }}' working-container
[/usr/bin/notashell]
$ buildah inspect --format '{{ .Docker.Config.Entrypoint }}' working-container
[/usr/bin/notashell]

--env, -e env[=value]

افزودن یک متغیر محیطی (مانند env=value) برای کانتینرهایی که بر پایه هر تصویری ساخته‌شده با کانتینر مشخص‌شده اجرا می‌شوند. این گزینه می‌تواند چندین بار استفاده شود. اگر env نام‌گذاری شود ولی نه علامت = و نه مقداری (value) مشخص گردد، مقدار از متغیرهای محیطی فرآیند جاری خوانده خواهد شد. اگر env با یک - پایانی همراه باشد، آن متغیر محیطی از پیکربندی حذف می‌شود. اگر env برابر "-" تنظیم شود، تمام متغیرهای محیطی از پیکربندی حذف می‌شوند.

--healthcheck command

مشخص کردن دستوری که باید برای بررسی صحت اجرای کانتینر اجرا شود.

مقادیر می‌توانند NONE، "CMD ..." (اجرای مستقیم دستور مشخص‌شده)، یا "CMD-SHELL ..." (اجرای دستور مشخص‌شده با پوسته سیستم)، یا مقدار خالی (حذف مقدار تنظیم‌شده قبلی و تنظیمات مرتبط) باشند.

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--healthcheck-interval interval

مشخص کردن فاصله زمانی میان اجرای دستوری که با گزینه --healthcheck تعیین شده است.

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--healthcheck-retries count

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

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--healthcheck-start-interval interval

مشخص کردن فاصله زمانی میان بررسی‌های سلامت در طول دوره راه‌اندازی اولیه کانتینر.

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--healthcheck-start-period interval

مشخص کردن میزان زمانی که می‌تواند پس از شروع کانتینر سپری شود، پیش از آنکه شکست در اجرای دستور گزینه --healthcheck به عنوان نشانه‌ای از خرابی کانتینر تلقی شود. در این دوره زمانی، شکست‌ها ناشی از راه‌اندازی کامل نشدن کانتینر در نظر گرفته شده و به عنوان خطا شمرده نمی‌شوند. پس از موفقیت دستور یا پایان این دوره زمانی، شکست‌ها به عنوان خطا محسوب خواهند شد.

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--healthcheck-timeout interval

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

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--history-comment comment

تنظیم یک توضیح بر روی بالاترین لایه در هر تصویری که با استفاده از کانتینر مشخص‌شده ایجاد خواهد شد.

--hostname host

تنظیم نام میزبان (host) هنگام اجرای کانتینرهایی که بر پایه تصاویر ساخته‌شده با کانتینر مشخص‌شده اجرا می‌شوند.

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--label, -l label=value

افزودن یک برچسب تصویر (label) (مانند label=value) به پیکربندی تصویر هر تصویری که با استفاده از کانتینر مشخص‌شده ساخته خواهد شد. این گزینه می‌تواند چندین بار استفاده شود. اگر label با یک - پایانی همراه باشد، آن برچسب از پیکربندی حذف می‌شود. اگر label برابر "-" تنظیم شود، تمام برچسب‌ها از پیکربندی حذف می‌شوند.

--onbuild onbuild command

افزودن دستور ONBUILD به تصویر. دستورات ONBUILD به طور خودکار زمانی اجرا می‌شوند که تصویری بر پایه تصویر در حال ساخت ایجاد گردد.

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--os operating system

تنظیم سیستم‌عامل هدف (operating system) برای هر تصویری که با استفاده از کانتینر مشخص‌شده ساخته خواهد شد. به طور پیش‌فرض، اگر کانتینر بر پایه یک تصویر باشد، سیستم‌عامل آن حفظ می‌شود، در غیر این صورت نام سیستم‌عامل میزبان ثبت خواهد شد.

--os-feature feature

تنظیم نام یک ویژگی مورد نیاز سیستم‌عامل (feature) برای هر تصویری که با استفاده از کانتینر مشخص‌شده ساخته خواهد شد. به طور پیش‌فرض، اگر کانتینر بر پایه یک تصویر باشد، فهرست ویژگی‌های سیستم‌عامل مورد نیاز تصویر پایه در صورت وجود حفظ می‌شود. این گزینه معمولاً فقط زمانی معنادار است که سیستم‌عامل تصویر ویندوز باشد.

اگر feature با یک - پایانی همراه باشد، آن ویژگی از فهرست ویژگی‌های مورد نیاز تصویر حذف می‌شود. اگر feature برابر "-" تنظیم شود، کل فهرست ویژگی‌ها از پیکربندی حذف می‌گردد.

--os-version version

تنظیم نسخه دقیق سیستم‌عامل مورد نیاز (version) برای هر تصویری که با استفاده از کانتینر مشخص‌شده ساخته خواهد شد. به طور پیش‌فرض، اگر کانتینر بر پایه یک تصویر باشد، نسخه سیستم‌عامل مورد نیاز تصویر پایه در صورت وجود حفظ می‌شود. این گزینه معمولاً فقط زمانی معنادار است که سیستم‌عامل تصویر ویندوز باشد و به طور معمول در تصاویر پایه ویندوز تنظیم شده است، بنابراین استفاده از این گزینه معمولاً غیرضروری است.

--port, -p port/protocol

افزودن یک پورت (port) برای باز کردن هنگام اجرای کانتینرهایی که بر پایه تصاویر ساخته‌شده با کانتینر مشخص‌شده اجرا می‌شوند. این گزینه می‌تواند چندین بار استفاده شود. برای تعیین اینکه پورت روی TCP یا UDP گوش دهد، از "port/protocol" استفاده کنید. اگر پروتکل مشخص نشود، پیش‌فرض TCP است. برای باز کردن پورت روی هر دو پروتکل TCP و UDP، گزینه port را چندین بار مشخص کنید. اگر port با یک - پایانی همراه باشد و قبلاً تنظیم شده باشد، آن پورت از پیکربندی حذف می‌شود. اگر مقدار پورت برابر - تنظیم شود، تمام تنظیمات پورت‌های بازشده از پیکربندی حذف می‌گردند.

--shell shell

تنظیم پوسته پیش‌فرض (shell) برای اجرا در داخل تصویر کانتینر. دستورالعمل shell امکان تغییر پوسته پیش‌فرض استفاده‌شده برای قالب پوسته‌ای دستورات را فراهم می‌کند. پوسته پیش‌فرض برای کانتینرهای لینوکس "/bin/sh -c" است.

نکته: این تنظیم در قالب تصویر OCIv1 وجود ندارد، بنابراین هنگام ذخیره تصاویر با قالب‌های OCIv1 نادیده گرفته می‌شود.

--stop-signal signal

تنظیم سیگنال توقف پیش‌فرض (signal) برای کانتینر. این سیگنال زمانی ارسال می‌شود که کانتینر متوقف گردد؛ مقدار پیش‌فرض SIGINT است.

--unsetannotation annotation

حذف یادداشت تصویر، به گونه‌ای که آن یادداشت از تصویر پایه به ارث برده نشود.

--unsetlabel label

حذف برچسب تصویر، به گونه‌ای که آن برچسب از تصویر پایه به ارث برده نشود.

--user, -u user[:group]

تنظیم کاربر پیش‌فرض (user) برای اجرای کانتینرهای بر پایه این تصویر. کاربر می‌تواند به صورت نام کاربری یا UID مشخص شود و به صورت اختیاری یک نام گروه یا GID با علامت دو نقطه (':') به دنبال آن بیاید. اگر از نام‌ها استفاده شود، کانتینر باید دارای مدخل‌های مربوط به آن نام‌ها در فایل‌های /etc/passwd و /etc/group خود باشد.

--variant variant

تنظیم گونه معماری هدف (variant) برای هر تصویری که با استفاده از کانتینر مشخص‌شده ساخته خواهد شد. به طور پیش‌فرض، اگر کانتینر بر پایه یک تصویر باشد، معماری هدف و اطلاعات گونه آن تصویر حفظ می‌شود، در غیر این صورت معماری و گونه میزبان ثبت می‌گردد.

--volume, -v volume

افزودن یک مسیر در درخت دایرکتوری که باید به عنوان یک حجم (volume) در هر تصویری ساخته‌شده با کانتینر مشخص‌شده علامت‌گذاری شود. این گزینه می‌تواند چندین بار استفاده شود. اگر volume با یک - پایانی همراه باشد و قبلاً تنظیم شده باشد، آن حجم از پیکربندی حذف می‌شود. اگر مقدار volume برابر "-" تنظیم شود، تمام حجم‌ها از پیکربندی حذف می‌گردند.

--workingdir directory

تنظیم دایرکتوری کاری اولیه (directory) برای کانتینرهایی که بر پایه تصاویر ساخته‌شده با کانتینر مشخص‌شده ایجاد می‌شوند.

buildah config --author='Jane Austen' --workingdir='/etc/mycontainers' containerID

buildah config --entrypoint /entrypoint.sh containerID

buildah config --entrypoint '[ "/entrypoint.sh", "dev" ]' containerID

buildah config --env foo=bar --env PATH=$PATH containerID

buildah config --env foo- containerID

buildah config --label Name=Mycontainer --label Version=1.0 containerID

buildah config --label Name- containerID

buildah config --annotation note=myNote containerID

buildah config --annotation note-

buildah config --volume /usr/myvol containerID

buildah config --volume /usr/myvol- containerID

buildah config --port 1234 --port 8080 containerID

buildah config --port 514/tcp --port 514/udp containerID

buildah config --env 1234=5678 containerID

buildah config --env 1234- containerID

buildah config --os-version 10.0.19042.1645 containerID

buildah config --os-feature win32k containerID

buildah config --os-feature win32k- containerID

buildah(1)

March 2017 buildah