https://github.com/kubearmor/kubearmor-client

KubeArmor cli tool aka kArmor :robot:
https://github.com/kubearmor/kubearmor-client

cli kubearmor kubernetes management security tool

Last synced: 3 days ago
JSON representation

KubeArmor cli tool aka kArmor :robot:

• Host: GitHub
• URL: https://github.com/kubearmor/kubearmor-client
• Owner: kubearmor
• License: apache-2.0
• Created: 2021-07-05T11:20:56.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-31T17:15:21.000Z (5 days ago)
• Last Synced: 2025-02-02T15:57:19.980Z (3 days ago)
• Topics: cli, kubearmor, kubernetes, management, security, tool
• Language: Go
• Homepage:
• Size: 1.59 MB
• Stars: 40
• Watchers: 5
• Forks: 84
• Open Issues: 73
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/kubearmor/kubearmor-client/badge)](https://securityscorecards.dev/viewer/?uri=github.com/kubearmor/kubearmor-client)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkubearmor%2Fkubearmor-client.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubearmor%2Fkubearmor-client?ref=badge_shield)

# karmor

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

## Installation

```shell

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.

```shell

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

```shell

export KARMOR_VERSION="1.1.0"

```

- Download released tarball, certificate, and signature files

  Download Details

```shell

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

```shell

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

```shell

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 non kubernetes/bare metal KubeArmor

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](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkubearmor%2Fkubearmor-client.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubearmor%2Fkubearmor-client?ref=badge_large)