(MODULES-11048) task to remove local filebucket #550

gimmyxd · 2021-04-15T12:23:20Z

This adds a task that removes the local filebucket
which was disabled by default in Puppet 7.
The location of filebucket is determined using the
clientbucketdir puppet config.

❯ bolt task show puppet_agent::delete_local_filebucket
puppet_agent::delete_local_filebucket
  Removes the local filebucket

Usage
  bolt task run puppet_agent::delete_local_filebucket --targets <targets>
  [force=<value>]

Parameters
  force  Optional[Boolean]
    ignore nonexistent files and errors

Tested on Windows:

$ ls  /cygdrive/c/ProgramData/PuppetLabs/puppet/cache/clientbucket
ls: cannot access /cygdrive/c/ProgramData/PuppetLabs/puppet/cache/clientbucket: No such file or directory

❯ bolt task run puppet_agent::delete_local_filebucket
 {"_error"=>{"msg"=>"Errno::ENOENT: No such file or directory @ apply2files - C:/ProgramData/PuppetLabs/puppet/cache/clientbucket", "kind"=>"puppet_agent/cannot-remove-error", "details"=>{}}}

❯ bolt task run puppet_agent::delete_local_filebucket force=true
   {:success=>true}

$ mkdir -p /cygdrive/c/ProgramData/PuppetLabs/puppet/cache/clientbucket

❯ bolt task run puppet_agent::delete_local_filebucket
  {:success=>true}
  
$ ls  /cygdrive/c/ProgramData/PuppetLabs/puppet/cache/clientbucket
ls: cannot access /cygdrive/c/ProgramData/PuppetLabs/puppet/cache/clientbucket: No such file or directory

gimmyxd · 2021-04-15T14:07:28Z

tasks/delete_local_filebucket.rb

+        override_locale: false,
+      }
+
+      command = "#{puppet_bin} config print clientbucketdir"


@joshcooper thoughts on this? Could this not return the correct path if clientbucketdir is set in a different section?

clientbucketdir can also be found without shelling out to puppet config print.

Puppet.initialize_settings Puppet[:clientbucketdir]

Looks like clientbucketdir is defined under the agent section in defaults.rb. However, the puppet filebucket application doesn't enforce a specific run_mode, so it will ignore the value of clientbucketdir if set under [agent].

Using this logic, I think we can rely on the initialize_settings approach as it would be a bit faster.

One downside with initialize_settings is it can only be called once:

irb(main):001:0> require 'puppet' => true irb(main):002:0> Puppet.initialize_settings => {} irb(main):003:0> Puppet.initialize_settings Traceback (most recent call last): 16: from /home/josh/.rbenv/versions/2.7.3/lib/ruby/gems/2.7.0/gems/bundler-2.2.16/lib/bundler/vendor/thor/lib/thor/base.rb:485:in `start' 15: from /home/josh/.rbenv/versions/2.7.3/lib/ruby/gems/2.7.0/gems/bundler-2.2.16/lib/bundler/cli.rb:30:in `dispatch' 14: from /home/josh/.rbenv/versions/2.7.3/lib/ruby/gems/2.7.0/gems/bundler-2.2.16/lib/bundler/vendor/thor/lib/thor.rb:392:in `dispatch' 13: from /home/josh/.rbenv/versions/2.7.3/lib/ruby/gems/2.7.0/gems/bundler-2.2.16/lib/bundler/vendor/thor/lib/thor/invocation.rb:127:in `invoke_command' 12: from /home/josh/.rbenv/versions/2.7.3/lib/ruby/gems/2.7.0/gems/bundler-2.2.16/lib/bundler/vendor/thor/lib/thor/command.rb:27:in `run' 11: from /home/josh/.rbenv/versions/2.7.3/lib/ruby/gems/2.7.0/gems/bundler-2.2.16/lib/bundler/cli.rb:494:in `exec' 10: from /home/josh/.rbenv/versions/2.7.3/lib/ruby/gems/2.7.0/gems/bundler-2.2.16/lib/bundler/cli/exec.rb:28:in `run' 9: from /home/josh/.rbenv/versions/2.7.3/lib/ruby/gems/2.7.0/gems/bundler-2.2.16/lib/bundler/cli/exec.rb:63:in `kernel_load' 8: from /home/josh/.rbenv/versions/2.7.3/lib/ruby/gems/2.7.0/gems/bundler-2.2.16/lib/bundler/cli/exec.rb:63:in `load' 7: from /home/josh/.rbenv/versions/2.7.3/bin/irb:23:in `<top (required)>' 6: from /home/josh/.rbenv/versions/2.7.3/bin/irb:23:in `load' 5: from /home/josh/.rbenv/versions/2.7.3/lib/ruby/gems/2.7.0/gems/irb-1.2.6/exe/irb:11:in `<top (required)>' 4: from (irb):3 3: from /home/josh/work/puppet/lib/puppet.rb:153:in `initialize_settings' 2: from /home/josh/work/puppet/lib/puppet.rb:178:in `do_initialize_settings_for_run_mode' 1: from /home/josh/work/puppet/lib/puppet/settings.rb:305:in `initialize_global_settings' Puppet::DevError (Attempting to initialize global default settings more than once!)

So it seems like there could be issues if this task was called twice in a plan (seems unlikely) or some other task also called initialize_settings?

I'd be inclined to just shell out.

ciprianbadescu · 2021-04-20T11:22:58Z

tasks/delete_local_filebucket.rb

+      ) unless puppet_bin_present?
+
+      begin
+        FileUtils.remove_dir(clientbucketdir, force)


It may not worth fixing it, but if the clientbucketdir is removed, the puppet command listing local filebuckets may error:

scrawny-tumbler:~ # find /opt/puppetlabs/puppet/cache/clientbucket/ find: `/opt/puppetlabs/puppet/cache/clientbucket/': No such file or directory scrawny-tumbler:~ # puppet filebucket -l list Error: Could not run: File not found scrawny-tumbler:~ # mkdir /opt/puppetlabs/puppet/cache/clientbucket/ scrawny-tumbler:~ # puppet filebucket -l list scrawny-tumbler:~ # puppet filebucket backup /etc/passwd --local scrawny-tumbler:~ #

Seems that puppet will create the directory again on the next run:

Debug: /File[/opt/puppetlabs/puppet/cache/clientbucket]: Adding autorequire relationship with File[/opt/puppetlabs/puppet/cache] ... Debug: /File[/opt/puppetlabs/puppet/cache/clientbucket]/ensure: created

Maybe we should just remove the directory contents then?

ciprianbadescu

good to merge, one optional comment

This adds a task that removes the local filebucket which was disabled by default in Puppet 7. The location of filebucket is determine using the `clientbucketdir` puppet config. ``` ❯ bolt task show puppet_agent::delete_local_filebucket puppet_agent::delete_local_filebucket Removes the local filebucket Usage bolt task run puppet_agent::delete_local_filebucket --targets <targets> [force=<value>] Parameters force Optional[Boolean] ignore nonexistent files and errors ```

gimmyxd requested a review from a team as a code owner April 15, 2021 12:23

gimmyxd requested a review from a team April 15, 2021 12:23

gimmyxd force-pushed the MODULES-11048 branch from 4a998b0 to 0b6623a Compare April 15, 2021 12:34

gimmyxd requested a review from joshcooper April 15, 2021 14:06

gimmyxd commented Apr 15, 2021

View reviewed changes

gimmyxd force-pushed the MODULES-11048 branch 2 times, most recently from 8292f29 to 191ae7f Compare April 20, 2021 05:41

ciprianbadescu reviewed Apr 20, 2021

View reviewed changes

ciprianbadescu approved these changes Apr 20, 2021

View reviewed changes

ciprianbadescu requested a review from a team April 20, 2021 11:26

gimmyxd force-pushed the MODULES-11048 branch from 191ae7f to 47b43e7 Compare April 20, 2021 12:54

gimmyxd force-pushed the MODULES-11048 branch from 47b43e7 to 7ec1c2a Compare April 20, 2021 14:34

gimmyxd closed this Apr 20, 2021

gimmyxd reopened this Apr 20, 2021

ciprianbadescu merged commit 3669c16 into puppetlabs:main Apr 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(MODULES-11048) task to remove local filebucket #550

(MODULES-11048) task to remove local filebucket #550

gimmyxd commented Apr 15, 2021 •

edited

Loading

gimmyxd Apr 15, 2021

gimmyxd Apr 15, 2021 •

edited

Loading

GabrielNagy Apr 19, 2021

joshcooper Apr 19, 2021

ciprianbadescu Apr 20, 2021

gimmyxd Apr 20, 2021

GabrielNagy Apr 20, 2021

ciprianbadescu left a comment

(MODULES-11048) task to remove local filebucket #550

(MODULES-11048) task to remove local filebucket #550

Conversation

gimmyxd commented Apr 15, 2021 • edited Loading

gimmyxd Apr 15, 2021

Choose a reason for hiding this comment

gimmyxd Apr 15, 2021 • edited Loading

Choose a reason for hiding this comment

GabrielNagy Apr 19, 2021

Choose a reason for hiding this comment

joshcooper Apr 19, 2021

Choose a reason for hiding this comment

ciprianbadescu Apr 20, 2021

Choose a reason for hiding this comment

gimmyxd Apr 20, 2021

Choose a reason for hiding this comment

GabrielNagy Apr 20, 2021

Choose a reason for hiding this comment

ciprianbadescu left a comment

Choose a reason for hiding this comment

gimmyxd commented Apr 15, 2021 •

edited

Loading

gimmyxd Apr 15, 2021 •

edited

Loading