Update Client 19 resource docs by IanMadd · Pull Request #152 · chef/chef-client-docs

IanMadd · 2026-03-02T20:52:04Z

Description

Version

These are changes for Chef Infra Client versions:

Definition of done

Issues resolved

https://progresssoftware.atlassian.net/browse/CHEF-30866

Related PRs

Checklist

spellcheck
use relref shortcode for links to Client docs in this doc set
all tests pass

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

netlify · 2026-03-02T20:52:34Z

✅ Deploy Preview for chef-infra-client ready!

Name	Link
🔨 Latest commit	`7b75258`
🔍 Latest deploy log	https://app.netlify.com/projects/chef-infra-client/deploys/69a5f877c4871e00080fb009
😎 Deploy Preview	https://deploy-preview-152--chef-infra-client.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

IanMadd · 2026-03-02T21:47:23Z

Should these resources be deleted?

chef_acl.yaml
chef_client.yaml
chef_container.yaml
chef_data_bag.yaml
chef_data_bag_item.yaml
chef_environment.yaml
chef_group.yaml
chef_node.yaml
chef_organization.yaml
chef_role.yaml
chef_user.yaml

IanMadd · 2026-03-02T21:47:27Z

The following resources have this set of actions added, but there's no explanation of what they are:

  :reconfig:
    markdown:
  :lock:
    markdown:
  :unlock:
    markdown:

bff_package
cab_package
chef_gem
chocolatey_package
dpkg_package
gem_package
homebrew_package
ips_package
macports_package
msu_package
openbsd_package
package
pacman_package
paludis_package
portage_package
powershell_package
rpm_package
smartos_package
snap_package
solaris_package
windows_package
yum_package
zypper_package

I assume the actions are inherited from the package resource, but the description isn't being added to the YAML output by the rake task.

IanMadd · 2026-03-02T22:11:31Z

Several resources have the default value of the chef_binary_path property changed from C:/opscode/chef/bin/chef-client to lazy default

chef_client_cron
chef_client_launchd
chef_client_scheduled_task
chef_client_systemd_timer

IanMadd · 2026-03-02T21:58:44Z

data/infra/resources/selinux_install.yaml

@@ -37,6 +37,8 @@ properties_list:
  default_value: lazy default


Is this right?

IanMadd · 2026-03-02T22:03:52Z

data/infra/resources/chef_gem.yaml

  :purge:
-    markdown: Purge a gem. This action typically removes the configuration files
-      as well as the gem.
+    markdown: Purge a package. This action typically removes the configuration files


Should this still be gem?

IanMadd · 2026-03-02T22:17:26Z

data/infra/resources/dnf_package.yaml

+  :flush_cache:
+    markdown:


No description of this action.

IanMadd · 2026-03-03T16:47:36Z

data/infra/resources/package.yaml

  description_list:
  - markdown: A Hash of environment variables in the form of {'ENV_VARIABLE' => 'VALUE'}
      to be set before running the command.
- property: flush_cache


Should these properties be deleted from the package resource:

flush-cache

gem_binary

homebrew_user

ignore_failure

notifies

response_file

response_file_variable

subscribes

IanMadd · 2026-03-03T16:49:18Z

data/infra/resources/perl.yaml

+  new_in: '17.0'
  description_list:
-  - markdown: Continue running a recipe if a resource fails for any reason. (default false)
- property: notifies


Should the notifies property be deleted?

IanMadd · 2026-03-03T18:35:37Z

data/infra/resources/windows_task.yaml

+  :change:
+    markdown:


Is there a description for this action?

IanMadd · 2026-03-03T18:36:56Z

data/infra/resources/windows_update_settings.yaml

+  :enable:
+    markdown:


Is there a description for this?

IanMadd · 2026-03-03T18:42:09Z

data/infra/resources/yum_package.yaml

+  :flush_cache:
+    markdown:


Is there a description for this?

IanMadd · 2026-03-03T18:43:15Z

data/infra/resources/yum_repository.yaml

+  :remove:
+    markdown:
  :makecache:
    markdown: Force the creation of the repository cache. This is also done automatically
      when a repository is updated.
-  :nothing:
-    shortcode: resources_common_actions_nothing.md
+  :add:
+    markdown:


What are the values for remove and add?

IanMadd · 2026-03-03T18:43:53Z

data/infra/resources/zypper_repository.yaml

+  :add:
+    markdown:


Is there a description for add?

IanMadd · 2026-03-03T20:15:14Z

data/infra/resources/macosx_service.yaml

+  :mask:
+    markdown:
+  :unmask:
+    markdown:


What should these be?

IanMadd · 2026-03-03T20:15:34Z

data/infra/resources/macosx_service.yaml

  ruby_type: String
  required: false
  description_list:
-  - markdown: The type of plist to be created


Should this be deleted?

IanMadd · 2026-03-03T20:17:37Z

data/infra/resources/remote_directory.yaml

      and new owner assignments use the current user (when necessary).
 - property: group
-  ruby_type: Integer, String
+  ruby_type: ''


There are a bunch of instances like this where ruby_type is changed from Integer, String to ''.

IanMadd · 2026-03-03T21:27:11Z

data/infra/resources/package.yaml

  required: false
  default_value: 'true'
  description_list:
  - markdown: '**yum_package** resource only. Downgrade a package to satisfy


According to this Jira ticket, the allow_downgrade is valid on several package resources.

https://progresssoftware.atlassian.net/browse/CHEF-25659

https://github.com/search?q=repo%3Achef%2Fchef%20allow_downgrade&type=code

We have it in the following resources:

dnf_package

dpkg_package

package

rpm_package

yum_package

zypper_package

IanMadd added 2 commits March 2, 2026 14:12

Update resource YAML files

69aaf4a

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

Update resource data files

7b75258

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

IanMadd changed the title ~~Update Clieng 19 resource docs~~ Update Client 19 resource docs Mar 2, 2026

IanMadd commented Mar 3, 2026

View reviewed changes

IanMadd mentioned this pull request Mar 3, 2026

Im/update resource docs 19 #137

Closed

7 tasks

IanMadd marked this pull request as ready for review March 3, 2026 20:55

IanMadd requested a review from a team as a code owner March 3, 2026 20:55

IanMadd commented Mar 3, 2026

View reviewed changes

		@@ -37,6 +37,8 @@ properties_list:
		default_value: lazy default

Conversation

IanMadd commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Version

Definition of done

Issues resolved

Related PRs

Checklist

Uh oh!

netlify bot commented Mar 2, 2026

✅ Deploy Preview for chef-infra-client ready!

Uh oh!

IanMadd commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IanMadd commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IanMadd commented Mar 2, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IanMadd Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

IanMadd commented Mar 2, 2026 •

edited

Loading

IanMadd commented Mar 2, 2026 •

edited

Loading

IanMadd commented Mar 2, 2026 •

edited

Loading

IanMadd Mar 3, 2026 •

edited

Loading