Ресурс windows_pagefile

Изменить эту страницу в репозитории Chef

Все страницы ресурсов Infra

Используйте ресурс windows_pagefile для настройки параметров файла подкачки в Windows.

Новое в Chef Infra Client 14.0.

Синтаксис

Полный синтаксис всех свойств, доступных для ресурса windows_pagefile:

windows_pagefile 'name' do
  automatic_managed      true, false
  initial_size           Integer
  maximum_size           Integer
  path                   String # default value: 'name' unless specified
  system_managed         true, false
  action                 Symbol # defaults to :set if not specified
end

где:

• windows_pagefile — это ресурс.
• name — имя блока ресурса.
• action определяет, какие шаги клиент Chef Infra предпримет, чтобы привести узел в желаемое состояние.
• automatic_managed, initial_size, maximum_size, path, и system_managed — доступные свойства этого ресурса.

Действия

Ресурс windows_pagefile имеет следующие действия:

:delete

Удаляет указанный файл подкачки.

:nothing

Этот блок ресурса не выполняет действий, пока не получит уведомление от другого ресурса о необходимости выполнить действие. После получения уведомления этот блок ресурса либо выполняется немедленно, либо добавляется в очередь для выполнения в конце выполнения Chef Infra Client.

:set

Настраивает файл подкачки по умолчанию, создавая его, если он не существует. (по умолчанию)

Свойства

Ресурс windows_pagefile имеет следующие свойства:

automatic_managed

Тип Ruby: true, false

Включить автоматическое управление начальным и максимальным размером файла подкачки. Установка этого значения в true игнорирует свойства initial_size и maximum_size.

initial_size

Тип Ruby: Целое число

Начальный размер файла подкачки в мегабайтах.

maximum_size

Тип Ruby: Целое число

Максимальный размер файла подкачки в мегабайтах.

path

Тип Ruby: Строка | Значение по умолчанию: The resource block's name

Необязательное свойство для установки имени файла подкачки, если оно отличается от имени блока ресурса.

system_managed

Тип Ruby: true, false

Настраивает, управляет ли система размером файла подкачки.

Общие функциональные возможности ресурсов

Ресурсы Chef включают общие свойства, уведомления и защитные механизмы ресурсов.

Общие свойства

Следующие свойства являются общими для всех ресурсов:

compile_time

Тип Ruby: true, false | Значение по умолчанию: false

Управление фазой, в которой ресурс выполняется на узле. Установка в true для запуска во время построения коллекции ресурсов (compile phase). Установка в false для запуска во время настройки узла клиентом Chef Infra (converge phase).

ignore_failure

Тип Ruby: true, false, :quiet | Значение по умолчанию: false

Продолжать выполнение рецепта, если ресурс терпит неудачу по какой-либо причине. :quiet не отображает полный стек отладки, и рецепт будет продолжать выполняться, если ресурс потерпит неудачу.

retries

Тип Ruby: Целое число | Значение по умолчанию: 0

Количество попыток перехватить исключения и повторить ресурс.

retry_delay

Тип Ruby: Целое число | Значение по умолчанию: 2

Задержка в секундах между попытками повтора.

sensitive

Тип Ruby: true, false | Значение по умолчанию: false

Обеспечить, чтобы конфиденциальные данные ресурсов не регистрировались клиентом Chef Infra.

Уведомления

notifies

Тип Ruby: Символ, 'Chef::Resource[String]'

Ресурс может уведомить другой ресурс о необходимости выполнить действие при изменении его состояния. Укажите 'resource[name]', действие, которое должен выполнить :action ресурс, и :timer для этого действия. Один ресурс может уведомить несколько ресурсов; используйте оператор notifies для каждого уведомляемого ресурса.

Если указанный ресурс не существует, возникает ошибка. В отличие от этого, subscribes не завершится с ошибкой, если исходный ресурс не найден.

Таймер указывает момент во время выполнения Chef Infra Client, когда выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие над уведомленным ресурсом должно выполняться до обработки блока ресурса, в котором находится уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и затем выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно выполняться немедленно для каждого уведомленного ресурса.

Синтаксис для notifies:

notifies :action, 'resource[name]', :timer

subscribes

Тип Ruby: Символ, 'Chef::Resource[String]'

Ресурс может отслеживать другой ресурс и затем принимать действие, если состояние отслеживаемого ресурса меняется. Укажите 'resource[name]', действие :action, и :timer для этого действия.

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, который он отслеживает. Например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда файл сертификата, расположенный в /etc/nginx/ssl/example.crt, обновляется. subscribes не вносит никаких изменений в сам файл сертификата, он просто отслеживает изменения в файле и выполняет действие :reload для своего ресурса (в данном примере nginx) при обнаружении изменения.

Если другой ресурс не существует, подписка не вызовет ошибку. В отличие от более жестких семантик notifies, которые вызовут ошибку, если другой ресурс не существует.

Таймер указывает момент во время выполнения Chef Infra Client, когда выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие над уведомленным ресурсом должно выполняться до обработки блока ресурса, в котором находится уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и затем выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно выполняться немедленно для каждого уведомленного ресурса.

Синтаксис для subscribes:

subscribes :action, 'resource[name]', :timer

Защитные механизмы

Свойство защитного механизма может использоваться для оценки состояния узла во время фазы выполнения Chef Infra Client. На основе результатов этой оценки свойство защитного механизма сообщает Chef Infra Client, следует ли продолжать выполнение ресурса. Свойство защитного механизма принимает либо строковое значение, либо значение блока Ruby:

• Строка выполняется как командная строка. Если команда возвращает 0, защитный механизм применяется. Если команда возвращает любое другое значение, свойство защитного механизма не применяется. Строковые защитные механизмы в powershell_script выполняют команды Windows PowerShell и могут возвращать true в дополнение к 0.
• Блок выполняется как код Ruby, который должен вернуть либо true, либо false. Если блок возвращает true, свойство защитного механизма применяется. Если блок возвращает false, свойство защитного механизма не применяется.

Свойство защитного механизма полезно для обеспечения идемпотентности ресурса, позволяя этому ресурсу проверить желаемое состояние по мере его выполнения, а затем, если желаемое состояние присутствует, не предпринимать никаких действий Chef Infra Client.

Следующие свойства могут использоваться для определения защитного механизма, оцениваемого во время фазы выполнения Chef Infra Client:

not_if

Препятствует выполнению ресурса, когда условие возвращает true.

only_if

Разрешает выполнение ресурса только в том случае, если условие возвращает true.

Примеры

В следующих примерах показаны различные подходы к использованию ресурса windows_pagefile в рецептах:

Установите систему для управления файлами подкачки:

windows_pagefile 'Enable automatic management of pagefiles' do
  automatic_managed true
end

Удалите файл подкачки:

windows_pagefile 'Delete the pagefile' do
  path 'C'
  action :delete
end

Переключитесь на управление файлами подкачки системой:

windows_pagefile 'Change the pagefile to System Managed' do
  path 'E:'
  system_managed true
  action :set
end

Создайте файл подкачки с начальным и максимальным размером:

windows_pagefile 'create the pagefile with these sizes' do
  path 'f:'
  initial_size 100
  maximum_size 200
end