Skip to content

Commit

Permalink
docs: fixed some typos and grammatical mistakes for improved clarity.
Browse files Browse the repository at this point in the history
  • Loading branch information
shaarifkhan committed Oct 10, 2024
1 parent 98dbe6b commit 1812763
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,19 @@ Note: this is not an officially supported Google product.
## Description

The primary use cases for Kube Startup CPU Boosts are workloads that require extra CPU resources during
startup phase - typically JVM based applications.
the startup phase - typically JVM based applications.

The Kube Startup CPU Boost leverages [In-place Resource Resize for Kubernetes Pods](https://kubernetes.io/blog/2023/05/12/in-place-pod-resize-alpha/)
feature introduced in Kubernetes 1.27. It allows to revert workload's CPU resource requests and limits
back to their original values without the need to recreate the Pods.

The increase of resources is achieved by Mutating Admission Webhook. By default, the webhook also
removes CPU resource limits if present. The original resource values are set by operator after given
removes CPU resource limits if present. The original resource values are set by operator after a given
period of time or when the POD condition is met.

## Installation

**Requires Kubernetes 1.27 on newer with `InPlacePodVerticalScaling` feature gate
**Requires Kubernetes 1.27 or newer with `InPlacePodVerticalScaling` feature gate
enabled.**

To install the latest release of Kube Startup CPU Boost in your cluster, run the following command:
Expand All @@ -54,7 +54,7 @@ kubectl apply -f https://github.com/google/kube-startup-cpu-boost/releases/downl
```
<!-- x-release-please-end -->

The Kube Startup CPU Boost components run in `kube-startup-cpu-boost-system` namespace.
The Kube Startup CPU Boost components run in the `kube-startup-cpu-boost-system` namespace.

### Install with Kustomize

Expand Down Expand Up @@ -185,7 +185,7 @@ spec:

### [Boost duration] fixed time

Define the fixed amount of time, the resource boost effect will last for it since the POD creation.
Define the fixed amount of time, the resource boost effect will last for it since the POD's creation.

```yaml
spec:
Expand All @@ -211,29 +211,29 @@ Define the POD condition, the resource boost effect will last until the conditio

Kube Startup CPU Boost operator can be configured with environmental variables.

| Variable | Type | Default | Description |
| --- | --- | --- | --- |
| `POD_NAMESPACE` | `string` | `kube-startup-cpu-boost-system` | Kube Startup CPU Boost operator namespace |
| `MGR_CHECK_INTERVAL` | `int` | `5` | Duration in seconds between boost manager checks for time based boost duration policy |
| `LEADER_ELECTION` | `bool` | `false` | Enables leader election for controller manager |
| `METRICS_PROBE_BIND_ADDR` | `string` | `:8080` | Address the metrics endpoint binds to |
| `HEALTH_PROBE_BIND_ADDR` | `string` | `:8081` | Address the health probe endpoint binds to |
| `SECURE_METRICS` | `bool` | `false` | Determines if the metrics endpoint is served securely |
| `ZAP_LOG_LEVEL` | `int` | `0` | Log level for ZAP logger |
| `ZAP_DEVELOPMENT` | `bool` | `false` | Enables development mode for ZAP logger |
| `HTTP2` | `bool` | `false` | Determines if the HTTP/2 protocol is used for webhook and metrics servers|
| `REMOVE_LIMITS` | `bool` | `true` | Enables operator to remove container CPU limits during the boost time |
| Variable | Type | Default | Description |
| --- | --- | --- |---------------------------------------------------------------------------------------|
| `POD_NAMESPACE` | `string` | `kube-startup-cpu-boost-system` | Kube Startup CPU Boost operator namespace |
| `MGR_CHECK_INTERVAL` | `int` | `5` | Duration in seconds between boost manager checks for time-based boost duration policy |
| `LEADER_ELECTION` | `bool` | `false` | Enables leader election for controller manager |
| `METRICS_PROBE_BIND_ADDR` | `string` | `:8080` | Address the metrics endpoint binds to |
| `HEALTH_PROBE_BIND_ADDR` | `string` | `:8081` | Address the health probe endpoint binds to |
| `SECURE_METRICS` | `bool` | `false` | Determines if the metrics endpoint is served securely |
| `ZAP_LOG_LEVEL` | `int` | `0` | Log level for ZAP logger |
| `ZAP_DEVELOPMENT` | `bool` | `false` | Enables development mode for ZAP logger |
| `HTTP2` | `bool` | `false` | Determines if the HTTP/2 protocol is used for webhook and metrics servers |
| `REMOVE_LIMITS` | `bool` | `true` | Enables operator to remove container CPU limits during the boost time |

## Metrics

Kube Startup CPU Boost exposes [prometheus](https://prometheus.io) metrics to monitor the health of
the system and the status of Startup CPU Boosts.

| Metric name | Type | Description | Labels |
| --- | --- | --- | --- |
| `boost_configurations` | Gauge | Number of registered Kube Startup CPU Boost configuration | `namespace`: the namespace of a Kube Startup CPU Boost |
| `boost_containers_total` | Counter | Number of a containers which CPU resources were increased | `namespace`: the namespace of container's POD, `boost`: name of a Kube Startup CPU Boost that increased container resources |
| `boost_containers_active` | Gauge | Number of a containers which CPU resources and not yet reverted to their original values | `namespace`: the namespace of container's POD, `boost`: name of a Kube Startup CPU Boost that increased container resources |
| Metric name | Type | Description | Labels |
| --- | --- |------------------------------------------------------------------------------------------| --- |
| `boost_configurations` | Gauge | Number of registered Kube Startup CPU Boost configuration | `namespace`: the namespace of a Kube Startup CPU Boost |
| `boost_containers_total` | Counter | Number of a containers whose CPU resources were increased | `namespace`: the namespace of container's POD, `boost`: name of a Kube Startup CPU Boost that increased container resources |
| `boost_containers_active` | Gauge | Number of a containers whose CPU resources and not yet reverted to their original values | `namespace`: the namespace of container's POD, `boost`: name of a Kube Startup CPU Boost that increased container resources |

### Scraping: Google Cloud Managed Service for Prometheus

Expand Down

0 comments on commit 1812763

Please sign in to comment.