Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 1 addition & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Just run `kubectl krew install deprecations` (this installs upstream, not this f
If you want to verify the generated manifests by Helm, you can run the program as following:

```console
helm template -f values.yaml .0 | kubepug --k8s-version v1.22.0 --input-file=-
helm template -f values.yaml . | kubepug --k8s-version v1.22.0 --input-file=-
```

Change the arguments in kubepug program (and Helm template!) as desired!
Expand Down Expand Up @@ -160,35 +160,6 @@ docker run -e VERSION=master generator > data.json
kubepug --k8s-version=v1.22 --database=location/of/your/data.json
```

### Example of Usage in CI with Github Actions

```yaml
name: Sample CI Workflow
# This workflow is triggered on pushes to the repository.
on: [push]
env:
HELM_VERSION: "v3.9.0"
K8S_TARGET_VERSION: "v1.22.0"

jobs:
api-deprecations-test:
runs-on: ubuntu-latest
steps:
- name: Check-out repo
uses: actions/checkout@v2

- uses: azure/setup-helm@v1
with:
version: $HELM_VERSION
id: install

- uses: cpanato/kubepug-installer@v1.0.0

- name: Run Kubepug with your Helm Charts Repository
run: |
find charts -mindepth 1 -maxdepth 1 -type d | xargs -t -n1 -I% /bin/bash -c 'helm template % --api-versions ${K8S_TARGET_VERSION} | kubepug --error-on-deprecated --error-on-deleted --k8s-version ${K8S_TARGET_VERSION} --input-file /dev/stdin'
```

## Screenshot

![Kubepug](assets/screenshot.png)
Expand Down
36 changes: 2 additions & 34 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,45 +12,13 @@ Kubepug can be installed in some different ways:
open an issue on the [github project](https://github.com/nudgebee/kubepug) asking for the new method.
No promises! But we will do our best to support it!

## Krew plugin
Krew is a Kubernetes / kubectl plugin manager. Kubepug can be installed
as a krew plugin with the following command:
## Container image

```
kubectl krew install deprecations
docker pull ghcr.io/nudgebee/kubepug:latest
```

## Getting the binary
Kubepug is compiled as a binary for various Operational Systems and architectures.

You can get the latest release from [the Release page](https://github.com/nudgebee/kubepug/releases/latest)

## Github Action
Kubepug can be used as a Github Action with the following definition:

```yaml
name: Sample CI Workflow
# This workflow is triggered on pushes to the repository.
on: [push]
env:
HELM_VERSION: "v3.9.0"
K8S_TARGET_VERSION: "v1.22.0"

jobs:
api-deprecations-test:
runs-on: ubuntu-latest
steps:
- name: Check-out repo
uses: actions/checkout@v2

- uses: azure/setup-helm@v1
with:
version: $HELM_VERSION
id: install

- uses: cpanato/kubepug-installer@v1.0.0

- name: Run Kubepug with your Helm Charts Repository
run: |
find charts -mindepth 1 -maxdepth 1 -type d | xargs -t -n1 -I% /bin/bash -c 'helm template % --api-versions ${K8S_TARGET_VERSION} | kubepug --error-on-deprecated --error-on-deleted --k8s-version ${K8S_TARGET_VERSION} --input-file /dev/stdin'
```