Skip to content

Commit d666d83

Browse files
chore: add low-resource section to README (#189)
1 parent 74e1c4a commit d666d83

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,30 @@ Installs a local Airbyte instance or updates an existing installation which was
179179
| --values | "" | Helm values file to further customize the Airbyte installation. |
180180
| --volume | "" | **Can be set multiple times**.<br />Mounts additional volumes in the kubernetes cluster.<br />Must be in the format of `<HOST_PATH>:<GUEST_PATH>`. |
181181
182+
#### Low Resource Mode
183+
184+
The `--low-resource-mode` flag optimizes Airbyte for environments with limited CPU and memory resources. When enabled, this mode makes the following changes:
185+
186+
**Resource Requests:**
187+
- Sets all job resource requests (CPU and memory) to `0`, allowing Kubernetes to schedule jobs without minimum resource guarantees
188+
- Applies to all job types: `check`, `discover`, `spec`, and `sidecar` containers
189+
190+
**Feature Adjustments:**
191+
- Disables the Connector Builder Server to reduce overall resource consumption
192+
193+
This mode is ideal for:
194+
- Development and testing environments with limited resources
195+
- Machines with constrained CPU or memory
196+
- Situations where multiple services need to share limited system resources
197+
198+
> [!NOTE]
199+
> While low resource mode reduces resource requirements, it may impact performance for data-intensive operations. It is not recommended for production workloads with large data volumes.
200+
201+
Example usage:
202+
```
203+
abctl local install --low-resource-mode
204+
```
205+
182206
### status
183207
184208
```abctl local status```

0 commit comments

Comments
 (0)