From f417af51ade505d4fe1acb232458c5546e08b5bc Mon Sep 17 00:00:00 2001 From: James M <35449344+JMercerGit@users.noreply.github.com> Date: Thu, 5 Jun 2025 14:41:40 +0100 Subject: [PATCH] Removal of Riak Control from 3.0.1 onwards Removal of Riak Control from 3.0.1 onwards --- content/riak/kv/3.0.1/using/admin.md | 6 - .../riak/kv/3.0.1/using/admin/riak-control.md | 240 ------------------ content/riak/kv/3.0.10/using/admin.md | 7 - .../kv/3.0.10/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.11/using/admin.md | 7 - .../kv/3.0.11/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.12/using/admin.md | 7 - .../kv/3.0.12/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.13/using/admin.md | 7 - .../kv/3.0.13/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.14/using/admin.md | 6 - .../kv/3.0.14/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.15/using/admin.md | 7 - .../kv/3.0.15/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.16/using/admin.md | 6 - .../kv/3.0.16/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.2/using/admin.md | 7 - .../riak/kv/3.0.2/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.3/using/admin.md | 7 - .../riak/kv/3.0.3/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.4/using/admin.md | 7 - .../riak/kv/3.0.4/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.6/using/admin.md | 7 - .../riak/kv/3.0.6/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.7/using/admin.md | 7 - .../riak/kv/3.0.7/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.8/using/admin.md | 7 - .../riak/kv/3.0.8/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.0.9/using/admin.md | 7 - .../riak/kv/3.0.9/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.2.0/using/admin.md | 7 - .../riak/kv/3.2.0/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.2.3/using/admin.md | 7 - .../riak/kv/3.2.3/using/admin/riak-control.md | 240 ------------------ content/riak/kv/3.2.4/using/admin.md | 7 - .../riak/kv/3.2.4/using/admin/riak-control.md | 239 ----------------- content/riak/kv/3.2.5/using/admin.md | 7 - .../riak/kv/3.2.5/using/admin/riak-control.md | 239 ----------------- 38 files changed, 4673 deletions(-) delete mode 100644 content/riak/kv/3.0.1/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.10/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.11/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.12/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.13/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.14/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.15/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.16/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.2/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.3/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.4/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.6/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.7/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.8/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.0.9/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.2.0/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.2.3/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.2.4/using/admin/riak-control.md delete mode 100644 content/riak/kv/3.2.5/using/admin/riak-control.md diff --git a/content/riak/kv/3.0.1/using/admin.md b/content/riak/kv/3.0.1/using/admin.md index 8d7e3bc66d..f2e33c3d91 100644 --- a/content/riak/kv/3.0.1/using/admin.md +++ b/content/riak/kv/3.0.1/using/admin.md @@ -22,7 +22,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -44,9 +43,4 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] diff --git a/content/riak/kv/3.0.1/using/admin/riak-control.md b/content/riak/kv/3.0.1/using/admin/riak-control.md deleted file mode 100644 index 1a7eb850c3..0000000000 --- a/content/riak/kv/3.0.1/using/admin/riak-control.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.1" -lastmod: 2020-08-20T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.1: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.1/ops/advanced/riak-control - - /riak/kv/3.0.1/ops/advanced/riak-control - ---- - -[config reference]: {{}}riak/kv/3.0.1/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.1/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.1/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.10/using/admin.md b/content/riak/kv/3.0.10/using/admin.md index a2e40917bd..bafe8e3b3f 100644 --- a/content/riak/kv/3.0.10/using/admin.md +++ b/content/riak/kv/3.0.10/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.10/using/admin/riak-control.md b/content/riak/kv/3.0.10/using/admin/riak-control.md deleted file mode 100644 index 1758790b27..0000000000 --- a/content/riak/kv/3.0.10/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.10" -lastmod: 2022-05-30T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.10: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.10/ops/advanced/riak-control - - /riak/kv/3.0.10/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.10/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.10/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.10/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.11/using/admin.md b/content/riak/kv/3.0.11/using/admin.md index da172ef596..3a99edf13d 100644 --- a/content/riak/kv/3.0.11/using/admin.md +++ b/content/riak/kv/3.0.11/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.11/using/admin/riak-control.md b/content/riak/kv/3.0.11/using/admin/riak-control.md deleted file mode 100644 index 6ed7551de0..0000000000 --- a/content/riak/kv/3.0.11/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.11" -lastmod: 2022-10-12T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.11: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.11/ops/advanced/riak-control - - /riak/kv/3.0.11/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.11/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.11/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.11/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.12/using/admin.md b/content/riak/kv/3.0.12/using/admin.md index fcdc0f4016..ebc821f934 100644 --- a/content/riak/kv/3.0.12/using/admin.md +++ b/content/riak/kv/3.0.12/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.12/using/admin/riak-control.md b/content/riak/kv/3.0.12/using/admin/riak-control.md deleted file mode 100644 index 5a6d3fac07..0000000000 --- a/content/riak/kv/3.0.12/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.12" -lastmod: 2022-12-20T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.12: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.12/ops/advanced/riak-control - - /riak/kv/3.0.12/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.12/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.12/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.12/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.13/using/admin.md b/content/riak/kv/3.0.13/using/admin.md index 00e036ec8a..ce0be80805 100644 --- a/content/riak/kv/3.0.13/using/admin.md +++ b/content/riak/kv/3.0.13/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.13/using/admin/riak-control.md b/content/riak/kv/3.0.13/using/admin/riak-control.md deleted file mode 100644 index c84497ec17..0000000000 --- a/content/riak/kv/3.0.13/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.13" -lastmod: 2023-02-04T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.13: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.13/ops/advanced/riak-control - - /riak/kv/3.0.13/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.13/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.13/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.13/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.14/using/admin.md b/content/riak/kv/3.0.14/using/admin.md index 6fe73e2557..c419fb80f0 100644 --- a/content/riak/kv/3.0.14/using/admin.md +++ b/content/riak/kv/3.0.14/using/admin.md @@ -43,9 +43,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.14/using/admin/riak-control.md b/content/riak/kv/3.0.14/using/admin/riak-control.md deleted file mode 100644 index 73e2a45c50..0000000000 --- a/content/riak/kv/3.0.14/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.14" -lastmod: 2023-02-13T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.14: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.14/ops/advanced/riak-control - - /riak/kv/3.0.14/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.14/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.14/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.14/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.15/using/admin.md b/content/riak/kv/3.0.15/using/admin.md index bd24640e49..d7ce23eb5a 100644 --- a/content/riak/kv/3.0.15/using/admin.md +++ b/content/riak/kv/3.0.15/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.15/using/admin/riak-control.md b/content/riak/kv/3.0.15/using/admin/riak-control.md deleted file mode 100644 index 52194a0afd..0000000000 --- a/content/riak/kv/3.0.15/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.15" -lastmod: 2023-02-15T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.15: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.15/ops/advanced/riak-control - - /riak/kv/3.0.15/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.15/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.15/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.15/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.16/using/admin.md b/content/riak/kv/3.0.16/using/admin.md index 17d32db669..e7653b4ab6 100644 --- a/content/riak/kv/3.0.16/using/admin.md +++ b/content/riak/kv/3.0.16/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,4 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] diff --git a/content/riak/kv/3.0.16/using/admin/riak-control.md b/content/riak/kv/3.0.16/using/admin/riak-control.md deleted file mode 100644 index 19908afd6c..0000000000 --- a/content/riak/kv/3.0.16/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.16" -lastmod: 2023-06-23T00:00:00-00:00 -sitemap: - priority: 0.8 -menu: - riak_kv-3.0.16: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.16/ops/advanced/riak-control - - /riak/kv/3.0.16/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.16/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.16/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.16/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.2/using/admin.md b/content/riak/kv/3.0.2/using/admin.md index e147660062..d5a41fb59f 100644 --- a/content/riak/kv/3.0.2/using/admin.md +++ b/content/riak/kv/3.0.2/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak-admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.2/using/admin/riak-control.md b/content/riak/kv/3.0.2/using/admin/riak-control.md deleted file mode 100644 index dd2748f4bf..0000000000 --- a/content/riak/kv/3.0.2/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.2" -lastmod: 2021-01-05T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.2: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.2/ops/advanced/riak-control - - /riak/kv/3.0.2/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.2/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.2/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.2/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.3/using/admin.md b/content/riak/kv/3.0.3/using/admin.md index 8a493f86c1..87352ab036 100644 --- a/content/riak/kv/3.0.3/using/admin.md +++ b/content/riak/kv/3.0.3/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.3/using/admin/riak-control.md b/content/riak/kv/3.0.3/using/admin/riak-control.md deleted file mode 100644 index e4d7d73130..0000000000 --- a/content/riak/kv/3.0.3/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.3" -lastmod: 2021-01-14T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.3: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.3/ops/advanced/riak-control - - /riak/kv/3.0.3/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.3/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.3/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.3/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.4/using/admin.md b/content/riak/kv/3.0.4/using/admin.md index bb388876d7..62016da268 100644 --- a/content/riak/kv/3.0.4/using/admin.md +++ b/content/riak/kv/3.0.4/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.4/using/admin/riak-control.md b/content/riak/kv/3.0.4/using/admin/riak-control.md deleted file mode 100644 index 48de53b1a0..0000000000 --- a/content/riak/kv/3.0.4/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.4" -lastmod: 2021-03-24T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.4: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.4/ops/advanced/riak-control - - /riak/kv/3.0.4/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.4/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.4/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.4/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.6/using/admin.md b/content/riak/kv/3.0.6/using/admin.md index ca00149a8b..eea6520d6d 100644 --- a/content/riak/kv/3.0.6/using/admin.md +++ b/content/riak/kv/3.0.6/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.6/using/admin/riak-control.md b/content/riak/kv/3.0.6/using/admin/riak-control.md deleted file mode 100644 index d60e6ec74c..0000000000 --- a/content/riak/kv/3.0.6/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.6" -lastmod: 2021-05-07T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.6: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.6/ops/advanced/riak-control - - /riak/kv/3.0.6/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.6/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.6/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.6/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.7/using/admin.md b/content/riak/kv/3.0.7/using/admin.md index e73d47a4bf..100c6d5649 100644 --- a/content/riak/kv/3.0.7/using/admin.md +++ b/content/riak/kv/3.0.7/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.7/using/admin/riak-control.md b/content/riak/kv/3.0.7/using/admin/riak-control.md deleted file mode 100644 index 20cee15186..0000000000 --- a/content/riak/kv/3.0.7/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.7" -lastmod: 2021-07-17T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.7: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.7/ops/advanced/riak-control - - /riak/kv/3.0.7/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.7/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.7/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.7/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.8/using/admin.md b/content/riak/kv/3.0.8/using/admin.md index 27e39d59be..1b39e7ba63 100644 --- a/content/riak/kv/3.0.8/using/admin.md +++ b/content/riak/kv/3.0.8/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak-admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.8/using/admin/riak-control.md b/content/riak/kv/3.0.8/using/admin/riak-control.md deleted file mode 100644 index 5a3ff1705a..0000000000 --- a/content/riak/kv/3.0.8/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.8" -lastmod: 2021-10-12T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.8: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.8/ops/advanced/riak-control - - /riak/kv/3.0.8/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.8/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.8/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.8/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.0.9/using/admin.md b/content/riak/kv/3.0.9/using/admin.md index 2eb1ab10e6..431abccec8 100644 --- a/content/riak/kv/3.0.9/using/admin.md +++ b/content/riak/kv/3.0.9/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.0.9/using/admin/riak-control.md b/content/riak/kv/3.0.9/using/admin/riak-control.md deleted file mode 100644 index 79b21ed0a2..0000000000 --- a/content/riak/kv/3.0.9/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.0.9" -lastmod: 2021-11-12T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.0.9: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.0.9/ops/advanced/riak-control - - /riak/kv/3.0.9/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.0.9/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.0.9/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.0.9/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.2.0/using/admin.md b/content/riak/kv/3.2.0/using/admin.md index 52ec47f929..6161c4f847 100644 --- a/content/riak/kv/3.2.0/using/admin.md +++ b/content/riak/kv/3.2.0/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.2.0/using/admin/riak-control.md b/content/riak/kv/3.2.0/using/admin/riak-control.md deleted file mode 100644 index 903b3f6bd0..0000000000 --- a/content/riak/kv/3.2.0/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.2.0" -lastmod: 2022-12-30T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.2.0: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.2.0/ops/advanced/riak-control - - /riak/kv/3.2.0/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.2.0/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.2.0/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.2.0/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.2.3/using/admin.md b/content/riak/kv/3.2.3/using/admin.md index ffe4bb747e..5af88f7986 100644 --- a/content/riak/kv/3.2.3/using/admin.md +++ b/content/riak/kv/3.2.3/using/admin.md @@ -22,7 +22,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -44,9 +43,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.2.3/using/admin/riak-control.md b/content/riak/kv/3.2.3/using/admin/riak-control.md deleted file mode 100644 index 442a385050..0000000000 --- a/content/riak/kv/3.2.3/using/admin/riak-control.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.2.3" -lastmod: 2024-12-09T00:00:00-00:00 - -sitemap: - priority: 0.2 -menu: - riak_kv-3.2.3: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.2.3/ops/advanced/riak-control - - /riak/kv/3.2.3/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.2.3/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.2.3/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.2.3/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.2.4/using/admin.md b/content/riak/kv/3.2.4/using/admin.md index a48629bcf1..4fd4780f0f 100644 --- a/content/riak/kv/3.2.4/using/admin.md +++ b/content/riak/kv/3.2.4/using/admin.md @@ -22,7 +22,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -44,9 +43,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.2.4/using/admin/riak-control.md b/content/riak/kv/3.2.4/using/admin/riak-control.md deleted file mode 100644 index 00349359e9..0000000000 --- a/content/riak/kv/3.2.4/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.2.4" -lastmod: 2025-01-26T00:00:00-00:00 -sitemap: - priority: 0.2 -menu: - riak_kv-3.2.4: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.2.4/ops/advanced/riak-control - - /riak/kv/3.2.4/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.2.4/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.2.4/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.2.4/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. - diff --git a/content/riak/kv/3.2.5/using/admin.md b/content/riak/kv/3.2.5/using/admin.md index f846ad5d77..1105b03797 100644 --- a/content/riak/kv/3.2.5/using/admin.md +++ b/content/riak/kv/3.2.5/using/admin.md @@ -21,7 +21,6 @@ aliases: [use admin commands]: ./commands/ [use admin riak cli]: ./riak-cli/ [use admin riak admin]: ./riak-admin/ -[use admin riak control]: ./riak-control/ ## In This Section @@ -43,9 +42,3 @@ Covers the `riak` interface, which enables control of the processes associated w [Learn More >>][use admin riak cli] -#### [Riak Control][use admin riak control] - -Overview of Riak Control, a web-based administrative console for Riak clusters. - -[Learn More >>][use admin riak control] - diff --git a/content/riak/kv/3.2.5/using/admin/riak-control.md b/content/riak/kv/3.2.5/using/admin/riak-control.md deleted file mode 100644 index 86f03bc34f..0000000000 --- a/content/riak/kv/3.2.5/using/admin/riak-control.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "Riak Control" -description: "" -project: "riak_kv" -project_version: "3.2.5" -lastmod: 2025-03-24T00:00:00-00:00 -sitemap: - priority: 0.9 -menu: - riak_kv-3.2.5: - name: "Riak Control" - identifier: "cluster_admin_riak_control" - weight: 103 - parent: "managing_cluster_admin" -toc: true -aliases: - - /riak/3.2.5/ops/advanced/riak-control - - /riak/kv/3.2.5/ops/advanced/riak-control ---- - -[config reference]: {{}}riak/kv/3.2.5/configuring/reference - -Riak Control is a web-based administrative console for inspecting and -manipulating Riak clusters. - -## Requirements - -Though Riak Control [is maintained as a separate application](https://github.com/basho/riak_control), the necessary code for it ships with versions of Riak 1.1 and above and requires no additional installation steps. - -Before getting started, you should know the address and port of the HTTP (or -HTTPS) listeners for the cluster member(s) running Riak Control. You can obtain -this information from the configuration files as indicated here: - -```riakconf -listener.http. = 127.0.0.1:8098 - -or - -listener.https. = 127.0.0.1:8096 - -## *** The default listeners in the riak.conf file are - -## named `internal`, so you would consult the value of - -## `listener.http.internal` in your configuration. - -``` - -```appconfig - {riak_api, - [ - %% Other configs - ... if HTTP is configured ... - {http,[{"127.0.0.1",8098}]}, - ... if HTTPS is configured ... - {https,[{"127.0.0.1",8069}]}, - %% Other configs - ]}, - -%% *** This is a truncated configuration to illustrate the -%% pertinent items -- the `http` and `https` tuples within -%% the `riak_api` tuple's value list. -``` - -{{% note title="Note on SSL" %}} -We strongly recommend that you enable SSL for Riak Control. It is disabled by -default, and if you wish to enable it you must do so explicitly. More -information can be found in the document below. -{{% /note %}} - -## Enabling and Disabling Riak Control - -Riak Control is disabled by default, meaning that you should see the -following in your [configuration files][config reference]: - -```riakconf -riak_control = off -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, false}, - %% Other configs - ]} -``` - -Enabling Riak Control is simple: - -```riakconf -riak_control = on -``` - -```appconfig -{riak_control, [ - %% Other configs - {enabled, true}, - %% Other configs - ]} -``` - -Make sure to restart the node once you have enabled Riak Control for the -change to take effect. - -After restarting the node, you should be able to access it by going -to `http://ip_address_of_listener:port/admin`. In the case of a development -cluster using the default configuration, you would access Riak Control at - - -If you enabled authentication for Riak Control while performing the above -configuration, you will be unable to access Riak Control until you have enabled -and configured SSL and HTTPS. - -## Enabling SSL and HTTPS - -In order to use SSL in conjunction with Riak Control, SSL must be -enabled on each Riak node. For more information, see our [security documentation]({{}}riak/kv/3.2.5/using/security/basics#enabling-ssl). Once SSL is enabled, you can proceed to setting up [authentication](#authentication) for Riak Control. - -Please note that Riak Control will not work if you have enabled -authentication but SSL is not set up properly. - -## Authentication - -Riak Control provides you the option of requiring authentication (via -HTTP basic auth) for users of the web interface. It is disabled by -default. To enable authentication: - -```riakconf -riak_control.auth.mode = userlist -``` - -```appconfig -{riak_control, [ - %% Other configs - {auth, userlist}, %% The only other available option is "none" - %% Other configs - ]} -``` - -When authentication is enabled, you can specify as many -username/password pairs as you wish. The default pair is the username - -`user` and the password `pass`. We strongly recommend selecting -different credentials. The example below would set up three user-defined -pairs: - -```riakconf -riak_control.auth.user.bob.password = bob_is_the_coolest -riak_control.auth.user.polly.password = h4x0r123 -riak_control.auth.user.riakrocks.password = cap_theorem_4_life -``` - -```appconfig -{riak_control, [ - %% Other configs - {userlist, [ - {"bob", "bob_is_the_coolest"}, - {"polly", "h4x0r123"}, - {"riakrocks", "cap_theorem_4_life"} - ]} - %% Other configs -]} -``` - -## User Interface - -To begin using Riak Control, navigate to https://ip_address_of_https_listener:https_port/admin -For a default configuration, this will be . - -If your browser warns you that it cannot authenticate the page, this may -be because you are using self-signed certificates. If you have -authentication enabled in your configuration, you will next be asked to -authenticate. Enter an appropriate username and password now. - -{{% note title="Note on browser TLS" %}} -Your browser needs to be support TLS v1.2 to use Riak Control over HTTPS. A -list of browsers that support TLS v1.2 can be found -[here](https://en.wikipedia.org/wiki/Transport_Layer_Security#Web_browsers). -TLS v1.2 may be disabled by default on your browser, for example if you are -using Firefox versions earlier than 27, Safari versions earlier than 7, Chrome -versions earlier than 30, or Internet Explorer versions earlier than 11. To -enable it, follow browser-specific instructions. -{{% /note %}} - -### Snapshot View - -When you first navigate to Riak Control, you will land on the Snapshot -view: - -[ ![Snapshot View]({{}}images/control_current_snapshot.png) ] ({{}}images/control_current_snapshot.png) - -In this interface, the health of your cluster is made immediately -obvious. In the event that something isn't quite right (or has the -potential to cause problems in the near future), the green check mark -will turn into a red `X`. The red `X` is accompanied by a list of -reasons for concern. Each item in the list links to a page where you can -get more information about the issue. - -### Cluster Management View - -On the top right side of the admin panel are navigation tabs. If you -click the **Cluster** tab, you will be taken to the cluster management -page. - -On this page, you can see all of the nodes in your cluster, along with -their status, the percentage of the ring owned by that node, and memory -consumption. You can also stage and commit changes to the cluster, such -as adding, removing, and marking nodes as down. - -Staged changes to the cluster: - -[ ![Cluster Management Staged]({{}}images/control_cluster_management_staged.png) ] ({{}}images/control_cluster_management_staged.png) - -Changes committed; transfers active: - -[ ![Cluster Management Transfers]({{}}images/control_cluster_management_transfers.png) ] ({{}}images/control_cluster_management_transfers.png) - -Cluster stabilizes after changes: - -[ ![Cluster Management Stable]({{}}images/control_cluster_management_stable.png) ] ({{}}images/control_cluster_management_stable.png) - -### Node Management View - -The node management view allows you to operate against the individual -nodes in the cluster. - -[ ![Node Management]({{}}images/control_node_management.png) ] ({{}}images/control_node_management.png) - -### Ring View - -One level deeper than the cluster view is the ring view. This is where you can -see the health of each [vnode]({{}}riak/kv/3.2.5/learn/glossary/#vnode). - -[ ![Ring View]({{}}images/control_current_ring.png) ] ({{}}images/control_current_ring.png) - -Most of the time, your ring will be too large to effectively manage from -the ring view. That said, with filters you can easily identify partition -ownership, unreachable primaries, and in-progress handoffs. -