Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for 13.1 - Salt #1653

Open
wants to merge 4 commits into
base: gh-pages
Choose a base branch
from

Conversation

bochi
Copy link

@bochi bochi commented Jul 29, 2020

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

This was referenced Jul 29, 2020
@bochi bochi force-pushed the update_docs_for_13.1 branch from 25a2a17 to d806a36 Compare July 29, 2020 11:58
Comment on lines 3 to 4
title: Foreman Salt 13.0 Manual
version: 13.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't these say 13.1?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course. Fixed, thanks.


## 1.1 Release Notes

### 1.1.1 Foreman plugin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changelog for 13.1?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.


If your Smart Proxy uses SSL, then the certs and key configured in the YAML should be the same ones it uses to talk to Foreman. If you're already using Puppet in Foreman, consult `/etc/puppet/foreman.yaml` or `/etc/puppet/node.rb` for those settings.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can also set the

can or have to?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have to ;)

@@ -384,7 +384,26 @@ When running `state.highstate`, you can have Foreman process the results and sho

![](/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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

capital F in foreman I guess

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

- /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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? To prevent reports being duplicated?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@lzap lzap changed the title Update docs for 13.1 Update docs for 13.1 - Salt Jan 17, 2022
@lzap
Copy link
Member

lzap commented Jan 17, 2022

What is the status here?

@sbernhard
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants