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

Changed the description for long description for install command #384

Closed
wants to merge 11 commits into from
3 changes: 3 additions & 0 deletions .github/workflows/broken-link-check.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: Broken link check
on: [push]

# Declare default permissions as read only.
permissions: read-all

jobs:
broken_link_checker_job:
runs-on: ubuntu-latest
Expand Down
7 changes: 5 additions & 2 deletions .github/workflows/ci-ginkgo-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ on:
pull_request:
branches: [main]

# Declare default permissions as read only.
permissions: read-all

jobs:
ginkgo-test:
runs-on: ubuntu-latest
Expand All @@ -14,7 +17,7 @@ jobs:
uses: actions/checkout@v2
- uses: actions/setup-go@v2
with:
go-version: "v1.20"
go-version: "v1.21"
- name: Create k8s Kind Cluster
uses: helm/[email protected]
- name: Test connectivity
Expand All @@ -29,4 +32,4 @@ jobs:
go install -mod=mod github.com/onsi/ginkgo/v2/ginkgo
make recommend -C tests/
timeout-minutes: 30


11 changes: 7 additions & 4 deletions .github/workflows/ci-go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ on:
pull_request:
branches: [main]

# Declare default permissions as read only.
permissions: read-all

jobs:
go-build:
runs-on: ubuntu-latest
Expand All @@ -15,7 +18,7 @@ jobs:

- uses: actions/setup-go@v2
with:
go-version: "v1.20"
go-version: "v1.21"

- name: Build karmor
run: make
Expand All @@ -28,7 +31,7 @@ jobs:

- uses: actions/setup-go@v2
with:
go-version: "v1.20"
go-version: "v1.21"

- name: Check gofmt
run: make gofmt
Expand All @@ -41,7 +44,7 @@ jobs:

- uses: actions/setup-go@v2
with:
go-version: "v1.20"
go-version: "v1.21"

- name: Run Gosec Security Scanner
run: make gosec
Expand All @@ -65,7 +68,7 @@ jobs:

- uses: actions/setup-go@v2
with:
go-version: "v1.20"
go-version: "v1.21"

- name: Run unit tests
run: make test
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ on:
schedule:
- cron: "27 20 * * 2"

# Declare default permissions as read only.
permissions: read-all

jobs:
analyze:
name: Analyze
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
name: Set up Go
uses: actions/setup-go@v2
with:
go-version: "1.20"
go-version: "1.21"

- name: Install Cosign
uses: sigstore/cosign-installer@main
Expand Down
2 changes: 1 addition & 1 deletion cmd/install.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ var installOptions install.Options
var installCmd = &cobra.Command{
Use: "install",
Short: "Install KubeArmor in a Kubernetes Cluster",
Long: `Install KubeArmor in a Kubernetes Clusters`,
Long: `The installation command deploys Kubearmor into the cluster with the specified options. This command includes a validation step that checks whether the provided string in the "env" parameter corresponds to a valid environment. The "save" flag can be employed to persistently store the generated manifest.`,
RunE: func(cmd *cobra.Command, args []string) error {
if err := installOptions.Env.CheckAndSetValidEnvironmentOption(cmd.Flag("env").Value.String()); err != nil {
return fmt.Errorf("error in checking environment option: %v", err)
Expand Down
2 changes: 1 addition & 1 deletion cmd/uninstall.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ var uninstallCmd = &cobra.Command{
func init() {
rootCmd.AddCommand(uninstallCmd)

uninstallCmd.Flags().StringVarP(&uninstallOptions.Namespace, "namespace", "n", "kubearmor", "Namespace for resources")
uninstallCmd.Flags().StringVarP(&uninstallOptions.Namespace, "namespace", "n", "", "If no namespace is specified, it defaults to all namespaces and deletes all KubeArmor objects across them.")
uninstallCmd.Flags().BoolVar(&uninstallOptions.Force, "force", false, "Force remove KubeArmor annotations from deployments. (Deployments might be restarted)")
uninstallCmd.Flags().BoolVar(&uninstallOptions.Verify, "verify", true, "Verify whether all KubeArmor resources are cleaned up or not")
}
42 changes: 28 additions & 14 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module github.com/kubearmor/kubearmor-client

go 1.20
go 1.21

replace (
github.com/etcd-io/bbolt => go.etcd.io/bbolt v1.3.6
Expand All @@ -20,7 +20,7 @@ require (
github.com/blang/semver v3.5.1+incompatible
github.com/cilium/cilium v1.13.2
github.com/clarketm/json v1.17.1
github.com/docker/docker v23.0.6+incompatible
github.com/docker/docker v24.0.7+incompatible
github.com/fatih/color v1.15.0
github.com/json-iterator/go v1.1.12
github.com/kubearmor/KubeArmor/protobuf v0.0.0-20231019102803-e4e0e68a457b
Expand All @@ -32,11 +32,11 @@ require (
github.com/sirupsen/logrus v1.9.0
github.com/spf13/cobra v1.7.0
golang.org/x/exp v0.0.0-20230510235704-dd950f8aeaea
golang.org/x/mod v0.10.0
golang.org/x/sync v0.2.0
golang.org/x/sys v0.10.0
golang.org/x/mod v0.13.0
golang.org/x/sync v0.4.0
golang.org/x/sys v0.13.0
google.golang.org/genproto v0.0.0-20230410155749-daa745c078e1 // indirect
google.golang.org/grpc v1.55.0
google.golang.org/grpc v1.56.3
google.golang.org/protobuf v1.30.0
sigs.k8s.io/yaml v1.3.0
)
Expand All @@ -51,9 +51,9 @@ require (
github.com/google/go-cmp v0.5.9
github.com/google/go-github v17.0.0+incompatible
github.com/kubearmor/KVMService/src/types v0.0.0-20220714130113-b0eba8c9ff34
github.com/kubearmor/KubeArmor/KubeArmor v0.0.0-20231019102803-e4e0e68a457b
github.com/kubearmor/KubeArmor/deployments v0.0.0-20231019102803-e4e0e68a457b
github.com/kubearmor/KubeArmor/pkg/KubeArmorController v0.0.0-20231019102803-e4e0e68a457b
github.com/kubearmor/KubeArmor/KubeArmor v0.0.0-20231128180713-7c210669ac99
github.com/kubearmor/KubeArmor/deployments v0.0.0-20231128180713-7c210669ac99
github.com/kubearmor/KubeArmor/pkg/KubeArmorController v0.0.0-20231129072440-719ae8563da7
github.com/onsi/ginkgo/v2 v2.9.7
github.com/onsi/gomega v1.27.8
k8s.io/api v0.27.3
Expand Down Expand Up @@ -81,6 +81,9 @@ require (
github.com/Azure/go-autorest/tracing v0.6.0 // indirect
github.com/DATA-DOG/go-sqlmock v1.5.0 // indirect
github.com/IGLOU-EU/go-wildcard v1.0.3 // indirect
github.com/Masterminds/goutils v1.1.1 // indirect
github.com/Masterminds/semver/v3 v3.2.1 // indirect
github.com/Masterminds/sprig/v3 v3.2.3 // indirect
github.com/Microsoft/go-winio v0.6.1 // indirect
github.com/OneOfOne/xxhash v1.2.8 // indirect
github.com/ProtonMail/go-crypto v0.0.0-20230426101702-58e86b294756 // indirect
Expand Down Expand Up @@ -121,12 +124,16 @@ require (
github.com/blang/semver/v4 v4.0.0 // indirect
github.com/cespare/xxhash/v2 v2.2.0 // indirect
github.com/chrismellard/docker-credential-acr-env v0.0.0-20230304212654-82a0ddb27589 // indirect
github.com/cilium/ebpf v0.11.0 // indirect
github.com/clbanning/mxj/v2 v2.5.7 // indirect
github.com/cloudflare/circl v1.3.2 // indirect
github.com/cockroachdb/apd/v2 v2.0.2 // indirect
github.com/common-nighthawk/go-figure v0.0.0-20210622060536-734e95fb86be // indirect
github.com/containerd/console v1.0.3 // indirect
github.com/containerd/containerd v1.7.1 // indirect
github.com/containerd/stargz-snapshotter/estargz v0.14.3 // indirect
github.com/containerd/ttrpc v1.2.2 // indirect
github.com/containerd/typeurl/v2 v2.1.1 // indirect
github.com/coreos/go-oidc/v3 v3.5.0 // indirect
github.com/cyberphone/json-canonicalization v0.0.0-20220623050100-57a0ce2678a7 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
Expand Down Expand Up @@ -192,6 +199,7 @@ require (
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
github.com/hashicorp/go-retryablehttp v0.7.2 // indirect
github.com/hashicorp/hcl v1.0.0 // indirect
github.com/huandu/xstrings v1.4.0 // indirect
github.com/imdario/mergo v0.3.15 // indirect
github.com/in-toto/in-toto-golang v0.6.0 // indirect
github.com/inconshreveable/go-update v0.0.0-20160112193335-8152e7eb6ccf // indirect
Expand Down Expand Up @@ -219,9 +227,11 @@ require (
github.com/mattn/go-sqlite3 v1.14.16 // indirect
github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
github.com/miekg/pkcs11 v1.1.1 // indirect
github.com/mitchellh/copystructure v1.2.0 // indirect
github.com/mitchellh/go-homedir v1.1.0 // indirect
github.com/mitchellh/go-wordwrap v1.0.1 // indirect
github.com/mitchellh/mapstructure v1.5.0 // indirect
github.com/mitchellh/reflectwalk v1.0.2 // indirect
github.com/moby/spdystream v0.2.0 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
Expand All @@ -241,6 +251,7 @@ require (
github.com/open-policy-agent/opa v0.52.0 // indirect
github.com/opencontainers/go-digest v1.0.0 // indirect
github.com/opencontainers/image-spec v1.1.0-rc3 // indirect
github.com/opencontainers/runtime-spec v1.1.0-rc.2 // indirect
github.com/opentracing/opentracing-go v1.2.1-0.20220228012449-10b1cf09e00b // indirect
github.com/pelletier/go-toml/v2 v2.0.8 // indirect
github.com/peterbourgon/diskv v2.0.1+incompatible // indirect
Expand All @@ -265,6 +276,7 @@ require (
github.com/segmentio/ksuid v1.0.4 // indirect
github.com/shibumi/go-pathspec v1.3.0 // indirect
github.com/shirou/gopsutil/v3 v3.23.3 // indirect
github.com/shopspring/decimal v1.3.1 // indirect
github.com/sigstore/cosign v1.13.1 // indirect
github.com/sigstore/fulcio v1.1.0 // indirect
github.com/sigstore/k8s-manifest-sigstore v0.4.4 // indirect
Expand Down Expand Up @@ -311,13 +323,14 @@ require (
go.uber.org/atomic v1.11.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.24.0 // indirect
golang.org/x/crypto v0.10.0 // indirect
golang.org/x/net v0.11.0 // indirect
golang.org/x/crypto v0.14.0 // indirect
golang.org/x/net v0.16.0 // indirect
golang.org/x/oauth2 v0.8.0 // indirect
golang.org/x/term v0.9.0 // indirect
golang.org/x/text v0.10.0 // indirect
golang.org/x/term v0.13.0 // indirect
golang.org/x/text v0.13.0 // indirect
golang.org/x/time v0.3.0 // indirect
golang.org/x/tools v0.9.1 // indirect
golang.org/x/tools v0.14.1-0.20231026192422-8b5abd452b28 // indirect
gomodules.xyz/jsonpatch/v2 v2.3.0 // indirect
google.golang.org/api v0.122.0 // indirect
google.golang.org/appengine v1.6.7 // indirect
gopkg.in/go-jose/go-jose.v2 v2.6.1 // indirect
Expand All @@ -327,6 +340,7 @@ require (
gopkg.in/yaml.v2 v2.4.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
k8s.io/component-base v0.27.2 // indirect
k8s.io/cri-api v0.27.1 // indirect
k8s.io/klog/v2 v2.100.1 // indirect
k8s.io/kube-openapi v0.0.0-20230501164219-8b0f38b5fd1f // indirect
k8s.io/kubectl v0.27.1 // indirect
Expand Down
Loading