Skip to content

Commit

Permalink
Updates riak-repl and riak-admin formatting to reflect changes (#266)
Browse files Browse the repository at this point in the history 
* Merge dev into master (#238)

* Add CS 3.0.1 docs (#221)

* Remove latest aliases from 3.0.0

* Remove latest aliases from 2.1.2

* Update download metadata 2023-08-16

* Add 3.0.1

* Update project descriptions

* Make nav menu image link to version homepage

* Added OTP version to CS 3.0.1 homepage

* Added OTP version to CS 3.0.0. homepage

* Hide titles for plaintext, text and log codeblocks

* Fix headings

* Hide codeblock title if blank

* Fixed headings and tables

* Formatting fixes

* Moved Release notes and changes Downloads icon

* Added the TOC back

* Added LUNR-based search (#226)

* Add CS 3.0.1 docs (#221) (#223)

* Remove latest aliases from 3.0.0

* Remove latest aliases from 2.1.2

* Update download metadata 2023-08-16

* Add 3.0.1

* Update project descriptions

* Make nav menu image link to version homepage

* Added OTP version to CS 3.0.1 homepage

* Added OTP version to CS 3.0.0. homepage

* Hide titles for plaintext, text and log codeblocks

* Fix headings

* Hide codeblock title if blank

* Fixed headings and tables

* Formatting fixes

* Moved Release notes and changes Downloads icon

* Added the TOC back

* Add "project" to community files

* Add search index and test cases

* Added search indexes to all projects and versions

* Remove dead 3rd party tracking code

* Replace search results screen

* Replace search box

* Add project_name_html to JSON

* Added basic lunr search

* Fix frontmatter issue

* Fix quote issue

* Removed Google Tag Manager stubs

* Search improvements

* Fix link

* Fix link

* Fix link and add search_boost

* Add sample keywords and search boosts

* Add example deprecated content.

* Add keywords and boosts to search indexes

* Add header meta value

* Better layout and boost support

* Auto-hide menu and move CSS

* Added keywords

* Added score

* Updated CSS/JS

* Add LUNR 2.3.9 JS file

This was missed in the PR from pjac-search on 2023-09-01 as the `dynamic/js/vendor` folder is in the git.ignore file.

* Update running-a-cluster.md (#228)

* Update running-a-cluster.md

* Update running-a-cluster.md

* Updated Alpine Linux instuctions (#237)

Added missing pages for 3.0.12+
Updated all to have correct URLs
Updated 3.0.09-32.0.11 to have -r1 instead of -r0
Updated downloads template to show x86_64 and aarch64 available
Updated 3.0.9+ to show Alpine Linux version and architecture

* Various issues with riak-admin changes and search files fixed (#235) (#236)

* Fixes broken links as a result of riak-admin/riak admin changes

Fixes broken links as a result of riak-admin/riak admin changes

* leveled_ko/so context

leveled_ko/so context, closes #234

* Removes errant search files

Pesky search references that got missed previously have been eliminated. This fixes  #225

Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com>

* Command Examples update (#230) (#239)

Authored-by: James M <35449344+JMercerGit@users.noreply.github.com>
Command output examples.

* Fix for outdated references and changes to the upgrading checklist to remove basho support references (#240) (#241)

* Resolves a broken link in a few pages after riak admin changes

Resolves a broken link in a few pages after riak admin changes

Also closes issue #220

* Changes to the upgrading checklist to remove references to basho support

Changes to the upgrading checklist to remove references to Basho support and adds both community and TI Tokyo options.
Also updates example emails in SI files from basho.com to dev.com
 Fixes issue #219

* Adds correct exampledomain usage

Adds correct exampledomain usage

Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com>

* Version History updates for V2.0.0 - V2.9.10 (#242)

* Version History updates for V2.0.0 - V2.9.10

Version History updates for V2.0.0 - V2.9.10

* Removed some remnant search files

Removed some remnant search files

* Fixes missing curl examples (#243) (#245)

* Fixes missing curl examples (#243)

Fixes missing curl examples

* missing curl example (#246)

* Fixes missing curl examples

Fixes missing curl examples

* 2.9.0p5 curl examples

2.9.0p5 curl examples that vanished into space

* 3.0.8 curl fix (#247)

* Fixes missing curl examples

Fixes missing curl examples

* 2.9.0p5 curl examples

2.9.0p5 curl examples that vanished into space

* 3.0.8 curl example

3.0.8 curl example

---------

Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com>

---------

Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com>

* Remove duplicate (#260)

* Remove duplicate (#261)

* Fix merge conflicts

* riak-admin clarification

`riak admin` clarification - Clarifying the format of `riak admin`, as  modern versions should accept `riak admin`, but incorrect list `riak-admin`

* Adjust riak-repl command to reflect updated format

Adjust riak-repl command to reflect updated `riak repl` format

---------

Co-authored-by: Peter Clark <peter.clark@tiot.jp>
  • Loading branch information
@JMercerGit @pjaclark
JMercerGit and pjaclark committed Apr 12, 2024
1 parent 08180ed commit 2fe252b
Show file tree
Hide file tree
Showing 315 changed files with 2,389 additions and 2,295 deletions.
5 changes: 4 additions & 1 deletion content/riak/kv/3.0.1/configuring/v2-multi-datacenter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ errors in your configuration files.
A full list of configurable parameters can be found in the sections
below.

**Note:**
In Riak KV 3.0.1+ the `riak-repl` command has been changed to `riak repl` (with no hyphen). For execution purposes, please use `riak repl`. Please be aware that the output from `riak repl` may quote `riak-repl` in command execution examples as it has inherited Riak KV 2.x functionality.

## Fullsync Settings

Setting | Options | Default | Description
Expand All @@ -106,7 +109,7 @@ Setting | Options | Default | Description
Setting | Options | Default | Description
:-------|:--------|:--------|:-----------
`data_root` | `path` (string) | `data/riak_repl` | Path (relative or absolute) to the working directory for the replication process
`queue_size` | `bytes` (integer) | `104857600` (100 MiB) | The size of the replication queue in bytes before the replication leader will drop requests. If requests are dropped, a fullsync will be required. Information about dropped requests is available using the `riak-repl status` command
`queue_size` | `bytes` (integer) | `104857600` (100 MiB) | The size of the replication queue in bytes before the replication leader will drop requests. If requests are dropped, a fullsync will be required. Information about dropped requests is available using the `riak repl status` command
`server_max_pending` | `max` (integer) | `5` | The maximum number of objects the leader will wait to get an acknowledgment from, from the remote location, before queuing the request
`vnode_gets` | `true`, `false` | `true` | If `true`, repl will do a direct get against the vnode, rather than use a `GET` finite state machine
`shuffle_ring` | `true`, `false` | `true `| If `true`, the ring is shuffled randomly. If `false`, the ring is traversed in order. Useful when a sync is restarted to reduce the chance of syncing the same partitions.
Expand Down
3 changes: 3 additions & 0 deletions content/riak/kv/3.0.1/using/admin/riak-admin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ Usage: riak admin { cluster | join | leave | backup | restore | test |
show | describe }
```

**Note:**
In Riak KV 3.0.1+ the `riak-admin` command has been changed to `riak admin` (with no hyphen). For execution purposes, please use `riak admin`. Please be aware that the output from `riak admin` may quote `riak-admin` in command execution examples as it has inherited Riak KV 2.x functionality.

## Node Naming

An important thing to bear in mind is that all Riak nodes have unique
Expand Down
5 changes: 4 additions & 1 deletion content/riak/kv/3.0.10/configuring/v2-multi-datacenter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@ errors in your configuration files.
A full list of configurable parameters can be found in the sections
below.

**Note:**
In Riak KV 3.0.1+ the `riak-repl` command has been changed to `riak repl` (with no hyphen). For execution purposes, please use `riak repl`. Please be aware that the output from `riak repl` may quote `riak-repl` in command execution examples as it has inherited Riak KV 2.x functionality.

## Fullsync Settings

Setting | Options | Default | Description
Expand All @@ -105,7 +108,7 @@ Setting | Options | Default | Description
Setting | Options | Default | Description
:-------|:--------|:--------|:-----------
`data_root` | `path` (string) | `data/riak_repl` | Path (relative or absolute) to the working directory for the replication process
`queue_size` | `bytes` (integer) | `104857600` (100 MiB) | The size of the replication queue in bytes before the replication leader will drop requests. If requests are dropped, a fullsync will be required. Information about dropped requests is available using the `riak-repl status` command
`queue_size` | `bytes` (integer) | `104857600` (100 MiB) | The size of the replication queue in bytes before the replication leader will drop requests. If requests are dropped, a fullsync will be required. Information about dropped requests is available using the `riak repl status` command
`server_max_pending` | `max` (integer) | `5` | The maximum number of objects the leader will wait to get an acknowledgment from, from the remote location, before queuing the request
`vnode_gets` | `true`, `false` | `true` | If `true`, repl will do a direct get against the vnode, rather than use a `GET` finite state machine
`shuffle_ring` | `true`, `false` | `true `| If `true`, the ring is shuffled randomly. If `false`, the ring is traversed in order. Useful when a sync is restarted to reduce the chance of syncing the same partitions.
Expand Down
6 changes: 3 additions & 3 deletions content/riak/kv/3.0.10/configuring/v2-multi-datacenter/nat.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,18 +65,18 @@ Server C is set up with a single internal IP address: `192.168.1.20`
Configure a listener on Server A:

```bash
riak-repl add-nat-listener riak@192.168.1.10 192.168.1.10 9010 50.16.238.123 9011
riak repl add-nat-listener riak@192.168.1.10 192.168.1.10 9010 50.16.238.123 9011
```

Configure a site (client) on Server B:

```bash
riak-repl add-site 50.16.238.123 9011 server_a_to_b
riak repl add-site 50.16.238.123 9011 server_a_to_b
```

Configure a site (client) on Server C:

```bash
riak-repl add-site 192.168.1.10 9010 server_a_to_c
riak repl add-site 192.168.1.10 9010 server_a_to_c
```

42 changes: 21 additions & 21 deletions content/riak/kv/3.0.10/configuring/v2-multi-datacenter/quick-start.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,25 +69,25 @@ addresses would need to be routable over the public Internet.
### Set Up the Listeners on Cluster1 (Source cluster)

On a node in Cluster1, `node1` for example, identify the nodes that will
be listening to connections from replication clients with `riak-repl
be listening to connections from replication clients with `riak repl
add-listener <nodename> <listen_ip> <port>` for each node that will be
listening for replication clients.

```bash
riak-repl add-listener riak@172.16.1.11 172.16.1.11 9010
riak-repl add-listener riak@172.16.1.12 172.16.1.12 9010
riak-repl add-listener riak@172.16.1.13 172.16.1.13 9010
riak repl add-listener riak@172.16.1.11 172.16.1.11 9010
riak repl add-listener riak@172.16.1.12 172.16.1.12 9010
riak repl add-listener riak@172.16.1.13 172.16.1.13 9010
```

### Set Up the Site on Cluster2 (Site cluster)

On a node in Cluster2, `node4` for example, inform the replication
clients where the Source Listeners are located with `riak-repl add-site
clients where the Source Listeners are located with `riak repl add-site
<ipaddr> <port> <sitename>`. Use the IP address(es) and port(s) you
configured in the earlier step. For `sitename` enter `Cluster1`.

```bash
riak-repl add-site 172.16.1.11 9010 Cluster1
riak repl add-site 172.16.1.11 9010 Cluster1
```

**Note**: While a Listener needs to be added to each node, only a single
Expand All @@ -97,10 +97,10 @@ Source cluster.

### Verify the Replication Configuration

Verify the replication configuration using `riak-repl status` on both a
Cluster1 node and a Cluster2 node. A full description of the `riak-repl
Verify the replication configuration using `riak repl status` on both a
Cluster1 node and a Cluster2 node. A full description of the `riak repl
status` command's output can be found in the documentation for
`riak-repl`'s [status output][cluster ops v2 mdc#status].
`riak repl`'s [status output][cluster ops v2 mdc#status].

On the Cluster1 node, verify that there are `listener_<nodename>`s for
each listening node, and that `leader` and `server_stats` are populated.
Expand Down Expand Up @@ -201,33 +201,33 @@ above in the other direction, i.e. from Cluster2 to Cluster1.
### Set Up the Listeners on Cluster2 (Source cluster)

On a node in Cluster2, `node4` for example, identify the nodes that will
be listening to connections from replication clients with `riak-repl
be listening to connections from replication clients with `riak repl
add-listener <nodename> <listen_ip> <port>` for each node that will be
listening for replication clients.

```bash
riak-repl add-listener riak@192.168.1.21 192.168.1.21 9010
riak-repl add-listener riak@192.168.1.22 192.168.1.22 9010
riak-repl add-listener riak@192.168.1.23 192.168.1.23 9010
riak repl add-listener riak@192.168.1.21 192.168.1.21 9010
riak repl add-listener riak@192.168.1.22 192.168.1.22 9010
riak repl add-listener riak@192.168.1.23 192.168.1.23 9010
```

### Set Up the Site on Cluster1 (Site cluster)

On a node in Cluster1, `node1` for example, inform the replication
clients where the Source Listeners are with `riak-repl add-site <ipaddr>
clients where the Source Listeners are with `riak repl add-site <ipaddr>
<port> <sitename>`. Use the IP address(es) and port(s) you configured in
the earlier step. For `sitename` enter **Cluster2**.

```bash
riak-repl add-site 192.168.1.21 9010 Cluster2
riak repl add-site 192.168.1.21 9010 Cluster2
```

### Verify the Replication Configuration

Verify the replication configuration using `riak-repl status` on a
Cluster1 node and a Cluster2 node. A full description of the `riak-repl
Verify the replication configuration using `riak repl status` on a
Cluster1 node and a Cluster2 node. A full description of the `riak repl
status` command's output can be found in the documentation for
`riak-repl`'s [status output][cluster ops v2 mdc#status].
`riak repl`'s [status output][cluster ops v2 mdc#status].

On the Cluster1 node, verify that `Cluster2_ips`, `leader`, and
`client_stats` are populated. They should look similar to the following:
Expand Down Expand Up @@ -353,16 +353,16 @@ To start a fullsync operation, issue the following command on your
leader node:

```bash
riak-repl start-fullsync
riak repl start-fullsync
```

A fullsync operation may also be cancelled. If a partition is in
progress, synchronization will stop after that partition completes.
During cancellation, `riak-repl status` will show 'cancelled' in the
During cancellation, `riak repl status` will show 'cancelled' in the
status.

```bash
riak-repl cancel-fullsync
riak repl cancel-fullsync
```

Fullsync operations may also be paused, resumed, or scheduled for
Expand Down
4 changes: 2 additions & 2 deletions content/riak/kv/3.0.10/configuring/v2-multi-datacenter/ssl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ Riak REPL SSL support consists of the following items:
## SSL Configuration

To configure SSL, you will need to include the following four settings
in the `riak-repl` section of your `advanced.config`:
in the `riak repl` section of your `advanced.config`:

```advancedconfig
{riak-repl, [
{riak repl, [
% ...
{ssl_enabled, true},
{certfile, "/full/path/to/site1-cert.pem"},
Expand Down
52 changes: 26 additions & 26 deletions content/riak/kv/3.0.10/configuring/v3-multi-datacenter/nat.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,17 @@ NAT addresses must be configured *statically*.

NAT rules can be configured at runtime, from the command line.

* `riak-repl nat-map show`
* `riak repl nat-map show`

Shows the current NAT mapping table

* `riak-repl nat-map add <externalip>[:port] <internalip>`
* `riak repl nat-map add <externalip>[:port] <internalip>`

Adds a NAT map from the external IP, with an optional port, to an
internal IP. The port number refers to a port that is automatically
mapped to the internal `cluster_mgr` port number.

* `riak-repl nat-map del <externalip>[:port] <internalip>`
* `riak repl nat-map del <externalip>[:port] <internalip>`

Deletes a specific NAT map entry.

Expand All @@ -56,14 +56,14 @@ NAT rules can be configured at runtime, from the command line.
* Realtime NAT replication changes will be applied once realtime is
stopped and started using the following command:

* `riak-repl realtime stop <clustername>`
* `riak-repl realtime start <clustername>`
* `riak repl realtime stop <clustername>`
* `riak repl realtime start <clustername>`

* Fullsync NAT replication changes will be applied on the next run of a
fullsync, or you can stop and start the current fullsync.

* `riak-repl fullsync stop <clustername>`
* `riak-repl fullsync start <clustername>`
* `riak repl fullsync stop <clustername>`
* `riak repl fullsync start <clustername>`

## Example

Expand Down Expand Up @@ -116,53 +116,53 @@ while the configured NAT port listens on `5566`.

```bash
# on any node of Cluster_A
riak-repl clustername Server_A
riak repl clustername Server_A

# on any node of Cluster_B
riak-repl clustername Server_B
riak repl clustername Server_B

# on any node of Cluster_C
riak-repl clustername Server_C
riak repl clustername Server_C

# on 50.16.238.120 of Cluster_B
riak-repl nat-map add 50.16.238.120:5555 192.168.2.40
riak repl nat-map add 50.16.238.120:5555 192.168.2.40
# on 50.16.238.121 of Cluster_B
riak-repl nat-map add 50.16.238.121:5555 192.168.2.41
riak repl nat-map add 50.16.238.121:5555 192.168.2.41
# on 50.16.238.122 of Cluster_B
riak-repl nat-map add 50.16.238.122:5555 192.168.2.42
riak repl nat-map add 50.16.238.122:5555 192.168.2.42
# on 50.16.238.123 of Cluster_B
riak-repl nat-map add 50.16.238.123:5555 192.168.2.43
riak repl nat-map add 50.16.238.123:5555 192.168.2.43
# on 50.16.238.124 of Cluster_B
riak-repl nat-map add 50.16.238.124:5555 192.168.2.44
riak repl nat-map add 50.16.238.124:5555 192.168.2.44

# on 192.168.3.60 of Cluster_C
riak-repl nat-map add 50.16.238.200:5550 192.168.3.60
riak repl nat-map add 50.16.238.200:5550 192.168.3.60
# on 192.168.3.61 of Cluster_C
riak-repl nat-map add 50.16.238.200:5551 192.168.3.61
riak repl nat-map add 50.16.238.200:5551 192.168.3.61
# on 192.168.3.62 of Cluster_C
riak-repl nat-map add 50.16.238.200:5552 192.168.3.62
riak repl nat-map add 50.16.238.200:5552 192.168.3.62
# on 192.168.3.63 of Cluster_C
riak-repl nat-map add 50.16.238.200:5553 192.168.3.63
riak repl nat-map add 50.16.238.200:5553 192.168.3.63
# on 192.168.3.64 of Cluster_C
riak-repl nat-map add 50.16.238.200:5554 192.168.3.64
riak repl nat-map add 50.16.238.200:5554 192.168.3.64

# Connect replication from Cluster_A to Cluster_B:
# on any node of Cluster_A
riak-repl connect 50.16.238.120:5555
riak repl connect 50.16.238.120:5555
# You can connect to any node in Cluster_B with NAT mapped IP's/ports
# This command only needs to be run *once* for a cluster.

# Connect replication from Cluster_A to Cluster_C:
# on any node of Cluster_A
riak-repl connect 50.16.238.200:5550
riak repl connect 50.16.238.200:5550
# You can connect to any node in Cluster_C with NAT mapped IP's/ports
# This command only needs to be run *once* for a cluster.

# on any node from Cluster_A
riak-repl realtime enable Cluster_B
riak-repl realtime enable Cluster_C
riak repl realtime enable Cluster_B
riak repl realtime enable Cluster_C

riak-repl realtime start Cluster_B
riak-repl realtime start Cluster_C
riak repl realtime start Cluster_B
riak repl realtime start Cluster_C
```

30 changes: 15 additions & 15 deletions content/riak/kv/3.0.10/configuring/v3-multi-datacenter/quick-start.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,36 +79,36 @@ Name | IP | Node name
#### Set up the Source on Cluster1

On a node in Cluster1, `node1` for example, initiate and name this
cluster with `riak-repl clustername <name>`:
cluster with `riak repl clustername <name>`:

```bash
riak-repl clustername Cluster1
riak repl clustername Cluster1
```

#### Setup the Sink on Cluster2

On a node in Cluster2, `node4` for example, initiation and name this
cluster with `riak-repl clustername <name>`:
cluster with `riak repl clustername <name>`:

```bash
riak-repl clustername Cluster2
riak repl clustername Cluster2
```

#### Connect the Source to the Sink

From Cluster1, connect to the IP and port of Cluster2 with `riak-repl
From Cluster1, connect to the IP and port of Cluster2 with `riak repl
connect <sink_ip>:<port>`:

```bash
riak-repl connect 10.60.77.10:9080
riak repl connect 10.60.77.10:9080
```

> The port can be found in the `riak_core` section of the `advanced.config`
> under `cluster_mgr`.
#### View your active connections

From Cluster1, view your active connections with `riak-repl
From Cluster1, view your active connections with `riak repl
connections`:

```
Expand All @@ -121,16 +121,16 @@ Cluster2 Cluster2 <0.7985.0> ["10.60.77.10:9080"] (via

#### Connect the Source to the Sink

From Cluster2, connect to the IP and port of Cluster1 with `riak-repl
From Cluster2, connect to the IP and port of Cluster1 with `riak repl
connect <sink_ip>:<port>`:

```bash
riak-repl connect 10.60.67.149:9080
riak repl connect 10.60.67.149:9080
```

#### View Your Active Connections

From Cluster2, view your active connections with `riak-repl
From Cluster2, view your active connections with `riak repl
connections`:

```
Expand All @@ -147,25 +147,25 @@ Check your IP bindings by running `netstat -a` on all nodes. You should see

### Enable Realtime Replication

From Cluster1, run `riak-repl realtime enable <clustername>` to start
From Cluster1, run `riak repl realtime enable <clustername>` to start
queuing updates on Cluster1 for replication:

```bash
riak-repl realtime enable Cluster2
riak repl realtime enable Cluster2
```

Also on Cluster1, run `riak-repl realtime start <clustername>` to
Also on Cluster1, run `riak repl realtime start <clustername>` to
establish connectivity from Cluster1 to Cluster2 to push queued updates:

```bash
riak-repl realtime start Cluster2
riak repl realtime start Cluster2
```

To enable bidirectional replication, do the reverse from Cluster2.
Once this is done, bidirectional replication should be operating.

## More information

For a full list of commands, you may enter `riak-repl` to see full
For a full list of commands, you may enter `riak repl` to see full
instructions on usage, or check the [Operations][cluster ops v3 mdc] documentation.

Loading

0 comments on commit 2fe252b

Please sign in to comment.