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

Update docs for stashed/cli@a4dd874e #293

Merged
merged 2 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/reference/cli/kubectl-stash.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ kubectl plugin for Stash by AppsCode. For more information, visit here: https://

### SEE ALSO

* [kubectl-stash check](/docs/reference/cli/kubectl-stash_check.md) - Check the repository for errors
* [kubectl-stash clone](/docs/reference/cli/kubectl-stash_clone.md) - Clone Kubernetes resources
* [kubectl-stash completion](/docs/reference/cli/kubectl-stash_completion.md) - Generate completion script
* [kubectl-stash cp](/docs/reference/cli/kubectl-stash_cp.md) - Copy stash resources from one namespace to another namespace
Expand All @@ -58,6 +59,7 @@ kubectl plugin for Stash by AppsCode. For more information, visit here: https://
* [kubectl-stash gen](/docs/reference/cli/kubectl-stash_gen.md) - generate stash resources
* [kubectl-stash key](/docs/reference/cli/kubectl-stash_key.md) - manages restic keys (passwords) for accessing the repository
* [kubectl-stash pause](/docs/reference/cli/kubectl-stash_pause.md) - Pause Stash backup temporarily
* [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
* [kubectl-stash unlock](/docs/reference/cli/kubectl-stash_unlock.md) - Unlock restic repository
Expand Down
55 changes: 55 additions & 0 deletions docs/reference/cli/kubectl-stash_check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Check
menu:
docs_{{ .version }}:
identifier: kubectl-stash-check
name: Check
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-stash check

Check the repository for errors

```
kubectl-stash check [flags]
```

### Options

```
-h, --help help for check
--read-data read all data blobs
--read-data-subset subset read a subset of data packs, specified as 'n/t' for specific part, or either 'x%' or 'x.y%' or a size in bytes with suffixes k/K, m/M, g/G, t/T for a random subset
--with-cache use existing cache, only read uncached data from repository
```

### 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

53 changes: 53 additions & 0 deletions docs/reference/cli/kubectl-stash_rebuild-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Rebuild-Index
menu:
docs_{{ .version }}:
identifier: kubectl-stash-rebuild-index
name: Rebuild-Index
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-stash rebuild-index

Build a new index

```
kubectl-stash rebuild-index [flags]
```

### Options

```
-h, --help help for rebuild-index
--read-all-packs read all pack files to generate new index from scratch
```

### 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

Loading