Skip to content

Update docs based on code PR #74 #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
runllm-pr-agent wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update docs based on code PR #74 #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
846c929
Update README.md
Jun 18, 2025
ac360e3
Update README.md
Jun 18, 2025
592df75
Update README.md
Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ helm install gremlin-integrations gremlin/gremlin-integrations \
--namespace gremlin \
--set gremlin.secret.teamID=YOUR-TEAM-ID \
--set-file gremlin.secret.certificate=PATH_TO_CERTIFICATE \
--set-file gremlin.secret.key=PATH_TO_PRIVATE_KEY
--set-file gremlin.secret.key=PATH_TO_PRIVATE_KEY \
--set gremlin.secret.certVolume=YOUR-CERT-VOLUME-CONFIG
```

For more detailed instructions, see the chart's
Expand Down
4 changes: 3 additions & 1 deletion gremlin-integrations/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ values.yaml for all available options.
| `nodeSelector` | Map of node labels for pod assignment for the `gremlin-integrations` container | `{}` |
| `tolerations` | List of node taints to tolerate for the `gremlin-integrations` container | `[]` |
| `affinity` | Map of node/pod affinities for the `gremlin-integrations` container | `{}` |
| `gremlin.serviceAccount.create` | Specifies whether Gremlin's kubernetes service account should be created by this helm chart | `true` |
| `gremlin.serviceAccount.create` | Specifies whether Gremlin's kubernetes service account should be created by this helm chart |
| `gremlin.secret.certVolume` | Used to define the value of the gremlin-cert volume except the name. This volume should always contain two files named `gremlin.cert` and `gremlin.key` containing the team certificate and private key used to auth the agents to the gremlin API | `{}` |
| `gremlin.serviceAccount.annotations` | Annotations to add to the Gremlin service account | `{}` | | `true` |
| `gremlin.serviceUrl` | Specifies the Control Plane endpoint URL | `https://api.gremlin.com/v1` |
| `gremlin.allowList` | Whitelist URLs in order to allow access only to specific set of endpoints | `""` |
| `gremlin.secret.managed` | Specifies whether Gremlin should manage its secrets with Helm | `false` |
Expand Down
2 changes: 2 additions & 0 deletions gremlin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ their default values. See values.yaml for all available options.
| `chao.nodeSelector` | Map of node labels for pod assignment for the `chao` container | `{}` |
| `chao.tolerations` | List of node taints to tolerate for the `chao` container | `[]` |
| `chao.affinity` | Map of node/pod affinities for the `chao` container | `{}` |
| `chao.serviceAccount.annotations` | Annotations to add to the Chao service account | `{}` |
| `chao.create` | Enable kubernetes targeting by installing k8s client | true |
| `chao.extraEnv` | Specify any arbitrary environment variables to pass to the Chao deployment. | `[]` |
| `chao.namespaces` | List of namespaces for Gremlin to watch for attacking | `[]`
Expand All @@ -45,6 +46,7 @@ their default values. See values.yaml for all available options.
| `gremlin.podSecurity.readOnlyRootFilesystem` | Forces the Gremlin Daemonset containers to run with a read-only root filesystem | `false` |
| `gremlin.podSecurity.supplementalGroups.rule` | Specifies the Linux groups the Gremlin Daemonset containers should run as | `RunAsAny` |
| `gremlin.podSecurity.fsGroup.rule` | Specifies the Linux groups applied to mounted volumes | `RunAsAny` |
| `gremlin.secret.certVolume` | Used to define the value of the gremlin-cert volume except the name. This volume should always contain two files named `gremlin.cert` and `gremlin.key` containing the team certificate and private key used to auth the agents to the gremlin API | `{}` |
| `gremlin.podSecurity.volumes` | Specifies the volume types the Gremlin Daemonset is allowed to use | `[configMap, secret, hostPath]` |
| `gremlin.podSecurity.podSecurityPolicy.create` | When true, Gremlin creates and uses a custom PodSecurityPolicy, granting all behaviors Gremlin needs | `false` |
| `gremlin.podSecurity.podSecurityPolicy.seLinux` | Sets the SecurityContext for the PSP used by the Gremlin Daemonset | `{ rule: MustRunAs, seLinuxOptions: { type: gremlin.process } }` |
Expand Down