chore: complete custom resource modernization

damacus · damacus · commit 6f8a993df7f0 · 2026-03-24T15:15:49.000Z
diff --git a/LIMITATIONS.md b/LIMITATIONS.md
@@ -0,0 +1,28 @@
+# Docker Cookbook Limitations
+
+## Supported Platforms
+
+This cookbook supports the following platforms:
+
+- Amazon Linux 2023
+- AlmaLinux 9/10
+- CentOS Stream 9/10
+- Debian 12/13
+- Fedora
+- Oracle Linux 8/9
+- Rocky Linux 9/10
+- Red Hat Enterprise Linux 8/9
+- Ubuntu 22.04/24.04
+
+## Supported Architectures
+
+- x86_64
+- aarch64 (arm64)
+- armv7l (armhf)
+- ppc64le (ppc64el)
+- s390x (IBM Z)
+
+## Requirements
+
+- Chef Infra Client 16.5 or later
+- `docker-api` gem
diff --git a/libraries/base.rb b/libraries/base.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Docker
   module Cookbook
     module Helpers
diff --git a/libraries/helpers_coerce.rb b/libraries/helpers_coerce.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DockerCookbook
   module DockerHelpers
     module Build
diff --git a/libraries/helpers_container.rb b/libraries/helpers_container.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DockerCookbook
   module DockerHelpers
     module Container
diff --git a/libraries/helpers_json.rb b/libraries/helpers_json.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DockerCookbook
   module DockerHelpers
     module Json
diff --git a/libraries/helpers_network.rb b/libraries/helpers_network.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DockerCookbook
   module DockerHelpers
     module Network
diff --git a/libraries/helpers_service.rb b/libraries/helpers_service.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Constants
 IPV6_ADDR ||= /(
 ([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|
diff --git a/libraries/helpers_swarm.rb b/libraries/helpers_swarm.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DockerCookbook
   module DockerHelpers
     module Swarm
diff --git a/resources/container.rb b/resources/container.rb
@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 use 'partial/_logging'
 
+resource_name :docker_container
+provides :docker_container
+
 include DockerCookbook::DockerHelpers::Container
 
 property :container_name, String, name_property: true
diff --git a/resources/exec.rb b/resources/exec.rb
@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
+resource_name :docker_exec
+provides :docker_exec
+
 property :host, [String, nil], default: lazy { ENV['DOCKER_HOST'] }, desired_state: false
 property :command, Array
 property :container, String
diff --git a/resources/image.rb b/resources/image.rb
@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
+resource_name :docker_image
+provides :docker_image
+
 property :read_timeout, Integer, default: 120, desired_state: false
 property :host, [String, nil], default: lazy { ENV['DOCKER_HOST'] }, desired_state: false
 
diff --git a/resources/image_prune.rb b/resources/image_prune.rb
@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
+resource_name :docker_image_prune
+provides :docker_image_prune
+
 property :read_timeout, Integer, default: 120, desired_state: false
 property :host, [String, nil], default: lazy { ENV['DOCKER_HOST'] }, desired_state: false
 
diff --git a/resources/installation_package.rb b/resources/installation_package.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
diff --git a/resources/installation_script.rb b/resources/installation_script.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
diff --git a/resources/installation_tarball.rb b/resources/installation_tarball.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
diff --git a/resources/network.rb b/resources/network.rb
@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
+resource_name :docker_network
+provides :docker_network
+
 require 'ipaddress'
 
 property :auxiliary_addresses, [String, Array, nil], coerce: proc { |v| coerce_auxiliary_addresses(v) }
diff --git a/resources/partial/_base.rb b/resources/partial/_base.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'docker'
 require 'shellwords'
 
diff --git a/resources/partial/_logging.rb b/resources/partial/_logging.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 property :log_driver,
          equal_to: %w( json-file syslog journald gelf fluentd awslogs splunk etwlogs gcplogs logentries loki-docker none local ),
          default: 'json-file',
diff --git a/resources/partial/_service_base.rb b/resources/partial/_service_base.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ################
 # Helper Methods
 ################
diff --git a/resources/plugin.rb b/resources/plugin.rb
@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
+resource_name :docker_plugin
+provides :docker_plugin
+
 property :local_alias, String, name_property: true
 property :remote_tag, String, default: 'latest'
 property :remote, String
diff --git a/resources/registry.rb b/resources/registry.rb
@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
+resource_name :docker_registry
+provides :docker_registry
+
 property :email, String
 
 property :password, String,
diff --git a/resources/service.rb b/resources/service.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 use 'partial/_service_base'
diff --git a/resources/service_base.rb b/resources/service_base.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 use 'partial/_service_base'
diff --git a/resources/service_manager_execute.rb b/resources/service_manager_execute.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 use 'partial/_service_base'
diff --git a/resources/service_manager_systemd.rb b/resources/service_manager_systemd.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 use 'partial/_service_base'
diff --git a/resources/swarm_init.rb b/resources/swarm_init.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 
 include DockerCookbook::DockerHelpers::Swarm
diff --git a/resources/swarm_join.rb b/resources/swarm_join.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 
 include DockerCookbook::DockerHelpers::Swarm
diff --git a/resources/swarm_service.rb b/resources/swarm_service.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 
 include DockerCookbook::DockerHelpers::Swarm
diff --git a/resources/swarm_token.rb b/resources/swarm_token.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unified_mode true
 
 include DockerCookbook::DockerHelpers::Swarm
diff --git a/resources/tag.rb b/resources/tag.rb
@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
+resource_name :docker_tag
+provides :docker_tag
+
 property :target_repo, String, name_property: true
 property :target_tag, String
 property :to_repo, String
diff --git a/resources/volume.rb b/resources/volume.rb
@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
+resource_name :docker_volume
+provides :docker_volume
+
 property :driver, String, desired_state: false
 property :host, [String, nil], default: lazy { ENV['DOCKER_HOST'] }, desired_state: false
 property :opts, Hash, desired_state: false
diff --git a/resources/volume_prune.rb b/resources/volume_prune.rb
@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 unified_mode true
 use 'partial/_base'
 
+resource_name :docker_volume_prune
+provides :docker_volume_prune
+
 property :read_timeout, Integer, default: 120, desired_state: false
 property :host, [String, nil], default: lazy { ENV['DOCKER_HOST'] }, desired_state: false
 
diff --git a/spec/docker_test/container_spec.rb b/spec/docker_test/container_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_test::container' do
diff --git a/spec/docker_test/exec_spec.rb b/spec/docker_test/exec_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_test::exec' do
diff --git a/spec/docker_test/image_prune_spec.rb b/spec/docker_test/image_prune_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_test::image_prune' do
diff --git a/spec/docker_test/image_spec.rb b/spec/docker_test/image_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_test::image' do
diff --git a/spec/docker_test/installation_package_spec.rb b/spec/docker_test/installation_package_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_test::installation_package' do
diff --git a/spec/docker_test/installation_tarball_spec.rb b/spec/docker_test/installation_tarball_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_test::installation_tarball' do
diff --git a/spec/docker_test/network_spec.rb b/spec/docker_test/network_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_test::network' do
diff --git a/spec/docker_test/plugin_spec.rb b/spec/docker_test/plugin_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_test::plugin' do
diff --git a/spec/docker_test/registry_spec.rb b/spec/docker_test/registry_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_test::registry' do
diff --git a/spec/docker_test/service_spec.rb b/spec/docker_test/service_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require_relative '../../libraries/helpers_service'
 
diff --git a/spec/docker_test/volume_spec.rb b/spec/docker_test/volume_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_test::volume' do
diff --git a/spec/helpers_container_spec.rb b/spec/helpers_container_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # require 'rspec'
 # require 'rspec/its'
 # require_relative '../libraries/helpers_container'
diff --git a/spec/helpers_network_spec.rb b/spec/helpers_network_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # require 'rspec'
 # require_relative '../libraries/helpers_network'
 #
diff --git a/spec/libraries/container_networks_spec.rb b/spec/libraries/container_networks_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'docker'
 require_relative '../../libraries/helpers_network'
diff --git a/spec/libraries/container_spec.rb b/spec/libraries/container_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'chef'
 require 'excon'
diff --git a/spec/libraries/image_prune_spec.rb b/spec/libraries/image_prune_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # TODO: Refactor test
 require 'spec_helper'
 require_relative '../../libraries/helpers_json'
diff --git a/spec/libraries/registry_spec.rb b/spec/libraries/registry_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_registry' do
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'chefspec'
 require 'chefspec/berkshelf'
 
diff --git a/spec/unit/resources/swarm_init_spec.rb b/spec/unit/resources/swarm_init_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_swarm_init' do
diff --git a/spec/unit/resources/swarm_join_spec.rb b/spec/unit/resources/swarm_join_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'docker_swarm_join' do
diff --git a/spec/unit/resources/swarm_service_spec.rb b/spec/unit/resources/swarm_service_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`module Docker`
`2`	`4`	`module Cookbook`
`3`	`5`	`module Helpers`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`module DockerCookbook`
`2`	`4`	`module DockerHelpers`
`3`	`5`	`module Build`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`# Constants`
`2`	`4`	`IPV6_ADDR \|\|= /(`
`3`	`5`	`([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|`