Skip to content
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

README.md tweaks #390

Merged
merged 7 commits into from
Dec 18, 2024
Merged

README.md tweaks #390

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9666d29
Format README.md using prettier.io
eden881 Dec 12, 2024
dc7b0e9
Add punctuation spacing
eden881 Dec 12, 2024
1350f46
Punctuation and capitalization fixes in the resource table
eden881 Dec 12, 2024
3193781
Differentiate between building from dev branch to building from local…
eden881 Dec 12, 2024
e81c492
Merge branch 'yonahd:main' into readme-resources
eden881 Dec 18, 2024
0cd3c5f
Update root.go with the change from README.md
eden881 Dec 18, 2024
4c5bca5
Tweaks to resource descriptions in both root.go and README.md
eden881 Dec 18, 2024
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
Next Next commit
Format README.md using prettier.io 
Fixes newline and table spacing
  • Loading branch information
@eden881
eden881 committed Dec 12, 2024
commit 9666d299e0fd051120850b5a53b61e0ddce120e8
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,19 +173,19 @@ kor [subcommand] --help
| ServiceAccounts | ServiceAccounts unused by Pods<br/>ServiceAccounts unused by roleBinding or clusterRoleBinding | |
| StatefulSets | Statefulsets with no Replicas | |
| Roles | Roles not used in roleBinding | |
| ClusterRoles | ClusterRoles not used in roleBinding or clusterRoleBinding<br/>ClusterRoles not used in ClusterRole aggregation | |
| RoleBindings | RoleBindings referencing invalid Role, ClusterRole, or ServiceAccounts | |
| ClusterRoles | ClusterRoles not used in roleBinding or clusterRoleBinding<br/>ClusterRoles not used in ClusterRole aggregation | |
| RoleBindings | RoleBindings referencing invalid Role, ClusterRole, or ServiceAccounts | |
| PVCs | PVCs not used in Pods | |
| Ingresses | Ingresses not pointing at any Service | |
| Hpas | HPAs not used in Deployments<br/> HPAs not used in StatefulSets | |
| CRDs | CRDs not used the cluster | |
| Pvs | PVs not bound to a PVC | |
| Pdbs | PDBs not used in Deployments / StatefulSets (templates) or in arbitrary Pods<br/>PDBs with empty selectors (match every pod) but no running pods in namespace | |
| Jobs | Jobs status is completed<br/> Jobs status is suspended<br/> Jobs failed with backoff limit exceeded (including indexed jobs) <br/> Jobs failed with dedaline exceeded | |
| Pdbs | PDBs not used in Deployments / StatefulSets (templates) or in arbitrary Pods<br/>PDBs with empty selectors (match every pod) but no running pods in namespace | |
| Jobs | Jobs status is completed<br/> Jobs status is suspended<br/> Jobs failed with backoff limit exceeded (including indexed jobs) <br/> Jobs failed with dedaline exceeded | |
| ReplicaSets | replicaSets that specify replicas to 0 and has already completed it's work |
| DaemonSets | DaemonSets not scheduled on any nodes |
| StorageClasses | StorageClasses not used by any PVs/PVCs |
| NetworkPolicies | NetworkPolicies with no Pods selected by podSelector or Ingress/Egress rules |
| NetworkPolicies | NetworkPolicies with no Pods selected by podSelector or Ingress/Egress rules |

### Deleting Unused resources

Expand Down Expand Up @@ -237,6 +237,7 @@ Additionally, you can use the `--group-by` flag to group the output by `namespac
```sh
kor all -n test --show-reason
```

```
Unused resources in namespace: "test"
+---+----------------+----------------------------------------------+--------------------------------------------------------+
Expand All @@ -258,6 +259,7 @@ Unused resources in namespace: "test"
```sh
kor all --group-by=resource --output=table
```

```
Unused ConfigMaps:
+---+-----------+---------------+
Expand Down Expand Up @@ -288,6 +290,7 @@ Unused ReplicaSets:
```sh
kor all --group-by=namespace --output=table
```

```
Unused resources in namespace: "ns1"
+---+---------------+--------------------+
Expand Down