Ресурс windows_share

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

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

Используйте ресурс windows_share для создания, изменения и удаления сетевых ресурсов Windows.

Новинка в Chef Infra Client 14.7.

Синтаксис

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

windows_share 'name' do
  ca_timeout                  Integer # default value: 0
  change_users                Array
  concurrent_user_limit       Integer # default value: 0
  continuously_available      true, false # default value: false
  description                 String
  encrypt_data                true, false # default value: false
  full_users                  Array
  path                        String
  read_users                  Array
  scope_name                  String # default value: "*"
  share_name                  String # default value: 'name' unless specified
  temporary                   true, false # default value: false
  action                      Symbol # defaults to :create if not specified
end

где:

• windows_share — это ресурс.
• name — имя блока ресурса.
• action определяет шаги, которые Chef Infra Client предпримет для приведения узла в желаемое состояние.
• ca_timeout, change_users, concurrent_user_limit, continuously_available, description, encrypt_data, full_users, path, read_users, scope_name, share_name и temporary — доступные свойства для этого ресурса.

Действия

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

:create

Создание и изменение сетевых ресурсов Windows.

:delete

Удаление существующего сетевого ресурса Windows.

:nothing

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

Свойства

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

ca_timeout

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

Время ожидания непрерывной доступности ресурса.

change_users

Тип в Ruby: Массив

Пользователи, которые должны иметь разрешение «изменение» для ресурса в формате домен\имя_пользователя.

concurrent_user_limit

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

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

continuously_available

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

Указывает, что ресурс постоянно доступен.

description

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

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

encrypt_data

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

Указывает, что ресурс зашифрован.

full_users

Тип в Ruby: Массив

Пользователи, которые должны иметь разрешение «полный доступ» для ресурса в формате домен\имя_пользователя.

path

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

Путь к папке, которую необходимо разделить. Требуется при создании. Если ресурс уже существует по другому пути, он удаляется и создаётся заново.

read_users

Тип в Ruby: Массив

Пользователи, которые должны иметь разрешение «чтение» для ресурса в формате домен\имя_пользователя.

scope_name

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

Имя области действия ресурса.

share_name

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

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

temporary

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

Срок действия нового сетевого ресурса SMB. Временный ресурс не сохраняется после следующей перезагрузки компьютера.

Общие функции ресурсов

Ресурсы 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[Строка]'

Ресурс может уведомлять другой ресурс о выполнении действий при изменении его состояния. Укажите '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[Строка]'

Ресурс может прослушивать другой ресурс и затем выполнять действия, если состояние прослушиваемого ресурса изменится. Укажите '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_share в рецептах:

Создание ресурса:

windows_share 'foo' do
  action :create
  path 'C:\foo'
  full_users ['DOMAIN_A\some_user', 'DOMAIN_B\some_other_user']
  read_users ['DOMAIN_C\Domain users']
end

Удалить общий доступ:

windows_share 'foo' do
  action :delete
end