Skip to content

Commit

Permalink
docs: Polished sections
Browse files Browse the repository at this point in the history
  • Loading branch information
Julien Ruaux committed Jun 2, 2023
1 parent 5376eee commit ed97bad
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
20 changes: 10 additions & 10 deletions docs/guide/src/docs/asciidoc/elasticache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ IMPORTANT: It is recommended to read the <<_replicate,Replication>> section to f

== Setup

.Prerequisites
=== Prerequisites

For this recipe you will require the following resources:

Expand All @@ -28,7 +28,7 @@ Refer to https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Endpoints.h
For a live migration you need to enable keyspace notifications on your Elasticache instance (see {link_ec_notifications}).
====

.Migration Host
=== Migration Host

To run the migration tool we will need an EC2 instance.

Expand Down Expand Up @@ -62,7 +62,7 @@ redis-cli -h <ec primary endpoint> -p 6379
Ensure that the above command allows you to connect to the remote Elasticache database successfully.


.Installing {project-title}
=== Installing {project-title}

Let's install {project-title} on the EC2 instance we set up previously.
For this we'll follow the steps for <<_linux_install,installing on Linux>>.
Expand All @@ -72,13 +72,13 @@ For this we'll follow the steps for <<_linux_install,installing on Linux>>.
We are now all set to begin the migration process.
The options you will use depend on your source and target databases, as well as the replication mode (snapshot or live).

.EC Single Master -> RE
=== EC Single Master -> RE
[source]
----
riot -h <source EC host> -p <source EC port> replicate -h <target RE host> -p <target RE port> --pass <RE password>
----

.Live EC Single Master -> RE
=== Live EC Single Master -> RE
[source]
----
riot -h <source EC host> -p <source EC port> replicate --mode live -h <target RE host> -p <target RE port> --pass <RE password>
Expand All @@ -93,7 +93,7 @@ riot -h <source EC host> -p <source EC port> --tls --pass <token> replicate -h <
----
====

.EC Cluster -> RE
=== EC Cluster -> RE

[source]
----
Expand All @@ -103,20 +103,20 @@ riot -h <source EC host> -p <source EC port> --cluster replicate -h <target RE h
NOTE: `--cluster` is an important parameter used ONLY for ElastiCache whenever cluster-mode is enabled.
Do note that the source database is specified first and the target database is specified after the replicate command and it is applicable for all the scenarios.

.EC Single Master -> RE (with specific DB namespace)
=== EC Single Master -> RE (with specific db index)

[source]
----
riot -h <source EC host> -p <source EC port> --db <index> replicate -h <target RE host> -p <target RE port> --pass <RE password>
----

.EC Single Master -> RE with OSS Cluster
=== EC Single Master -> RE with OSS Cluster
[source]
----
riot -h <source EC host> -p <source EC port> replicate -h <target RE host> -p <target RE port> --pass <RE password> --cluster
----

.Live EC Cluster -> RE with OSS Cluster
=== Live EC Cluster -> RE with OSS Cluster

[source]
----
Expand All @@ -132,7 +132,7 @@ riot -h <source EC host> -p <source EC port> --cluster replicate --mode live -h

== Troubleshooting

.Authentication Required
=== Authentication Required
You might face this error message while running the migration tool:

[source]
Expand Down
3 changes: 1 addition & 2 deletions docs/guide/src/docs/asciidoc/faker-import.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ To show the full usage, run:
riot faker-import --help
----


You must specify at least one Redis command as a target.

The keys that will be written are constructed from input records by concatenating the keyspace prefix and key fields.
Expand Down Expand Up @@ -61,7 +60,7 @@ riot faker-import lease="number.digits(2)"

Refer to {link_datafaker_doc} for complete documentation.

.RediSearch
== RediSearch

You can infer Faker fields from a RediSearch index using the `--infer` option:

Expand Down
6 changes: 3 additions & 3 deletions docs/guide/src/docs/asciidoc/usage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
{project-title} can be installed in different ways depending on your environment and preference.

[[_macos_install]]
.Homebrew (macOS)
=== Homebrew (macOS)

[source]
----
brew install redis-developer/tap/riot
----

[[_windows_install]]
.Scoop (Windows)
=== Scoop (Windows)

[source]
----
Expand All @@ -23,7 +23,7 @@ scoop install riot
----

[[_linux_install]]
.Download and run (Linux)
=== Download and run (Linux)

{project-title} requires Java and the easiest option is to use the version packaged with Ubuntu.
By default Ubuntu 18.04 includes Open JDK 11.
Expand Down

0 comments on commit ed97bad

Please sign in to comment.