macos_userdefaults Ресурс

Редактировать эту страницу в репозитории Chef

Страница справки по ресурсам

Используйте ресурс macos_userdefaults для управления системой пользовательских параметров macOS. Свойства этого ресурса передаются команде defaults, а параметры следуют соглашениям этой команды. Подробную информацию о работе инструмента см. в справочной странице man для defaults(1).

Новое в Chef Infra Client 14.0.

Синтаксис

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

macos_userdefaults 'name' do
  domain      String # default value: NSGlobalDomain: the global domain.
  host        String, Symbol
  key         String
  sudo        true, false # default value: false
  type        String
  user        String
  value       Integer, Float, String, true, false, Hash, Array
  action      Symbol # defaults to :write if not specified
end

где:

• macos_userdefaults — это ресурс.
• name — имя блока ресурса.
• action определяет, какие действия Chef Infra Client предпримет для приведения узла к желаемому состоянию.
• domain, host, key, sudo, type, user, и value — доступные свойства этого ресурса.

Действия

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

:delete

Удаляет ключ параметра из указанного домена.

:nothing

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

:write

По умолчанию. Записывает параметр в указанный домен.

Свойства

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

domain

Тип Ruby: Строка | Значение по умолчанию: NSGlobalDomain: the global domain.

Домен, к которому относятся пользовательские параметры.

host

Тип Ruby: Строка, Символ

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

Новое в Chef Infra Client 16.3

key

Тип Ruby: Строка | REQUIRED

Ключ параметра.

sudo

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

Установите в значение true, если для изменения параметра требуется доступ с привилегиями. Это требует бесклеточного sudo для команды ‘/usr/bin/defaults’ для пользователя, выполняющего Chef Infra Client.

type

Тип Ruby: СтрокаДопустимые значения: "array", "bool", "dict", "float", "int", "string"

Тип значения ключа параметра.

user

Тип Ruby: Строка

Системный пользователь, которому будет применён параметр.

value

Тип Ruby: Целое число, дробное число, строка, true, false, хэш, массив | REQUIRED

Значение ключа. Примечание: если свойство type установлено в bool, формы логических значений true/false, которые Apple принимает в команде defaults, будут преобразованы: 0/1, ‘TRUE’/‘FALSE,’ ‘true’/false', ‘YES’/‘NO’, или ‘yes’/‘no’.

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

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

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

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

compile_time

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

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

ignore_failure

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

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

retries

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

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

retry_delay

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

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

sensitive

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

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

Уведомления

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.

Примеры

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

Укажите значение глобального домена

macos_userdefaults 'Full keyboard access to all controls' do
  key 'AppleKeyboardUIMode'
  value 2
end

Установка значения в определённом домене

macos_userdefaults 'Enable macOS firewall' do
  domain '/Library/Preferences/com.apple.alf'
  key 'globalstate'
  value 1
end

Указание типа ключа для пропуска автоматического определения типа

macos_userdefaults 'Finder expanded save dialogs' do
  key 'NSNavPanelExpandedStateForSaveMode'
  value 'TRUE'
  type 'bool'
end