Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

option names for karmor #76

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci-go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ jobs:

- uses: actions/setup-go@v2
with:

go-version: v1.18

- name: Build karmor
Expand Down Expand Up @@ -68,5 +69,4 @@ jobs:
go-version: v1.18

- name: Run unit tests
run: make test

run: make test
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ CURDIR := $(shell pwd)
INSTALLDIR := $(shell go env GOPATH)/bin/

ifeq (, $(shell which govvv))

s1ntaxe770r marked this conversation as resolved.
Show resolved Hide resolved
$(shell go install github.com/ahmetb/govvv@latest)
endif

PKG := $(shell go list ./selfupdate)

s1ntaxe770r marked this conversation as resolved.
Show resolved Hide resolved
GIT_INFO := $(shell govvv -flags -pkg $(PKG))

.PHONY: build
Expand All @@ -23,10 +25,12 @@ install: build
clean:
cd $(CURDIR); rm -f karmor


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

.PHONY: test
test:
cd $(CURDIR); go test -v ./...


s1ntaxe770r marked this conversation as resolved.
Show resolved Hide resolved
.PHONY: protobuf
vm-protobuf:
cd $(CURDIR)/vm/protobuf; protoc --proto_path=. --go_opt=paths=source_relative --go_out=plugins=grpc:. vm.proto
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,25 @@

**karmor** is a client tool to help manage [KubeArmor](github.com/kubearmor/KubeArmor).


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

## Installation

The following sections show how to install the kArmor. It can be installed either from source, or from pre-built binary releases.

### From Script

kArmor has an installer script that will automatically grab the latest version of kArmor and install it locally.

Comment on lines +8 to +13
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following sections show how to install the kArmor. It can be installed either from source, or from pre-built binary releases.
### From Script
kArmor has an installer script that will automatically grab the latest version of kArmor and install it locally.

```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

curl -sfL http://get.kubearmor.io/ | sudo sh -s -- -b /usr/local/bin
```

### Installing from Source

Build karmor from source if you want to test the latest (pre-release) karmor version.


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

```
git clone https://github.com/kubearmor/kubearmor-client.git
cd kubearmor-client
Expand Down
2 changes: 1 addition & 1 deletion cmd/policy.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,5 @@ func init() {
vmPolicyCmd.AddCommand(vmPolicyDeleteCmd)

// gRPC endpoint flag to communicate with KubeArmor. Available across subcommands.
vmPolicyCmd.PersistentFlags().StringVar(&policyOptions.GRPC, "gRPC", "", "gRPC server information")
vmPolicyCmd.PersistentFlags().StringVar(&policyOptions.GRPC, " grpc", "", "gRPC server information")
s1ntaxe770r marked this conversation as resolved.
Show resolved Hide resolved
}
2 changes: 1 addition & 1 deletion go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -1823,4 +1823,4 @@ sigs.k8s.io/structured-merge-diff/v4 v4.2.3/go.mod h1:qjx8mGObPmV2aSZepjQjbmb2ih
sigs.k8s.io/yaml v1.1.0/go.mod h1:UJmg0vDUVViEyp3mgSv9WPwZCDxu4rQW1olrI1uml+o=
sigs.k8s.io/yaml v1.2.0/go.mod h1:yfXDCHCao9+ENCvLSE62v9VSji2MKu5jeNfTrofGhJc=
sigs.k8s.io/yaml v1.3.0 h1:a2VclLzOGrwOHDiV8EfBGhvjHvP46CtW5j6POvhYGGo=
sigs.k8s.io/yaml v1.3.0/go.mod h1:GeOyir5tyXNByN85N/dRIT9es5UQNerPYEKK56eTBm8=
sigs.k8s.io/yaml v1.3.0/go.mod h1:GeOyir5tyXNByN85N/dRIT9es5UQNerPYEKK56eTBm8=