Skip to content

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
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 <barun.acharya@accuknox.com>
  • Loading branch information
daemon1024 committed Sep 27, 2021
1 parent df2b274 commit e4deac2
Show file tree
Hide file tree
Showing 4 changed files with 427 additions and 3 deletions.
7 changes: 6 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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)
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,45 @@
# 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
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.
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.
```
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit e4deac2

Please sign in to comment.