Skip to content

Commit

Permalink
changes to the docs to reflect the move to git based config files
Browse files Browse the repository at this point in the history
  • Loading branch information
Marko Karg committed Feb 12, 2018
1 parent 26783e1 commit 4061db4
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 12 deletions.
23 changes: 23 additions & 0 deletions backup/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions docs/gluster-module-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]``
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/gluster-module-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ ssh student@<rhgs1PublicIP>
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.

Expand Down Expand Up @@ -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]``
Expand All @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/gluster-module-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/gluster-module-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions docs/gluster-module-6.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 4061db4

Please sign in to comment.