kosli_snapshot_k8s.md

title	kosli snapshot k8s
description	Report a snapshot of running pods in a K8S cluster or namespace(s) to Kosli.

Synopsis

kosli snapshot k8s ENVIRONMENT-NAME [flags]

Report a snapshot of running pods in a K8S cluster or namespace(s) to Kosli.
Skip --namespaces and --namespaces-regex to report all pods in all namespaces in a cluster. The reported data includes pod container images digests and creation timestamps. You can customize the scope of reporting to include or exclude namespaces.

Flags

Flag	Type	Description
--config-file	string	[optional] The path to a YAML config file that maps multiple Kosli environments to namespace selectors. Cannot be used with a positional environment name argument or namespace flags.
-D, --dry-run	bool	[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors.
-x, --exclude-namespaces	strings	[optional] The comma separated list of namespaces names to exclude from reporting artifacts info from. Requires cluster-wide read permissions for pods and namespaces. Can't be used together with --namespaces or --namespaces-regex.
--exclude-namespaces-regex	strings	[optional] The comma separated list of namespaces regex patterns to exclude from reporting artifacts info from. Requires cluster-wide read permissions for pods and namespaces. Can't be used together with --namespaces or --namespaces-regex.
-h, --help	bool	help for k8s
-k, --kubeconfig	string	[defaulted] The kubeconfig path for the target cluster. (default "$HOME/.kube/config")
-n, --namespaces	strings	[optional] The comma separated list of namespaces names to report artifacts info from. Can't be used together with --exclude-namespaces or --exclude-namespaces-regex.
--namespaces-regex	strings	[optional] The comma separated list of namespaces regex patterns to report artifacts info from. Requires cluster-wide read permissions for pods and namespaces. Can't be used together with --exclude-namespaces --exclude-namespaces-regex.

Flags inherited from parent commands

Flag	Type	Description
-a, --api-token	string	The Kosli API token.
-A, --auto-environment	bool	[optional] Create the environment (with the type inferred from the snapshot subcommand) if it does not already exist, before reporting the snapshot.
--debug	bool	[optional] Print debug logs to stdout.
--environment-description	string	[optional] The environment description.
--exclude-scaling	bool	[optional] Exclude scaling events for snapshots. Snapshots with scaling changes will not result in new environment records. (DEPRECATED: this flag is deprecated and will be removed in a future version. Scaling events do not trigger new snapshots.)
-H, --host	string	[defaulted] The Kosli endpoint. (default "https://app.kosli.com")
--http-proxy	string	[optional] The HTTP proxy URL including protocol and port number. e.g. http://proxy-server-ip:proxy-port
--include-scaling	bool	[optional] Include scaling events for snapshots. Snapshots with scaling changes will result in new environment records. (DEPRECATED: this flag is deprecated and will be removed in a future version. Scaling events do not trigger new snapshots.)
-r, --max-api-retries	int	[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)
--org	string	The Kosli organization.
-q, --quiet	bool	[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both --quiet and --debug are set, --debug wins.

Examples Use Cases

These examples all assume that the flags --api-token, --org, --host, (and --flow, --trail when required), are set/provided.

```shell kosli snapshot k8s yourEnvironmentName

</Accordion>
<Accordion title="report what is running in an entire cluster using kubeconfig at $HOME/.kube/config (with global flags defined in environment or in a config file)">
```shell
export KOSLI_API_TOKEN=yourAPIToken
export KOSLI_ORG=yourOrgName

kosli snapshot k8s yourEnvironmentName

```shell kosli snapshot k8s yourEnvironmentName --exclude-namespaces kube-system,utilities

</Accordion>
<Accordion title="report what is running in a given namespace in the cluster using kubeconfig at $HOME/.kube/config">
```shell
kosli snapshot k8s yourEnvironmentName 
	--namespaces your-namespace 

```shell kosli snapshot k8s yourEnvironmentName --kubeconfig /path/to/kube/config ```