Merge pull request #7 from daemon1024/prep-release

Prepare for release

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: goreleaser
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      -
+        name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.17
+      -
+        name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v2
+        with:
+          distribution: goreleaser
+          version: latest
+          args: release --rm-dist
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.goreleaser.yaml

@@ -0,0 +1,14 @@
+project_name: karmor
+
+builds:
+  - binary: karmor
+    goos:
+      - darwin
+      - linux
+      - windows
+    goarch:
+      - amd64
+      - arm64
+    ldflags: -w -s -X github.com/kubearmor/kubearmor-client/version.BuildDate={{.Date}} -X github.com/kubearmor/kubearmor-client/version.GitSummary={{.Version}}
+    env:
+      - CGO_ENABLED=0

Makefile

@@ -1,4 +1,5 @@
 CURDIR=$(shell pwd)
+INSTALLDIR=$(shell go env GOPATH)/bin/
 
 ifeq (,$(shell which govvv))
 $(shell go install github.com/ahmetb/govvv@latest)
@@ -13,4 +14,8 @@ build:
 	go mod tidy
 	CGO_ENABLED=0 go build \
 	-ldflags "-w -s ${GIT_INFO}" \
-	-o karmor
+	-o karmor
+
+.PHONY: install
+install: build
+	install -m 0755 karmor $(DESTDIR)$(INSTALLDIR)

README.md

@@ -1 +1,41 @@
-# KubeArmor-Client
+# kArmor
+
+**kArmor** is a CLI client to help manage [KubeArmor](github.com/kubearmor/KubeArmor)
+
+KubeArmor is a container-aware runtime security enforcement system that
+restricts the behavior (such as process execution, file access, and networking
+operation) of containers at the system level.
+
+## Installation
+
+```
+curl -sfL https://raw.githubusercontent.com/kubearmor/kubearmor-client/main/install.sh | sh
+```
+
+To build and install, clone the repository and
+```
+make install
+```
+
+## Usage
+
+```
+CLI Utility to help manage KubeArmor
+
+Usage:
+  karmor [command]
+
+Available Commands:
+  completion  generate the autocompletion script for the specified shell
+  get         Display specified resources
+  help        Help about any command
+  install     Install KubeArmor in a Kubernetes Cluster
+  log         Observe Logs from KubeArmor
+  uninstall   Uninstall KubeArmor from a Kubernetes Cluster
+  version     Display version information
+
+Flags:
+  -h, --help   help for karmor
+
+Use "karmor [command] --help" for more information about a command.
+```

cmd/root.go

@@ -25,7 +25,7 @@ var rootCmd = &cobra.Command{
 		}
 		return nil
 	},
-	Use:   "kubearmor",
+	Use:   "karmor",
 	Short: "A CLI Utility to help manage KubeArmor",
 	Long: `CLI Utility to help manage KubeArmor