Update docs for 13.1 - Salt by bochi · Pull Request #1653 · theforeman/theforeman.org

bochi · 2020-07-29T11:55:36Z

Update docs for 13.1
This PR includes 3 commits:

create directory for 13.1
include docs for the filecache option
include docs for the packaged salt-report-upload runner/reactor

adamruzicka · 2020-07-29T12:13:38Z

plugins/foreman_salt/13.1/index.md

+title: Foreman Salt 13.0 Manual
+version: 13.0


Shouldn't these say 13.1?

Of course. Fixed, thanks.

adamruzicka · 2020-07-29T12:14:08Z

plugins/foreman_salt/13.1/index.md

+
+## 1.1 Release Notes
+
+### 1.1.1 Foreman plugin


Changelog for 13.1?

adamruzicka · 2020-07-29T12:15:30Z

plugins/foreman_salt/13.1/index.md


+The :filecache: option makes foreman-node read the grains cache from files rather than using salt-run. 
+
+Please note this will only work if the master is not configured to use an external minion cache module. With salt's default configuration the filecache option works fine and should be used as it is much faster than getting the cache using salt-run. Please note that for this to work, the "msgpack" rubygem needs to be present.


Is that something one has to do manually or is it brought in as a dependency when installing the rpm?

That I am not sure of. Currently, in our containerized foreman proxy we are installing it manually using gem install because there's no package available. @sbernhard commited something to foreman-packaging though adding the rubygem, but as of now, there's no dependency in the spec file yet.

adamruzicka · 2020-07-29T12:15:52Z

plugins/foreman_salt/13.1/index.md

+
+Please note this will only work if the master is not configured to use an external minion cache module. With salt's default configuration the filecache option works fine and should be used as it is much faster than getting the cache using salt-run. Please note that for this to work, the "msgpack" rubygem needs to be present.
+
+If your salt-master is configured to use a different data directory for cache, you can also set the :cachedir: option to the same directory you configured in the salt master configuration.


you can also set the

can or have to?

adamruzicka · 2020-07-29T12:16:29Z

plugins/foreman_salt/13.1/index.md

 ![](/static/images/plugins/foreman_salt/reports.gif)

-Uploading the salt reports is done by `/usr/sbin/upload-salt-reports` and is scheduled by a cron job running on the smart proxy.  By default, reports are uploaded to Foreman once every 10 minutes from the Salt master's job cache. You may modify the smart_proxy_salt cron job to customize this by editing `/etc/cron.d/smart_proxy_salt`.
+There are two ways to upload the highstate reports to foreman:


capital F in foreman I guess

adamruzicka · 2020-07-29T12:17:41Z

plugins/foreman_salt/13.1/index.md

+    - /usr/share/foreman-salt/reactor/foreman_report_upload.sls
+```
+
+In case you decide to use the reactor/runner solution, please also remove the cronjob triggering `/usr/sbin/upload-salt-reports` from `/etc/cron.d/smart_proxy_salt`.


Why? To prevent reports being duplicated?

Correct, I made it more clear. Thanks for your comments

lzap · 2022-01-17T13:22:59Z

What is the status here?

sbernhard · 2022-01-17T14:52:00Z

Good question. I thought the "next" documentation system should be used. See https://docs.theforeman.org/3.1/Managing_Hosts/index-foreman-el.html#Using_Salt_for_Configuration_Management_managing-hosts

This was referenced Jul 29, 2020

Add runner upload docs #1652

Closed

Add filecache docs #1646

Closed

bochi added 3 commits July 29, 2020 13:57

add docs for 13.1

474afbb

add filecache docs for foreman-node

3fba0f7

add report upload reactor/runner docs

d806a36

bochi force-pushed the update_docs_for_13.1 branch from 25a2a17 to d806a36 Compare July 29, 2020 11:58

adamruzicka reviewed Jul 29, 2020

View reviewed changes

fix adam's comments

7eba9ed

lzap changed the title ~~Update docs for 13.1~~ Update docs for 13.1 - Salt Jan 17, 2022


		The :filecache: option makes foreman-node read the grains cache from files rather than using salt-run.

		Please note this will only work if the master is not configured to use an external minion cache module. With salt's default configuration the filecache option works fine and should be used as it is much faster than getting the cache using salt-run. Please note that for this to work, the "msgpack" rubygem needs to be present.


		Please note this will only work if the master is not configured to use an external minion cache module. With salt's default configuration the filecache option works fine and should be used as it is much faster than getting the cache using salt-run. Please note that for this to work, the "msgpack" rubygem needs to be present.

		If your salt-master is configured to use a different data directory for cache, you can also set the :cachedir: option to the same directory you configured in the salt master configuration.

Conversation

bochi commented Jul 29, 2020

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!

lzap commented Jan 17, 2022

Uh oh!

sbernhard commented Jan 17, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants