krew: Rename kubectl-az to kubectl-aks

Author: mqasimsarfraz

.github/workflows/kubectl-az.yml .github/workflows/kubectl-aks.yml

@@ -1,11 +1,11 @@
-name: Microsoft Azure CLI kubectl plugin CI
+name: Microsoft AKS CLI kubectl plugin CI
 env:
   GO_VERSION: 1.17 # TODO: Update
-  AZURE_PREFIX: kubectl-az-ci
+  AZURE_PREFIX: kubectl-aks-ci
 concurrency:
   # Only one workflow can run at a time unless
   # we create a new AKS cluster per github_ref (branch)
-  group: kubectl-az-ci
+  group: kubectl-aks-ci
 
 on:
   pull_request:
@@ -17,7 +17,7 @@ on:
 
 jobs:
   build:
-    name: Build kubectl-az
+    name: Build kubectl-aks
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -45,25 +45,25 @@ jobs:
         uses: actions/checkout@v3
       - name: Build and generate tarball
         run: |
-          target=kubectl-az-${{ matrix.os }}-${{ matrix.arch }}
+          target=kubectl-aks-${{ matrix.os }}-${{ matrix.arch }}
 
           make $target
 
-          binary_name=kubectl-az
+          binary_name=kubectl-aks
           if [ ${{ matrix.os }} = "windows" ]; then
-            binary_name=kubectl-az.exe
+            binary_name=kubectl-aks.exe
           fi
 
           # Prepare binary as artifact, it will be used by other jobs
           mv $target $binary_name
           tar --sort=name --owner=root:0 --group=root:0 \
             -czf ${target}.tar.gz \
             $binary_name LICENSE
-      - name: Add kubectl-az-${{ matrix.os }}-${{ matrix.arch }}.tar.gz as artifact
+      - name: Add kubectl-aks-${{ matrix.os }}-${{ matrix.arch }}.tar.gz as artifact
         uses: actions/upload-artifact@v3
         with:
-          name: kubectl-az-${{ matrix.os }}-${{ matrix.arch }}-tar-gz
-          path: kubectl-az-${{ matrix.os }}-${{ matrix.arch }}.tar.gz
+          name: kubectl-aks-${{ matrix.os }}-${{ matrix.arch }}-tar-gz
+          path: kubectl-aks-${{ matrix.os }}-${{ matrix.arch }}.tar.gz
 
   unit-tests:
     name: Run unit tests
@@ -170,15 +170,15 @@ jobs:
               exit 1
               ;;
           esac
-      - name: Get kubectl-az from artifact
+      - name: Get kubectl-aks from artifact
         uses: actions/download-artifact@v3
         with:
-          name: kubectl-az-${{ env.os }}-${{ matrix.arch }}-tar-gz
-      - name: Prepare kubectl-az binary
+          name: kubectl-aks-${{ env.os }}-${{ matrix.arch }}-tar-gz
+      - name: Prepare kubectl-aks binary
         shell: bash
         run: |
-          tar zxvf kubectl-az-${{ env.os }}-${{ matrix.arch }}.tar.gz
-          chmod +x kubectl-az
+          tar zxvf kubectl-aks-${{ env.os }}-${{ matrix.arch }}.tar.gz
+          chmod +x kubectl-aks
           ls -la
       - name: Login to Azure
         uses: azure/login@v1
@@ -196,7 +196,7 @@ jobs:
       - name: Run integration tests
         shell: bash
         run: |
-          make integration-test -o kubectl-az
+          make integration-test -o kubectl-aks
 
   release:
     name: Release
@@ -210,10 +210,10 @@ jobs:
     - uses: actions/checkout@v3
     - name: Get all artifacts.
       uses: actions/download-artifact@v3
-    - name: Rename all artifacts to kubectl-az-${{ github.ref_name }}.tar.gz
+    - name: Rename all artifacts to kubectl-aks-${{ github.ref_name }}.tar.gz
       shell: bash
       run: |
-        for i in kubectl-az-*-*-tar-gz/kubectl-az-*-*.tar.gz; do
+        for i in kubectl-aks-*-*-tar-gz/kubectl-aks-*-*.tar.gz; do
           mv $i $(dirname $i)/$(basename $i .tar.gz)-${{ github.ref_name }}.tar.gz
         done
     - name: Create Release
@@ -222,12 +222,12 @@ jobs:
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
         name: Release ${{ github.ref }}
-    - name: Upload kubectl-az binaries to the release
+    - name: Upload kubectl-aks binaries to the release
       uses: csexton/release-asset-action@v2
       with:
-        pattern: "kubectl-az-*-*-tar-gz/kubectl-az-*-*.tar.gz"
+        pattern: "kubectl-aks-*-*-tar-gz/kubectl-aks-*-*.tar.gz"
         github-token: ${{ secrets.GITHUB_TOKEN }}
         release-url: ${{ steps.create_release.outputs.upload_url }}
     - name: Update new version in krew-index
-      if: github.repository == 'azure/kubectl-az'
+      if: github.repository == 'azure/kubectl-aks'
       uses: rajatjindal/[email protected]

.gitignore

@@ -4,8 +4,8 @@
 *.dll
 *.so
 *.dylib
-/kubectl-az
-/kubectl-az-*-*
+/kubectl-aks
+/kubectl-aks-*-*
 
 # Test binary, built with `go test -c`
 *.test

.krew.yaml

@@ -1,35 +1,37 @@
 apiVersion: krew.googlecontainertools.github.com/v1alpha2
 kind: Plugin
 metadata:
-  name: az
+  name: aks
 spec:
   version: {{ .TagName }}
-  homepage: https://github.com/Azure/kubectl-az
+  homepage: https://github.com/Azure/kubectl-aks
   shortDescription: Interact with an AKS cluster
   description: |
     This plugin provides a set of commands that can be used to debug an AKS
     cluster even when the cluster's control plane is not working correctly. For
     instance, when the API server is having problems.
 
-    This plugin is not meant to replace az, but to complement it by providing
+    This plugin is not meant to replace az [1], but to complement it by providing
     additional commands and, mainly, allowing users to have a kubectl-like
     experience when working with an AKS cluster.
+
+    [1] https://learn.microsoft.com/en-us/cli/azure/
   platforms:
   - selector:
       matchLabels:
         os: linux
         arch: amd64
-    {{addURIAndSha "https://github.com/Azure/kubectl-az/releases/download/{{ .TagName }}/kubectl-az-linux-amd64-{{ .TagName }}.tar.gz" .TagName }}
-    bin: kubectl-az
+    {{addURIAndSha "https://github.com/Azure/kubectl-aks/releases/download/{{ .TagName }}/kubectl-aks-linux-amd64-{{ .TagName }}.tar.gz" .TagName }}
+    bin: kubectl-aks
   - selector:
       matchLabels:
         os: darwin
         arch: amd64
-    {{addURIAndSha "https://github.com/Azure/kubectl-az/releases/download/{{ .TagName }}/kubectl-az-darwin-amd64-{{ .TagName }}.tar.gz" .TagName }}
-    bin: kubectl-az
+    {{addURIAndSha "https://github.com/Azure/kubectl-aks/releases/download/{{ .TagName }}/kubectl-aks-darwin-amd64-{{ .TagName }}.tar.gz" .TagName }}
+    bin: kubectl-aks
   - selector:
       matchLabels:
         os: windows
         arch: amd64
-    {{addURIAndSha "https://github.com/Azure/kubectl-az/releases/download/{{ .TagName }}/kubectl-az-windows-amd64-{{ .TagName }}.tar.gz" .TagName }}
-    bin: kubectl-az
+    {{addURIAndSha "https://github.com/Azure/kubectl-aks/releases/download/{{ .TagName }}/kubectl-aks-windows-amd64-{{ .TagName }}.tar.gz" .TagName }}
+    bin: kubectl-aks.exe

Makefile

@@ -12,48 +12,48 @@ else
 	VERSION := $(TAG)-dirty
 endif
 
-LDFLAGS := "-X github.com/Azure/kubectl-az/cmd.version=$(VERSION) -extldflags '-static'"
+LDFLAGS := "-X github.com/Azure/kubectl-aks/cmd.version=$(VERSION) -extldflags '-static'"
 
-.DEFAULT_GOAL := kubectl-az
+.DEFAULT_GOAL := kubectl-aks
 
 # Build
-KUBECTL_AZ_TARGETS = \
-	kubectl-az-linux-amd64 \
-	kubectl-az-linux-arm64 \
-	kubectl-az-darwin-amd64 \
-	kubectl-az-darwin-arm64 \
-	kubectl-az-windows-amd64
+KUBECTL_AKS_TARGETS = \
+	kubectl-aks-linux-amd64 \
+	kubectl-aks-linux-arm64 \
+	kubectl-aks-darwin-amd64 \
+	kubectl-aks-darwin-arm64 \
+	kubectl-aks-windows-amd64
 
-.PHONY: list-kubectl-az-targets
-list-kubectl-az-targets:
-	@echo $(KUBECTL_AZ_TARGETS)
+.PHONY: list-kubectl-aks-targets
+list-kubectl-aks-targets:
+	@echo $(KUBECTL_AKS_TARGETS)
 
-.PHONY: kubectl-az-all
-kubectl-az-all: $(KUBECTL_AZ_TARGETS)
+.PHONY: kubectl-aks-all
+kubectl-aks-all: $(KUBECTL_AKS_TARGETS)
 
-.PHONY: kubectl-az
-kubectl-az: kubectl-az-$(GOHOSTOS)-$(GOHOSTARCH)
-	mv kubectl-az-$(GOHOSTOS)-$(GOHOSTARCH) kubectl-az
+.PHONY: kubectl-aks
+kubectl-aks: kubectl-aks-$(GOHOSTOS)-$(GOHOSTARCH)
+	mv kubectl-aks-$(GOHOSTOS)-$(GOHOSTARCH) kubectl-aks
 
 # make does not allow implicit rules (with '%') to be phony so let's use
 # the 'phony_explicit' dependency to make implicit rules inherit the phony
 # attribute
 .PHONY: phony_explicit
 phony_explicit:
 
-.PHONY: kubectl-az-%
-kubectl-az-%: phony_explicit
+.PHONY: kubectl-aks-%
+kubectl-aks-%: phony_explicit
 	export GO111MODULE=on CGO_ENABLED=0 && \
 	export GOOS=$(shell echo $* |cut -f1 -d-) GOARCH=$(shell echo $* |cut -f2 -d-) && \
 	go build -ldflags $(LDFLAGS) \
-		-o kubectl-az-$${GOOS}-$${GOARCH} \
-		github.com/Azure/kubectl-az
+		-o kubectl-aks-$${GOOS}-$${GOARCH} \
+		github.com/Azure/kubectl-aks
 
 # Install
 .PHONY: install
-install: kubectl-az
+install: kubectl-aks
 	mkdir -p ~/.local/bin/
-	cp kubectl-az ~/.local/bin/
+	cp kubectl-aks ~/.local/bin/
 
 # Run unit tests
 .PHONY: unit-test
@@ -62,15 +62,15 @@ unit-test:
 
 # Run integration tests
 .PHONY: integration-test
-integration-test: kubectl-az
-	KUBECTL_AZ="$(shell pwd)/kubectl-az" \
+integration-test: kubectl-aks
+	KUBECTL_AKS="$(shell pwd)/kubectl-aks" \
 		go test -v ./test/integration/... -integration
 
 # Clean
 .PHONY: clean
 clean:
-	rm -f kubectl-az
+	rm -f kubectl-aks
 
 .PHONY: cleanall
 cleanall: clean
-	rm -f $(KUBECTL_AZ_TARGETS)
+	rm -f $(KUBECTL_AKS_TARGETS)

README.md

@@ -1,6 +1,6 @@
-# Microsoft Azure CLI kubectl plugin
+# Microsoft Azure Kubernetes Service (AKS) CLI kubectl plugin
 
-`kubectl-az` is a `kubectl` plugin that provides a set of commands that can be
+`kubectl-aks` is a `kubectl` plugin that provides a set of commands that can be
 used to debug an AKS cluster even when the cluster's control plane is not
 working correctly. For instance, when the API server is having problems.
 
@@ -16,7 +16,7 @@ available command and which one is the most suitable for your case:
 - [check-apiserver-connectivity](docs/check-apiserver-connectivity.md)
 - [config](docs/config.md)
 
-Consider `kubectl-az` expects the cluster to use virtual machine scale sets,
+Consider `kubectl-aks` expects the cluster to use virtual machine scale sets,
 which is the case of an AKS cluster. And, the use of the `--node` flag requires
 the Kubernetes control plane to up and running, because the VMSS instance
 information of the node will be retrieved from the Kubernetes API server.
@@ -30,41 +30,41 @@ to the commands using the `--id` flag or separately with the `--subscription`,
 
 ## Install
 
-There is multiple ways to install the `kubectl-az`.
+There is multiple ways to install the `kubectl-aks`.
 
 ### Install a specific release
 
 It is possible to download the asset for a given release and platform from the
-[releases page](https://github.com/azure/kubectl-az/releases/), uncompress and
-move the `kubectl-az` executable to any folder in your `$PATH`.
+[releases page](https://github.com/azure/kubectl-aks/releases/), uncompress and
+move the `kubectl-aks` executable to any folder in your `$PATH`.
 
 ```bash
 VERSION=v0.1.0
-curl -sL https://github.com/azure/kubectl-az/releases/latest/download/kubectl-az-linux-amd64-${VERSION}.tar.gz | sudo tar -C /usr/local/bin -xzf - kubectl-az
-kubectl az version
+curl -sL https://github.com/azure/kubectl-aks/releases/latest/download/kubectl-aks-linux-amd64-${VERSION}.tar.gz | sudo tar -C /usr/local/bin -xzf - kubectl-aks
+kubectl aks version
 ```
 
 ### Compile from source
 
-To build `kubectl-az` from source, you'll need to have a Golang version 1.17
+To build `kubectl-aks` from source, you'll need to have a Golang version 1.17
 or higher installed:
 
 ```bash
-git clone https://github.com/Azure/kubectl-az.git
-cd kubectl-az
+git clone https://github.com/Azure/kubectl-aks.git
+cd kubectl-aks
 # Build and copy the resulting binary in $HOME/.local/bin/
 make install
-kubectl az version
+kubectl aks version
 ```
 
 ## Usage
 
 ```bash
-$ kubectl az --help
-Microsoft Azure CLI kubectl plugin
+$ kubectl aks --help
+Microsoft AKS CLI kubectl plugin
 
 Usage:
-  kubectl-az [command]
+  kubectl-aks [command]
 
 Available Commands:
   check-apiserver-connectivity Check connectivity between the nodes and the Kubernetes API Server
@@ -75,18 +75,18 @@ Available Commands:
   version                      Show version
 
 Flags:
-  -h, --help   help for kubectl-az
+  -h, --help   help for kubectl-aks
 
-Use "kubectl-az [command] --help" for more information about a command.
+Use "kubectl-aks [command] --help" for more information about a command.
 ```
 
-It is necessary to sign in to Azure to run any `kubectl-az` command. To do so,
+It is necessary to sign in to Azure to run any `kubectl-aks` command. To do so,
 you can use any authentication method provided by the [Azure
 CLI](https://github.com/Azure/azure-cli/) using the `az login` command; see
 further details
 [here](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli).
 However, if you do not have the Azure CLI or have not signed in yet,
-`kubectl-az` will open the default browser and load the Azure sign-in page where
+`kubectl-aks` will open the default browser and load the Azure sign-in page where
 you need to authenticate.
 
 ## Contributing

cmd/check-apiserver-connectivity.go

@@ -10,7 +10,7 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/Azure/kubectl-az/cmd/utils"
+	"github.com/Azure/kubectl-aks/cmd/utils"
 	"github.com/spf13/cobra"
 )
 

cmd/config.go

@@ -8,8 +8,8 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/Azure/kubectl-az/cmd/utils"
-	"github.com/Azure/kubectl-az/cmd/utils/config"
+	"github.com/Azure/kubectl-aks/cmd/utils"
+	"github.com/Azure/kubectl-aks/cmd/utils/config"
 )
 
 var configCmd = &cobra.Command{

cmd/root.go

@@ -6,16 +6,16 @@ package cmd
 import (
 	"os"
 
-	"github.com/Azure/kubectl-az/cmd/utils"
+	"github.com/Azure/kubectl-aks/cmd/utils"
 	"github.com/spf13/cobra"
 )
 
 // Common flags for all subcommands
 var commonFlags utils.CommonFlags
 
 var rootCmd = &cobra.Command{
-	Use:   "kubectl-az",
-	Short: "Microsoft Azure CLI kubectl plugin",
+	Use:   "kubectl-aks",
+	Short: "Microsoft AKS CLI kubectl plugin",
 }
 
 func Execute() {