Skip to content

Commit

Permalink
Merge branch 'main' into jenworthington-patch-11
Browse files Browse the repository at this point in the history
  • Loading branch information
mstopa-splunk authored May 23, 2024
2 parents 428774c + bef6f88 commit 8bcddbd
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions docs/pluggable_modules.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,36 @@
# Pluggable modules guide:
# Working with pluggable modules

SC4S Lite pluggable modules are predefined modules that you can enable or disable by modifying your own config file. This yaml file contains a list of add-ons. See the example and list of available pluggable modules in ([config.yaml reference file](https://github.com/splunk/splunk-connect-for-syslog/blob/main/package/lite/etc/config.yaml)) for more information. Once you update own config.yaml you need mount it to the docker container and override /etc/syslog-ng/config.yaml.
SC4S Lite pluggable modules are predefined modules that you can enable or disable by modifying your `config.yaml` file. This file contains a list of add-ons. See the example and list of available pluggable modules in ([config.yaml reference file](https://github.com/splunk/splunk-connect-for-syslog/blob/main/package/lite/etc/config.yaml)) for more information. Once you update `config.yaml`, you mount it to the Docker container and override `/etc/syslog-ng/config.yaml`.


## Install SC4S Lite using docker-compose:
## Install SC4S Lite using Docker Compose

The installation process is identical to the installation process for[ docker-compose for SC4S](./gettingstarted/docker-compose.md) with the following modifications.
The installation process is identical to the installation process for[ Docker Compose for SC4S](./gettingstarted/docker-compose.md) with the following modifications.

* Use the SC4S Lite image instead of the SC4S image:
```
image: ghcr.io/splunk/splunk-connect-for-syslog/container3lite
```

* Mount your config.yaml file with your add-ons to /etc/syslog-ng/config.yaml:
* Mount your `config.yaml` file with your add-ons to `/etc/syslog-ng/config.yaml`:

```
volumes:
- /path/to/your/config.yaml:/etc/syslog-ng/config.yaml
```

## Kubernetes:

The installation process is identical to the installation process for [Kubernetes for SC4S](./gettingstarted/k8s-microk8s.md) with the following modifications:

* Use the SC4S Lite image instead of SC4S in values.yaml:
* Use the SC4S Lite image instead of SC4S in `values.yaml`:
```
image:
repository: ghcr.io/splunk/splunk-connect-for-syslog/container3lite
```

* Mount config. Add `addons` section inside `sc4s` at values.yaml:
* Mount `config.yaml`. Add an `addons` section inside `sc4s` in `values.yaml`:

```
sc4s:
Expand Down

0 comments on commit 8bcddbd

Please sign in to comment.