Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Massive update to docs #2533

Draft
wants to merge 136 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
136 commits
Select commit Hold shift + click to select a range
423e60f
Resetting to Basho head
pjaclark Jun 2, 2022
47921c5
Riak KV 3.0.0 -> 3.0.4 (#111)
pjaclark Jun 2, 2022
ea688da
Removed 'fake.txt'
pjaclark Jun 2, 2022
2d318f2
Removed 'fake.txt' (#113)
pjaclark Jun 2, 2022
465bb83
Changed display name of OS versions on Downloads
pjaclark Jun 2, 2022
0127f14
Made Contact Us configurable
pjaclark Jun 2, 2022
d1ef1fb
Pretty OS version names and configurable Contact Us (#114)
pjaclark Jun 2, 2022
dc305bc
Fix for Contact Us url
pjaclark Jun 2, 2022
f1a2b2e
Merge remote-tracking branch 'origin/dev'
Jun 2, 2022
ad4d215
Updated file download data
pjaclark Jun 3, 2022
f81408b
More pretty names for OS versions
pjaclark Jun 4, 2022
64d0890
Show a configurable download root on Downloads
pjaclark Jun 4, 2022
629dab4
More pretty names and file store link on Downloads (#115)
pjaclark Jun 4, 2022
3143627
initial 3.0.6 update (#116) (#117)
pjaclark Jun 24, 2022
9f85fa4
3.0.7 doc creation and update (#122) (#124)
pjaclark Aug 5, 2022
fd8de13
Fix bad link
pjaclark Aug 5, 2022
8b5cfee
3.0.8 doc update (#125) (#126)
pjaclark Aug 5, 2022
b2f034b
Dev 3.0.9 (#143)
pjaclark Sep 30, 2022
e8e02c5
Dev pjac aaefold (#145)
pjaclark Nov 29, 2022
17c27ce
Dev pjac aaefold2 (#146)
pjaclark Nov 29, 2022
8734818
Dev ts 3.0.0 (#147)
pjaclark Nov 29, 2022
f811a23
Added Alpinhe Linux options
pjaclark Nov 29, 2022
8cf7fc9
Updated TS 3.0.0 supported OSs based on downloads
pjaclark Nov 29, 2022
a1893ee
Added OTP version to TS 3.0.0
pjaclark Nov 29, 2022
a3e6d3a
Removed link to Basho Academy
pjaclark Nov 29, 2022
55a85ce
Removed references to Basho Academy
pjaclark Nov 29, 2022
32b2da2
Add repair_keys_range aaefold function for 3.0.8+
pjaclark Nov 29, 2022
954686b
Changed the aaefold examples to use nicer dates.
pjaclark Nov 30, 2022
ec5dab5
Fix modified_filter for repair_keys_range function
pjaclark Nov 30, 2022
1d51d4c
Fix layout and add link
pjaclark Nov 30, 2022
b06793d
Fix layout and links
pjaclark Nov 30, 2022
edf8bbe
Add quick deploy scripts for TIOT
pjaclark Nov 30, 2022
cd9b36e
Fix incorrect erlang, specify riakattach
pjaclark Dec 2, 2022
60d287e
Fix typo
pjaclark Dec 2, 2022
08717de
Update code blocks erlang->riakattach, fix typo
pjaclark Dec 2, 2022
d86415d
Copy 2.1.2 -> 3.0.0
pjaclark Dec 2, 2022
97f878c
Update
pjaclark Dec 2, 2022
c685f82
3.0.10 updates (#151) (#153)
pjaclark Dec 7, 2022
3d22c66
3.0.11 release notes, file creation and version number changes (#152)…
pjaclark Dec 7, 2022
c58429f
Update project descriptions
pjaclark Dec 7, 2022
5f2e576
Add missing aaefold docs for 3.0.10
pjaclark Dec 7, 2022
3248589
Fix bad char at top of file
pjaclark Dec 7, 2022
b03fbcf
Updated instructions for Alpine Linux
pjaclark Dec 7, 2022
5f5605f
Add Alpine Linux to 3.0.11 and reorder menus
pjaclark Dec 7, 2022
818cf41
Updated downloads page to have Alpine Linux info.
pjaclark Dec 7, 2022
3c87106
Make alpine info on downloads consistant
pjaclark Dec 7, 2022
6548b60
Add alpine instructions to 3.0.9
pjaclark Dec 7, 2022
f9213ec
Update alpine instructions
pjaclark Dec 7, 2022
e1505fa
Update 3.0.9 instructions to use the testing repo
pjaclark Dec 7, 2022
cc524ce
Fix numbering in alpine 3.0.9
pjaclark Dec 7, 2022
9324719
Removing superflous 3.0.9 alpine instruction
pjaclark Dec 7, 2022
9e87161
Point GitHub to dev branch
pjaclark Dec 7, 2022
db2ab6b
Update alpine install instructions
pjaclark Dec 7, 2022
5fbc1e0
Fix typo
pjaclark Dec 7, 2022
953fa5e
Make alpine install instuctions since 3.0.9
pjaclark Dec 7, 2022
c9af483
Added latest for aaefolds
pjaclark Dec 7, 2022
3c948b8
Merge branch 'master' into dev
pjaclark Dec 9, 2022
a5e1240
Add docs.riak.info docker compose file
pjaclark Dec 9, 2022
c6b0fcd
Dev 3.0.12 (#163)
pjaclark Jan 20, 2023
6ac0a1a
Dev 3.0.12 (#171)
pjaclark Jan 20, 2023
2b0c8d9
Merge branch 'basho:master' into dev
pjaclark Jan 20, 2023
9998aff
3.2.0 updates (#177) (#179)
pjaclark Feb 9, 2023
1f6061d
Fix to date (#175)
pjaclark Feb 9, 2023
60299c9
Fix typo (#174)
pjaclark Feb 9, 2023
0c48f67
Key changes for Riak CS 3.0.0 (#185)
Bob-The-Marauder May 5, 2023
1a63c3d
Merge branch 'dev' into dev-cs-3.0.0
pjaclark May 5, 2023
f5b316a
Dev cs 3.0.0 (#186)
pjaclark May 5, 2023
5f3f987
Updated to dockers files and metadata.
pjaclark May 11, 2023
641a2ae
Fix URL errors
pjaclark May 11, 2023
5e818bb
URl fix
pjaclark May 11, 2023
b5cebf9
Fix bad links to KV latest
pjaclark May 11, 2023
65c15e9
Add markdownlint to allow acceptable errors
pjaclark May 11, 2023
cf6f471
Fix markdown
pjaclark May 11, 2023
9afc4c1
Fixes for Riak search across verions (#187)
JMercerGit May 12, 2023
92869d1
Revert "Fixes for Riak search across verions (#187)" (#188)
pjaclark May 12, 2023
6a8cafd
Merge branch 'dev' of github.com:Ti-Tokyo/riak-docs-fork into dev
pjaclark May 12, 2023
bf5c24c
Search fixes (#189)
JMercerGit May 12, 2023
633e64d
Merge branch 'dev' of github.com:Ti-Tokyo/riak-docs-fork into dev
pjaclark May 12, 2023
2aef7f9
Mark 2.x search files as only in 2.x (#193)
pjaclark May 12, 2023
ec22fbc
Updating index.md (#191)
JMercerGit May 12, 2023
1fcd9d6
Fix broken links and update old version references (#190)
Bob-The-Marauder May 12, 2023
00578ae
Updates to install doc (#195)
Bob-The-Marauder May 12, 2023
d2532de
Merge branch 'dev' into dev-cs-3.0.0
pjaclark May 12, 2023
49adbe2
Update installing.md
pjaclark May 12, 2023
aac2290
Update installing.md
pjaclark May 12, 2023
2e39fc9
Update installing.md
pjaclark May 12, 2023
e605f53
Update installing.md
pjaclark May 12, 2023
6685b83
Update installing.md
pjaclark May 12, 2023
3c47eb2
Dev cs 3.0.0 (#194)
pjaclark May 12, 2023
85bb815
Fix bad Stanchion file links
pjaclark May 12, 2023
8121da2
Update installing.md
pjaclark May 12, 2023
d6b1d52
Update installing.md
pjaclark May 12, 2023
db1254c
Update installing.md
pjaclark May 12, 2023
b8ba524
Set KV 3.2 as LTS and hide 2.2 in menu
pjaclark May 14, 2023
5418825
Remove markdown issues (#197)
pjaclark May 19, 2023
43ce02c
Add aae_fold function erase_keys (#201)
pjaclark Jun 9, 2023
82b3852
Update installing.md (#203)
Bob-The-Marauder Jun 13, 2023
0fc29fc
Merge branch 'dev' into dev-cs-3.0.0
pjaclark Jun 14, 2023
d438b83
Update installing.md
pjaclark Jun 14, 2023
07fb81d
Merge pull request #204 from TI-Tokyo/dev-cs-3.0.0
Bob-The-Marauder Jun 14, 2023
077aad9
Add erase_keys to 2.9.4+ (#205)
pjaclark Jun 16, 2023
50e05eb
Pjac erase keys historic (#206)
pjaclark Jun 16, 2023
375e716
version updates and other fixes (#202) (#207)
pjaclark Jun 16, 2023
95d9316
config fixes (#209)
JMercerGit Jun 16, 2023
c806d89
Updated downloads and projects metadata files
pjaclark Jun 16, 2023
01708d6
Add aae_fold erase keys to 3.0.13 to 3.0.15 (#210)
pjaclark Jun 16, 2023
844552a
Add erase_keys and fix some markdown lint (#211)
pjaclark Jun 16, 2023
83e9ce9
Re-order menus for Data Types (#213)
pjaclark Jun 30, 2023
2e5ac25
Menu order change (#214)
pjaclark Jun 30, 2023
be88182
Initial 3.0.16 creation (#212) (#215)
pjaclark Jul 6, 2023
dba0b4f
Fix data type list order for 3.0.16
pjaclark Jul 6, 2023
eee08d8
Markdown lint fixes and metadata update (#216)
pjaclark Jul 6, 2023
444c0c0
Add CS 3.0.1 docs (#221)
pjaclark Aug 18, 2023
8d694ce
Add CS 3.0.1 docs (#221) (#223)
pjaclark Aug 23, 2023
d2c0ca0
Added LUNR-based search (#226)
pjaclark Sep 1, 2023
b8d7618
Add LUNR 2.3.9 JS file
pjaclark Sep 1, 2023
27b059f
Update running-a-cluster.md (#228)
pjaclark Nov 10, 2023
c6f3359
Updated Alpine Linux instuctions (#237)
pjaclark Nov 10, 2023
0a4ba31
Merge branch 'master' into dev
pjaclark Nov 10, 2023
237bc22
Various issues with riak-admin changes and search files fixed (#235) …
pjaclark Nov 10, 2023
ed3008e
Command Examples update (#230) (#239)
pjaclark Nov 10, 2023
49654ec
Fix for outdated references and changes to the upgrading checklist to…
pjaclark Nov 17, 2023
855b644
Version History updates for V2.0.0 - V2.9.10 (#242)
JMercerGit Nov 23, 2023
962c547
Fixes missing curl examples (#243) (#245)
pjaclark Nov 24, 2023
9dead9f
Merge dev into master (#238)
pjaclark Nov 24, 2023
7455c4d
Add sitemap support (#251)
pjaclark Nov 29, 2023
73c1ee4
Remove general search indexes from sitemap (#252)
pjaclark Nov 29, 2023
18a5905
Fixes various 404 page issues (#249)
pjaclark Dec 8, 2023
214eee2
Fix doc generation for non-root paths (#256)
pjaclark Dec 11, 2023
b61ccd0
Set canonical to be latest version instead of "latest" (#257)
pjaclark Dec 11, 2023
79d6b25
Creation of Oracle Linux Installation doc (#258)
JMercerGit Dec 15, 2023
1b0bf32
Merge changes between dev and master
pjaclark Dec 15, 2023
e35cca3
Remove duplicate (#260)
pjaclark Dec 15, 2023
8a47bdd
Remove duplicate (#261)
pjaclark Dec 22, 2023
f20d6f8
Fix merge conflicts
pjaclark Dec 22, 2023
ff6f648
Update Dockerfile
pjaclark Mar 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix broken links and update old version references (#190)
* Key changes for Riak CS 3.0.0

* Fixed disappearing spaces and link typos

* Switched hard coded docs links to dynamic baseurl links. Fixed a broken link target.

* Changed old url structure to match current

* Fixed out of date install instructions and version compatibility table
  • Loading branch information
Bob-The-Marauder authored May 12, 2023
commit 1fcd9d615902eb62c5881639c38be79701d66984
188 changes: 65 additions & 123 deletions content/riak/cs/3.0.0/cookbooks/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can install Riak CS on a single node (for development purposes) or
using an automated deployment tool. Any Riak CS installation involves
three components, all of which must be installed separately:

* [Riak KV]({{<baseurl>}}riak/kv/2.1.4/) --- The distributed database on top of which Riak CS
* [Riak KV]({{<baseurl>}}riak/kv/3.0.9/) --- The distributed database on top of which Riak CS
is built
* Riak CS itself
* [Stanchion]({{<baseurl>}}riak/cs/3.0.0/theory/stanchion) --- An application used to manage [globally unique entities]({{<baseurl>}}riak/cs/3.0.0/theory/stanchion/#globally-unique-entities) such as users and buckets.
Expand All @@ -41,18 +41,18 @@ Before installing Riak CS, Riak KV must be installed on each node in
your cluster. You can install Riak KV either as part of an OS-specific package
or from source.

* [Debian and Ubuntu]({{<baseurl>}}riak/kv/2.1.4/setup/installing/debian-ubuntu)
* [RHEL and CentOS]({{<baseurl>}}riak/kv/2.1.4/setup/installing/rhel-centos)
* [Mac OS X]({{<baseurl>}}riak/kv/2.1.4/setup/installing/mac-osx)
* [FreeBSD]({{<baseurl>}}riak/kv/2.1.4/setup/installing/freebsd)
* [SUSE]({{<baseurl>}}riak/kv/2.1.4/setup/installing/suse)
* [From Source]({{<baseurl>}}riak/kv/2.1.4/setup/installing/source)
* [Debian and Ubuntu]({{<baseurl>}}riak/kv/3.0.9/setup/installing/debian-ubuntu)
* [RHEL and CentOS]({{<baseurl>}}riak/kv/3.0.9/setup/installing/rhel-centos)
<!-- * [Mac OS X]({{<baseurl>}}riak/kv/3.0.9/setup/installing/mac-osx) -->
* [FreeBSD]({{<baseurl>}}riak/kv/3.0.9/setup/installing/freebsd)
<!-- * [SUSE]({{<baseurl>}}riak/kv/3.0.9/setup/installing/suse) -->
* [From Source]({{<baseurl>}}riak/kv/3.0.9/setup/installing/source)

Riak is also officially supported on the following public cloud
infrastructures:

* [Windows Azure]({{<baseurl>}}riak/kv/2.1.4/setup/installing/windows-azure)
* [AWS Marketplace]({{<baseurl>}}riak/kv/2.1.4/setup/installing/amazon-web-services)
* [Windows Azure]({{<baseurl>}}riak/kv/3.0.9/setup/installing/windows-azure)
* [AWS Marketplace]({{<baseurl>}}riak/kv/3.0.9/setup/installing/amazon-web-services)

Remember that you must repeat this installation process on each node in
your cluster. For future reference, you should make note of the Riak KV
Expand All @@ -64,7 +64,7 @@ documentation on [configuring Riak KV for CS]({{<baseurl>}}riak/cs/3.0.0/cookboo
## Installing Riak CS on a Node

Riak CS and Stanchion packages are available on the [Download Riak CS]({{<baseurl>}}riak/cs/3.0.0/downloads/)
page. Similarly, Riak packages are available on the [Download Riak KV]({{<baseurl>}}riak/kv/2.1.4/downloads/) page.
page. Similarly, Riak packages are available on the [Download Riak KV]({{<baseurl>}}riak/kv/3.0.9/downloads/) page.

After downloading Riak CS, Stanchion, and Riak, install them using your
operating system's package management commands.
Expand All @@ -76,13 +76,14 @@ it should not be operated in a manner that exposes it directly to the
public internet**. Instead, consider a load-balancing solution
such as a dedicated device [HAProxy](http://haproxy.1wt.eu) or [Nginx](http://wiki.nginx.org/Main) between Riak CS and the outside world.

<!--
### Installing Riak CS on Mac OS X

To install Riak CS on OS X, first download the appropriate package from
the [downloads]({{<baseurl>}}riak/cs/3.0.0/downloads) page:

```bash
curl -O http://s3.amazonaws.com/downloads.basho.com/riak-cs/1.5/3.0.0/osx/10.8/riak-cs-3.0.0-OSX-x86_64.tar.gz
curl -O https://files.tiot.jp/riak/cs/3.0/3.0.0/osx/10.8/riak-cs-3.0.0-OSX-x86_64.tar.gz
```

Then, unpack the downloaded tarball:
Expand All @@ -92,111 +93,49 @@ tar -xvzf riak-cs-3.0.0-OSX-x86_64.tar.gz
```

At this point, you can move on to [configuring Riak CS]({{<baseurl>}}riak/cs/3.0.0/cookbooks/configuration/riak-cs/).

-->
### Installing Riak CS on Debian or Ubuntu

On Debian and Ubuntu, Riak CS packages are hosted on
[packagecloud.io](https://packagecloud.io/basho/riak-cs). Instructions
for installing via shell scripts, manual installation, Chef, and Puppet
can be found in packagecloud's [installation docs](https://packagecloud.io/basho/riak/install).
On Debian and Ubuntu, Riak CS packages are also hosted on
[files.tiot.jp](https://files.tiot.jp/riak/cs/3.0/3.0.0/).

Platform-specific pages are linked below:

* [Lucid](https://packagecloud.io/basho/riak-cs/riak-cs_3.0.0-1_amd64.deb?distro=lucid)
* [Precise](https://packagecloud.io/basho/riak-cs/riak-cs_3.0.0-1_amd64.deb?distro=precise)
* [Squeeze](https://packagecloud.io/basho/riak-cs/riak-cs_3.0.0-1_amd64.deb?distro=squeeze)
* [Trusty](https://packagecloud.io/basho/riak-cs/riak-cs_3.0.0-1_amd64.deb?distro=trusty)
* [Wheezy](https://packagecloud.io/basho/riak-cs/riak-cs_3.0.0-1_amd64.deb?distro=wheezy)

#### Advanced apt Installation

For the simplest installation process on LTS (Long-Term Support)
releases, use `apt-get`. First, you must retrieve the signing key:
* [Focal](https://files.tiot.jp/riak/cs/3.0/3.0.0/ubuntu/focal64/riak-cs_3.0.0-OTP22_amd64.deb)
* [Jammy](https://files.tiot.jp/riak/cs/3.0/3.0.0/ubuntu/jammy64/riak-cs_3.0.0-OTP22_amd64.deb)
* [Stretch](https://files.tiot.jp/riak/cs/3.0/3.0.0/debian/9/riak-cs_3.0.0-OTP22_amd64.deb)
* [Buster](https://files.tiot.jp/riak/cs/3.0/3.0.0/debian/10/riak-cs_3.0.0-OTP22_amd64.deb)
* [Bullseye](https://files.tiot.jp/riak/cs/3.0/3.0.0/debian/11/riak-cs_3.0.0-OTP22_amd64.deb)

```curl
curl https://packagecloud.io/gpg.key | sudo apt-key add -
```

Second, you must install the `apt-transport-https` package in order to
be able to fetch packages over HTTPS:
#### dpkg Installation

```curl
sudo apt-get install -y apt-transport-https
```

With HTTPS enabled, we recommend adding the desired Riak CS package to
your `.list` file. packagecloud can autogenerate such a file on the
basis of a name that you specify, e.g. a hostname, and the desired
operating system and distribution. The following example script would
store your hostname in the variable `HOSTNAME`, send that information to
packagecloud to autogenerate a `.list` file, and then store the return
value in a file called `basho.list`, which is stored in the
`/etc/apt/sources.list.d` directory. This example script is specific to
the Precise Ubuntu distribution:

```bash
#!/bin/bash

HOSTNAME=`hostname -f`
FILENAME=/etc/apt/sources.list.d/basho.list
OS=ubuntu
DIST=precise
PACKAGE_CLOUD_RIAK_CS_DIR=https://packagecloud.io/install/repositories/basho/riak-cs
curl "${PACKAGE_CLOUD_RIAK_CS_DIR}/config_file.list?os=${OS}&dist=${DIST}&name=${HOSTNAME}" > $FILENAME
```

The `name` that you submit to packagecloud can be anything you like. The
`HOSTNAME` used above was for example purposes. The resulting file
should hold contents like the following:

```
# this file was generated by packagecloud.io for
# the repository at https://packagecloud.io/basho/riak

deb https://packagecloud.io/basho/riak-cs/ubuntu/ precise main
deb-src https://packagecloud.io/basho/riak-cs/ubuntu/ precise main
```

With your `basho.list` file populated, you can update your apt sources
list:

```bash
sudo apt-get update
```
For the simplest installation process on LTS (Long-Term Support)
releases, use `dpkg -i` after downloading the appropriate package for your OS..

Now install the `riak-cs` package:

```bash
sudo apt-get install riak-cs
sudo dpkg -i riak-cs_3.0.0-OTP22_amd64.deb
```

### Installing Riak CS on RHEL or CentOS


On RHEL or CentOS, Riak CS packages are hosted on
[packagecloud.io](https://packagecloud.io/basho/riak-cs). Instructions
for installing via shell scripts, manual installation, Chef, and Puppet
can be found in packagecloud's [installation
docs](https://packagecloud.io/basho/riak-cs/install).
[files.tiot.jp](https://files.tiot.jp/riak/cs/3.0/3.0.0/).

Platform-specific pages are linked below:

* [el5](https://packagecloud.io/basho/riak-cs/riak-cs-3.0.0-1.x86_64.rpm?distro=5)
* [el6](https://packagecloud.io/basho/riak-cs/packages/el/6/riak-cs-3.0.0-1.el6.x86_64.rpm)
<!-- * [el7](https://packagecloud.io/basho/riak-cs/riak-cs-3.0.0-1.x86_64.rpm?distro=7) -->
* [Fedora 19](https://packagecloud.io/basho/riak-cs/riak-cs-3.0.0-1.fc19.x86_64.rpm?distro=19)
* [el7](https://files.tiot.jp/riak/cs/3.0/3.0.0/rhel/7/riak-cs-3.0.0.OTP22-1.el7.x86_64.rpm)
* [el8](https://files.tiot.jp/riak/cs/3.0/3.0.0/rhel/8/riak-cs-3.0.0.OTP22-1.el8.x86_64.rpm)

#### Advanced rpm Installation
#### yum Installation

For the simplest installation process on LTS (Long-Term Support)
releases, use yum. First, you must install the `pygpgme` package, which
enables yum to handle [GPG](https://www.gnupg.org/) signatures:
releases, use `yum` after downloading the appropriate package for your OS.

```bash
sudo yum install pygpgme
```

If you wish to install using a `.repo` file, packagecloud can generate
<!--If you wish to install using a `.repo` file, packagecloud can generate
one for you on the basis of a name that you specify, e.g. a hostname,
and the desired operating system and distribution. The following example
script would store your hostname in the variable `HOSTNAME`, send that
Expand All @@ -222,7 +161,7 @@ should hold contents like the following:
```
[basho_riak-cs]
name=basho_riak-cs
baseurl=https://packagecloud.io/basho/riak-cs/el/5/$basesearch
baseurl=https://files.tiot.jp/riak/cs//el/5/$basesearch
repo_gpgcheck=1
gpgcheck=0
enabled=1
Expand All @@ -232,7 +171,11 @@ sslcacert=/etc/pki/tls/certs/ca-bundle.crt
```

With your `basho.repo` file populated, you can update your rpm sources
list.
list. -->

```bash
sudo yum localinstall -y riak-cs-3.0.0.OTP22-1*
```

## Installing Stanchion on a Node

Expand All @@ -258,7 +201,7 @@ configured to send all requests to a single Stanchion node, failing over
to a secondary Stanchion node if the primary is unavailable. More
details can be found in [Specifying the Stanchion Node]({{<baseurl>}}riak/cs/3.0.0/cookbooks/configuration/#specifying-the-stanchion-node).

### Installing Stanchion on Mac OS X
<!--### Installing Stanchion on Mac OS X

First, download the appropriate package from the [downloads]({{<baseurl>}}riak/cs/3.0.0/downloads/#stanchion-1-4-3) page.

Expand All @@ -273,10 +216,10 @@ stanchion-2.0.0-OSX-x86_64.tar.gz
```

At this point, you can move on to [configuring Riak CS]({{<baseurl>}}riak/cs/3.0.0/cookbooks/configuration/riak-cs).

-->
### Installing Stanchion on Debian or Ubuntu

On Debian or Ubuntu, you can either use `apt` or install the `.deb`
<!-- On Debian or Ubuntu, you can either use `apt` or install the `.deb`
package manually.

#### Installing Using `apt` (recommended)
Expand Down Expand Up @@ -304,52 +247,51 @@ sudo apt-get install stanchion
At this point, you can move on to [configuring Riak CS]({{<baseurl>}}riak/cs/3.0.0/cookbooks/configuration/riak-cs).

#### Installing the `.deb` Package Manually (not recommended)
-->
On Debian and Ubuntu, Riak CS packages are hosted on
[files.tiot.jp](https://files.tiot.jp/riak/stanchion/3.0/3.0.0/).

```bash
sudo dpkg -i <stanchion-package.deb>
```

Replace `<riak-cs-package.deb>` with the actual filename for the package
you are installing.
Platform-specific pages are linked below:

At this point, you can move on to [configuring Riak CS]({{<baseurl>}}riak/cs/3.0.0/cookbooks/configuration/riak-cs).
* [Focal](https://files.tiot.jp/riak/stanchion/3.0/3.0.0/ubuntu/focal64/riak-cs_3.0.0-OTP22_amd64.deb)
* [Jammy](https://files.tiot.jp/riak/stanchion/3.0/3.0.0/ubuntu/jammy64/riak-cs_3.0.0-OTP22_amd64.deb)
* [Stretch](https://files.tiot.jp/riak/stanchion/3.0/3.0.0/debian/9/riak-cs_3.0.0-OTP22_amd64.deb)
* [Buster](https://files.tiot.jp/riak/stanchion/3.0/3.0.0/debian/10/riak-cs_3.0.0-OTP22_amd64.deb)
* [Bullseye](https://files.tiot.jp/riak/stanchion/3.0/3.0.0/debian/11/stanchion_3.0.0-OTP22_amd64.deb)

### Installing Stanchion on RHEL or CentOS

On RHEL or CentOS, you can either use `yum` or install the `.rpm`
package manually.
#### dpkg Installation

#### Installing Using `yum` (recommended)
For the simplest installation process on LTS (Long-Term Support)
releases, use `dpkg -i` after downloading the appropriate package for your OS..

For CentOS/RHEL 6:
Now install the `stanchion` package:

```bash
sudo yum install http://yum.basho.com/gpg/basho-release-6-1.noarch.rpm
sudo dpkg -i stanchion_3.0.0-OTP22_amd64.deb
```

For CentOS/RHEL 5:
At this point, you can move on to [configuring Riak CS]({{<baseurl>}}riak/cs/3.0.0/cookbooks/configuration/riak-cs).

```
sudo yum install http://yum.basho.com/gpg/basho-release-5-1.noarch.rpm
```
### Installing Stanchion on RHEL or CentOS

Once the `.rpm` package has been installed, install Stanchion:
On RHEL or CentOS, Stanchion packages are hosted on
[files.tiot.jp](https://files.tiot.jp/riak/stanchion/3.0/3.0.0/rhel/).

```basho
sudo yum install stanchion
```
Platform-specific pages are linked below:

At this point, you can move on to [configuring Riak CS]({{<baseurl>}}riak/cs/3.0.0/cookbooks/configuration/riak-cs).
* [el7](https://files.tiot.jp/riak/stanchion/3.0/3.0.0/rhel/7/stanchion-3.0.0.OTP22-1.el7.x86_64.rpm)
* [el8](https://files.tiot.jp/riak/stanchion/3.0/3.0.0/rhel/8/stanchion-3.0.0.OTP22-1.el8.x86_64.rpm)

#### Installing the `.rpm` Package Manually (not recommended)
#### yum Installation

For the simplest installation process on LTS (Long-Term Support)
releases, use `yum` after downloading the appropriate package for your OS.

```bash
sudo rpm -Uvh <stanchion-package.rpm>
sudo yum -localinstall -y stanchion-3.0.0*
```

Replace `<stanchion-package.rpm>` with the actual filename for the
package you are installing.

At this point, you can move on to [configuring Riak CS]({{<baseurl>}}riak/cs/3.0.0/cookbooks/configuration/riak-cs).

> **Note on SELinux**
Expand Down
7 changes: 5 additions & 2 deletions content/riak/cs/3.0.0/cookbooks/version-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,14 @@ Riak version | Stanchion version | Riak CS version
1.4.12 | 1.5.0 | 1.5.4
2.0.5 | 2.0.0 | 2.0.0
2.0.5 | 2.0.0 | 2.0.1
3.0.0 | 2.1.0 | 2.1.0
2.1.4 | 2.1.1 | 2.1.1
2.9.8 | 2.1.2 | 2.1.2
3.0.9 | 3.0.0 | 3.0.0

**Note**: While Riak CS versions 1.5.0 and later will work with Riak
1.4.x, we highly recommend running CS with at least Riak 1.4.8,
preferably 1.4.10.
preferably 1.4.10. In the same way, Riak CS 2.1.2 will work with Riak
from KV 2.1.x through to KV 3.0.x.

Basic functionality testing consists of account creation, object storage and
retrieval, bucket listing operations, and Access Control List (ACL) enforcement
Expand Down