github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/docs/user_docs/cli/kbcli_dataprotection_backup.md (about)

     1  ---
     2  title: kbcli dataprotection backup
     3  ---
     4  
     5  Create a backup for the cluster.
     6  
     7  ```
     8  kbcli dataprotection backup NAME [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14    # Create a backup for the cluster, use the default backup policy and volume snapshot backup method
    15    kbcli dp backup mybackup --cluster mycluster
    16    
    17    # create a backup with a specified method, run "kbcli cluster desc-backup-policy mycluster" to show supported backup methods
    18    kbcli dp backup mybackup --cluster mycluster --method mymethod
    19    
    20    # create a backup with specified backup policy, run "kbcli cluster list-backup-policy mycluster" to show the cluster supported backup policies
    21    kbcli dp backup mybackup --cluster mycluster --policy mypolicy
    22    
    23    # create a backup from a parent backup
    24    kbcli dp backup mybackup --cluster mycluster --parent-backup myparentbackup
    25  ```
    26  
    27  ### Options
    28  
    29  ```
    30        --cluster string            Cluster name
    31        --deletion-policy string    Deletion policy for backup, determine whether the backup content in backup repo will be deleted after the backup is deleted, supported values: [Delete, Retain] (default "Delete")
    32    -h, --help                      help for backup
    33        --method string             Backup methods are defined in backup policy (required), if only one backup method in backup policy, use it as default backup method, if multiple backup methods in backup policy, use method which volume snapshot is true as default backup method
    34        --parent-backup string      Parent backup name, used for incremental backup
    35        --policy string             Backup policy name, if not specified, use the cluster default backup policy
    36        --retention-period string   Retention period for backup, supported values: [1y, 1mo, 1d, 1h, 1m] or combine them [1y1mo1d1h1m], if not specified, the backup will not be automatically deleted, you need to manually delete it.
    37  ```
    38  
    39  ### Options inherited from parent commands
    40  
    41  ```
    42        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    43        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    44        --as-uid string                  UID to impersonate for the operation.
    45        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    46        --certificate-authority string   Path to a cert file for the certificate authority
    47        --client-certificate string      Path to a client certificate file for TLS
    48        --client-key string              Path to a client key file for TLS
    49        --context string                 The name of the kubeconfig context to use
    50        --disable-compression            If true, opt-out of response compression for all requests to the server
    51        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    52        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    53        --match-server-version           Require server version to match client version
    54    -n, --namespace string               If present, the namespace scope for this CLI request
    55        --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")
    56    -s, --server string                  The address and port of the Kubernetes API server
    57        --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
    58        --token string                   Bearer token for authentication to the API server
    59        --user string                    The name of the kubeconfig user to use
    60  ```
    61  
    62  ### SEE ALSO
    63  
    64  * [kbcli dataprotection](kbcli_dataprotection.md)	 - Data protection command.
    65  
    66  #### Go Back to [CLI Overview](cli.md) Homepage.
    67