methodk8s

command module
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 12, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

README

methodk8s

GitHub Release Verify Go Report Card

GitHub Downloads Docker Pulls

methodk8s provides security operators with a number of data-rich K8S enumeration capabilities to help them gain visibility into their K8s Cluster. Designed with data-modeling and data-integration needs in mind, methodk8s can be used on its own as an interactive CLI, orchestrated as part of a broader data pipeline, or leveraged from within the Method Platform.

The number of security-relevant K8s resources that methodk8s can enumerate are constantly growing. For the most up to date listing, please see the documentation here

To learn more about methodk8s, please see the Documentation site for the most detailed information.

Quick Start

Get methodk8s

For the full list of available installation options, please see the Installation page. For convenience, here are some of the most commonly used options:

Authentication

For authenticated workflows, you need to pass in your kube config file to the docker container

docker run -v /path/to/your/kubeconfig:/opt/method/methodk8s/kubeconfig methodsecurity/methodk8s

General Usage

methodk8s <resource> enumerate 
Examples
methodk8s pod enumerate --url test-cluster.net
methodk8s node enumerate --context minikube --path ~/.kube/config

Contributing

Interested in contributing to methodk8s? Please see our Contribution page.

Want More?

If you're looking for an easy way to tie methodk8s into your broader cybersecurity workflows, or want to leverage some autonomy to improve your overall security posture, you'll love the broader Method Platform.

For more information, see [https://method.security]

Community

methodk8s is a Method Security open source project.

Learn more about Method's open source source work by checking out our other projects here.

Have an idea for a Tool to contribute? Open a Discussion here.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
generated
go
internal
pod

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL