updated docs and removed proxyjump assumption

Author: TimidRobot

README.md

@@ -2,7 +2,7 @@
 
 Creative Commons Site Reliability Engineering WordPress Data Pull
 
-**:warning: Destroys and replaces destination data**
+> :warning: **Destroys and replaces destination data**
 
 
 ## Code of Conduct
@@ -14,8 +14,8 @@ Creative Commons Site Reliability Engineering WordPress Data Pull
 > behavior to [conduct@creativecommons.org](mailto:conduct@creativecommons.org)
 > per our [reporting guidelines][reporting_guide].
 
-[code_of_conduct]:https://creativecommons.github.io/community/code-of-conduct/
-[reporting_guide]:https://creativecommons.github.io/community/code-of-conduct/enforcement/
+[code_of_conduct]:https://opensource.creativecommons.org/community/code-of-conduct/
+[reporting_guide]:https://opensource.creativecommons.org/community/code-of-conduct/enforcement/
 
 
 ## Contributing
@@ -25,14 +25,22 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md).
 
 ## Assumptions
 
-1. Destination web hosting and WordPress are configured independently (ex. by
-   SaltStack)
-   - `wp-config.php` is already setup
-   - user is a member of `www-data`
-   - [WP-CLI][wp-cli] is installed on the destination host
-2. WordPress source data was created using
-   [/states/wordpress/files/backup_wordpress.sh][backup] found in the
-   [creativecommons/sre-salt-prime][salt-prime] repository.
+1. `DEST_HOST`:
+   1. Web hosting and WordPress are configured independently (ex. by
+      SaltStack)
+      - `wp-config.php` is already setup
+      - user has appopriate permissions (ex. member of `www-data`)
+      - [WP-CLI][wp-cli] is already installed
+   2. You may need to configure your users `.ssh/config`. For example,
+      `chapters_stage` requires the following entry:
+        ```
+        Host 10.22.10.14
+            ProxyJump 10.22.10.10
+        ```
+2. `SOURCE_HOST`:
+   1. WordPress source data was created using
+      [/states/wordpress/files/backup_wordpress.sh][backup] found in the
+      [creativecommons/sre-salt-prime][salt-prime] repository.
 
 [wp-cli]: https://wp-cli.org/
 [salt-prime]: https://github.com/creativecommons/sre-salt-prime
@@ -41,14 +49,20 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md).
 
 ## Use
 
-1. Optionally, run [`backup_wordpress.sh`][backup] on the source host
-2. Clone this repository
-3. Make a copy of one of the appropriate [`config_examples/`](config_examples/)
-   and replace `FILEPATH` and `USERNAME`
-4. Execute script with config file as only argument. For example:
-    ```shell
-    ./wp-pull.sh chapters__stage
-    ```
+1. `SOURCE_HOST`: *(optional)*
+   - run [`backup_wordpress.sh`][backup] on the
+2. Local/laptop:
+   1. Clone this repository
+   2. Prepare configuration file
+      1. Make a copy of one of the appropriate
+         [`config_examples/`](config_examples/)
+      2. Replace `FILEPATH` and `USERNAME` with your information
+      3. Ensure `SOURCE_DB_FILE` and `SOURCE_UPLOADS_FILE` are valid files on
+         the `SOURCE_HOST`.
+   3. Execute script with config file as only argument. For example:
+        ```shell
+        ./wp-pull.sh chapters__stage
+        ```
 
 
 # Alternatives

bin/wp-pull-remote.sh

@@ -147,7 +147,7 @@ display_dest_host_info() {
 display_source_host_info() {
     headerone 'SOURCE_HOST: Info / Connection Validation'
     echo -n "${DKG}LABEL:${RST}               "
-    ssh -t -q -oProxyJump=${BASTION_HOST_REMOTE} ${SOURCE_HOST_REMOTE} '
+    ssh -t -q ${SOURCE_HOST_REMOTE} '
         if [[ -f /etc/salt/minion_id ]]
         then
             cat /etc/salt/minion_id

config_examples/chapters__stage

@@ -1,5 +1,3 @@
-# vim: ft=sshconfig
-#
 # The following are parsed by wp-pull.sh:
 #
 # DEST_DOMAIN: stage.creativecommons.net
@@ -13,12 +11,11 @@
 # SOURCE_UPLOADS_FILE: /var/www/chapters/backup/now/uploads.tgz
 
 
-#pushconfig
 Host bastion-us-east-2
     HostName bastion-us-east-2.creativecommons.org
 
 
-# The wp-pull HostName is the DEST_HOST
+# The wp-pull HostName is the DEST_HOST.
 Host wp-pull
     AddKeysToAgent yes
     ForwardAgent yes
@@ -35,3 +32,6 @@ Host *
     ServerAliveInterval 30
     TCPKeepAlive no
     User USERNAME
+
+
+# vim: ft=sshconfig