Skip to content

Commit 397cf94

Browse files
tamalsahatamalsaha
authored
Generate cli reference docs (#10)
Signed-off-by: Tamal Saha <tamal@appscode.com>
1 parent 772be22 commit 397cf94

20 files changed

Lines changed: 1293 additions & 23 deletions

‎docs/_index.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Stash kubectl plugin
3+
description: Stash kubectl plugin Reference
4+
menu:
5+
product_stash_{{.version}}:
6+
identifier: stash-cli-references-{{ .subproject_version }}
7+
name: {{ .subproject_version }}
8+
parent: stash-cli-references
9+
weight: 20
10+
menu_name: product_stash_{{.version}}
11+
---

‎docs/kubectl-stash.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: Kubectl-Stash
3+
menu:
4+
product_stash_{{.version}}:
5+
identifier: kubectl-stash-{{ .subproject_version }}
6+
name: Kubectl-Stash
7+
parent: stash-cli-references-{{ .subproject_version }}
8+
weight: 0
9+
product_name: stash
10+
section_menu_id: guides
11+
menu_name: product_stash_{{.version}}
12+
aliases:
13+
- /products/stash/{{.version}}/guides/latest/cli/reference/{{ .subproject_version }}
14+
15+
---
16+
## kubectl-stash
17+
18+
kubectl plugin for Stash by AppsCode
19+
20+
### Synopsis
21+
22+
kubectl plugin for Stash by AppsCode. For more information, visit here: https://appscode.com/products/stash
23+
24+
### Options
25+
26+
```
27+
--alsologtostderr log to standard error as well as files
28+
--as string Username to impersonate for the operation
29+
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
30+
--cache-dir string Default HTTP cache directory (default "/home/tamal/.kube/http-cache")
31+
--certificate-authority string Path to a cert file for the certificate authority
32+
--client-certificate string Path to a client certificate file for TLS
33+
--client-key string Path to a client key file for TLS
34+
--cluster string The name of the kubeconfig cluster to use
35+
--context string The name of the kubeconfig context to use
36+
--enable-analytics Send analytical events to Google Analytics (default true)
37+
--enable-status-subresource If true, uses sub resource for crds.
38+
-h, --help help for kubectl-stash
39+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
40+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
41+
--log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
42+
--log-dir string If non-empty, write log files in this directory
43+
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
44+
--logtostderr log to standard error instead of files
45+
--match-server-version Require server version to match client version
46+
-n, --namespace string If present, the namespace scope for this CLI request
47+
--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")
48+
-s, --server string The address and port of the Kubernetes API server
49+
--stderrthreshold severity logs at or above this threshold go to stderr
50+
--token string Bearer token for authentication to the API server
51+
--use-kubeapiserver-fqdn-for-aks if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true)
52+
--user string The name of the kubeconfig user to use
53+
-v, --v Level log level for V logs
54+
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
55+
```
56+
57+
### SEE ALSO
58+
59+
* [kubectl-stash clone](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_clone.md) - Clone Kubernetes resources
60+
* [kubectl-stash cp](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_cp.md) - Copy stash resources from one namespace to another namespace
61+
* [kubectl-stash create](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_create.md) - create stash resources
62+
* [kubectl-stash delete](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_delete.md) - Delete stash resources
63+
* [kubectl-stash download](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_download.md) - Download snapshots
64+
* [kubectl-stash trigger](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_trigger.md) - Trigger a backup
65+
* [kubectl-stash unlock](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_unlock.md) - Unlock Restic Repository
66+
* [kubectl-stash version](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_version.md) - Prints binary version number.
67+

‎docs/kubectl-stash_clone.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: Clone
3+
menu:
4+
product_stash_{{.version}}:
5+
identifier: kubectl-stash-clone-{{ .subproject_version }}
6+
name: Clone
7+
parent: stash-cli-references-{{ .subproject_version }}
8+
product_name: stash
9+
section_menu_id: guides
10+
menu_name: product_stash_{{.version}}
11+
---
12+
## kubectl-stash clone
13+
14+
Clone Kubernetes resources
15+
16+
### Synopsis
17+
18+
Clone Kubernetes resources
19+
20+
### Options
21+
22+
```
23+
-h, --help help for clone
24+
--to-namespace string Destination namespace.
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
--alsologtostderr log to standard error as well as files
31+
--as string Username to impersonate for the operation
32+
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
33+
--cache-dir string Default HTTP cache directory (default "/home/tamal/.kube/http-cache")
34+
--certificate-authority string Path to a cert file for the certificate authority
35+
--client-certificate string Path to a client certificate file for TLS
36+
--client-key string Path to a client key file for TLS
37+
--cluster string The name of the kubeconfig cluster to use
38+
--context string The name of the kubeconfig context to use
39+
--enable-analytics Send analytical events to Google Analytics (default true)
40+
--enable-status-subresource If true, uses sub resource for crds.
41+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
42+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
43+
--log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
44+
--log-dir string If non-empty, write log files in this directory
45+
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
46+
--logtostderr log to standard error instead of files
47+
--match-server-version Require server version to match client version
48+
-n, --namespace string If present, the namespace scope for this CLI request
49+
--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")
50+
-s, --server string The address and port of the Kubernetes API server
51+
--stderrthreshold severity logs at or above this threshold go to stderr
52+
--token string Bearer token for authentication to the API server
53+
--use-kubeapiserver-fqdn-for-aks if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true)
54+
--user string The name of the kubeconfig user to use
55+
-v, --v Level log level for V logs
56+
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
57+
```
58+
59+
### SEE ALSO
60+
61+
* [kubectl-stash](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash.md) - kubectl plugin for Stash by AppsCode
62+
* [kubectl-stash clone pvc](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_clone_pvc.md) - Clone PVC
63+

‎docs/kubectl-stash_clone_pvc.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: Clone Pvc
3+
menu:
4+
product_stash_{{.version}}:
5+
identifier: kubectl-stash-clone-pvc-{{ .subproject_version }}
6+
name: Clone Pvc
7+
parent: stash-cli-references-{{ .subproject_version }}
8+
product_name: stash
9+
section_menu_id: guides
10+
menu_name: product_stash_{{.version}}
11+
---
12+
## kubectl-stash clone pvc
13+
14+
Clone PVC
15+
16+
### Synopsis
17+
18+
Use Backup and Restore process for cloning PVC
19+
20+
```
21+
kubectl-stash clone pvc [flags]
22+
```
23+
24+
### Examples
25+
26+
```
27+
# Clone PVC
28+
stash clone pvc source-pvc -n demo --to-namespace=demo1 --secret=<secret> --bucket=<bucket> --prefix=<prefix> --provider=<provider>
29+
```
30+
31+
### Options
32+
33+
```
34+
--bucket string Name of the cloud bucket/container
35+
--endpoint string Endpoint for s3/s3 compatible backend
36+
-h, --help help for pvc
37+
--max-connections int Specify maximum concurrent connections for GCS, Azure and B2 backend
38+
--prefix string Prefix denotes the directory inside the backend
39+
--provider string Backend provider (i.e. gcs, s3, azure etc)
40+
--secret string Name of the Storage Secret
41+
```
42+
43+
### Options inherited from parent commands
44+
45+
```
46+
--alsologtostderr log to standard error as well as files
47+
--as string Username to impersonate for the operation
48+
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
49+
--cache-dir string Default HTTP cache directory (default "/home/tamal/.kube/http-cache")
50+
--certificate-authority string Path to a cert file for the certificate authority
51+
--client-certificate string Path to a client certificate file for TLS
52+
--client-key string Path to a client key file for TLS
53+
--cluster string The name of the kubeconfig cluster to use
54+
--context string The name of the kubeconfig context to use
55+
--enable-analytics Send analytical events to Google Analytics (default true)
56+
--enable-status-subresource If true, uses sub resource for crds.
57+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
58+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
59+
--log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
60+
--log-dir string If non-empty, write log files in this directory
61+
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
62+
--logtostderr log to standard error instead of files
63+
--match-server-version Require server version to match client version
64+
-n, --namespace string If present, the namespace scope for this CLI request
65+
--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")
66+
-s, --server string The address and port of the Kubernetes API server
67+
--stderrthreshold severity logs at or above this threshold go to stderr
68+
--to-namespace string Destination namespace.
69+
--token string Bearer token for authentication to the API server
70+
--use-kubeapiserver-fqdn-for-aks if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true)
71+
--user string The name of the kubeconfig user to use
72+
-v, --v Level log level for V logs
73+
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
74+
```
75+
76+
### SEE ALSO
77+
78+
* [kubectl-stash clone](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_clone.md) - Clone Kubernetes resources
79+

‎docs/kubectl-stash_cp.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Cp
3+
menu:
4+
product_stash_{{.version}}:
5+
identifier: kubectl-stash-cp-{{ .subproject_version }}
6+
name: Cp
7+
parent: stash-cli-references-{{ .subproject_version }}
8+
product_name: stash
9+
section_menu_id: guides
10+
menu_name: product_stash_{{.version}}
11+
---
12+
## kubectl-stash cp
13+
14+
Copy stash resources from one namespace to another namespace
15+
16+
### Synopsis
17+
18+
Copy stash resources from one namespace to another namespace
19+
20+
### Options
21+
22+
```
23+
-h, --help help for cp
24+
--to-namespace string Destination namespace.
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
--alsologtostderr log to standard error as well as files
31+
--as string Username to impersonate for the operation
32+
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
33+
--cache-dir string Default HTTP cache directory (default "/home/tamal/.kube/http-cache")
34+
--certificate-authority string Path to a cert file for the certificate authority
35+
--client-certificate string Path to a client certificate file for TLS
36+
--client-key string Path to a client key file for TLS
37+
--cluster string The name of the kubeconfig cluster to use
38+
--context string The name of the kubeconfig context to use
39+
--enable-analytics Send analytical events to Google Analytics (default true)
40+
--enable-status-subresource If true, uses sub resource for crds.
41+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
42+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
43+
--log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
44+
--log-dir string If non-empty, write log files in this directory
45+
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
46+
--logtostderr log to standard error instead of files
47+
--match-server-version Require server version to match client version
48+
-n, --namespace string If present, the namespace scope for this CLI request
49+
--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")
50+
-s, --server string The address and port of the Kubernetes API server
51+
--stderrthreshold severity logs at or above this threshold go to stderr
52+
--token string Bearer token for authentication to the API server
53+
--use-kubeapiserver-fqdn-for-aks if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true)
54+
--user string The name of the kubeconfig user to use
55+
-v, --v Level log level for V logs
56+
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
57+
```
58+
59+
### SEE ALSO
60+
61+
* [kubectl-stash](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash.md) - kubectl plugin for Stash by AppsCode
62+
* [kubectl-stash cp backupconfig](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_cp_backupconfig.md) - Copy BackupConfiguration from one namespace to another namespace
63+
* [kubectl-stash cp repository](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_cp_repository.md) - Copy Repository and Secret
64+
* [kubectl-stash cp secret](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_cp_secret.md) - Copy Secret
65+
* [kubectl-stash cp volumesnapshot](/docs/guides/latest/cli/reference/{{< param "info.subproject_version" >}}/kubectl-stash_cp_volumesnapshot.md) - Copy VolumeSnapshot
66+

0 commit comments

Comments
 (0)