From 4a4bd94c7517483b9d1629d208766e9aed094308 Mon Sep 17 00:00:00 2001 From: 1gtm <1gtm@appscode.com> Date: Thu, 18 Sep 2025 09:48:53 +0000 Subject: [PATCH] Update docs for stashed/cli@e57fa98a Signed-off-by: 1gtm <1gtm@appscode.com> --- docs/reference/cli/kubectl-stash.md | 1 + .../cli/kubectl-stash_purge-repos.md | 71 +++++++++++++++++++ 2 files changed, 72 insertions(+) create mode 100644 docs/reference/cli/kubectl-stash_purge-repos.md diff --git a/docs/reference/cli/kubectl-stash.md b/docs/reference/cli/kubectl-stash.md index 59bd24d9..8e9b9538 100644 --- a/docs/reference/cli/kubectl-stash.md +++ b/docs/reference/cli/kubectl-stash.md @@ -61,6 +61,7 @@ kubectl plugin for Stash by AppsCode. For more information, visit here: https:// * [kubectl-stash migrate](/docs/reference/cli/kubectl-stash_migrate.md) - Migrate restic repository to v2 * [kubectl-stash pause](/docs/reference/cli/kubectl-stash_pause.md) - Pause Stash backup temporarily * [kubectl-stash prune](/docs/reference/cli/kubectl-stash_prune.md) - Prune restic repository +* [kubectl-stash purge-repos](/docs/reference/cli/kubectl-stash_purge-repos.md) - Purge old repositories from backend storage * [kubectl-stash rebuild-index](/docs/reference/cli/kubectl-stash_rebuild-index.md) - Build a new index * [kubectl-stash resume](/docs/reference/cli/kubectl-stash_resume.md) - Resume Stash backup * [kubectl-stash trigger](/docs/reference/cli/kubectl-stash_trigger.md) - Trigger a backup diff --git a/docs/reference/cli/kubectl-stash_purge-repos.md b/docs/reference/cli/kubectl-stash_purge-repos.md new file mode 100644 index 00000000..6970567c --- /dev/null +++ b/docs/reference/cli/kubectl-stash_purge-repos.md @@ -0,0 +1,71 @@ +--- +title: Purge-Repos +menu: + docs_{{ .version }}: + identifier: kubectl-stash-purge-repos + name: Purge-Repos + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash purge-repos + +Purge old repositories from backend storage + +``` +kubectl-stash purge-repos [flags] +``` + +### Examples + +``` + # Basic usage: Purge repositories older than 1 year + kubectl stash purge-repos --storage-config=storage-config.yaml --older-than=1y + + # Dry run to see what would be deleted without actually deleting + kubectl stash purge-repos --storage-config=storage-config.yaml --older-than=6mo --dry-run + + # Purge with different time formats + kubectl stash purge-repos --storage-config=storage-config.yaml --older-than=30d + kubectl stash purge-repos --storage-config=storage-config.yaml --older-than=6mo + kubectl stash purge-repos --storage-config=storage-config.yaml --older-than=1y6mo + kubectl stash purge-repos --storage-config=storage-config.yaml --older-than=24h +``` + +### Options + +``` + --dry-run List repositories that would be deleted without actually deleting them + -h, --help help for purge-repos + --older-than string Purge repositories older than this duration (e.g., 1y, 6mo, 30d, 24h) + --storage-config string Path to storage configuration YAML/JSON file (required) +``` + +### Options inherited from parent commands + +``` + --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. + --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. + --as-uid string UID to impersonate for the operation. + --cache-dir string Default cache directory (default "/home/runner/.kube/cache") + --certificate-authority string Path to a cert file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --disable-compression If true, opt-out of response compression for all requests to the server + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") + -s, --server string The address and port of the Kubernetes API server + --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use +``` + +### SEE ALSO + +* [kubectl-stash](/docs/reference/cli/kubectl-stash.md) - kubectl plugin for Stash by AppsCode +