Skip to content

Commit

Permalink
Dev 3.0.9 (#143)
Browse files Browse the repository at this point in the history
* Update for 3.0.9 Docs version (#127)

* Removed 'fake.txt' (#113)

Done to a) remove fake.txt, and b) to reset dev to master.

* Pretty OS version names and configurable Contact Us (#114)

* Pretty OS version names taken from `data/os_metadata.yaml`
* Configurable Contact Us URI in `config.yaml`
* Removed `fake.txt` used for the HEAD reset in master

* More pretty names and file store link on Downloads (#115)

* Updated file download data

* More pretty names for OS versions

* Show a configurable download root on Downloads

* Initial 3.0.9 doc creation

Initial 3.0.9 doc creation

* Update Release notes for 3.0.9

Update Release notes for 3.0.9

* Update References and config.yaml for 3.0.9

Update References and config.yaml for 3.0.9, including the addition of the new default configuration for "worker_pool_size"

* Fixes issues with riak-admin being used instead of riak admin

Fixes issues with riak-admin being used instead of riak admin in versions 3.0.3 +

Co-authored-by: Peter Clark <peter.clark@tiot.jp>
Co-authored-by: Andrei Zavada <andrei.zavada@tiot.jp>

* Final 3.0.9 update (#139)

* Removed 'fake.txt' (#113)

Done to a) remove fake.txt, and b) to reset dev to master.

* Pretty OS version names and configurable Contact Us (#114)

* Pretty OS version names taken from `data/os_metadata.yaml`
* Configurable Contact Us URI in `config.yaml`
* Removed `fake.txt` used for the HEAD reset in master

* More pretty names and file store link on Downloads (#115)

* Updated file download data

* More pretty names for OS versions

* Show a configurable download root on Downloads

* Initial 3.0.9 doc creation

Initial 3.0.9 doc creation

* Update Release notes for 3.0.9

Update Release notes for 3.0.9

* Update References and config.yaml for 3.0.9

Update References and config.yaml for 3.0.9, including the addition of the new default configuration for "worker_pool_size"

* Fixes issues with riak-admin being used instead of riak admin

Fixes issues with riak-admin being used instead of riak admin in versions 3.0.3 +

Co-authored-by: Peter Clark <peter.clark@tiot.jp>
Co-authored-by: Andrei Zavada <andrei.zavada@tiot.jp>

Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com>
Co-authored-by: Andrei Zavada <andrei.zavada@tiot.jp>
  • Loading branch information
3 people committed Sep 30, 2022
1 parent 8b5cfee commit b2f034b
Show file tree
Hide file tree
Showing 574 changed files with 69,513 additions and 2,254 deletions.
4 changes: 2 additions & 2 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ params:
- ["2.1.1", "2.1.3", "2.1.4"]
- ["2.2.0", "2.2.1", "2.2.2", "2.2.3", "2.2.6"]
- ["2.9.0p5", "2.9.1", "2.9.2", "2.9.4", "2.9.7", "2.9.8", "2.9.9", "2.9.10"]
- ["3.0.1", "3.0.2", "3.0.3", "3.0.4", "3.0.6", "3.0.7", "3.0.8"]
latest: "3.0.8"
- ["3.0.1", "3.0.2", "3.0.3", "3.0.4", "3.0.6", "3.0.7", "3.0.8", "3.0.9"]
latest: "3.0.9"
lts: ["2.9", "3.0"]
archive_below: "2.2"
#archived_url: "http://docs.riak.com/riak/1.4.12/"
Expand Down
2 changes: 1 addition & 1 deletion content/riak/kv/3.0.3/_reference-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
[use admin index]: {{<baseurl>}}riak/kv/3.0.3/using/admin/
[use admin commands]: {{<baseurl>}}riak/kv/3.0.3/using/admin/commands/
[use admin riak cli]: {{<baseurl>}}riak/kv/3.0.3/using/admin/riak-cli/
[use admin riak-admin]: {{<baseurl>}}riak/kv/3.0.3/using/admin/riak-admin/
[use admin riak admin]: {{<baseurl>}}riak/kv/3.0.3/using/admin/riak admin/
[use admin riak control]: {{<baseurl>}}riak/kv/3.0.3/using/admin/riak-control/

### Cluster Operations
Expand Down
6 changes: 3 additions & 3 deletions content/riak/kv/3.0.3/add-ons/redis/developing-rra.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ an opaque value, ie a `string`. The following command provides an example of
creating the bucket-type `rra`:

```sh
if ! riak-admin bucket-type status rra >/dev/null 2>&1; then
riak-admin bucket-type create rra '{"props":{}}'
riak-admin bucket-type activate rra
if ! riak admin bucket-type status rra >/dev/null 2>&1; then
riak admin bucket-type create rra '{"props":{}}'
riak admin bucket-type activate rra
fi
```

Expand Down
8 changes: 4 additions & 4 deletions content/riak/kv/3.0.3/configuring/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ aliases:

[config reference]: {{<baseurl>}}riak/kv/3.0.3/configuring/reference
[use running cluster]: {{<baseurl>}}riak/kv/3.0.3/using/running-a-cluster
[use admin riak-admin#member-status]: {{<baseurl>}}riak/kv/3.0.3/using/admin/riak-admin/#member-status
[use admin riak admin#member-status]: {{<baseurl>}}riak/kv/3.0.3/using/admin/riak admin/#member-status
[perf erlang]: {{<baseurl>}}riak/kv/3.0.3/using/performance/erlang
[plan start]: {{<baseurl>}}riak/kv/3.0.3/setup/planning/start
[plan best practices]: {{<baseurl>}}riak/kv/3.0.3/setup/planning/best-practices
Expand Down Expand Up @@ -61,7 +61,7 @@ We advise that you make as many of the changes below as practical
_before_ joining the nodes together into a cluster. Once your
configuration has been set on each node, follow the steps in [Basic Cluster Setup][use running cluster] to complete the clustering process.

Use [`riak-admin member-status`][use admin riak-admin#member-status]
Use [`riak admin member-status`][use admin riak admin#member-status]
to determine whether any given node is a member of a cluster.

## Erlang VM Tunings
Expand Down Expand Up @@ -143,10 +143,10 @@ the location of this file)

### Verifying ring size

You can use the `riak-admin` command can verify the ring size:
You can use the `riak admin` command can verify the ring size:

```bash
riak-admin status | grep ring
riak admin status | grep ring
```

Console output:
Expand Down
4 changes: 2 additions & 2 deletions content/riak/kv/3.0.3/configuring/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ aliases:
[plan backend multi]: ../../setup/planning/backend/multi
[config backend multi]: ../../setup/planning/backend/multi/#configuring-multiple-backends-1
[use admin riak cli]: ../../using/admin/riak-cli
[use admin riak-admin]: ../../using/admin/riak-admin
[use admin riak admin]: ../../using/admin/riak admin
[glossary aae]: ../../learn/glossary/#active-anti-entropy-aae
[use ref search 2i]: ../../using/reference/secondary-indexes
[cluster ops bucket types]: ../../using/cluster-operations/bucket-types
Expand Down Expand Up @@ -194,7 +194,7 @@ parameters below.

<tr>
<td><code>platform_bin_dir</code></td>
<td>The directory in which the <a href="../../using/admin/riak-admin"><code>riak-admin</code></a>,
<td>The directory in which the <a href="../../using/admin/riak admin"><code>riak admin</code></a>,
<code>riak-debug</code>, and now-deprecated <code>search-cmd</code>
executables are stored.</td>
<td><code>./bin</code></td>
Expand Down
8 changes: 4 additions & 4 deletions content/riak/kv/3.0.3/configuring/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,18 +133,18 @@ Enable this node in distributed query plans; defaults to `on`.

If enabled, this node will participate in distributed Solr queries. If disabled, the node will be excluded from Riak search cover plans, and will therefore never be consulted in a distributed query. Note that this node may still be used to execute a query. Use this flag if you have a long running administrative operation (e.g. reindexing) which requires that the node be removed from query plans, and which would otherwise result in inconsistent search results.

This setting can also be changed via `riak-admin` by issuing one of the following commands:
This setting can also be changed via `riak admin` by issuing one of the following commands:

```
riak-admin set search.dist_query=off
riak admin set search.dist_query=off
```
or

```
riak-admin set search.dist_query=on
riak admin set search.dist_query=on
```

Setting this value in riak.conf is useful when you are restarting a node which was removed from search queries with the `riak-admin` feature. Setting `search.dis_query` in riak.conf will prevent the node from being included in search queries until it is fully spun up.
Setting this value in riak.conf is useful when you are restarting a node which was removed from search queries with the `riak admin` feature. Setting `search.dis_query` in riak.conf will prevent the node from being included in search queries until it is fully spun up.

Valid values: `on` or `off`

Expand Down
24 changes: 12 additions & 12 deletions content/riak/kv/3.0.3/configuring/strong-consistency.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ toc: true
[glossary vnode]: {{<baseurl>}}riak/kv/3.0.3/learn/glossary/#vnode
[concept buckets]: {{<baseurl>}}riak/kv/3.0.3/learn/concepts/buckets
[cluster ops bucket types]: {{<baseurl>}}riak/kv/3.0.3/using/cluster-operations/bucket-types
[use admin riak-admin#ensemble]: {{<baseurl>}}riak/kv/3.0.3/using/admin/riak-admin/#ensemble-status
[use admin riak-admin]: {{<baseurl>}}riak/kv/3.0.3/using/admin/riak-admin
[use admin riak admin#ensemble]: {{<baseurl>}}riak/kv/3.0.3/using/admin/riak admin/#ensemble-status
[use admin riak admin]: {{<baseurl>}}riak/kv/3.0.3/using/admin/riak admin
[config reference#advanced]: {{<baseurl>}}riak/kv/3.0.3/configuring/reference/#advanced-configuration
[plan cluster capacity]: {{<baseurl>}}riak/kv/3.0.3/setup/planning/cluster-capacity
[cluster ops strong consistency]: {{<baseurl>}}riak/kv/3.0.3/using/cluster-operations/strong-consistency
Expand Down Expand Up @@ -99,7 +99,7 @@ than three nodes, strong consistency will be **enabled** but not yet
state. Once at least three nodes with strong consistency enabled are
detected in the cluster, the system will be activated and ready for use.
You can check on the status of the strong consistency subsystem using
the [`riak-admin ensemble-status`][use admin riak-admin#ensemble] command.
the [`riak admin ensemble-status`][use admin riak admin#ensemble] command.

## Fault Tolerance

Expand Down Expand Up @@ -136,12 +136,12 @@ of N, i.e. `n_val`, for buckets
can create and activate a bucket type with N set to 5 and strong
consistency enabled---we'll call the bucket type
`consistent_and_fault_tolerant`---using the following series of
[commands][use admin riak-admin]:
[commands][use admin riak admin]:

```bash
riak-admin bucket-type create consistent_and_fault_tolerant \
riak admin bucket-type create consistent_and_fault_tolerant \
'{"props": {"consistent":true,"n_val":5}}'
riak-admin bucket-type activate consistent_and_fault_tolerant
riak admin bucket-type activate consistent_and_fault_tolerant
```

If the `activate` command outputs `consistent_and_fault_tolerant has
Expand Down Expand Up @@ -244,7 +244,7 @@ unable to service strongly consistent operations. The best strategy is
to reboot nodes one at a time and wait for each node to rejoin existing
[ensembles][cluster ops strong consistency] before
continuing to the next node. At any point in time, the state of
currently existing ensembles can be checked using [`riak-admin ensemble-status`][admin riak-admin#ensemble].
currently existing ensembles can be checked using [`riak admin ensemble-status`][admin riak admin#ensemble].

## Performance

Expand All @@ -263,9 +263,9 @@ can be found in [Adding and Removing Nodes][cluster ops add remove node].
Your cluster's configuration can also affect strong consistency
performance. See the section on [configuration][config reference#strong-cons] below.

## riak-admin ensemble-status
## riak admin ensemble-status

The [`riak-admin`][use admin riak-admin] interface
The [`riak admin`][use admin riak admin] interface
used for general node/cluster management has an `ensemble-status`
command that provides insight into the current status of the consensus
subsystem undergirding strong consistency.
Expand All @@ -274,7 +274,7 @@ Running the command by itself will provide the current state of the
subsystem:

```bash
riak-admin ensemble-status
riak admin ensemble-status
```

If strong consistency is not currently enabled, you will see `Note: The
Expand Down Expand Up @@ -340,13 +340,13 @@ ensembles are displayed in the `Ensembles` section of the
To inspect a specific ensemble, specify the ID:

```bash
riak-admin ensemble-status <id>
riak admin ensemble-status <id>
```

The following would inspect ensemble 2:

```bash
riak-admin ensemble-status 2
riak admin ensemble-status 2
```

Below is sample output for a single ensemble:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The JSON object in the response will contain up to two entries, `"props"` and
parameters. The default is for only `"props"` to be present.

See [HTTP Set Bucket Properties]({{<baseurl>}}riak/kv/3.0.3/developing/api/http/set-bucket-props) for more information about the available
bucket properties. See [Managing Bucket Types Through the Command Line]({{< baseurl >}}riak/kv/3.0.3/using/reference/bucket-types/#managing-bucket-types-through-the-command-line) for more details about reading bucket types using the `riak-admin bucket-type` interface.
bucket properties. See [Managing Bucket Types Through the Command Line]({{< baseurl >}}riak/kv/3.0.3/using/reference/bucket-types/#managing-bucket-types-through-the-command-line) for more details about reading bucket types using the `riak admin bucket-type` interface.

## Example

Expand Down
2 changes: 1 addition & 1 deletion content/riak/kv/3.0.3/developing/api/http/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ $ curl -v http://127.0.0.1:8098/stats -H "Accept: text/plain"

## Output Explanation

The output of `/stats` contains the output of `riak-admin status` detailed in the [Inspecting a Node]({{<baseurl>}}riak/kv/3.0.3/using/cluster-operations/inspecting-node) doc, plus the below stats generated by the Riak Core application.
The output of `/stats` contains the output of `riak admin status` detailed in the [Inspecting a Node]({{<baseurl>}}riak/kv/3.0.3/using/cluster-operations/inspecting-node) doc, plus the below stats generated by the Riak Core application.

Stat | Description
------------------------------|---------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ you're using. In order to set those replication properties, you should
create a bucket type that sets those properties. Below is an example:

```bash
riak-admin bucket-type create custom_props '{"props":{"n_val":5,"r":3,"w":3}}'
riak-admin bucket-type activate custom_props
riak admin bucket-type create custom_props '{"props":{"n_val":5,"r":3,"w":3}}'
riak admin bucket-type activate custom_props
```

Now, any time you store an object in a bucket with the type
Expand Down Expand Up @@ -138,8 +138,8 @@ that type to 2. To do so, you must create and activate a bucket type
that sets this property:

```bash
riak-admin bucket-type create n_val_equals_2 '{"props":{"n_val":2}}'
riak-admin bucket-type activate n_val_equals_2
riak admin bucket-type create n_val_equals_2 '{"props":{"n_val":2}}'
riak admin bucket-type activate n_val_equals_2
```

Now, all buckets that bear the type `n_val_equals_2` will have `n_val`
Expand Down Expand Up @@ -180,8 +180,8 @@ As an example, let's create and activate a bucket type with `r` set to
result from only one node.

```bash
riak-admin bucket-type create r_equals_1 '{"props":{"r":1}}'
riak-admin bucket-type activate r_equals_1
riak admin bucket-type create r_equals_1 '{"props":{"r":1}}'
riak admin bucket-type activate r_equals_1
```

Here's an example read request using the `r_equals_1` bucket type:
Expand Down Expand Up @@ -246,8 +246,8 @@ As an example, let's create and activate a bucket type with `w` set to
`3`:

```bash
riak-admin bucket-type create w_equals_3 '{"props":{"w":3}}'
riak-admin activate w_equals_3
riak admin bucket-type create w_equals_3 '{"props":{"w":3}}'
riak admin activate w_equals_3
```

Now, we can attempt a write to a bucket bearing the type `w_equals_3`:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ To give an example, we'll create a bucket type called
`true`:

```bash
riak-admin bucket-type create strongly_consistent \
riak admin bucket-type create strongly_consistent \
'{"props":{"consistent":true}}'
```

Expand All @@ -96,15 +96,15 @@ check the status of the type to ensure that it has propagated through
all nodes and is thus ready to be activated:

```bash
riak-admin bucket-type status strongly_consistent
riak admin bucket-type status strongly_consistent
```

If the console outputs `strongly_consistent has been created and may be
activated` and the properties listing shows that `consistent` has been
set to `true`, then you may proceed with activation:

```bash
riak-admin bucket-type activate strongly_consistent
riak admin bucket-type activate strongly_consistent
```

When activation is successful, the console will return the following:
Expand Down
6 changes: 3 additions & 3 deletions content/riak/kv/3.0.3/developing/app-guide/write-once.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ The following example shows how to configure a bucket type with the
`write_once` property:

```bash
riak-admin bucket-type create my-bucket-type '{"props": {"write_once": true}}'
riak admin bucket-type create my-bucket-type '{"props": {"write_once": true}}'
# my-bucket-type created

riak-admin bucket-type activate my-bucket-type
riak admin bucket-type activate my-bucket-type
# my-bucket-type has been activated

riak-admin bucket-type status my-bucket-type
riak admin bucket-type status my-bucket-type
# my-bucket-type is active
...
write_once: true
Expand Down
16 changes: 8 additions & 8 deletions content/riak/kv/3.0.3/developing/data-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ The following would create a separate bucket type for each of the four
bucket-level data types:

```bash
riak-admin bucket-type create maps '{"props":{"datatype":"map"}}'
riak-admin bucket-type create sets '{"props":{"datatype":"set"}}'
riak-admin bucket-type create counters '{"props":{"datatype":"counter"}}'
riak-admin bucket-type create hlls '{"props":{"datatype":"hll"}}'
riak-admin bucket-type create gsets '{"props":{"datatype":"gset"}}'
riak admin bucket-type create maps '{"props":{"datatype":"map"}}'
riak admin bucket-type create sets '{"props":{"datatype":"set"}}'
riak admin bucket-type create counters '{"props":{"datatype":"counter"}}'
riak admin bucket-type create hlls '{"props":{"datatype":"hll"}}'
riak admin bucket-type create gsets '{"props":{"datatype":"gset"}}'
```

> **Note**
Expand All @@ -73,10 +73,10 @@ the exception of `default`.

Once you've created a bucket with a Riak data type, you can check
to make sure that the bucket property configuration associated with that
type is correct. This can be done through the `riak-admin` interface:
type is correct. This can be done through the `riak admin` interface:

```bash
riak-admin bucket-type status maps
riak admin bucket-type status maps
```

This will return a list of bucket properties and their associated values
Expand All @@ -94,7 +94,7 @@ to be usable in Riak. This can also be done using the `bucket-type`
command interface:

```bash
riak-admin bucket-type activate maps
riak admin bucket-type activate maps
```

To check whether activation has been successful, simply use the same
Expand Down
8 changes: 4 additions & 4 deletions content/riak/kv/3.0.3/developing/data-types/counters.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The examples in this section will show you how to use counters on their own.
Start by creating a bucket type with the `datatype` parameter set to `counter`:

```bash
riak-admin bucket-type create counters '{"props":{"datatype":"counter"}}'
riak admin bucket-type create counters '{"props":{"datatype":"counter"}}'
```

> **Note**
Expand All @@ -39,7 +39,7 @@ riak-admin bucket-type create counters '{"props":{"datatype":"counter"}}'
After creating a bucket with a Riak data type, confirm the bucket property configuration associated with that type is correct:

```bash
riak-admin bucket-type status counters
riak admin bucket-type status counters
```

This returns a list of bucket properties and their values
Expand All @@ -54,13 +54,13 @@ datatype: counter
Once we have confirmed the bucket type is properly configured, we can activate the bucket type to be used in Riak KV:

```bash
riak-admin bucket-type activate counters
riak admin bucket-type activate counters
```

We can check if activation has been successful by using the same `bucket-type status` command shown above:

```bash
riak-admin bucket-type status counters
riak admin bucket-type status counters
```

After creating and activating our new `counters` bucket type, we can setup our client to start using the bucket type as detailed in the next section.
Expand Down
8 changes: 4 additions & 4 deletions content/riak/kv/3.0.3/developing/data-types/gsets.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Unlike sets, elements can only be added and no element modification or deletion
Start by creating a bucket type with the `datatype` parameter `gset`:

```bash
riak-admin bucket-type create gsets '{"props":{"datatype":"gset"}}'
riak admin bucket-type create gsets '{"props":{"datatype":"gset"}}'
```

> **Note**
Expand All @@ -47,7 +47,7 @@ riak-admin bucket-type create gsets '{"props":{"datatype":"gset"}}'
After creating a bucket with a Riak data type, confirm the bucket property configuration associated with that type is correct:

```bash
riak-admin bucket-type status gsets
riak admin bucket-type status gsets
```

This returns a list of bucket properties and their values
Expand All @@ -62,13 +62,13 @@ datatype: gset
Once we have confirmed the bucket type is properly configured, we can activate the bucket type to be used in Riak KV:

```bash
riak-admin bucket-type activate gsets
riak admin bucket-type activate gsets
```

We can check if activation has been successful by using the same `bucket-type status` command shown above:

```bash
riak-admin bucket-type status gsets
riak admin bucket-type status gsets
```

After creating and activating our new `gsets` bucket type, we can setup our client to start using the bucket type as detailed in the next section.
Expand Down
Loading

0 comments on commit b2f034b

Please sign in to comment.