From 44feabd10212b78f789ed863621e7543f6183e63 Mon Sep 17 00:00:00 2001 From: Richard Davis Date: Thu, 3 Mar 2022 18:48:59 +0000 Subject: [PATCH] updated README and added better description, fixed auto set version --- .github/workflows/release.yml | 4 ++-- .goreleaser.yml | 10 +++++----- README.md | 11 ++++++++++- release.yaml | 20 +++++++++++--------- 4 files changed, 28 insertions(+), 17 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1f8b3cf..966ad9d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -20,5 +20,5 @@ jobs: args: release --rm-dist env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - name: Update new version in krew-index - uses: rajatjindal/krew-release-bot@v0.0.38 + # - name: Update new version in krew-index + # uses: rajatjindal/krew-release-bot@v0.0.38 diff --git a/.goreleaser.yml b/.goreleaser.yml index 903f3c6..37eb485 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -1,10 +1,10 @@ -project_name: ice +project_name: kubectl-ice release: github: owner: NimbleArchitect name: kubectl-ice builds: - - id: ice + - id: kubectl-ice goos: - linux - windows @@ -18,11 +18,11 @@ builds: - GO111MODULE=on main: cmd/plugin/main.go ldflags: -s -w - -X github.com/NimbleArchitect/kubectl-ice/cmd/plugin/cli.version= + -X github.com/NimbleArchitect/kubectl-ice/cmd/plugin/cli.version={{ .Version }} archives: - - id: ice + - id: kubectl-ice builds: - - ice + - kubectl-ice name_template: "{{ .ProjectName }}_{{ .Os }}_{{ .Arch }}" format_overrides: - goos: windows diff --git a/README.md b/README.md index 214e4d1..8e23322 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ # kubectl-ice - This plugin shows useful information about the containers inside a pod useful for trouble shooting container issues +With ice you can peer inside a pod and easily see volume, image, port and exec configurations, along with cpu and memory metrics all at the container level (requires metrics server) + +supports all the standard kubectl flags including: + +Flags: + -A, --all-namespaces list containers form pods in all namespaces + --context string The name of the kubeconfig context to use + -n, --namespace string If present, the namespace scope for this CLI request + -l, --selector string Selector (label query) to filter on + # Installation ## From binary diff --git a/release.yaml b/release.yaml index 9bab5ed..731bf8a 100644 --- a/release.yaml +++ b/release.yaml @@ -1,7 +1,7 @@ apiVersion: krew.googlecontainertools.github.com/v1alpha2 kind: Plugin metadata: - name: ice + name: kubectl-ice spec: version: "v0.1.0" platforms: @@ -12,11 +12,11 @@ spec: uri: https://github.com/NimbleArchitect/kubectl-ice/releases/download/v0.1.0/ice_linux_amd64.tar.gz sha256: "" files: - - from: "./ice" + - from: "./kubectl-ice" to: "." - from: LICENSE to: "." - bin: "ice" + bin: "kubectl-ice" - selector: matchLabels: os: darwin @@ -24,11 +24,11 @@ spec: uri: https://github.com/NimbleArchitect/kubectl-ice/releases/download/v0.1.0/ice_darwin_amd64.tar.gz sha256: "" files: - - from: "./ice" + - from: "./kubectl-ice" to: "." - from: LICENSE to: "." - bin: "ice" + bin: "kubectl-ice" - selector: matchLabels: os: windows @@ -36,12 +36,12 @@ spec: uri: https://github.com/NimbleArchitect/kubectl-ice/releases/download/v0.1.0/ice_windows_amd64.zip sha256: "" files: - - from: "/ice.exe" + - from: "/kubectl-ice.exe" to: "." - from: LICENSE to: "." - bin: "ice.exe" - shortDescription: A new plugin + bin: "kubectl-ice.exe" + shortDescription: ice lets you view configuration settings of containers inside pods. homepage: https://github.com/NimbleArchitect/kubectl-ice caveats: | Usage: @@ -52,4 +52,6 @@ spec: or https://github.com/NimbleArchitect/kubectl-ice/blob/v0.1.0/doc/USAGE.md description: | - ice lets you view configuration settings of containers inside pods. + With ice you can peer inside a pod and easily see volume, image, port and exec configurations, + along with cpu and memory metrics all at the container level (requires metrics server) +