From 8bd59d9f536bebb52a70483f01a7be89cd8da65e Mon Sep 17 00:00:00 2001 From: Nandini Vij Date: Mon, 15 Jun 2020 17:20:43 -0700 Subject: [PATCH 1/4] Docs: Upgrade process updated --- docs/upgrade.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/upgrade.md b/docs/upgrade.md index a0a3dde..1033fbd 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -4,16 +4,18 @@ Splunk Connect for Syslog is updated regularly using a CI/CD development process must be taken into account prior and after an upgrade. Ensure to follow specific instructions below to ensure a smooth transition to a new version of SC4S in production. -## Version 1.9.0 +###Upgrade process +Check the current version of SC4S by running ```sudo docker logs SC4S```. For latest version choose the latest SC4S image in the sc4s.service file +``` +[Service] +Environment="SC4S_IMAGE=splunk/scs:latest" +``` +Restart the service +```sudo systemctl restart sc4s``` -* 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. - -## Version 1.10.0 - -* The "Development" section outlines new instructions for operation with the vscode IDE. \ No newline at end of file +Having latest is recommended but if some other version is required specify in the service file. For eg: +``` +[Service] +Environment="SC4S_IMAGE=splunk/scs:v1.20.0" +``` +Follow the link for release information https://github.com/splunk/splunk-connect-for-syslog/releases \ No newline at end of file From e4d5571b038f64505652ed180ebfa64be89dfb32 Mon Sep 17 00:00:00 2001 From: mbonsack Date: Mon, 15 Jun 2020 17:53:38 -0700 Subject: [PATCH 2/4] Minor clarification for upgrade docs * Minor clarification of proper tag for sc4s unit file --- docs/upgrade.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/upgrade.md b/docs/upgrade.md index 1033fbd..71f472c 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -1,11 +1,12 @@ # Upgrading Splunk Connect for Syslog Splunk Connect for Syslog is updated regularly using a CI/CD development process. The notes below outline significant changes that -must be taken into account prior and after an upgrade. Ensure to follow specific instructions below to ensure a smooth transition to -a new version of SC4S in production. +must be taken into account prior and after an upgrade. Ensure to follow specific instructions below to ensure a smooth +transition to a new version of SC4S in production. ###Upgrade process -Check the current version of SC4S by running ```sudo docker logs SC4S```. For latest version choose the latest SC4S image in the sc4s.service file +Check the current version of SC4S by running ```sudo logs SC4S```. For the latest version, use the +`latest` tag for the SC4S image in the sc4s.service unit file: ``` [Service] Environment="SC4S_IMAGE=splunk/scs:latest" @@ -18,4 +19,4 @@ Having latest is recommended but if some other version is required specify in th [Service] Environment="SC4S_IMAGE=splunk/scs:v1.20.0" ``` -Follow the link for release information https://github.com/splunk/splunk-connect-for-syslog/releases \ No newline at end of file +Follow the link for release information https://github.com/splunk/splunk-connect-for-syslog/releases From d107dc034fe269fbbe8ffb65f1af890e993744ae Mon Sep 17 00:00:00 2001 From: mbonsack Date: Mon, 15 Jun 2020 17:54:57 -0700 Subject: [PATCH 3/4] Markdown fix * Markdown fix --- docs/upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/upgrade.md b/docs/upgrade.md index 71f472c..0c16ff1 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -4,7 +4,7 @@ Splunk Connect for Syslog is updated regularly using a CI/CD development process must be taken into account prior and after an upgrade. Ensure to follow specific instructions below to ensure a smooth transition to a new version of SC4S in production. -###Upgrade process +## Upgrade process Check the current version of SC4S by running ```sudo logs SC4S```. For the latest version, use the `latest` tag for the SC4S image in the sc4s.service unit file: ``` From bcbf7fe143e20defac58fb326177be9796c145d3 Mon Sep 17 00:00:00 2001 From: mbonsack Date: Mon, 15 Jun 2020 18:01:02 -0700 Subject: [PATCH 4/4] Update markdown for URL * Update markdown for URL --- docs/upgrade.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/upgrade.md b/docs/upgrade.md index 0c16ff1..ea15acb 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -14,9 +14,9 @@ Environment="SC4S_IMAGE=splunk/scs:latest" Restart the service ```sudo systemctl restart sc4s``` -Having latest is recommended but if some other version is required specify in the service file. For eg: +Using the latest version is recommended, but a specific version can be specified in the unit file if desired: ``` [Service] Environment="SC4S_IMAGE=splunk/scs:v1.20.0" ``` -Follow the link for release information https://github.com/splunk/splunk-connect-for-syslog/releases +See the [release information](https://github.com/splunk/splunk-connect-for-syslog/releases) for more detail.