HBASE-16412 Warnings from asciidoc
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/0ef41f89 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/0ef41f89 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/0ef41f89 Branch: refs/heads/HBASE-19064 Commit: 0ef41f895572f0f839782e4c87249e0f2a2af6f1 Parents: 5d1b211 Author: Michael Stack <st...@apache.org> Authored: Thu Mar 22 05:40:37 2018 -0700 Committer: Michael Stack <st...@apache.org> Committed: Thu Mar 22 12:22:29 2018 -0700 ---------------------------------------------------------------------- src/main/asciidoc/_chapters/backup_restore.adoc | 52 +++++++------------ src/main/asciidoc/_chapters/developer.adoc | 12 +++-- .../resources/images/backup-app-components.png | Bin 24366 -> 0 bytes .../resources/images/backup-cloud-appliance.png | Bin 30114 -> 0 bytes .../images/backup-dedicated-cluster.png | Bin 24950 -> 0 bytes .../resources/images/backup-intra-cluster.png | Bin 19348 -> 0 bytes .../resources/images/backup-app-components.png | Bin 0 -> 24366 bytes .../resources/images/backup-cloud-appliance.png | Bin 0 -> 30114 bytes .../images/backup-dedicated-cluster.png | Bin 0 -> 24950 bytes .../resources/images/backup-intra-cluster.png | Bin 0 -> 19348 bytes 10 files changed, 28 insertions(+), 36 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/0ef41f89/src/main/asciidoc/_chapters/backup_restore.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/backup_restore.adoc b/src/main/asciidoc/_chapters/backup_restore.adoc index a9dbcf5..4e6c506 100644 --- a/src/main/asciidoc/_chapters/backup_restore.adoc +++ b/src/main/asciidoc/_chapters/backup_restore.adoc @@ -710,66 +710,54 @@ image::backup-app-components.png[] The following is an outline of the steps and examples of commands that are used to backup the data for the _green_ application and to recover the data later. All commands are run when logged in as HBase superuser. -1. A backup set called _green_set_ is created as an alias for both the transactions table and the customer table. The backup set can +* A backup set called _green_set_ is created as an alias for both the transactions table and the customer table. The backup set can be used for all operations to avoid typing each table name. The backup set name is case-sensitive and should be formed with only printable characters and without spaces. -[source] ----- -$ hbase backup set add green_set transactions -$ hbase backup set add green_set customer ----- + $ hbase backup set add green_set transactions + $ hbase backup set add green_set customer -2. The first backup of green_set data must be a full backup. The following command example shows how credentials are passed to Amazon +* The first backup of green_set data must be a full backup. The following command example shows how credentials are passed to Amazon S3 and specifies the file system with the s3a: prefix. -[source] ----- -$ ACCESS_KEY=ABCDEFGHIJKLMNOPQRST -$ SECRET_KEY=123456789abcdefghijklmnopqrstuvwxyzABCD -$ sudo -u hbase hbase backup create full\ - s3a://$ACCESS_KEY:SECRET_KEY@prodhbasebackups/backups -s green_set ----- + $ ACCESS_KEY=ABCDEFGHIJKLMNOPQRST + $ SECRET_KEY=123456789abcdefghijklmnopqrstuvwxyzABCD + $ sudo -u hbase hbase backup create full\ + s3a://$ACCESS_KEY:SECRET_KEY@prodhbasebackups/backups -s green_set -3. Incremental backups should be run according to a schedule that ensures essential data recovery in the event of a catastrophe. At +* Incremental backups should be run according to a schedule that ensures essential data recovery in the event of a catastrophe. At this retail company, the HBase admin team decides that automated daily backups secures the data sufficiently. The team decides that they can implement this by modifying an existing Cron job that is defined in `/etc/crontab`. Consequently, IT modifies the Cron job by adding the following line: -[source] ----- -@daily hbase hbase backup create incremental s3a://$ACCESS_KEY:$SECRET_KEY@prodhbasebackups/backups -s green_set ----- + @daily hbase hbase backup create incremental s3a://$ACCESS_KEY:$SECRET_KEY@prodhbasebackups/backups -s green_set -4. A catastrophic IT incident disables the production cluster that the green application uses. An HBase system administrator of the +* A catastrophic IT incident disables the production cluster that the green application uses. An HBase system administrator of the backup cluster must restore the _green_set_ dataset to the point in time closest to the recovery objective. - ++ NOTE: If the administrator of the backup HBase cluster has the backup ID with relevant details in accessible records, the following search with the `hdfs dfs -ls` command and manually scanning the backup ID list can be bypassed. Consider continuously maintaining and protecting a detailed log of backup IDs outside the production cluster in your environment. - ++ The HBase administrator runs the following command on the directory where backups are stored to print the list of successful backup IDs on the console: -`hdfs dfs -ls -t /prodhbasebackups/backups` + `hdfs dfs -ls -t /prodhbasebackups/backups` -5. The admin scans the list to see which backup was created at a date and time closest to the recovery objective. To do this, the +* The admin scans the list to see which backup was created at a date and time closest to the recovery objective. To do this, the admin converts the calendar timestamp of the recovery point in time to Unix time because backup IDs are uniquely identified with Unix time. The backup IDs are listed in reverse chronological order, meaning the most recent successful backup appears first. - ++ The admin notices that the following line in the command output corresponds with the _green_set_ backup that needs to be restored: -`/prodhbasebackups/backups/backup_1467823988425` + /prodhbasebackups/backups/backup_1467823988425` -6. The admin restores green_set invoking the backup ID and the -overwrite option. The -overwrite option truncates all existing data +* The admin restores green_set invoking the backup ID and the -overwrite option. The -overwrite option truncates all existing data in the destination and populates the tables with data from the backup dataset. Without this flag, the backup data is appended to the existing data in the destination. In this case, the admin decides to overwrite the data because it is corrupted. -[source] ----- -$ sudo -u hbase hbase restore -s green_set \ - s3a://$ACCESS_KEY:$SECRET_KEY@prodhbasebackups/backups backup_1467823988425 \ -overwrite ----- + $ sudo -u hbase hbase restore -s green_set \ + s3a://$ACCESS_KEY:$SECRET_KEY@prodhbasebackups/backups backup_1467823988425 \ -overwrite [[br.data.security]] ## Security of Backup Data http://git-wip-us.apache.org/repos/asf/hbase/blob/0ef41f89/src/main/asciidoc/_chapters/developer.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/developer.adoc b/src/main/asciidoc/_chapters/developer.adoc index 155c808..5509d8c 100644 --- a/src/main/asciidoc/_chapters/developer.adoc +++ b/src/main/asciidoc/_chapters/developer.adoc @@ -786,14 +786,18 @@ Make sure you are pulling from the repository when tests run and that you are no ==== See link:https://www.apache.org/dev/publishing-maven-artifacts.html[Publishing Maven Artifacts] for some pointers on this maven staging process. - ++ If the HBase version ends in `-SNAPSHOT`, the artifacts go elsewhere. They are put into the Apache snapshots repository directly and are immediately available. Making a SNAPSHOT release, this is what you want to happen. - -At this stage, you have two tarballs in your 'build output directory' and a set of artifacts in a staging area of the maven repository, in the 'closed' state. ++ +At this stage, you have two tarballs in your 'build output directory' and a set of artifacts +in a staging area of the maven repository, in the 'closed' state. Next sign, fingerprint and then 'stage' your release candiate build output directory via svnpubsub by committing -your directory to link:https://dist.apache.org/repos/dist/dev/hbase/[The 'dev' distribution directory] (See comments on link:https://issues.apache.org/jira/browse/HBASE-10554[HBASE-10554 Please delete old releases from mirroring system] but in essence it is an svn checkout of https://dist.apache.org/repos/dist/dev/hbase -- releases are at https://dist.apache.org/repos/dist/release/hbase). In the _version directory_ run the following commands: +your directory to link:https://dist.apache.org/repos/dist/dev/hbase/[The dev distribution directory] +(See comments on link:https://issues.apache.org/jira/browse/HBASE-10554[HBASE-10554 Please delete old releases from mirroring system] +but in essence it is an svn checkout of link:https://dist.apache.org/repos/dist/dev/hbase[dev/hbase] -- releases are at +link:https://dist.apache.org/repos/dist/release/hbase[release/hbase]). In the _version directory_ run the following commands: [source,bourne] ---- http://git-wip-us.apache.org/repos/asf/hbase/blob/0ef41f89/src/main/site/resources/images/backup-app-components.png ---------------------------------------------------------------------- diff --git a/src/main/site/resources/images/backup-app-components.png b/src/main/site/resources/images/backup-app-components.png deleted file mode 100644 index 5e403e2..0000000 Binary files a/src/main/site/resources/images/backup-app-components.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/hbase/blob/0ef41f89/src/main/site/resources/images/backup-cloud-appliance.png ---------------------------------------------------------------------- diff --git a/src/main/site/resources/images/backup-cloud-appliance.png b/src/main/site/resources/images/backup-cloud-appliance.png deleted file mode 100644 index 76b6d5a..0000000 Binary files a/src/main/site/resources/images/backup-cloud-appliance.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/hbase/blob/0ef41f89/src/main/site/resources/images/backup-dedicated-cluster.png ---------------------------------------------------------------------- diff --git a/src/main/site/resources/images/backup-dedicated-cluster.png b/src/main/site/resources/images/backup-dedicated-cluster.png deleted file mode 100644 index bca282d..0000000 Binary files a/src/main/site/resources/images/backup-dedicated-cluster.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/hbase/blob/0ef41f89/src/main/site/resources/images/backup-intra-cluster.png ---------------------------------------------------------------------- diff --git a/src/main/site/resources/images/backup-intra-cluster.png b/src/main/site/resources/images/backup-intra-cluster.png deleted file mode 100644 index 113c577..0000000 Binary files a/src/main/site/resources/images/backup-intra-cluster.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/hbase/blob/0ef41f89/src/site/resources/images/backup-app-components.png ---------------------------------------------------------------------- diff --git a/src/site/resources/images/backup-app-components.png b/src/site/resources/images/backup-app-components.png new file mode 100644 index 0000000..5e403e2 Binary files /dev/null and b/src/site/resources/images/backup-app-components.png differ http://git-wip-us.apache.org/repos/asf/hbase/blob/0ef41f89/src/site/resources/images/backup-cloud-appliance.png ---------------------------------------------------------------------- diff --git a/src/site/resources/images/backup-cloud-appliance.png b/src/site/resources/images/backup-cloud-appliance.png new file mode 100644 index 0000000..76b6d5a Binary files /dev/null and b/src/site/resources/images/backup-cloud-appliance.png differ http://git-wip-us.apache.org/repos/asf/hbase/blob/0ef41f89/src/site/resources/images/backup-dedicated-cluster.png ---------------------------------------------------------------------- diff --git a/src/site/resources/images/backup-dedicated-cluster.png b/src/site/resources/images/backup-dedicated-cluster.png new file mode 100644 index 0000000..bca282d Binary files /dev/null and b/src/site/resources/images/backup-dedicated-cluster.png differ http://git-wip-us.apache.org/repos/asf/hbase/blob/0ef41f89/src/site/resources/images/backup-intra-cluster.png ---------------------------------------------------------------------- diff --git a/src/site/resources/images/backup-intra-cluster.png b/src/site/resources/images/backup-intra-cluster.png new file mode 100644 index 0000000..113c577 Binary files /dev/null and b/src/site/resources/images/backup-intra-cluster.png differ
