Skip to content

📚 Clean up README #433

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

Merged
abahmed merged 2 commits into from
Mar 25, 2026
Merged

📚 Clean up README #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
347c0ad
📚🧹📝 Clean up README: remove architecture section & fix Google Chat typo
abahmed Mar 25, 2026
6d6f34f
📦⬆️ Bump stretchr/objx from 0.5.2 to 0.5.3
abahmed Mar 25, 2026
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
51 changes: 15 additions & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@

## ⚡️ Getting Started

### Install
### 📦 Install

#### Using Helm
#### ⎈ Using Helm

```shell
helm repo add kwatch https://kwatch.dev/charts
Expand All @@ -41,7 +41,7 @@ helm install [RELEASE_NAME] kwatch/kwatch --namespace kwatch --create-namespace

To get more details, please check [chart's configuration](https://github.com/abahmed/kwatch/blob/main/deploy/chart/README.md)

#### Using kubectl
#### 🐙 Using kubectl

You need to get config template to add your configs

Expand All @@ -61,30 +61,9 @@ To deploy **kwatch**, execute following command:
kubectl apply -f https://raw.githubusercontent.com/abahmed/kwatch/v0.10.4/deploy/deploy.yaml
```

## High Level Architecture
## ⚙️ Configuration

<p>
<img src="./assets/highlevelarchitecture.png" width="70%"/>
</p>

| Point | URL |
|:---------------------------------|:--------------------------------------------------------------------------------- |
| `4.1` | <https://github.com/abahmed/kwatch/blob/main/main.go#L18> |
| `5.1.` | <https://github.com/abahmed/kwatch/blob/main/main.go#L21> / 24 |
| `6.1.` | <https://github.com/abahmed/kwatch/blob/main/main.go#L36> |
| `7.0.` | <https://github.com/abahmed/kwatch/blob/main/main.go#L40> |
| `7.1.` | <https://github.com/abahmed/kwatch/blob/main/upgrader/upgrader.go#L16> |
| `8.1.&8.2` | <https://github.com/abahmed/kwatch/blob/main/main.go#L46> / 52 |
| `8.3.` | <https://github.com/abahmed/kwatch/blob/main/main.go#L53> |
| `9.0.` | <https://github.com/abahmed/kwatch/blob/main/main.go#L58> |
| `9.1.` | <https://github.com/abahmed/kwatch/blob/main/controller/start.go#L20> |
| `9.2.` | <https://github.com/abahmed/kwatch/blob/main/controller/controller.go#L37> |
| `9.3.` | <https://github.com/abahmed/kwatch/blob/main/controller/controller.go> |
| `9.4.` | <https://github.com/abahmed/kwatch/tree/main/provider> |

## Configuration

### General
### 🔧 General

| Parameter | Description |
|:-------------------------------|:-----------------------|
Expand All @@ -97,7 +76,7 @@ kubectl apply -f https://raw.githubusercontent.com/abahmed/kwatch/v0.10.4/deploy
| `IgnoreLogPatterns` | Optional list of regexp patterns of logs to ignore |


### App
### 📱 App

| Parameter | Description |
|:------------------------------|:------------------------------------------- |
Expand All @@ -107,14 +86,14 @@ kubectl apply -f https://raw.githubusercontent.com/abahmed/kwatch/v0.10.4/deploy
| `app.logFormatter` | used for setting custom formatter when app prints logs: text, json (default: text) |


### Telemetry (Not Released)
### 📊 Telemetry (Not Released)

| Parameter | Description |
|:------------------------------|:------------------------------------------- |
| `telemetry.enabled` | If set to true, anonymous telemetry data (cluster ID and version) is sent on first run to help track kwatch usage (default: false) |


### Health Check (Not Released)
### 💓 Health Check (Not Released)

| Parameter | Description |
|:------------------------------|:------------------------------------------- |
Expand All @@ -126,13 +105,13 @@ kubectl apply -f https://raw.githubusercontent.com/abahmed/kwatch/v0.10.4/deploy
- `GET /health` - Returns `{"status": "ok"}` (application/json)


### Upgrader
### 🔄 Upgrader

| Parameter | Description |
|:------------------------------|:------------------------------------------- |
| `upgrader.disableUpdateCheck` | If set to true, does not check for and notify about kwatch updates |

### PVC Monitor
### 💾 PVC Monitor

| Parameter | Description |
|:-----------------------------|:------------------------------------------- |
Expand All @@ -141,15 +120,15 @@ kubectl apply -f https://raw.githubusercontent.com/abahmed/kwatch/v0.10.4/deploy
| `pvcMonitor.threshold` | the percentage of accepted pvc usage. if current usage exceeds this value, it will send a notification (default: 80) |


### Node Monitor
### 🖥️ Node Monitor

| Parameter | Description |
|:-----------------------------|:------------------------------------------- |
| `nodeMonitor.enabled` | to enable or disable node monitoring (default: true) |



### Alerts
### 🔔 Alerts

#### Slack

Expand Down Expand Up @@ -335,12 +314,12 @@ If you want to enable Zenduty, provide IntegrationKey with optional alert type
<img src="./assets/googlechat.png" width="50%"/>
</p>

If you want to enable Rocket Chat, provide the webhook with optional text
If you want to enable Google Chat, provide the webhook with optional text

| Parameter | Description |
|:---------------------------|:---------------------------------------|
| `alert.googlechat.webhook` | Google Chat webhook URL |
| `alert.rocketchat.text` | Customized text in Google Chat message |
| `alert.googlechat.text` | Customized text in Google Chat message |

#### Custom webhook

Expand All @@ -353,7 +332,7 @@ basic auth
| `alert.webhook.headers` | optional list of name and value |
| `alert.webhook.basicAuth` | optional username and password |

### Cleanup
### 🧹 Cleanup

```shell
kubectl delete -f https://raw.githubusercontent.com/abahmed/kwatch/v0.10.4/deploy/config.yaml
Expand Down
3 changes: 1 addition & 2 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ require (
k8s.io/client-go v0.35.3
)

require github.com/stretchr/objx v0.5.2 // indirect

require (
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
github.com/emicklei/go-restful/v3 v3.13.0 // indirect
Expand Down Expand Up @@ -48,6 +46,7 @@ require (
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
github.com/spf13/pflag v1.0.10 // indirect
github.com/stretchr/objx v0.5.3 // indirect
github.com/x448/float16 v0.8.4 // indirect
go.yaml.in/yaml/v2 v2.4.4 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ github.com/slack-go/slack v0.20.0/go.mod h1:K81UmCivcYd/5Jmz8vLBfuyoZ3B4rQC2GHVX
github.com/spf13/pflag v1.0.10 h1:4EBh2KAYBwaONj6b2Ye1GiHfwjqyROoF4RwYO+vPwFk=
github.com/spf13/pflag v1.0.10/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
github.com/stretchr/objx v0.5.3 h1:jmXUvGomnU1o3W/V5h2VEradbpJDwGrzugQQvL0POH4=
github.com/stretchr/objx v0.5.3/go.mod h1:rDQraq+vQZU7Fde9LOZLr8Tax6zZvy4kuNKF+QYS+U0=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
Expand Down
Loading