Skip to content

Commit 3b00e20

Browse files
committed
docs: add krew install to CLI reference and installation guide
The kubectl-attune plugin is available via Krew since PR kubernetes-sigs/krew-index#5788 was merged. Add krew as the recommended install method in both the CLI reference and the getting-started installation page, and add a kubectl plugin section to the installation guide. Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
1 parent dd36af1 commit 3b00e20

3 files changed

Lines changed: 20 additions & 7 deletions

File tree

docs/getting-started/installation.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,21 @@ attunenamespacedefaults.attune.io 2026-01-15T00:00:00Z
106106
attunepolicies.attune.io 2026-01-15T00:00:00Z
107107
```
108108

109+
## kubectl plugin (optional)
110+
111+
The `kubectl attune` plugin provides quick access to recommendations,
112+
savings estimates, and resize history.
113+
114+
```bash
115+
# Install via Krew (recommended)
116+
kubectl krew install attune
117+
118+
# Or build from source
119+
make build-plugin && sudo cp bin/kubectl-attune /usr/local/bin/
120+
```
121+
122+
See the [CLI Reference](../reference/cli.md) for available commands.
123+
109124
## Next steps
110125

111126
Head to the [Quick Start](quickstart.md) to create your first AttunePolicy.

docs/reference/cli.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,12 @@ reasoning.
55
## Installation
66

77
```bash
8-
# Build from source
9-
make build-plugin
8+
# Install via Krew (recommended)
9+
kubectl krew install attune
1010

11-
# Copy to your PATH (system-wide)
11+
# Or build from source
12+
make build-plugin
1213
sudo cp bin/kubectl-attune /usr/local/bin/
13-
14-
# Or install for the current user only
15-
install -Dm755 bin/kubectl-attune "$HOME/.local/bin/kubectl-attune"
16-
export PATH="$HOME/.local/bin:$PATH"
1714
```
1815

1916
## Commands

lychee.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ exclude = [
55
"example\\.com",
66
"medium\\.com",
77
"hub\\.docker\\.com",
8+
"securityscorecards\\.dev",
89
]
910
exclude_loopback = true
1011
max_concurrency = 8

0 commit comments

Comments
 (0)