Skip to content

Commit

Permalink
chore: README format
Browse files Browse the repository at this point in the history
  • Loading branch information
@lanathlor
lanathlor committed Jan 16, 2025
1 parent bfd2cfc commit f0dd769
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,29 @@ This template is used to deploy ClearNDR CE.

#### Values

| Config | description | default |
| -------- | ------- | ------- |
| globals.restartmode | restart mode of all services | "unless-stopped" |
| opensearch.openPort | Open port of opensearch to local network | false |
| opensearch.openPort.dashboards.openPort | Open port of opensearch-dashboards to local network | false |
| scirius.registry | Image registry where to find scirius image | "ghcr.io/stamusnetworks/scirius" |
| scirius.version | Scirius version to install | clearndr-ce-b1 |
| scirius.debug | Enable debug mode | false |
| suricata.interfaces | List of interfaces to monitor | "..."(all network interfaces on host) |
| arkime.openPort | Open port of Arkime Viewer | false |
| evebox.version | Evebox version to install | master |
| Config | description | default |
| ------------------------------ | --------------------------------------------------- | ------------------------------------- |
| globals.restartmode | restart mode of all services | "unless-stopped" |
| opensearch.openPort | Open port of opensearch to local network | false |
| opensearch.dashboards.openPort | Open port of opensearch-dashboards to local network | false |
| scirius.registry | Image registry where to find scirius image | "ghcr.io/stamusnetworks/scirius" |
| scirius.version | Scirius version to install | clearndr-ce-b1 |
| scirius.debug | Enable debug mode | false |
| suricata.interfaces | List of interfaces to monitor | "..."(all network interfaces on host) |
| arkime.openPort | Open port of Arkime Viewer | false |
| evebox.version | Evebox version to install | master |

## Top level variables in templates

| Variable | Value |
| -------- | ------- |
| .Values | values given to the template by users |
| .Release.name | Name of the release. |
| .Release.user | user creating the release |
| .Release.group | user's group creating the release |
| .Release.location | where the release is placed |
| .Release.isUpgrade | is the release an upgrade |
| .Release.isInstall | is the release an install |
| .Release.service | name of the service creating the release (stamusctl/stamusd) |
| .Template.name | name of the current template |
| .Release.version | version of the current template |
| Variable | Value |
| ------------------ | ------------------------------------------------------------ |
| .Values | values given to the template by users |
| .Release.name | Name of the release. |
| .Release.user | user creating the release |
| .Release.group | user's group creating the release |
| .Release.location | where the release is placed |
| .Release.isUpgrade | is the release an upgrade |
| .Release.isInstall | is the release an install |
| .Release.service | name of the service creating the release (stamusctl/stamusd) |
| .Template.name | name of the current template |
| .Release.version | version of the current template |

0 comments on commit f0dd769

Please sign in to comment.