WIP/RFC: Add `run_agent` task by alexjfisher · Pull Request #709 · theforeman/puppet-puppet

alexjfisher · 2019-10-17T11:10:29Z

No description provided.

tasks/run_agent.rb

alexjfisher · 2019-10-17T11:14:10Z

tasks/run_agent.rb

@@ -0,0 +1,160 @@
+#!/opt/puppetlabs/puppet/bin/ruby


This seems to be the most sensible default. Non AIO users can override this in their bolt configuration with interpreters.

alexjfisher · 2019-10-17T11:17:13Z

tasks/run_agent.rb

+require 'etc'
+require 'json'
+require 'yaml'
+require_relative '../../ruby_task_helper/files/task_helper.rb'


Should I add puppetlabs/ruby_task_helper to the metadata.json?
As far as the module is concerned, it's a 'soft' dependency. But I also don't envisage a module namespace clash, so adding it to the metadata might be more helpful to users.

alexjfisher · 2019-10-17T11:18:53Z

tasks/run_agent.rb

+require 'yaml'
+require_relative '../../ruby_task_helper/files/task_helper.rb'
+
+class RunAgentTask < TaskHelper


No idea what to use for the class name. The docs aren't especially helpful.

alexjfisher · 2019-10-17T11:20:50Z

tasks/run_agent.rb

+    if agent_locked?
+      raise TaskHelper::Error.new(
+        'Lockfile still exists after waiting',
+        'theforeman-puppet/lockfile_timeout_expired'


> kind - A standard string for machines to handle. You may share kinds between your modules or namespace kinds per module.

Not really sure if this is a good choice or how important it is.

alexjfisher · 2019-10-17T11:21:50Z

tasks/run_agent.rb

+      )
+    end
+
+    waited


I don't think I'm actually using this returned value at the moment. I suppose I could bung it into the response??

alexjfisher · 2019-10-17T11:24:25Z

tasks/run_agent.rb

+    cmd << if @noop
+             '--noop'
+           else
+             '--no-noop'


This is to override the value in the config file. I should probably make this clearer in whatever docs I write or in the task metadata.

alexjfisher · 2019-10-17T11:25:30Z

tasks/run_agent.rb

+    case status.exitstatus
+    when 0
+      {
+        result: 'The run succeeded with no changes or failures; the system was already in the desired state (or --noop was used).',


Most of this text was taken from the puppet docs. I added the bit about noop myself. Maybe I should open a PR to fix this upstream ;)

runejuhl · 2019-10-21T11:40:38Z

Quoting myself from https://gist.github.com/alexjfisher/753c61e09e891c9c9336ba0522b581a4#gistcomment-3057265

If you plan on using this not just for development you should probably avoid using -t (--test):
--test
Enable the most common options used for testing. These are 'onetime', 'verbose', 'no-daemonize', 'no-usecacheonfailure', 'detailed-exitcodes', 'no-splay', and 'show_diff'.
https://puppet.com/docs/puppet/latest/man/agent.html

Specifically you don't want the no-usecacheonfailure:
usecacheonfailure

Whether to use the cached configuration when the remote configuration will not compile. This option is useful for testing new configurations, where you want to fix the broken configuration rather than reverting to a known-good one.
Default: true
https://puppet.com/docs/puppet/latest/configuration.html#usecacheonfailure

That is, if you use -t/--test you implicitly set no-usecacheonfailure, which usually isn't what you want for a production run.

runejuhl · 2019-10-21T12:34:36Z

tasks/run_agent.rb

+  end
+
+  def run_puppet
+    cmd = [@puppet_bin, 'agent', '-t', '--detailed-exitcodes']


Sorry, with #709 (comment) I was of course referring to this line.

For a manual run (as opposed to a normal scheduled run), I think I'd personally never want to accidentally be using the cache. I do need a way of making this and other options configurable though.

--detailed-exitcodes is redundant here though (already included in -t).

Yes, agreed, having a simple toggle for --test (which doesn't use cache) and --no-daemonize --onetime --no-splay --detailed-exitcodes (which would use cache) would be nice.

Can you override options set with --test by setting conflicting arguments?
eg does

puppet agent -t --usecacheonfailure

work?

answering my own question... Apparently not.

Seems like it:

$ puppet apply --noop -e 'file { "/tmp/omgtest": ensure => file, }' Notice: Compiled catalog for managua.lan in environment production in 0.01 seconds Notice: /Stage[main]/Main/File[/tmp/omgtest]/ensure: current_value 'absent', should be 'file' (noop) Notice: Class[Main]: Would have triggered 'refresh' from 1 event Notice: Stage[main]: Would have triggered 'refresh' from 1 event Notice: Applied catalog in 0.02 seconds $ puppet apply --noop -e 'file { "/tmp/omgtest": ensure => file, }' --no-noop Notice: Compiled catalog for managua.lan in environment production in 0.01 seconds Notice: /Stage[main]/Main/File[/tmp/omgtest]/ensure: created Notice: Applied catalog in 0.01 seconds

And yes, it'd be much better to use the default --test.

Seems to work just fine with puppet apply. Last argument takes precedence:

$ puppet apply --no-noop -e 'file { "/tmp/omgtest": ensure => file, }' --noop Notice: Compiled catalog for managua.lan in environment production in 0.01 seconds Notice: /Stage[main]/Main/File[/tmp/omgtest]/ensure: current_value 'absent', should be 'file' (noop) Notice: Class[Main]: Would have triggered 'refresh' from 1 event Notice: Stage[main]: Would have triggered 'refresh' from 1 event Notice: Applied catalog in 0.01 seconds

I went for puppet agent -t --splay and the run didn't wait a random amount of time.

@runejuhl I've added a puppet_settings variable. It's an optional hash where you can override the default settings.

alexjfisher · 2019-10-23T14:24:25Z

.sync.yml

+  extra:
+    - gem: bolt
+      version: '~> 1.15'
+      # TODO: Add something to foreman-installer-modulesync to support `unless ENV['PUPPET_VERSION'] =~ /^5/`


@ekohl a raw_append option??

ekohl · 2020-04-09T13:30:47Z

@alexjfisher what do we want to do with this? I don't have bolt or the capability to maintain this. Would you be interested in becoming a co-maintainer for the module?

theforeman-bot added Needs testing Not yet reviewed labels Oct 17, 2019

ekohl reviewed Oct 17, 2019

View reviewed changes

tasks/run_agent.rb Outdated Show resolved Hide resolved

alexjfisher commented Oct 17, 2019

View reviewed changes

alexjfisher force-pushed the run_agent_task branch from e8e7da3 to 10359ab Compare October 18, 2019 16:04

runejuhl reviewed Oct 21, 2019

View reviewed changes

alexjfisher force-pushed the run_agent_task branch 8 times, most recently from e6687f8 to 9182626 Compare October 23, 2019 13:27

alexjfisher commented Oct 23, 2019

View reviewed changes

ekohl added Enhancement Waiting on contributor labels Oct 23, 2019

WIP/RFC: Add run_agent task

5b2946a

alexjfisher force-pushed the run_agent_task branch from 9182626 to 5b2946a Compare February 14, 2020 11:36

theforeman-bot removed the Waiting on contributor label Feb 14, 2020

zjhuntin added the Waiting on contributor label Apr 23, 2020

+                    )
+                  end
+                  waited

Comments

Conversation

alexjfisher commented Oct 17, 2019

Uh oh!

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!

runejuhl commented Oct 21, 2019

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!

ekohl commented Apr 9, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants