Skip to content

Commit

Permalink
Minor docs updates/corrections
Browse files Browse the repository at this point in the history
* Update upgrade doc to include unit file changes
* Fix two errors in runtime docs
  • Loading branch information
Mark Bonsack committed Feb 3, 2020
1 parent 0b87ff0 commit c99e149
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/gettingstarted/byoe-rhel7.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ gomplate --version

```scl enable rh-python36 bash```

* create the sc4s unit file ``/etc/systemd/system/sc4s.service`` and add the following content
* create the sc4s unit file ``/lib/systemd/system/sc4s.service`` and add the following content

```ini
[Unit]
Expand Down
4 changes: 2 additions & 2 deletions docs/gettingstarted/podman-systemd-general.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ ExecStart=/usr/bin/podman run -p 514:514 -p 514:514/udp -p 6514:6514 \
failure to the upstream destination(s). This will also be used to keep track of the state of syslog-ng between restarts, and in
particular the state of the disk buffer. This is a required step.
```
sudo docker volume create splunk-sc4s-var
sudo podman volume create splunk-sc4s-var
```

* Create the subdirectory ``/opt/sc4s/local``. This will be used as a mount point for local overrides and configurations.
Expand Down Expand Up @@ -279,7 +279,7 @@ information.

To operate SC4S as a user other than root, follow the instructions above, with these modifications:

## Prepare SC4S user
## Prepare sc4s user

Create a non-root user in which to run SC4S and prepare podman for non-root operation:

Expand Down
5 changes: 4 additions & 1 deletion docs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ a new version of SC4S in production.

## Version 1.9.0

Example context files have been added to the local mount `context` directory. These example files will be updated at each release
* Example context files have been added to the local mount `context` directory. These example files will be updated at each release
to outline support for new data sources, which can be added to existing context files (those without the `.example` extension).
Existing context files will _not_ be overwritten on subsequent SC4S starts/upgrades, so ensure that any new content from these example
files is incorporated into existing context files.

* UNIT FILE CHANGES: Make sure to update the unit file used to start the sc4s service with the changes included in this release. It
includes updates for proper operation with RHEL 8, and is backward-compatible with RHEL 7.7.

0 comments on commit c99e149

Please sign in to comment.