From 4061db4fa944f0eaf0f3c4bbc0e6b2432bae905e Mon Sep 17 00:00:00 2001 From: Marko Karg Date: Mon, 12 Feb 2018 13:09:43 +0100 Subject: [PATCH] changes to the docs to reflect the move to git based config files --- backup/mkdocs.yml | 23 +++++++++++++++++++++++ docs/gluster-module-2.md | 4 ++-- docs/gluster-module-3.md | 6 +++--- docs/gluster-module-4.md | 6 +++--- docs/gluster-module-5.md | 2 +- docs/gluster-module-6.md | 3 +-- mkdocs.yml | 2 +- 7 files changed, 34 insertions(+), 12 deletions(-) create mode 100644 backup/mkdocs.yml diff --git a/backup/mkdocs.yml b/backup/mkdocs.yml new file mode 100644 index 0000000..dbee113 --- /dev/null +++ b/backup/mkdocs.yml @@ -0,0 +1,23 @@ +site_name: RHGS Test Drive Instructions +site_favicon: images/favicon.ico +copyright: 'Copyright ©2016 Red Hat, Inc.' +markdown_extensions: + - smarty + - toc + - sane_lists + - footnotes + - smart_strong + - codehilite + - nl2br +theme: united +extra: + logo: 'images/Logo_RH_RGB_Default.svg' +pages: +- Introduction: index.md +- Modules: + - 'Module 1 - Introduction to Gluster concepts': gluster-module-1.md + - 'Module 2 - Volume Setup and Client Access': gluster-module-2.md + - 'Module 3 - Volume Operations and Administration': gluster-module-3.md + - 'Module 4 - Disperse Volumes (Erasure Coding)': gluster-module-4.md + - 'Module 5 - Snapshot Operations and Administration': gluster-module-5.md + - 'Module 6 - Geo-Replication and Disaster Recovery': gluster-module-6.md diff --git a/docs/gluster-module-2.md b/docs/gluster-module-2.md index cba4600..f90718e 100644 --- a/docs/gluster-module-2.md +++ b/docs/gluster-module-2.md @@ -220,7 +220,7 @@ You will now build a 2-brick *replicated* volume using the gdeploy method. A rep View the gdeploy configuration file with the below command. ```bash -cat ~/repvol.conf +cat ~/materials/gdeploy/repvol.conf ``` ``[hosts]`` @@ -255,7 +255,7 @@ In order to use `gdeploy`, the node from which it is run requires passwordless s With passwordless ssh configured, you can deploy the **repvol** volume using the `gdeploy` command (NOTE because we rely on the ssh keys, you do not need to use `sudo` for this command). ```bash -gdeploy -vv -c ~/repvol.conf +gdeploy -vv -c ~/materials/gdeploy/repvol.conf ``` ## Viewing Volume Details diff --git a/docs/gluster-module-3.md b/docs/gluster-module-3.md index 7dfaf8a..825f8b3 100644 --- a/docs/gluster-module-3.md +++ b/docs/gluster-module-3.md @@ -30,7 +30,7 @@ ssh student@ If you have not already done so as part of **Module 2**, deploy the **repvol** volume using the provided gdeploy configuration file. ```bash -gdeploy -c ~/repvol.conf +gdeploy -c ~/materials/gdeploy/repvol.conf ``` Confirm the volume configuration. @@ -302,7 +302,7 @@ sudo gluster volume info repvol You will use the `gdeploy` command to create the new brick backends for nodes rhgs3 through rhgs6, and to add these new bricks to the layout of the **repvol** volume. Take a look at the contents of the configuration file. ```bash -cat ~/repvol-expand.conf +cat ~/materials/gdeploy/repvol-expand.conf ``` ``[hosts]`` @@ -327,7 +327,7 @@ cat ~/repvol-expand.conf Use `gdeploy` to make the volume change. ```bash -gdeploy -c ~/repvol-expand.conf +gdeploy -c ~/materials/gdeploy/repvol-expand.conf ``` Take a look at the updated volume configuration. Note the changes to **Type** and **Number of Bricks**, as well as the additional bricks listed. diff --git a/docs/gluster-module-4.md b/docs/gluster-module-4.md index fd4dc34..6657120 100644 --- a/docs/gluster-module-4.md +++ b/docs/gluster-module-4.md @@ -114,17 +114,17 @@ fstype=glusterfs client_mount_points=/rhgs/client/native/ecvol ``` -> **NOTE** You can check your work against the provided `/home/student/example/ecvol.conf` file. +> **NOTE** You can check your work against the provided `/home/student/materials/gdeploy/ecvol.conf` file. ## Deploy and Review your Disperse Volume -Using `gdeploy` and the `/home/student/ecvol.conf` file you've created, automate the deployment of your disperse **ecvol** volume. +Using `gdeploy` and the `/home/student/materials/gdeploy/ecvol.conf` file you've created, automate the deployment of your disperse **ecvol** volume. > **NOTE** The `sudo` tool is not needed for the `gdeploy` command. ```bash -gdeploy -c /home/student/ecvol.conf +gdeploy -c /home/student/materials/gdeploy/ecvol.conf ``` When the deployment completes, you should find that you have a properly-configured and started disperse Gluster volume. diff --git a/docs/gluster-module-5.md b/docs/gluster-module-5.md index fded38c..c956d0a 100644 --- a/docs/gluster-module-5.md +++ b/docs/gluster-module-5.md @@ -65,7 +65,7 @@ Then restart the glusterd service to make make the changes effective: If you have not already done so as part of **Module 2**, deploy the ``distvol`` volume, using the provided gdeploy configuration file. ```bash -gdeploy -c ~/distvol.conf +gdeploy -c ~/materials/gdeploy/distvol.conf ``` Confirm the volume configuration. ```bash diff --git a/docs/gluster-module-6.md b/docs/gluster-module-6.md index 2483c68..4a84ad1 100644 --- a/docs/gluster-module-6.md +++ b/docs/gluster-module-6.md @@ -33,8 +33,7 @@ The cleanup.sh script in student's home will do the following: 1. Stop and delete the volumes "repvol" and "distvol" 2. Remove the nodes "rhgs4", "rhgs5" and "rhgs6" from the pool of trusted nodes -3. Create a ssh key for "root" and copy it to "rhgs4" since password-less root - access is needed later on for the geo-replication. +3. Create a ssh key for "root" and copy it to "rhgs4" since password-less root access is needed later on for the geo-replication. ### MANUAL STEPS diff --git a/mkdocs.yml b/mkdocs.yml index dbee113..139c6f2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: RHGS Test Drive Instructions site_favicon: images/favicon.ico -copyright: 'Copyright ©2016 Red Hat, Inc.' +copyright: 'Copyright ©2018 Red Hat, Inc.' markdown_extensions: - smarty - toc