From d28b672580b47b10d46017ade773a2172c18b846 Mon Sep 17 00:00:00 2001 From: Tamal Saha Date: Fri, 6 Sep 2024 09:59:36 -0700 Subject: [PATCH] Update docs Signed-off-by: Tamal Saha --- .../v2024.8.27/guides/backends/s3/index.md | 13 +- .../guides/cli/kubectl-plugin/index.md | 83 +- .../hooks/overview/images/job-model.svg | 1059 +---------------- .../v2024.8.27/guides/hooks/overview/index.md | 6 +- .../v2024.8.27/reference/cli/kubectl-stash.md | 4 +- .../reference/cli/kubectl-stash_check.md | 121 ++ .../cli/kubectl-stash_rebuild-index.md | 119 ++ .../v2024.8.27/reference/operator/stash.md | 2 +- data/products/kubestash.json | 11 +- data/products/voyager.json | 11 +- 10 files changed, 342 insertions(+), 1087 deletions(-) create mode 100644 content/docs/v2024.8.27/reference/cli/kubectl-stash_check.md create mode 100644 content/docs/v2024.8.27/reference/cli/kubectl-stash_rebuild-index.md diff --git a/content/docs/v2024.8.27/guides/backends/s3/index.md b/content/docs/v2024.8.27/guides/backends/s3/index.md index d813a10fb1..29f931d934 100644 --- a/content/docs/v2024.8.27/guides/backends/s3/index.md +++ b/content/docs/v2024.8.27/guides/backends/s3/index.md @@ -132,12 +132,13 @@ Now, you have to create a `Repository` crd. You have to provide the storage secr Following parameters are available for `S3` backend. -| Parameter | Type | Description | -| ------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `s3.endpoint` | `Required` | For S3, use `s3.amazonaws.com`. If your bucket is in a different location, S3 server (s3.amazonaws.com) will redirect Stash to the correct endpoint. For DigitalOCean, use `nyc3.digitaloceanspaces.com` etc. depending on your bucket region. For S3-compatible other storage services like Minio / Rook use URL of the server. | -| `s3.bucket` | `Required` | Name of Bucket. If the bucket does not exist yet it will be created in the default location (`us-east-1` for S3). It is not possible at the moment for Stash to create a new bucket in a different location, so you need to create it using a different program. | -| `s3.region` | `Optional` | Specify the region of your bucket. | -| `s3.prefix` | `Optional` | Path prefix inside the bucket where the backed up data will be stored. | +| Parameter | Type | Description | +|------------------| ---------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `s3.endpoint` | `Required` | For S3, use `s3.amazonaws.com`. If your bucket is in a different location, S3 server (s3.amazonaws.com) will redirect Stash to the correct endpoint. For DigitalOCean, use `nyc3.digitaloceanspaces.com` etc. depending on your bucket region. For S3-compatible other storage services like Minio / Rook use URL of the server. | +| `s3.bucket` | `Required` | Name of Bucket. If the bucket does not exist yet it will be created in the default location (`us-east-1` for S3). It is not possible at the moment for Stash to create a new bucket in a different location, so you need to create it using a different program. | +| `s3.region` | `Optional` | Specify the region of your bucket. | +| `s3.prefix` | `Optional` | Path prefix inside the bucket where the backed up data will be stored. | +| `s3.insecureTLS` | `Optional` | Specify whether to skip TLS certificate verification. Setting this field to `true` disables verification, which might be necessary in cases where the server uses self-signed certificates or certificates from an untrusted CA. Use this option with caution, as it can expose the client to man-in-the-middle attacks and other security risks. Only use it when absolutely necessary. | Below, the YAML of a sample `Repository` crd that uses an `S3` bucket as a backend. diff --git a/content/docs/v2024.8.27/guides/cli/kubectl-plugin/index.md b/content/docs/v2024.8.27/guides/cli/kubectl-plugin/index.md index e1816637ed..510c56b375 100644 --- a/content/docs/v2024.8.27/guides/cli/kubectl-plugin/index.md +++ b/content/docs/v2024.8.27/guides/cli/kubectl-plugin/index.md @@ -107,7 +107,9 @@ Available command for `kubectl stash` cli are: | [key add](#key-add) | Add a new key (password) to a restic repository. | | [key update](#key-update) | Update current key (password) of a restic repository. | | [key remove](#key-remove) | Remove a key (password) of a restic repository. | -| [gen rules](#generate-rules) | Generate restore rules from nearest snapshots at a specific time | +| [gen rules](#generate-rules) | Generate restore rules from nearest snapshots at a specific time. | +| [check](#check-repository) | Test the restic repository for errors and reports any errors it finds. | +| [rebuild-index](#rebuild-index) | Create a new index based on the pack files in the restic repository | ## Create Command @@ -118,7 +120,7 @@ Available command for `kubectl stash` cli are: To create a `Repository`, you need to provide a `Repository` name and backend information and credential. You will provide the information and credential by using flags. The available flags are: | Flag | Description | -| ------------------- | ----------------------------------------------------------------------------- | +|---------------------|-------------------------------------------------------------------------------| | `--namespace` | Indicates the namespace where the Repository will be created | | `--secret` | Specify the name of the storage secret that will be used to create Repository | | `--bucket` | Specify the name of the cloud bucket/container. | @@ -144,13 +146,13 @@ $ kubectl stash create repository gcs-repo --namespace=demo --secret=gcs-secret To create a `BackupConfiguration`, you need to provide `BackupConfiguration` name, `Repository` name, Target, and RetentionPolicy, etc. You will provide the `Repository` name, Target, RetentionPolicy by using flags. The available flags are: | Flag | Description | -| ----------------------- | ---------------------------------------------------------------------------------------------- | +|-------------------------|------------------------------------------------------------------------------------------------| | `--namespace` | Indicates the namespace where the `BackupConfiguration` will be created | | `--target-apiversion` | Specify API-Version of the target resource. | | `--target-kind` | Specify kind of the target resource. | | `--target-name` | Specify name of the target resource. | -| `--repo-name` | Specify name of the `Repository` that will be created. | -| `--repo-namespace` | Specify namespace of the `Repository` that will be created. | +| `--repo-name` | Specify name of the `Repository` that will be created. | +| `--repo-namespace` | Specify namespace of the `Repository` that will be created. | | `--schedule` | Specify schedule of the backup. | | `--driver` | `Driver` indicates the mechanism used to backup (i.e. VolumeSnapshotter, Restic) | | `--task` | Specify name of a `Task` | @@ -186,13 +188,13 @@ $ kubectl stash create backupconfig ss-backup --namespace=demo --repo-name=gcs-r To create a `RestoreSession`, you need to provide a `Repository` name, Target or `VolumeClaimTemplate`, etc. You will provide the `Repository` name, Target or `VolumeClaimTemplate` by using flags. The available flags are: | Flag | Description | -| ---------------------- | ------------------------------------------------------------------------------ | +|------------------------|--------------------------------------------------------------------------------| | `--namespace` | Indicates the namespace where the `RestoreSession` will be created | | `--target-apiversion` | API-Version of the target resource. | | `--target-kind` | Specify kind of the target resource. | | `--target-name` | Specify name of the target resource. | -| `--repo-name` | specify name of the `Repository`. | -| `--repo-namespace` | specify namespace of the `Repository` | +| `--repo-name` | specify name of the `Repository`. | +| `--repo-namespace` | specify namespace of the `Repository` | | `--driver` | Driver indicates the mechanism used to backup (i.e. VolumeSnapshotter, Restic) | | `--task` | Name of the Task | | `--replica` | Replica specifies the number of replicas whose data should be backed up. | @@ -228,9 +230,9 @@ $ kubectl stash create restoresession ss-restore --namespace=demo --repo-name=gc To copy a Secret, you need to provide Secret name and destination namespace. You will provide the destination namespace by using flag. The available flags are: -| Flag | Description | -| ---------------- |----------------------------------------------------------------------| -| `--namespace` | Indicates the namespace of the respective `Secret`. | +| Flag | Description | +|------------------|------------------------------------------------------------------------| +| `--namespace` | Indicates the namespace of the respective `Secret`. | | `--to-namespace` | Indicates the destination namespace where the `Secret` will be copied. | **Format:** @@ -254,9 +256,9 @@ To copy a Repository, you need to provide a Repository name and destination name You will provide the destination namespace by using flag. The available flags are: -| Flag | Description | -| ---------------- |-----------------------------------------------------------------------| -| `--namespace` | Indicates the namespace of the respective `Repository`. | +| Flag | Description | +|------------------|----------------------------------------------------------------------------| +| `--namespace` | Indicates the namespace of the respective `Repository`. | | `--to-namespace` | Indicates the destination namespace where the `Repository` will be copied. | **Format:** @@ -282,7 +284,7 @@ To copy a BackupConfiguration, you need to provide BackupConfiguration name and You will provide the destination namespace by using flags. The available flags are: | Flag | Description | -| ---------------- |-------------------------------------------------------------------------------------| +|------------------|-------------------------------------------------------------------------------------| | `--namespace` | Indicates the namespace of the respective `BackupConfiguration`. | | `--to-namespace` | Indicates the destination namespace where the `BackupConfiguration` will be copied. | @@ -303,7 +305,7 @@ $ kubectl stash cp backupconfig my-backupconfig --namespace=demo --to-namespace= To copy a VolumeSnapshot, you need to provide `VolumeSnapshot` name and destination namespace. You will provide the destination namespace by using flag. The available flags are: | Flag | Description | -| ---------------- |--------------------------------------------------------------------------------| +|------------------|--------------------------------------------------------------------------------| | `--namespace` | Indicates the namespace of the respective `VolumeSnapshot`. | | `--to-namespace` | Indicates the destination namespace where the `VolumeSnapshot` will be copied. | @@ -326,7 +328,7 @@ To clone a PVC, you need to provide backend credentials for creating Repository. You will provide the backend credential by using flags. The available flags are: | Flag | Description | -| ------------------- |-------------------------------------------------------------------------------| +|---------------------|-------------------------------------------------------------------------------| | `--namespace` | Indicates namespace of the respective pvc. | | `--to-namespace` | Indicates the destination namespace where the PVC will be cloned. | | `--secret` | Specify the name of the storage secret that will be used to create Repository | @@ -595,7 +597,8 @@ $ kubectl stash key remove my-repo --namespace=demo --id cdc89a7d ## Generate Rules -`kubectl stash debug` command is used to create rules for a RestoreSession to recover the database and application backups. This command finds the nearest repository snapshots for a given timestamp and generates two rules: one for the snapshots just before the specified timestamp and another for those at or after the specified timestamp. The available flags for this command are: +`kubectl stash gen rules` command is used to create rules for a RestoreSession to recover the database and application +backups. This command finds the nearest repository snapshots for a given timestamp and generates two rules: one for the snapshots just before the specified timestamp and another for those at or after the specified timestamp. The available flags for this command are: | Flag | Description | |----------------------|-------------------------------------------------------------| @@ -614,3 +617,47 @@ kubectl stash gen rules [flags] ```bash $ kubectl stash gen rules my-repo --namespace=demo --timestamp 2023-10-05T05:16:11Z ``` + +## Check Repository + +`kubectl stash check` command is used to test the restic repository for errors and reports any errors it finds. It can also be used to read all data and therefore simulate a restore. By default, the command will always load all data directly from the repository and not use a local cache. The available flags for this command are: + +| Flag | Description | +|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--namespace` | Indicates the namespace of the respective `Repository`. | +| `--read-data` | Read all data blobs. | +| `--with-cache` | Use existing cache, only read uncached data from repository. | +| `--read-data-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 | + +**Format** + +```bash +kubectl stash check [flags] +``` + +**Example** + +```bash +$ kubectl stash check my-repo --namespace=demo --read-data +``` + +## Rebuild Index + +`kubectl stash rebuild-index` command is used to create a new index based on the pack files in the restic repository. + +| Flag | Description | +|--------------------|---------------------------------------------------------| +| `--namespace` | Indicates the namespace of the respective `Repository`. | +| `--read-all-packs` | Read all pack files to generate new index from scratch. | + +**Format** + +```bash +kubectl stash rebuild-index [flags] +``` + +**Example** + +```bash +$ kubectl stash rebuild-index my-repo --namespace=demo --read-all-packs +``` \ No newline at end of file diff --git a/content/docs/v2024.8.27/guides/hooks/overview/images/job-model.svg b/content/docs/v2024.8.27/guides/hooks/overview/images/job-model.svg index f31032cd4d..d198f850a3 100644 --- a/content/docs/v2024.8.27/guides/hooks/overview/images/job-model.svg +++ b/content/docs/v2024.8.27/guides/hooks/overview/images/job-model.svg @@ -1,1058 +1 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + \ No newline at end of file diff --git a/content/docs/v2024.8.27/guides/hooks/overview/index.md b/content/docs/v2024.8.27/guides/hooks/overview/index.md index 7abfaab29b..8fbe36f5c1 100644 --- a/content/docs/v2024.8.27/guides/hooks/overview/index.md +++ b/content/docs/v2024.8.27/guides/hooks/overview/index.md @@ -121,13 +121,15 @@ Here, we are going to discuss how Stash executes the hooks in different scenario
Fig: Hook Execution flow in sidecar model
-- **Job Model:** In Job model, `httpGet`, `httpPost` and `tcpSocket` are executed by the backup/restore job. However, the `exec` hook is executed in the targeted application pod. In order to determine the targeted application pod, Stash uses the `Service` specified in the respective `AppBinding` crd. It first determines the endpoints of the Service. Then, it executes the hook into one of the pod pointed by those endpoints. Hence, if the `AppBinding` points to an external URL, it is not possible for Stash to execute the `exec` hook. The hook execution flow in job model is shown in the following diagram: +- **Job Model:** In the Job model, the hooks are run by the backup/restore job. For the `exec` hook, the command is executed inside the targeted application pod. In order to determine the targeted application pod, Stash uses the `Service` specified in the respective `AppBinding` CRD. It first determines the endpoints of the Service. Then, it executes the hook into one of the pod pointed by those endpoints. Hence, if the `AppBinding` points to an external URL, it is not possible for Stash to execute the hook. The hook execution flow in job model is shown in the following diagram:
  Hook Execution flow in job model
Fig: Hook Execution flow in job model
+> Note: If the postBackup hook doesn't run (e.g., because of a timeout, backup disruption, etc.), the Stash operator will handle it instead of the backup job. However, if the preBackup hook is configured but doesn’t execute or fails the postBackup hook will not be run. + - **Batch Backup:** In batch backup using `BackupBatch` object, the global hooks are executed by the Stash operator itself. When Stash operator completes executing the global pre-task hook, the individual targets start executing their local pre-task hook. Then, they complete their backup process and executes their local post-task hook. Finally, the Stash operator executes global post-task hooks. The hook execution flow in batch backup is shown in the following diagram:
@@ -156,6 +158,8 @@ If the backup or restore process fails then the respective `postBackup` or `post - `OnFailure`: The hook will be executed after the backup/restore process only if the backup/restore has failed. - `OnFinalRetryFailure`: The hook will be executed after the backup process only if the backup has failed with no more retry attempts left. +In case of backup job, if the postBackup hook container doesn't run for any reason, the postBackup hook is executed by the Stash operator instead of the backup job (if targeted application is not `AppBinding`). For `AppBinding`, hook is executed in the targeted application pod. + If the `postBackup` or `postRestore` hook fails, the respective BackupSession or RestoreSession will be marked as `Failed`. ## Templating Support in Hook diff --git a/content/docs/v2024.8.27/reference/cli/kubectl-stash.md b/content/docs/v2024.8.27/reference/cli/kubectl-stash.md index dc641d5af1..59e3411c0b 100644 --- a/content/docs/v2024.8.27/reference/cli/kubectl-stash.md +++ b/content/docs/v2024.8.27/reference/cli/kubectl-stash.md @@ -84,7 +84,7 @@ kubectl plugin for Stash by AppsCode ### Synopsis -kubectl plugin for Stash by AppsCode. For more information, visit here: https://appscode.com/products/stash +kubectl plugin for Stash by AppsCode. For more information, visit here: https://stash.run ### Options @@ -113,6 +113,7 @@ kubectl plugin for Stash by AppsCode. For more information, visit here: https:// ### SEE ALSO +* [kubectl-stash check](/docs/v2024.8.27/reference/cli/kubectl-stash_check) - Check the repository for errors * [kubectl-stash clone](/docs/v2024.8.27/reference/cli/kubectl-stash_clone) - Clone Kubernetes resources * [kubectl-stash completion](/docs/v2024.8.27/reference/cli/kubectl-stash_completion) - Generate completion script * [kubectl-stash cp](/docs/v2024.8.27/reference/cli/kubectl-stash_cp) - Copy stash resources from one namespace to another namespace @@ -123,6 +124,7 @@ kubectl plugin for Stash by AppsCode. For more information, visit here: https:// * [kubectl-stash gen](/docs/v2024.8.27/reference/cli/kubectl-stash_gen) - generate stash resources * [kubectl-stash key](/docs/v2024.8.27/reference/cli/kubectl-stash_key) - manages restic keys (passwords) for accessing the repository * [kubectl-stash pause](/docs/v2024.8.27/reference/cli/kubectl-stash_pause) - Pause Stash backup temporarily +* [kubectl-stash rebuild-index](/docs/v2024.8.27/reference/cli/kubectl-stash_rebuild-index) - Build a new index * [kubectl-stash resume](/docs/v2024.8.27/reference/cli/kubectl-stash_resume) - Resume Stash backup * [kubectl-stash trigger](/docs/v2024.8.27/reference/cli/kubectl-stash_trigger) - Trigger a backup * [kubectl-stash unlock](/docs/v2024.8.27/reference/cli/kubectl-stash_unlock) - Unlock restic repository diff --git a/content/docs/v2024.8.27/reference/cli/kubectl-stash_check.md b/content/docs/v2024.8.27/reference/cli/kubectl-stash_check.md new file mode 100644 index 0000000000..6ba30bc62d --- /dev/null +++ b/content/docs/v2024.8.27/reference/cli/kubectl-stash_check.md @@ -0,0 +1,121 @@ +--- +title: Check +menu: + docs_v2024.8.27: + identifier: kubectl-stash-check + name: Check + parent: reference-cli +menu_name: docs_v2024.8.27 +section_menu_id: reference +info: + cli: v0.35.0 + community: v0.35.0 + elasticsearch: + - 5.6.4-v32 + - 6.2.4-v32 + - 6.3.0-v32 + - 6.4.0-v32 + - 6.5.3-v32 + - 6.8.0-v32 + - 7.14.0-v18 + - 7.2.0-v32 + - 7.3.2-v32 + - 8.2.0-v15 + enterprise: v0.35.0 + etcd: + - 3.5.0-v19 + installer: v2024.8.27 + kubedump: + - 0.1.0-v15 + mariadb: + - 10.5.8-v26 + mongodb: + - 3.4.17-v32 + - 3.4.22-v32 + - 3.6.13-v32 + - 3.6.8-v32 + - 4.0.11-v32 + - 4.0.3-v32 + - 4.0.5-v32 + - 4.1.13-v32 + - 4.1.4-v32 + - 4.1.7-v32 + - 4.2.3-v32 + - 4.4.6-v23 + - 5.0.15-v5 + - 5.0.3-v20 + - 6.0.5-v8 + mysql: + - 5.7.25-v32 + - 8.0.14-v32 + - 8.0.21-v26 + - 8.0.3-v32 + nats: + - 2.6.1-v20 + - 2.8.2-v15 + percona-xtradb: + - 5.7-v27 + postgres: + - 10.14-v31 + - 11.9-v31 + - 12.4-v31 + - 13.1-v28 + - 14.0-v20 + - 15.1-v12 + - 16.1-v1 + - 9.6.19-v31 + redis: + - 5.0.13-v20 + - 6.2.5-v20 + - 7.0.5-v13 + ui-server: v0.16.0 + vault: + - 1.10.3-v12 + version: v2024.8.27 +--- + +## 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/v2024.8.27/reference/cli/kubectl-stash) - kubectl plugin for Stash by AppsCode + diff --git a/content/docs/v2024.8.27/reference/cli/kubectl-stash_rebuild-index.md b/content/docs/v2024.8.27/reference/cli/kubectl-stash_rebuild-index.md new file mode 100644 index 0000000000..be90931ec0 --- /dev/null +++ b/content/docs/v2024.8.27/reference/cli/kubectl-stash_rebuild-index.md @@ -0,0 +1,119 @@ +--- +title: Rebuild-Index +menu: + docs_v2024.8.27: + identifier: kubectl-stash-rebuild-index + name: Rebuild-Index + parent: reference-cli +menu_name: docs_v2024.8.27 +section_menu_id: reference +info: + cli: v0.35.0 + community: v0.35.0 + elasticsearch: + - 5.6.4-v32 + - 6.2.4-v32 + - 6.3.0-v32 + - 6.4.0-v32 + - 6.5.3-v32 + - 6.8.0-v32 + - 7.14.0-v18 + - 7.2.0-v32 + - 7.3.2-v32 + - 8.2.0-v15 + enterprise: v0.35.0 + etcd: + - 3.5.0-v19 + installer: v2024.8.27 + kubedump: + - 0.1.0-v15 + mariadb: + - 10.5.8-v26 + mongodb: + - 3.4.17-v32 + - 3.4.22-v32 + - 3.6.13-v32 + - 3.6.8-v32 + - 4.0.11-v32 + - 4.0.3-v32 + - 4.0.5-v32 + - 4.1.13-v32 + - 4.1.4-v32 + - 4.1.7-v32 + - 4.2.3-v32 + - 4.4.6-v23 + - 5.0.15-v5 + - 5.0.3-v20 + - 6.0.5-v8 + mysql: + - 5.7.25-v32 + - 8.0.14-v32 + - 8.0.21-v26 + - 8.0.3-v32 + nats: + - 2.6.1-v20 + - 2.8.2-v15 + percona-xtradb: + - 5.7-v27 + postgres: + - 10.14-v31 + - 11.9-v31 + - 12.4-v31 + - 13.1-v28 + - 14.0-v20 + - 15.1-v12 + - 16.1-v1 + - 9.6.19-v31 + redis: + - 5.0.13-v20 + - 6.2.5-v20 + - 7.0.5-v13 + ui-server: v0.16.0 + vault: + - 1.10.3-v12 + version: v2024.8.27 +--- + +## 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/v2024.8.27/reference/cli/kubectl-stash) - kubectl plugin for Stash by AppsCode + diff --git a/content/docs/v2024.8.27/reference/operator/stash.md b/content/docs/v2024.8.27/reference/operator/stash.md index 963b9222e3..bd00b1825f 100644 --- a/content/docs/v2024.8.27/reference/operator/stash.md +++ b/content/docs/v2024.8.27/reference/operator/stash.md @@ -84,7 +84,7 @@ Stash by AppsCode - Backup your Kubernetes Volumes ### Synopsis -Stash is a Kubernetes operator for restic. For more information, visit here: https://appscode.com/products/stash +Stash is a Kubernetes operator for restic. For more information, visit here: https://stash.run ### Options diff --git a/data/products/kubestash.json b/data/products/kubestash.json index 8ebd956198..967fbcdd3e 100644 --- a/data/products/kubestash.json +++ b/data/products/kubestash.json @@ -176,6 +176,15 @@ "hostDocs": false, "show": true }, + { + "version": "v2024.8.30", + "hostDocs": true, + "show": true, + "info": { + "cli": "v0.11.0", + "installer": "v2024.8.30" + } + }, { "version": "v2024.8.14", "hostDocs": true, @@ -222,7 +231,7 @@ } } ], - "latestVersion": "v2024.8.14", + "latestVersion": "v2024.8.30", "socialLinks": { "facebook": "https://facebook.com/appscode", "github": "https://github.com/kubestash", diff --git a/data/products/voyager.json b/data/products/voyager.json index 2e4b963d1b..942ab0d31f 100644 --- a/data/products/voyager.json +++ b/data/products/voyager.json @@ -131,6 +131,15 @@ "hostDocs": false, "show": true }, + { + "version": "v2024.8.30", + "hostDocs": true, + "show": true, + "info": { + "cli": "v0.0.16", + "installer": "v2024.8.30" + } + }, { "version": "v2024.3.18", "hostDocs": true, @@ -443,7 +452,7 @@ "hostDocs": false } ], - "latestVersion": "v2024.3.18", + "latestVersion": "v2024.8.30", "socialLinks": { "facebook": "https://facebook.com/appscode", "github": "https://github.com/voyagermesh/voyager",