Ресурс apt_repository

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

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

Используйте ресурс apt_repository для указания дополнительных репозиториев APT. Добавление нового репозитория немедленно обновит кэш пакетов APT.

Новое в Chef Infra Client 12.9.

Синтаксис

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

apt_repository 'name' do
  arch               String, false
  cache_rebuild      true, false # default value: true
  components         Array # default value: `main` if using a PPA repository.
  cookbook           String, false
  deb_src            true, false # default value: false
  distribution       String, false # default value: The LSB codename of the node such as 'focal'.
  key                String, Array, false # default value: []
  key_proxy          String, false
  keyserver          String, false # default value: "keyserver.ubuntu.com"
  repo_name          String # default value: 'name' unless specified
  trusted            true, false # default value: false
  uri                String
  action             Symbol # defaults to :add if not specified
end

где:

• apt_repository — это ресурс.
• name — имя блока ресурса.
• action определяет действия, которые Chef Infra Client предпримет, чтобы привести узел в желаемое состояние.
• arch, cache_rebuild, components, cookbook, deb_src, distribution, key, key_proxy, keyserver, repo_name, trusted, и uri — доступные для этого ресурса свойства.

Действия

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

:add

Создаёт файл репозитория по адресу /etc/apt/sources.list.d/ и создаёт список репозитория. (по умолчанию)

:nothing

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

:remove

Удаляет список репозитория.

Свойства

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

arch

Тип Ruby: Строка, false

Ограничить пакеты определённой архитектурой процессора, например, i386 или amd64.

cache_rebuild

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

Определяет, нужно ли перестроить кэш пакетов APT.

components

Тип Ruby: Массив | Значение по умолчанию: `main` if using a PPA repository.

Группировки пакетов, такие как ‘main’ и ‘stable’.

cookbook

Тип Ruby: Строка, false

Если ключ должен быть файлом cookbook_file, укажите кулинарную книгу, где находится ключ для файлов/по умолчанию. Значение по умолчанию — nil, поэтому будет использоваться кулинарная книга, где используется ресурс.

deb_src

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

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

distribution

Тип Ruby: Строка, false | Значение по умолчанию: The LSB codename of the node such as 'focal'.

Обычно кодовое имя дистрибутива, например, xenial, bionic, или focal.

key

Тип Ruby: Строка, массив, false | Значение по умолчанию: []

Если указан сервер ключей, это предполагается отпечатком; в противном случае это может быть URI GPG-ключа для репозитория или cookbook_file.

key_proxy

Тип Ruby: Строка, false

Если задано, указанный прокси передаётся GPG через http-proxy=.

keyserver

Тип Ruby: Строка, false | Значение по умолчанию: keyserver.ubuntu.com

Сервер GPG-ключей, откуда должен быть получен ключ репозитория.

repo_name

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

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

Новое в Chef Client 14.1

trusted

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

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

uri

Тип Ruby: Строка

Основа дистрибутива Debian.

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

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

Примеры

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

Добавление репозитория с базовыми настройками:

apt_repository 'nginx' do
  uri        'http://nginx.org/packages/ubuntu/'
  components ['nginx']
end

Включить репозитории Ubuntu multiverse:

apt_repository 'security-ubuntu-multiverse' do
  uri          'http://security.ubuntu.com/ubuntu'
  distribution 'xenial-security'
  components   ['multiverse']
  deb_src      true
end

Добавить PPA Nginx, автоматически обнаружить ключ и URL репозитория:

apt_repository 'nginx-php' do
  uri          'ppa:nginx/stable'
end

Добавить PPA JuJu, получить ключ с сервера ключей Ubuntu и добавить репозиторий источника:

apt_repository 'juju' do
  uri 'ppa:juju/stable'
  components ['main']
  distribution 'xenial'
  key 'C8068B11'
  action :add
  deb_src true
end

Добавление репозитория, для авторизации пакетов которого требуется несколько ключей:

apt_repository 'rundeck' do
  uri 'https://dl.bintray.com/rundeck/rundeck-deb'
  distribution '/'
  key ['379CE192D401AB61', 'http://rundeck.org/keys/BUILD-GPG-KEY-Rundeck.org.key']
  keyserver 'keyserver.ubuntu.com'
  action :add
end

Добавить репозиторий Cloudera Repo пакетов CDH4 для Ubuntu 16.04 на архитектуре AMD64:

apt_repository 'cloudera' do
  uri          'http://archive.cloudera.com/cdh4/ubuntu/xenial/amd64/cdh'
  arch         'amd64'
  distribution 'xenial-cdh4'
  components   ['contrib']
  key          'http://archive.cloudera.com/debian/archive.key'
end

Удалить репозиторий из списка:

apt_repository 'zenoss' do
  action :remove
end