Create release v2.4.0

nuodb · Mar 5, 2024 · 9af7829 · 9af7829
1 parent d0acca0
commit 9af7829
Show file tree

Hide file tree

Showing 2 changed files with 2,108 additions and 322 deletions.
diff --git a/nuodb-cp.adoc b/nuodb-cp.adoc
@@ -1,4 +1,4 @@
-:revnumber: 2.3.0
+:revnumber: 2.4.0
 :toc: left
 
 [#nuodb-cp]
@@ -7,7 +7,8 @@
 Command-line interface for the NuoDB Control Plane REST Service
 
 ....
-nuodb-cp [-hV] [database
+nuodb-cp [-hV] [backup
+               |database
                |project
                |user
                |httpclient
@@ -27,6 +28,253 @@ nuodb-cp [-hV] [database
 
 |===
 
+[#backup]
+== backup
+
+Inspect and manage backups using the DBaaS REST service
+
+....
+nuodb-cp backup [-hV] [list
+                      |get
+                      |create
+                      |update
+                      |delete]
+....
+
+[cols="1,3"]
+|===
+|`-h, --help`
+|Show this help message and exit.
+
+|`-V, --version`
+|Print version information and exit.
+
+|===
+
+[#backup-list]
+=== list
+
+List backups
+
+....
+nuodb-cp backup list [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
+                     [--trusted-cert=<trustedCert>] [-l=<labelFilter>]...
+                     [--list-accessible] RESOURCE
+....
+
+[cols="1,3"]
+|===
+|`RESOURCE`
+|The fully-qualified name of the resource containing backups to list, e.g. `<organization>/<project>/<database>` for a database, `<organization>/<project>` for a project, `<organization>` for an organization, or `/` to list backups across all organizations
+
+|`-b, --url-base`
+|The base URL for the server, including the protocol +
+*default*: `${NUODB_CP_URL_BASE:-http://localhost:8080}`
+
+|`-u, --user`
+|The name of the user issuing the request +
+*default*: `${NUODB_CP_USER}`
+
+|`-p, --password`
+|The password to authenticate the user +
+*default*: `${NUODB_CP_PASSWORD}`
+
+|`--trusted-cert`
+|The certificate used to verify the HTTPS server in PEM format +
+*default*: `${NUODB_CP_TRUSTED_CERT}`
+
+|`-l, --label-filter`
+|Filter to apply based on labels
+
+|`--list-accessible`
+|Whether to return any accessible sub-resources even if the current user does not have access privileges to list all resources at this level
+
+|`-h, --help`
+|Show this help message and exit.
+
+|`-V, --version`
+|Print version information and exit.
+
+|===
+
+[#backup-get]
+=== get
+
+Get an existing backup
+
+....
+nuodb-cp backup get [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
+                    [--trusted-cert=<trustedCert>] BACKUP
+....
+
+[cols="1,3"]
+|===
+|`BACKUP`
+|The fully-qualified name of the backup in the format `<organization>/<project>/<database>/<backup>`
+
+|`-b, --url-base`
+|The base URL for the server, including the protocol +
+*default*: `${NUODB_CP_URL_BASE:-http://localhost:8080}`
+
+|`-u, --user`
+|The name of the user issuing the request +
+*default*: `${NUODB_CP_USER}`
+
+|`-p, --password`
+|The password to authenticate the user +
+*default*: `${NUODB_CP_PASSWORD}`
+
+|`--trusted-cert`
+|The certificate used to verify the HTTPS server in PEM format +
+*default*: `${NUODB_CP_TRUSTED_CERT}`
+
+|`-h, --help`
+|Show this help message and exit.
+
+|`-V, --version`
+|Print version information and exit.
+
+|===
+
+[#backup-create]
+=== create
+
+Create a new backup
+
+....
+nuodb-cp backup create [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
+                       [--trusted-cert=<trustedCert>] [-l=<String=String>]...
+                       [--import-source-handle=<backupHandle>]
+                       [--import-source-plugin=<backupPlugin>] BACKUP BACKUP
+....
+
+[cols="1,3"]
+|===
+|`BACKUP`
+|The fully-qualified name of the backup in the format `<organization>/<project>/<database>/<backup>`
+
+|`BACKUP`
+|The fully-qualified name of the backup to create in the format `<organization>/<project>/<database>/<backup>`, or the database name in the format `<organization>/<project>/<database>` for an on-demand backup
+
+|`-b, --url-base`
+|The base URL for the server, including the protocol +
+*default*: `${NUODB_CP_URL_BASE:-http://localhost:8080}`
+
+|`-u, --user`
+|The name of the user issuing the request +
+*default*: `${NUODB_CP_USER}`
+
+|`-p, --password`
+|The password to authenticate the user +
+*default*: `${NUODB_CP_PASSWORD}`
+
+|`--trusted-cert`
+|The certificate used to verify the HTTPS server in PEM format +
+*default*: `${NUODB_CP_TRUSTED_CERT}`
+
+|`-l, --label`
+|Label to attach to resource
+
+|`--import-source-handle`
+|The existing backup handle to import
+
+|`--import-source-plugin`
+|The plugin used to create the backup to import
+
+|`-h, --help`
+|Show this help message and exit.
+
+|`-V, --version`
+|Print version information and exit.
+
+|===
+
+[#backup-update]
+=== update
+
+Update an existing backup
+
+....
+nuodb-cp backup update [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
+                       [--trusted-cert=<trustedCert>] [--editor=<editor>] BACKUP
+....
+
+[cols="1,3"]
+|===
+|`BACKUP`
+|The fully-qualified name of the backup in the format `<organization>/<project>/<database>/<backup>`
+
+|`-b, --url-base`
+|The base URL for the server, including the protocol +
+*default*: `${NUODB_CP_URL_BASE:-http://localhost:8080}`
+
+|`-u, --user`
+|The name of the user issuing the request +
+*default*: `${NUODB_CP_USER}`
+
+|`-p, --password`
+|The password to authenticate the user +
+*default*: `${NUODB_CP_PASSWORD}`
+
+|`--trusted-cert`
+|The certificate used to verify the HTTPS server in PEM format +
+*default*: `${NUODB_CP_TRUSTED_CERT}`
+
+|`--editor`
+|The editor to use to update the resource +
+*default*: `${NUODB_CP_EDITOR:-vi}`
+
+|`-h, --help`
+|Show this help message and exit.
+
+|`-V, --version`
+|Print version information and exit.
+
+|===
+
+[#backup-delete]
+=== delete
+
+Delete an existing backup
+
+....
+nuodb-cp backup delete [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
+                       [--trusted-cert=<trustedCert>] [--timeout=<timeout>]
+                       BACKUP
+....
+
+[cols="1,3"]
+|===
+|`BACKUP`
+|The fully-qualified name of the backup in the format `<organization>/<project>/<database>/<backup>`
+
+|`-b, --url-base`
+|The base URL for the server, including the protocol +
+*default*: `${NUODB_CP_URL_BASE:-http://localhost:8080}`
+
+|`-u, --user`
+|The name of the user issuing the request +
+*default*: `${NUODB_CP_USER}`
+
+|`-p, --password`
+|The password to authenticate the user +
+*default*: `${NUODB_CP_PASSWORD}`
+
+|`--trusted-cert`
+|The certificate used to verify the HTTPS server in PEM format +
+*default*: `${NUODB_CP_TRUSTED_CERT}`
+
+|`--timeout`
+|The number of seconds to wait for the deletion to be finalized, unless 0 is specified which indicates not to wait
+
+|`-h, --help`
+|Show this help message and exit.
+
+|`-V, --version`
+|Print version information and exit.
+
+|===
+
 [#database]
 == database
 
@@ -178,8 +426,7 @@ nuodb-cp database create [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
 |Label to attach to resource
 
 |`--dba-password`
-|The password for the DBA user +
-*default*: `${NUODB_CP_DBA_PASSWORD}`
+|The password for the DBA user
 
 |`--tier`
 |The tier for the database
@@ -342,8 +589,7 @@ nuodb-cp database connect [-sShV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
 *default*: `${NUODB_CP_DB_USER}`
 
 |`--db-password`
-|The password to authenticate the database user +
-*default*: `${NUODB_CP_DB_PASSWORD}`
+|The password to authenticate the database user
 
 |`--ingress-port`
 |The port for the ingress load balancer enabling database connectivity +
@@ -1028,7 +1274,8 @@ Inspect and manage Kubernetes state for the NuoDB Control Plane
 
 ....
 nuodb-cp k8s [-hV] [generate-tls
-                   |create-user]
+                   |create-user
+                   |rotate-dba-creds]
 ....
 
 [cols="1,3"]
@@ -1140,6 +1387,41 @@ nuodb-cp k8s create-user [-chV] [--password[=<password>]] -p=<project> [-ap
 
 |===
 
+[#k8s-rotate-dba-creds]
+=== rotate-dba-creds
+
+Rotate DBA credentials for a NuoDB database
+
+....
+nuodb-cp k8s rotate-dba-creds [-hV] [--dba-password[=<dbaPassword>]]
+                              [--finalize] ORGANIZATION PROJECT DATABASE
+....
+
+[cols="1,3"]
+|===
+|`ORGANIZATION`
+|The name of the organization for the target database
+
+|`PROJECT`
+|The name of the project for the target database
+
+|`DATABASE`
+|The name of the database which credentials are being rotated
+
+|`--dba-password`
+|The target password for the DBA user
+
+|`--finalize`
+|Finalize database DBA password rotation to make the target DBA password current
+
+|`-h, --help`
+|Show this help message and exit.
+
+|`-V, --version`
+|Print version information and exit.
+
+|===
+
 [#generate-completion]
 == generate-completion