Merge pull request #118 from kubernauts/tk8ctl-rename

Rename tk8 to tk8ctl

Author: ishantanu

Dockerfile

@@ -27,7 +27,7 @@ LABEL  org.label-schema.description="CLI to deploy kubernetes using kubespray an
        org.label-schema.vcs-url="https://github.com/kubernauts/tk8" \
        org.label-schema.vendor="kubernauts"
 
-COPY --from=builder /go/src/github.com/kubernauts/tk8/tk8 /usr/local/bin/tk8
+COPY --from=builder /go/src/github.com/kubernauts/tk8/tk8ctl /usr/local/bin/tk8ctl
 
 RUN apk --update add \
     python \
@@ -52,7 +52,7 @@ RUN pip install --upgrade cffi
 RUN pip install --upgrade ansible
 RUN pip install --upgrade ansible-modules-hashivault
 
-RUN chmod +x /usr/local/bin/tk8
+RUN chmod +x /usr/local/bin/tk8ctl
 
 ## Install terraform
 
@@ -68,4 +68,4 @@ RUN mkdir /tk8
 
 WORKDIR /tk8
 
-ENTRYPOINT [ "/usr/local/bin/tk8" ]
+ENTRYPOINT [ "/usr/local/bin/tk8ctl" ]

Makefile

@@ -10,7 +10,7 @@ default: bin
 .PHONY: bin
 bin:
 	go get -u ./...
-	go build ${BUILD_FLAGS} -o tk8 main.go
+	go build ${BUILD_FLAGS} -o tk8ctl main.go
 
 .PHONY: install
 install:
@@ -47,7 +47,7 @@ release:
 	./scripts/check-gofmt.sh
 	golint $(PKGS)
 	go vet $(PKGS)
-	go build ${BUILD_FLAGS} -o tk8 main.go
-	GOOS=darwin GOARCH=amd64 CGO_ENABLED=0 go build ${BUILD_FLAGS} -o tk8-darwin-amd64 main.go
-	GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build ${BUILD_FLAGS}  -o tk8-linux-amd64 main.go
-	GOOS=linux GOARCH=386 CGO_ENABLED=0 go build ${BUILD_FLAGS}  -o tk8-linux-386 main.go
+	go build ${BUILD_FLAGS} -o tk8ctl main.go
+	GOOS=darwin GOARCH=amd64 CGO_ENABLED=0 go build ${BUILD_FLAGS} -o tk8ctl-darwin-amd64 main.go
+	GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build ${BUILD_FLAGS}  -o tk8ctl-linux-amd64 main.go
+	GOOS=linux GOARCH=386 CGO_ENABLED=0 go build ${BUILD_FLAGS}  -o tk8ctl-linux-386 main.go

README.md

@@ -57,12 +57,12 @@ Create a separate folder and store the executable binary file there, a configura
 `export AWS_ACCESS_KEY_ID=xxx`
 
 Then execute the CLI with the command:
-`tk8 cluster install aws`
+`tk8ctl cluster install aws`
 
 With this command the TK8 CLI will create all of the required resources in AWS and installs Kubernetes on it.
 
 If you no longer need the cluster, you can use the command:
-`tk8 cluster destroy aws`
+`tk8ctl cluster destroy aws`
 to automatically remove all of the resources.
 
 

README_de.md

@@ -54,12 +54,12 @@ Erstellen Sie einen separaten Ordner und speichern Sie die ausführbare Datei do
 `export AWS_ACCESS_KEY_ID=xxx`
 
 Sie führen dann die CLI mit dem Befehl aus:
-`tk8 cluster install aws`
+`tk8ctl cluster install aws`
 
 Mit diesem Befehl erstellt der TK8 CLI alle benötigten Ressourcen in AWS und installiert dafür einen Kubernet-Cluster.
 
 Wenn Sie den Cluster nicht mehr benötigen, können Sie den Befehl verwenden:
-`tk8 cluster destroy aws`
+`tk8ctl cluster destroy aws`
 um automatisch alle Ressourcen zu entfernen.
 
 ## Contributing

cmd/cli/root.go

@@ -27,7 +27,7 @@ var cfgFile string
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
-	Use:   "tk8",
+	Use:   "tk8ctl",
 	Short: "CLI application to deploy kubernetes and some addons",
 	Long: `
 Command line application to deploy kubernetes using the pure kubespray distribution. 

docs/de/add-on/development.md

@@ -7,21 +7,21 @@ Die Add-On-Implementierung muss eine allgemeine Lösung sein, daher stellen wir
 Der Befehl ein Addon zu erstellen ist folgender:
 
 ```shell
-tk8 addon create my-addon
+tk8ctl addon create my-addon
 ```
 
 Dieser Befehl ruft die tk8-addon-Entwicklung von GitHub ab und erstellt einen neuen Ordner unter ./addons/my-addon.
 
 Das Beispiel ist ein einfaches Nginx Deployment und ein LoadBalancer-Service, um darauf zuzugreifen. So kann der Benutzer, der dieses Add-on erstellt hat, es direkt verwenden und auf den k8s-Cluster anwenden.
 
 ```shell
-tk8 addon install my-addon --kubeconfig /path/to/cluster/config
+tk8ctl addon install my-addon --kubeconfig /path/to/cluster/config
 ```
 
 und kann mit dem folgenden Befehl wieder entfernt werden
 
 ```shell
-tk8 addon destroy my-addon --kubeconfig /path/to/cluster/config
+tk8ctl addon destroy my-addon --kubeconfig /path/to/cluster/config
 ```
 
 Das Standard-Entwickler-Add-on enthält keine main.sh-Datei. Aber wir müssen eine Dokumentation dafür erstellen. Unsere eigenen Add-ons könnten es nutzen und brauchen.

docs/de/add-on/introduction.md

@@ -10,33 +10,33 @@ Wir machen einen Switch mit installierten tk8 Add-ons und stellen eine Verknüpf
 #### Den kompletten Pfad verwenden
 
 ```shell
-tk8 addon install https://github.com/kubernauts/tk8-addon-rancher
-tk8 addon install https://github.com/kubernauts/tk8-addon-prometheus
-tk8 addon install https://github.com/kubernauts/tk8-addon-grafana
-tk8 addon install https://github.com/kubernauts/tk8-addon-monitoring-stack
-tk8 addon install https://github.com/kubernauts/tk8-addon-elk
-tk8 addon install https://github.com/kubernauts/tk8-addon-...
-tk8 addon install https://github.com/USERNAME/ADDON-REPO
+tk8ctl addon install https://github.com/kubernauts/tk8-addon-rancher
+tk8ctl addon install https://github.com/kubernauts/tk8-addon-prometheus
+tk8ctl addon install https://github.com/kubernauts/tk8-addon-grafana
+tk8ctl addon install https://github.com/kubernauts/tk8-addon-monitoring-stack
+tk8ctl addon install https://github.com/kubernauts/tk8-addon-elk
+tk8ctl addon install https://github.com/kubernauts/tk8-addon-...
+tk8ctl addon install https://github.com/USERNAME/ADDON-REPO
 ```
 
 #### Verwenden Sie die Shortcuts
 
 ```shell
-tk8 addon install rancher
-tk8 addon install prometheus
-tk8 addon install grafana
-tk8 addon install monitoring-stack
-tk8 addon install elk
+tk8ctl addon install rancher
+tk8ctl addon install prometheus
+tk8ctl addon install grafana
+tk8ctl addon install monitoring-stack
+tk8ctl addon install elk
 ```
 
 ### Add-on entfernen
 
 ```shell
-tk8 addon destroy rancher
-tk8 addon destroy prometheus
-tk8 addon destroye grafana
-tk8 addon destroy monitoring-stack
-tk8 addon destroy elk
+tk8ctl addon destroy rancher
+tk8ctl addon destroy prometheus
+tk8ctl addon destroye grafana
+tk8ctl addon destroy monitoring-stack
+tk8ctl addon destroy elk
 ```
 
 ## Entwicklung
@@ -48,5 +48,5 @@ Die create-Methode von tk8 erstellt ein neues Add-on im lokalen Ordner. Dieses A
 [Weitere Informationen hier](development.md)
 
 ```shell
-tk8 addon erstellen my-addon erstellen
+tk8ctl addon erstellen my-addon erstellen
 ```

docs/de/provisioner/aws/aws.md

@@ -90,9 +90,9 @@ aws:
 Once done run:
 
 ```shell
-tk8 cluster init
-tk8 cluster aws --create
-tk8 cluster aws --install
+tk8ctl cluster init
+tk8ctl cluster aws --create
+tk8ctl cluster aws --install
 ```
 
 Post installation the **kubeconfig** will be available at: _./kubespray/inventory/awscluster/artifacts/admin.conf_
@@ -103,10 +103,10 @@ Post installation the **kubeconfig** will be available at: _./kubespray/inventor
 
 ## Destroy the provisioned cluster
 
-Make sure you are in same directory where you executed `tk8 cluster init` with the cloned kubespray directory.
+Make sure you are in same directory where you executed `tk8ctl cluster init` with the cloned kubespray directory.
 
 To delete the provisioned cluster run:
 
 ```shell
-tk8 cluster aws --destroy
+tk8ctl cluster aws --destroy
 ```

docs/de/provisioner/baremetal/baremetal.md

@@ -90,7 +90,7 @@ Create the inventory file on the Ansible host.
 Initialize the kubespray repo:
 
 ```shell
-tk8 cluster init
+tk8ctl cluster init
 ```
 
 Set the neecessary parameters
@@ -112,7 +112,7 @@ os:
 Start the kubernetes installation on the bare metal servers:
 
 ```shell
-tk8 cluster baremetal --install
+tk8ctl cluster baremetal --install
 ```
 
 ## Configure and Deploy MetalLB
@@ -139,7 +139,7 @@ The address field above is the IP address range that will be used for the LB ser
 To deploy MetalLB run:
 
 ```shell
-tk8 cluster baremetal --loadbalancer
+tk8ctl cluster baremetal --loadbalancer
 ```
 
 ## Post Installation

docs/de/provisioner/baremetal/introduction.md

@@ -90,7 +90,7 @@ Create the inventory file on the Ansible host.
 Initialize the kubespray repo:
 
 ```shell
-tk8 cluster init
+tk8ctl cluster init
 ```
 
 Set the neecessary parameters
@@ -112,7 +112,7 @@ os:
 Start the kubernetes installation on the bare metal servers:
 
 ```shell
-tk8 cluster baremetal --install
+tk8ctl cluster baremetal --install
 ```
 
 ## Configure and Deploy MetalLB
@@ -139,7 +139,7 @@ The address field above is the IP address range that will be used for the LB ser
 To deploy MetalLB run:
 
 ```shell
-tk8 cluster baremetal --loadbalancer
+tk8ctl cluster baremetal --loadbalancer
 ```
 
 ## Post Installation

docs/de/provisioner/introduction.md

@@ -59,7 +59,7 @@ Erstellen Sie nun ein Issue im Git Repository und verweisen auf die neue Impleme
 Der Provisioner muss in die Map cmd.provisioners (cmd/provisioners.go) hinzugefügt werden und kann anschließend über die CLI verwendet werden.
 
 ```shell
-tk8 cluster install MyProvisioner
+tk8ctl cluster install MyProvisioner
 ```
 
 Benötigen Sie Unterstützung oder haben Fragen zur implementierung dann treten Sie unseren [Slack Server](https://kubernauts-slack-join.herokuapp.com/) bei.

docs/en/add-on/development.md

@@ -7,21 +7,21 @@ The Add-On implementation needs to be a  general solution so we provide a comman
 The command to create the example add-on gets created with this.
 
 ```shell
-tk8 addon create my-addon
+tk8ctl addon create my-addon
 ```
 
 This command pulls the tk8-addon-develop from GitHub and creates a new folder below ./addons/my-addon
 
 The example is a simple nginx deployment and a LoadBalancer service to expose this. So the user who creates this add-on can directly use it and apply it to the k8s cluster
 
 ```shell
-tk8 addon install my-addon
+tk8ctl addon install my-addon
 ```
 
 and could remove it from the k8s cluster with
 
 ```shell
-tk8 addon destroy my-addon
+tk8ctl addon destroy my-addon
 ```
 
 The default developer add-on doesn't contain a main.sh file. But we need to create documentation for it. Our own add-ons could use and need it.

docs/en/add-on/introduction.md

@@ -11,33 +11,33 @@ We make a switch with install tk8 add-ons and provide a shortcut. A shortcut cou
 ### Use the complete Path
 
 ```shell
-tk8 addon install https://github.com/kubernauts/tk-addon-rancher
-tk8 addon install https://github.com/kubernauts/tk-addon-prometheus
-tk8 addon install https://github.com/kubernauts/tk-addon-grafana
-tk8 addon install https://github.com/kubernauts/tk-addon-monitoring-stack
-tk8 addon install https://github.com/kubernauts/tk-addon-elk
-tk8 addon install https://github.com/kubernauts/tk-addon-...
-tk8 addon install https://github.com/USERNAME/ADDON-REPO
+tk8ctl addon install https://github.com/kubernauts/tk-addon-rancher
+tk8ctl addon install https://github.com/kubernauts/tk-addon-prometheus
+tk8ctl addon install https://github.com/kubernauts/tk-addon-grafana
+tk8ctl addon install https://github.com/kubernauts/tk-addon-monitoring-stack
+tk8ctl addon install https://github.com/kubernauts/tk-addon-elk
+tk8ctl addon install https://github.com/kubernauts/tk-addon-...
+tk8ctl addon install https://github.com/USERNAME/ADDON-REPO
 ```
 
 ### Use the shortcut
 
 ```shell
-tk8 addon install rancher
-tk8 addon install prometheus
-tk8 addon install grafana
-tk8 addon install monitoring-stack
-tk8 addon install elk
+tk8ctl addon install rancher
+tk8ctl addon install prometheus
+tk8ctl addon install grafana
+tk8ctl addon install monitoring-stack
+tk8ctl addon install elk
 ```
 
 ### Destroy a add-on
 
 ```shell
-tk8 addon destroy rancher
-tk8 addon destroy prometheus
-tk8 addon destroy grafana
-tk8 addon destroy monitoring-stack
-tk8 addon destroy elk
+tk8ctl addon destroy rancher
+tk8ctl addon destroy prometheus
+tk8ctl addon destroy grafana
+tk8ctl addon destroy monitoring-stack
+tk8ctl addon destroy elk
 ```
 
 ## Development
@@ -48,5 +48,5 @@ The create method of tk8 creates a new add-on in the local folder. This add-on i
 [More information here](development.md)
 
 ```shell
-tk8 addon create my-addon
+tk8ctl addon create my-addon
 ```

docs/en/provisioner/aws/cli.md

@@ -48,7 +48,7 @@ aws:
 Once done run:
 
 ```shell
-tk8 cluster install aws
+tk8ctl cluster install aws
 ```
 
 Post installation the **kubeconfig** will be available at: _$(pwd)/inventory/*yourWorkspaceOrClusterName*/artifacts/admin.conf_
@@ -65,5 +65,5 @@ If you use a different workspace name with the --name flag please provided it on
 To delete the provisioned cluster run:
 
 ```shell
-tk8 cluster destroy aws
+tk8ctl cluster destroy aws
 ```

docs/en/provisioner/aws/eks.md

@@ -36,7 +36,7 @@ eks:
 Once done run:
 
 ```shell
-tk8 cluster install eks
+tk8ctl cluster install eks
 ```
 
 or with Docker
@@ -59,7 +59,7 @@ If you use a different workspace name with the --name flag please provide it on
 To delete the provisioned cluster run:
 
 ```shell
-tk8 cluster destroy eks
+tk8ctl cluster destroy eks
 ```
 
 or with Docker