Ресурс powershell_package_source

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

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

Используйте ресурс powershell_package_source для регистрации источника пакетов PowerShell и поставщика пакетов PowerShell. Здесь мы рассматриваем два разных объекта. Первый — это источник пакетов, такой как репозиторий PowerShell или источник NuGet. Второй объект — это поставщик, который PowerShell использует для доступа к этому источнику, например, PowerShellGet, NuGet, Chocolatey и т. д.

Новое в Chef Infra Client 14.3.

Синтаксис

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

powershell_package_source 'name' do
  new_name                     String
  password                     String
  provider_name                String # default value: "NuGet"
  publish_location             String
  script_publish_location      String
  script_source_location       String
  source_location              String
  source_name                  String # default value: 'name' unless specified
  trusted                      true, false # default value: false
  user                         String
  action                       Symbol # defaults to :register if not specified
end

где:

• powershell_package_source — это ресурс.
• name — это имя, данное блоку ресурса.
• action определяет, какие действия Chef Infra Client предпримет для приведения узла в желаемое состояние.
• new_name, password, provider_name, publish_location, script_publish_location, script_source_location, source_location, source_name, trusted, и user — это доступные для этого ресурса свойства.

Действия

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

:nothing

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

:register

Регистрирует источник пакетов PowerShell. (по умолчанию)

:set

Обновляет существующий репозиторий PowerShell или источник пакетов.

:unregister

Удаляет источник пакетов PowerShell.

Свойства

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

new_name

Тип Ruby: Строка

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

Новое в Chef Infra Client 17.6

password

Тип Ruby: Строка

Пароль, который в составе объекта учетных данных используется для регистрации репозитория или другого источника пакетов.

Новое в Chef Infra Client 17.6

provider_name

Тип Ruby: Строка | Значение по умолчанию: NuGet Разрешенные значения: "NuGet", "PowerShellGet", "Programs", "chocolatey", "msi", "msu", "psl", "winget"

Поставщик управления пакетами для источника пакетов. По умолчанию — PowerShellGet. Изменяйте этот параметр только в особых случаях.

publish_location

Тип Ruby: Строка

URL, по которому будут публиковаться модули. Действительно только если поставщик — PowerShellGet.

script_publish_location

Тип Ruby: Строка

Расположение, куда будут публиковаться скрипты для этого источника. Действительно только если поставщик — PowerShellGet.

script_source_location

Тип Ruby: Строка

URL расположения скриптов для этого источника. Действительно только если поставщик — PowerShellGet.

source_location

Тип Ruby: Строка

URL расположения для получения модулей.

Новое в Chef Infra Client 17.6

source_name

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

Метка, которая задаёт имя вашего источника пакетов.

trusted

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

Доверять ли пакетам из этого источника. Используется при создании источника пакетов из не-PowerShell репозитория.

user

Тип Ruby: Строка

Имя пользователя, которое в составе объекта учетных данных используется для регистрации репозитория или другого источника пакетов.

Новое в Chef Infra Client 17.6

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

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

Примеры

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

Добавление нового ненадёжного репозитория PowerShell, требующего учетных данных для подключения:

powershell_package_source 'PowerShellModules' do
  source_name                  "PowerShellModules"
  source_location              "https://pkgs.dev.azure.com/some-org/some-project/_packaging/some_feed/nuget/v2"
  publish_location             "https://pkgs.dev.azure.com/some-org/some-project/_packaging/some_feed/nuget/v2"
  trusted                      false
  user                         "someuser@somelocation.io"
  password                     "my_password"
  provider_name                "PSRepository"
  action                       :register
end

Добавление нового источника пакетов, использующего Chocolatey в качестве поставщика пакетов:

powershell_package_source 'PowerShellModules' do
  source_name                  "PowerShellModules"
  source_location              "https://pkgs.dev.azure.com/some-org/some-project/_packaging/some_feed/nuget/v2"
  publish_location             "https://pkgs.dev.azure.com/some-org/some-project/_packaging/some_feed/nuget/v2"
  trusted                      true
  provider_name                "chocolatey"
  action                       :register
end

Добавление нового источника скриптов PowerShell, которому доверяют:

powershell_package_source 'MyDodgyScript' do
  source_name                  "MyDodgyScript"
  script_source_location       "https://pkgs.dev.azure.com/some-org/some-project/_packaging/some_feed/nuget/v2"
  script_publish_location      "https://pkgs.dev.azure.com/some-org/some-project/_packaging/some_feed/nuget/v2"
  trusted                      true
  action                       :register
end

Обновление существующего репозитория PowerShell для повышения уровня доверия:

powershell_package_source 'MyPSModule' do
  source_name                  "MyPSModule"
  trusted                      true
  action                       :set
end

Обновление источника пакетов Nuget с новым именем и повышением уровня доверия:

powershell_package_source 'PowerShellModules -> GoldFishBowl' do
  source_name                  "PowerShellModules"
  new_name                     "GoldFishBowl"
  provider_name                "Nuget"
  trusted                      true
  action                       :set
end

Обновление источника пакетов Nuget с новым именем, если источник защищён именем пользователя и паролем:

powershell_package_source 'PowerShellModules -> GoldFishBowl' do
  source_name                  "PowerShellModules"
  new_name                     "GoldFishBowl"
  trusted                      true
  user                         "user@domain.io"
  password                     "some_secret_password"
  action                       :set
end

Отключение источника пакетов:

powershell_package_source 'PowerShellModules' do
  source_name                  "PowerShellModules"
  action                       :unregister
end