/kubearmor-client

KubeArmor cli tool aka kArmor :robot:

Primary LanguageGoApache License 2.0Apache-2.0

OpenSSF Scorecard FOSSA Status

karmor

karmor is a client tool to help manage KubeArmor.

Installation

curl -sfL http://get.kubearmor.io/ | sh -s

Installing From Source

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

git clone https://github.com/kubearmor/kubearmor-client.git
cd kubearmor-client
make install

Steps to Verify the Binary (Recommended)

We sign all releases with cosign, therefore we recommend verifying karmor tarball prior to its installation.

Below are the instructions to verify the binary using cosign for version v1.1.0.

  • Use an environment variable to set the karmor version
export KARMOR_VERSION="1.1.0"
  • Download released tarball, certificate, and signature files
Download Details 
curl -LO https://github.com/kubearmor/kubearmor-client/releases/download/v${KARMOR_VERSION}/karmor_${KARMOR_VERSION}_linux_amd64.tar.gz

curl -LO https://github.com/kubearmor/kubearmor-client/releases/download/v${KARMOR_VERSION}/karmor_${KARMOR_VERSION}_linux_amd64.tar.gz.cert

curl -LO https://github.com/kubearmor/kubearmor-client/releases/download/v${KARMOR_VERSION}/karmor_${KARMOR_VERSION}_linux_amd64.tar.gz.sig
  • Verify the released tarball integrity with cosign
Verification Details 
cosign verify-blob karmor_${KARMOR_VERSION}_linux_amd64.tar.gz --certificate-identity=https://github.com/kubearmor/kubearmor-client/.github/workflows/release.yml@refs/tags/v${KARMOR_VERSION} --certificate-oidc-issuer=https://token.actions.githubusercontent.com --signature karmor_${KARMOR_VERSION}_linux_amd64.tar.gz.sig --certificate karmor_${KARMOR_VERSION}_linux_amd64.tar.gz.cert

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
  help        Help about any command
  install     Install KubeArmor in a Kubernetes Cluster
  logs        Observe Logs from KubeArmor
  probe       Checks for supported KubeArmor features in the current environment
  profile     Profiling of logs
  recommend   Recommend Policies
  rotate-tls  Rotate webhook controller tls certificates
  selfupdate  selfupdate this cli tool
  sysdump     Collect system dump information for troubleshooting and error report
  uninstall   Uninstall KubeArmor from a Kubernetes Cluster
  version     Display version information
  vm          VM commands for kvmservice

Flags:
      --context string      Name of the kubeconfig context to use
  -h, --help                help for karmor
      --kubeconfig string   Path to the kubeconfig file to use

Use "karmor [command] --help" for more information about a command.

License

FOSSA Status