From 48809b46301bbdb8f34357a24c81bdd29d15372e Mon Sep 17 00:00:00 2001 From: daemon1024 Date: Mon, 27 Sep 2021 12:09:34 +0530 Subject: [PATCH] Add installation instructions Generated an installation script using godownloader Updated README with usage and installation instructions Add make target to install binary to GOPATH Signed-off-by: Barun Acharya --- Makefile | 7 +- README.md | 42 +++++- cmd/root.go | 2 +- install.sh | 375 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 423 insertions(+), 3 deletions(-) create mode 100755 install.sh diff --git a/Makefile b/Makefile index 91e9bf4c..8392a022 100644 --- a/Makefile +++ b/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 \ No newline at end of file + -o karmor + +.PHONY: install +install: build + install -m 0755 karmor $(DESTDIR)$(INSTALLDIR) \ No newline at end of file diff --git a/README.md b/README.md index 4d6fc47c..c9601ab4 100644 --- a/README.md +++ b/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://github.com/raw/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. +``` \ No newline at end of file diff --git a/cmd/root.go b/cmd/root.go index dc031bd2..1093e028 100644 --- a/cmd/root.go +++ b/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 diff --git a/install.sh b/install.sh new file mode 100755 index 00000000..b7a6f785 --- /dev/null +++ b/install.sh @@ -0,0 +1,375 @@ +#!/usr/bin/env sh +set -e +# Code generated by godownloader on 2021-09-27T06:20:55Z. DO NOT EDIT. +# + +usage() { + this=$1 + cat </dev/null +} +echoerr() { + echo "$@" 1>&2 +} +log_prefix() { + echo "$0" +} +_logp=6 +log_set_priority() { + _logp="$1" +} +log_priority() { + if test -z "$1"; then + echo "$_logp" + return + fi + [ "$1" -le "$_logp" ] +} +log_tag() { + case $1 in + 0) echo "emerg" ;; + 1) echo "alert" ;; + 2) echo "crit" ;; + 3) echo "err" ;; + 4) echo "warning" ;; + 5) echo "notice" ;; + 6) echo "info" ;; + 7) echo "debug" ;; + *) echo "$1" ;; + esac +} +log_debug() { + log_priority 7 || return 0 + echoerr "$(log_prefix)" "$(log_tag 7)" "$@" +} +log_info() { + log_priority 6 || return 0 + echoerr "$(log_prefix)" "$(log_tag 6)" "$@" +} +log_err() { + log_priority 3 || return 0 + echoerr "$(log_prefix)" "$(log_tag 3)" "$@" +} +log_crit() { + log_priority 2 || return 0 + echoerr "$(log_prefix)" "$(log_tag 2)" "$@" +} +uname_os() { + os=$(uname -s | tr '[:upper:]' '[:lower:]') + case "$os" in + cygwin_nt*) os="windows" ;; + mingw*) os="windows" ;; + msys_nt*) os="windows" ;; + esac + echo "$os" +} +uname_arch() { + arch=$(uname -m) + case $arch in + x86_64) arch="amd64" ;; + x86) arch="386" ;; + i686) arch="386" ;; + i386) arch="386" ;; + aarch64) arch="arm64" ;; + armv5*) arch="armv5" ;; + armv6*) arch="armv6" ;; + armv7*) arch="armv7" ;; + esac + echo ${arch} +} +uname_os_check() { + os=$(uname_os) + case "$os" in + darwin) return 0 ;; + dragonfly) return 0 ;; + freebsd) return 0 ;; + linux) return 0 ;; + android) return 0 ;; + nacl) return 0 ;; + netbsd) return 0 ;; + openbsd) return 0 ;; + plan9) return 0 ;; + solaris) return 0 ;; + windows) return 0 ;; + esac + log_crit "uname_os_check '$(uname -s)' got converted to '$os' which is not a GOOS value. Please file bug at https://github.com/client9/shlib" + return 1 +} +uname_arch_check() { + arch=$(uname_arch) + case "$arch" in + 386) return 0 ;; + amd64) return 0 ;; + arm64) return 0 ;; + armv5) return 0 ;; + armv6) return 0 ;; + armv7) return 0 ;; + ppc64) return 0 ;; + ppc64le) return 0 ;; + mips) return 0 ;; + mipsle) return 0 ;; + mips64) return 0 ;; + mips64le) return 0 ;; + s390x) return 0 ;; + amd64p32) return 0 ;; + esac + log_crit "uname_arch_check '$(uname -m)' got converted to '$arch' which is not a GOARCH value. Please file bug report at https://github.com/client9/shlib" + return 1 +} +untar() { + tarball=$1 + case "${tarball}" in + *.tar.gz | *.tgz) tar --no-same-owner -xzf "${tarball}" ;; + *.tar) tar --no-same-owner -xf "${tarball}" ;; + *.zip) unzip "${tarball}" ;; + *) + log_err "untar unknown archive format for ${tarball}" + return 1 + ;; + esac +} +http_download_curl() { + local_file=$1 + source_url=$2 + header=$3 + if [ -z "$header" ]; then + code=$(curl -w '%{http_code}' -sL -o "$local_file" "$source_url") + else + code=$(curl -w '%{http_code}' -sL -H "$header" -o "$local_file" "$source_url") + fi + if [ "$code" != "200" ]; then + log_debug "http_download_curl received HTTP status $code" + return 1 + fi + return 0 +} +http_download_wget() { + local_file=$1 + source_url=$2 + header=$3 + if [ -z "$header" ]; then + wget -q -O "$local_file" "$source_url" + else + wget -q --header "$header" -O "$local_file" "$source_url" + fi +} +http_download() { + log_debug "http_download $2" + if is_command curl; then + http_download_curl "$@" + return + elif is_command wget; then + http_download_wget "$@" + return + fi + log_crit "http_download unable to find wget or curl" + return 1 +} +http_copy() { + tmp=$(mktemp) + http_download "${tmp}" "$1" "$2" || return 1 + body=$(cat "$tmp") + rm -f "${tmp}" + echo "$body" +} +github_release() { + owner_repo=$1 + version=$2 + test -z "$version" && version="latest" + giturl="https://github.com/${owner_repo}/releases/${version}" + json=$(http_copy "$giturl" "Accept:application/json") + test -z "$json" && return 1 + version=$(echo "$json" | tr -s '\n' ' ' | sed 's/.*"tag_name":"//' | sed 's/".*//') + test -z "$version" && return 1 + echo "$version" +} +hash_sha256() { + TARGET=${1:-/dev/stdin} + if is_command gsha256sum; then + hash=$(gsha256sum "$TARGET") || return 1 + echo "$hash" | cut -d ' ' -f 1 + elif is_command sha256sum; then + hash=$(sha256sum "$TARGET") || return 1 + echo "$hash" | cut -d ' ' -f 1 + elif is_command shasum; then + hash=$(shasum -a 256 "$TARGET" 2>/dev/null) || return 1 + echo "$hash" | cut -d ' ' -f 1 + elif is_command openssl; then + hash=$(openssl -dst openssl dgst -sha256 "$TARGET") || return 1 + echo "$hash" | cut -d ' ' -f a + else + log_crit "hash_sha256 unable to find command to compute sha-256 hash" + return 1 + fi +} +hash_sha256_verify() { + TARGET=$1 + checksums=$2 + if [ -z "$checksums" ]; then + log_err "hash_sha256_verify checksum file not specified in arg2" + return 1 + fi + BASENAME=${TARGET##*/} + want=$(grep "${BASENAME}" "${checksums}" 2>/dev/null | tr '\t' ' ' | cut -d ' ' -f 1) + if [ -z "$want" ]; then + log_err "hash_sha256_verify unable to find checksum for '${TARGET}' in '${checksums}'" + return 1 + fi + got=$(hash_sha256 "$TARGET") + if [ "$want" != "$got" ]; then + log_err "hash_sha256_verify checksum for '$TARGET' did not verify ${want} vs $got" + return 1 + fi +} +cat /dev/null <