Skip to content

Commit

Permalink
refactoring docs
Browse files Browse the repository at this point in the history
  • Loading branch information
samuel-esp committed Jul 10, 2024
1 parent 0a289a5 commit 95d522b
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,11 @@ Scale down / "pause" Kubernetes workload (`Deployments`, `StatefulSets`,
- [Notes](#notes)
- [Configuration](#configuration)
- [Uptime / downtime spec](#uptime--downtime-spec)
- [Alternative logic, based on periods](#alternative-logic-based-on-periods)
- [Alternative Logic, Based on Periods](#alternative-logic-based-on-periods)
- [Command Line Options](#command-line-options)
- [Scaling Jobs](#scaling-jobs)
- [Scaling Daemonsets](#scaling-daemonset)
- [Matching Labels Argument](#matching-labels-argument)
- [Namespace Defaults](#namespace-defaults)
- [Contributing](#contributing)
- [License](#license)
Expand All @@ -33,8 +36,7 @@ Scale down / "pause" Kubernetes workload (`Deployments`, `StatefulSets`,

## Concepts

> [!NOTE]
> `Deployments` are interchangeable by any kind of _supported workload_ for this whole guide unless explicitly stated otherwise.
> :memo: `Deployments` are interchangeable by any kind of _supported workload_ for this whole guide unless explicitly stated otherwise.
>
> The complete list of supported workload is defined [here](./kube_downscaler/scaler.py#9-14).
Expand Down Expand Up @@ -216,7 +218,7 @@ Each time specification can be in one of two formats:
`<YYYY>-<MM>-<DD>T<HH>:<MM>:<SS>[+-]<TZHH>:<TZMM>`.
### Alternative logic, based on periods
### Alternative Logic, Based on Periods
Instead of strict uptimes or downtimes, you can chose time periods for
upscaling or downscaling. The time definitions are the same. In this
Expand Down Expand Up @@ -346,11 +348,11 @@ Available command line options:
: Optional: admission controller used by the kube-downscaler to downscale and upscale
jobs. Required only if "jobs" are specified inside "--include-resources" arg.
Supported Admission Controllers are
\[gatekeeper, kyverno*\] [^1]
\[gatekeeper, kyverno*\]
> [!IMPORTANT]
> [^1]Make sure to read the dedicated section below to understand how to use the
> --admission-controller feature correctly
> Make sure to read the dedicated section below to understand how to use the
> `--admission-controller` feature correctly
### Scaling Jobs
Expand Down

0 comments on commit 95d522b

Please sign in to comment.