Krew Plugin Usage

If you’re using KubeSnapIt via Krew as a kubectl plugin (Linux/macOS), here are the usage examples to help you manage your Kubernetes resources effectively.

Ensure you are connected to your Kubernetes cluster before using KubeSnapIt. You can use kubectl commands to check your connection and manage your contexts.

Parameters

Parameter	Description
`-Namespace`	Specifies the namespace to snapshot or restore.
`-AllNamespaces`	Captures or restores all namespaces. Overrides the `-Namespace` parameter.
`-AllNonSystemNamespaces`	Capture all non-system namespaces. If this is provided, `-Namespace` and `-AllNamespaces` will be ignored.
`-OutputPath`	Path to save the snapshot files.
`-InputPath`	Path to restore snapshots from or for comparison.
`-ComparePath`	Path to the second snapshot for comparison.
`-Labels`	Filters Kubernetes objects based on specified labels (e.g., `app=nginx`).
`-Objects`	Comma-separated list of specific objects in the `kind/name` format.
`-DryRun`	Simulates snapshotting or restoring without making any actual changes.
`-Restore`	Restores resources from the specified snapshot path.
`-Compare`	Compares two snapshots or a snapshot with the current cluster state.
`-CompareWithCluster`	Compares a snapshot with the current cluster state.
`-Force`	Bypasses confirmation prompts when restoring snapshots.
`-Verbose`	Shows detailed output during the snapshot, restore, or comparison process.
`-SnapshotHelm`	Backup Helm releases and their values.
`-Help`	Displays the help information for using `KubeSnapIt`.

Taking a Snapshot

To capture a snapshot of Kubernetes resources in a specific namespace:

kubectl KubeSnapIt --namespace "your-namespace" --output-path "./snapshots"

To capture snapshots of all resources across all namespaces:

kubectl KubeSnapIt --all-namespaces --output-path "./snapshots"

To capture snapshots of all non-system namespaces

kubectl kubesnapit -allnonsystemnamespaces -outputpath ./snapshots

To capture snapshots with specific labels

kubectl kubesnapit -namespace my-namespace -labels app=nginx -outputpath ./snapshots

To capture snapshots of specific objects

kubectl kubesnapit -namespace my-namespace -objects pod/my-pod,deployment/my-deployment -outputpath ./snapshots

Snapshotting Helm Releases

To capture snapshots of Helm releases in a specific namespace

kubectl kubesnapit -backuphelm -namespace my-namespace -outputpath ./helm-backups

To capture snapshots of Helm releases in all namespaces

kubectl kubesnapit -backuphelm -allnamespaces -outputpath ./helm-backups

To capture snapshots of Helm releases in all non-system namespaces

kubectl kubesnapit -backuphelm -allnonsystemnamespaces -outputpath ./helm-backups

Comparing Snapshots

To compare a local snapshot against the live cluster state:

kubectl kubesnapit -comparewithcluster -inputpath ./snapshots

To compare two local snapshots:

kubectl kubesnapit -comparesnapshots -inputpath ./snapshots/snapshot1 -comparepath ./snapshots/snapshot2

Resource Restoration

To restore a Kubernetes resource from a snapshot using kubectl KubeSnapIt, use the following command. By default, this will ask for confirmation before restoring:

kubectl KubeSnapIt restore --input-path "./snapshots/your_snapshot.yaml"

Skipping Confirmation with `--force`

If you want to bypass the confirmation prompt and restore the resources immediately, use the --force option:

kubectl KubeSnapIt restore --input-path "./snapshots/your_snapshot.yaml" --force

This command restores the resources from the specified snapshot without asking for confirmation.

Dry Run Mode

Use the --dry-run option to simulate snapshotting or restoration processes without making any actual changes:

kubectl KubeSnapIt --namespace "your-namespace" --output-path "./snapshots" --dry-run

For detailed logging examples, check out our Logging and Output page.