Ресурс windows_dfs_namespace

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

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

Используйте ресурс windows_dfs_namespace для создания общего доступа и пространства имён DFS на сервере Windows.

Впервые в Chef Infra Client 15.0.

Синтаксис

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

windows_dfs_namespace 'name' do
  change_users        Array # default value: []
  description         String
  full_users          Array # default value: ["BUILTIN\\administrators"]
  namespace_name      String # default value: 'name' unless specified
  read_users          Array # default value: []
  root                String # default value: "C:\\DFSRoots"
  action              Symbol # defaults to :create if not specified
end

где:

• windows_dfs_namespace — это ресурс.
• name — имя блока ресурса.
• action определяет действия, которые Chef Infra Client предпримет для приведения узла в желаемое состояние.
• change_users, description, full_users, namespace_name, read_users, и root — доступные свойства этого ресурса.

Действия

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

:create

Создаёт пространство имён dfs на сервере. (по умолчанию)

:delete

Удаляет пространство имён DFS, включая директорию на диске.

:nothing

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

Свойства

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

change_users

Тип в Ruby: Массив | Значение по умолчанию: []

Определяет, какие пользователи должны иметь доступ к изменению общего доступа.

description

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

Описание общего доступа.

full_users

Тип в Ruby: Массив | Значение по умолчанию: ["BUILTIN\\administrators"]

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

namespace_name

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

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

read_users

Тип в Ruby: Массив | Значение по умолчанию: []

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

root

Тип в Ruby: Строка | Значение по умолчанию: C:\DFSRoots

Корневой каталог для создания дерева DFS. По умолчанию C:\DFSRoots.

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

Ресурсы 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 Infra Client.

Уведомления

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.

Примеры

Этот ресурс не имеет примеров.