Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kubescape/kollector
Kollector is an in-cluster component of the Kubescape security platform. It Communicates with the Kubernetes API server to collect cluster information and watches for changes in the cluster.
https://github.com/kubescape/kollector
kubernetes kubescape kubescape-helm
Last synced: about 2 months ago
JSON representation
Kollector is an in-cluster component of the Kubescape security platform. It Communicates with the Kubernetes API server to collect cluster information and watches for changes in the cluster.
- Host: GitHub
- URL: https://github.com/kubescape/kollector
- Owner: kubescape
- License: apache-2.0
- Created: 2022-03-13T16:54:39.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-21T13:36:31.000Z (5 months ago)
- Last Synced: 2024-08-21T15:05:55.108Z (5 months ago)
- Topics: kubernetes, kubescape, kubescape-helm
- Language: Go
- Homepage:
- Size: 4.21 MB
- Stars: 2
- Watchers: 2
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Kollector
The Kollector component is an in-cluster component of the [Kubescape security platform](https://www.armosec.io/blog/kubescape-open-source-kubernetes-security-platform/?utm_source=github&utm_medium=repository).
It communicates with the Kubernetes API server to collect cluster information and watches for changes in the cluster.
The information sent to the Kubescape SaaS platform.
## Building Kollector
To build the kollector run: `go build .`
## Configuration
Load config file using the `CONFIG` environment variable
`export CONFIG=path/to/clusterData.json`
example/clusterData.json
```json5
{
"gatewayWebsocketURL": "127.0.0.1:8001",
"gatewayRestURL": "127.0.0.1:8002",
"kubevulnURL": "127.0.0.1:8081",
"kubescapeURL": "127.0.0.1:8080",
"eventReceiverRestURL": "https://report.armo.cloud",
"eventReceiverWebsocketURL": "wss://report.armo.cloud",
"rootGatewayURL": "wss://ens.euprod1.cyberarmorsoft.com/v1/waitfornotification",
"accountID": "*********************",
"clusterName": "******"
}
```
## Environment Variables
Check out `watch/environmentvariables.go`
* `WAIT_BEFORE_REPORT`: Wait before sending the report to the gateway. Default: 60 seconds. This value is in seconds.
## VS code configuration samples
You can use the sample file below to setup your VS code environment for building and debugging purposes.
.vscode/launch.json
```json5
{
"version": "0.2.0",
"configurations": [
{
"name": "Launch Package",
"type": "go",
"request": "launch",
"mode": "auto",
"program": "${workspaceRoot}",
"env": {
"NAMESPACE": "kubescape",
"CONFIG": "${workspaceRoot}/.vscode/clusterData.json",
},
"args": [
"-alsologtostderr", "-v=4", "2>&1"
]
}
]
}
```