Skip to content

Commit

Permalink
README fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
DaemonDude23 committed Aug 15, 2021
1 parent 3227919 commit 03103f5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
**kube-inverter**

- [Why](#why)
- [This Tool's Purpose](#this-tools-purpose)
- [What This Tool Does](#what-this-tool-does)
- [Install](#install)
- [Put it in Your `$PATH`](#put-it-in-your-path)
- [CLI Usage](#cli-usage)
Expand All @@ -25,17 +25,17 @@ Kubernetes `v1.22` is [removing support](https://kubernetes.io/docs/reference/us

The `Ingress` syntax is changing a bit. Sure, you could update them by hand, which I do often, but that is lame. I have hundreds upon hundreds of `Ingress` objects to convert, and I bet others do as well, so this should help.

## This Tool's Purpose
## What This Tool Does

Converts **Kubernetes** `Ingress` YAML objects with `apiVersion: networking.k8s.io/v1beta1` _to_ `apiVersion: networking.k8s.io/v1`, modifying:

- The keys/values for:
- `serviceName`
- `ServicePort` - either name (`str`) or port number (`int`)
- Checks for `apiVersion` differences in the [Points of Interest](#points-of-interest) section.
- (Optional) Injects a configurable `pathPrefix` into each `Ingress` object.
- (Optional) Injects a configurable `pathType` into each `Ingress` object.
- YAML Comments/order/formatting are preserved... mostly. It depends on their scope, but hey, I'm tryin'!
-
- Skips over objects that do not fit the criteria to be converted.

Requires Python `3.6`+

Expand Down

0 comments on commit 03103f5

Please sign in to comment.