Update yml/unit files in runtime docs (#132)

Update unit/yml files to reflect new single mount point
CSVD · Oct 10, 2019 · d510239 · d510239
1 parent 7fec302
commit d510239
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 27 deletions.
diff --git a/docs/gettingstarted/docker-swarm-general.md b/docs/gettingstarted/docker-swarm-general.md
@@ -18,18 +18,18 @@ services:
        - target: 514
          published: 514
          protocol: tcp
-#Comment the following line out if using docker-compose
+# Comment the following line out if using docker-compose
          mode: host
        - target: 514
          published: 514
          protocol: udp
-#Comment the following line out if using docker-compose         
+# Comment the following line out if using docker-compose         
          mode: host
     env_file:
       - /opt/sc4s/env_file
     volumes:
       - /opt/sc4s/local:/opt/syslog-ng/etc/conf.d/local
-#Uncomment the following line if custom TLS certs are provided
+# Uncomment the following line if custom TLS certs are provided
 #     - /opt/sc4s/tls:/opt/syslog-ng/tls
 ```
 

diff --git a/docs/gettingstarted/docker-swarm-rhel7.md b/docs/gettingstarted/docker-swarm-rhel7.md
@@ -46,20 +46,18 @@ services:
        - target: 514
          published: 514
          protocol: tcp
-#Comment the following line out if using docker-compose
+# Comment the following line out if using docker-compose
          mode: host
        - target: 514
          published: 514
          protocol: udp
-#Comment the following line out if using docker-compose         
+# Comment the following line out if using docker-compose         
          mode: host
     env_file:
       - /opt/sc4s/env_file
     volumes:
-      - /opt/sc4s/default/splunk_index.csv:/opt/syslog-ng/etc/context-local/splunk_index.csv
-      - /opt/sc4s/default/vendor_product_by_source.csv:/opt/syslog-ng/etc/context-local/vendor_product_by_source.csv
-      - /opt/sc4s/default/vendor_product_by_source.conf:/opt/syslog-ng/etc/context-local/vendor_product_by_source.conf
-#Uncomment the following line if custom TLS certs are provided
+      - /opt/sc4s/local:/opt/syslog-ng/etc/conf.d/local
+# Uncomment the following line if custom TLS certs are provided
       - /opt/sc4s/tls:/opt/syslog-ng/tls
 ```
 

diff --git a/docs/gettingstarted/docker-systemd-general.md b/docs/gettingstarted/docker-systemd-general.md
@@ -16,28 +16,25 @@ Requires=network.service
 [Service]
 Environment="SC4S_IMAGE=splunk/sc4s:latest"
 
-#Note Uncomment the following line to use custom index names AND download the splunk_index.csv file template per getting started
-Environment="SC4S_UNIT_SPLUNK_INDEX=-v /opt/sc4s/default/splunk_index.csv:/opt/syslog-ng/etc/context-local/splunk_index.csv"
+# Optional mount point for local overrides and configurations; see notes in docs
 
-#Note Uncomment the following two lines for host and ip based source type mapping AND download the two file templates per getting started
-Environment="SC4S_UNIT_VP_CSV=-v /opt/sc4s/default/vendor_product_by_source.csv:/opt/syslog-ng/etc/context-local/vendor_product_by_source.csv"
-Environment="SC4S_UNIT_VP_CONF=-v /opt/sc4s/default/vendor_product_by_source.conf:/opt/syslog-ng/etc/context-local/vendor_product_by_source.conf"
+Environment="SC4S_LOCAL_CONFIG_MOUNT=-v /opt/sc4s/local:/opt/syslog-ng/etc/conf.d/local"
 
-#Uncomment the following line if custom TLS certs are provided
-#Environment="SC4S_TLS_DIR=-v /opt/sc4s/tls:/opt/syslog-ng/tls"
+# Uncomment the following line if custom TLS certs are provided
+# Environment="SC4S_TLS_DIR=-v /opt/sc4s/tls:/opt/syslog-ng/tls"
 
 TimeoutStartSec=0
 Restart=always
 
 ExecStartPre=/usr/bin/docker pull $SC4S_IMAGE
 ExecStartPre=/usr/bin/docker run \
         --env-file=/opt/sc4s/default/env_file \
-        "$SC4S_UNIT_SPLUNK_INDEX" "$SC4S_UNIT_VP_CSV" "$SC4S_UNIT_VP_CONF" "$SC4S_TLS_DIR" \
+        "$SC4S_LOCAL_CONFIG_MOUNT" \
         --name SC4S_preflight --rm \
         $SC4S_IMAGE -s
 ExecStart=/usr/bin/docker run -p 514:514 -p 514:514/udp \
         --env-file=/opt/sc4s/default/env_file \
-        "$SC4S_UNIT_SPLUNK_INDEX"  "$SC4S_UNIT_VP_CSV" "$SC4S_UNIT_VP_CONF" "$SC4S_TLS_DIR" \
+        "$SC4S_LOCAL_CONFIG_MOUNT" \
         --name SC4S --rm \
 $SC4S_IMAGE
 ```

diff --git a/docs/gettingstarted/podman-systemd-general.md b/docs/gettingstarted/podman-systemd-general.md
@@ -16,28 +16,25 @@ Requires=network.service
 [Service]
 Environment="SC4S_IMAGE=splunk/scs:latest"
 
-#Note Uncomment the following line to use custom index names AND download the splunk_index.csv file template per getting started
-Environment="SC4S_UNIT_SPLUNK_INDEX=-v /opt/sc4s/default/splunk_index.csv:/opt/syslog-ng/etc/context-local/splunk_index.csv"
+# Optional mount point for local overrides and configurations; see notes in docs
 
-#Note Uncomment the following two lines for host and ip based source type mapping AND download the two file templates per getting started
-Environment="SC4S_UNIT_VP_CSV=-v /opt/sc4s/default/vendor_product_by_source.csv:/opt/syslog-ng/etc/context-local/vendor_product_by_source.csv"
-Environment="SC4S_UNIT_VP_CONF=-v /opt/sc4s/default/vendor_product_by_source.conf:/opt/syslog-ng/etc/context-local/vendor_product_by_source.conf"
+Environment="SC4S_LOCAL_CONFIG_MOUNT=-v /opt/sc4s/local:/opt/syslog-ng/etc/conf.d/local"
 
-#Uncomment the following line if custom TLS certs are provided
-#Environment="SC4S_TLS_DIR=-v /opt/sc4s/tls:/opt/syslog-ng/tls"
+# Uncomment the following line if custom TLS certs are provided
+# Environment="SC4S_TLS_DIR=-v /opt/sc4s/tls:/opt/syslog-ng/tls"
 
 TimeoutStartSec=0
 Restart=always
 
 ExecStartPre=/usr/bin/podman pull $SC4S_IMAGE
 ExecStartPre=/usr/bin/podman run \
         --env-file=/opt/sc4s/default/env_file \
-        "$SC4S_UNIT_SPLUNK_INDEX" "$SC4S_UNIT_VP_CSV" "$SC4S_UNIT_VP_CONF" "$SC4S_TLS_DIR" \
+        "$SC4S_LOCAL_CONFIG_MOUNT" \
         --name SC4S_preflight --rm \
         $SC4S_IMAGE -s
 ExecStart=/usr/bin/podman run -p 514:514 -p 514:514/udp \
         --env-file=/opt/sc4s/default/env_file \
-        "$SC4S_UNIT_SPLUNK_INDEX"  "$SC4S_UNIT_VP_CSV" "$SC4S_UNIT_VP_CONF" "$SC4S_TLS_DIR" \
+        "$SC4S_LOCAL_CONFIG_MOUNT" \
         --name SC4S --rm \
 $SC4S_IMAGE
 ```