Remote Observability Service Sub-commands for MariaDB Shell

Overview

MariaDB Shell supports the ros sub-command for use with the Remote Observability Service.

Compatibility

MariaDB Shell (mariadb-shell) has been tested by MariaDB to properly connect and execute commands with:

  • Distributed Transactions

  • Multi-Node Analytics

  • Replicated Transactions

  • Single Node Analytics

  • Single Node Transactions

  • MariaDB Enterprise ColumnStore 6

  • MariaDB Enterprise ColumnStore 22.08

  • MariaDB Enterprise ColumnStore 23.02

  • MariaDB Enterprise Server 10.4

  • MariaDB Enterprise Server 10.5

  • MariaDB Enterprise Server 10.6

  • MariaDB MaxScale 2.4

  • MariaDB MaxScale 2.5

  • MariaDB MaxScale 6

  • MariaDB MaxScale 22.08

  • MariaDB MaxScale 23.02

  • MariaDB Xpand 5.3

  • MariaDB Xpand 6.0

  • MariaDB Xpand 6.1

Supported Operating Systems

  • Apple macOS (x86_64 / M1)

  • CentOS 7 (x86_64)

  • Debian 10 (x86_64)

  • Debian 11 (x86_64)

  • Microsoft Windows (x86_64)

  • Red Hat Enterprise Linux 7 (x86_64)

  • Red Hat Enterprise Linux 8 (x86_64)

  • Red Hat Enterprise Linux 9 (x86_64)

  • Rocky Linux 8 (x86_64)

  • Rocky Linux 9 (x86_64)

  • Ubuntu 18.04 (x86_64)

  • Ubuntu 20.04 (x86_64)

  • Ubuntu 22.04 (x86_64)

Execute via Interactive Shell

The ros sub-commands can be executed from an interactive shell:

MariaDB (No Database) » ros install

Execute via CLI

The ros sub-commands can also be executed using CLI commands:

$ mariadb-shell \
   ros install

create-user

The ros create-user sub-command creates a database or MaxScale user for MariaDB Agent Manager. It is equivalent to Agent Manager's create-user sub-command and supports the same command-line options.

diagnose

The ros diagnose sub-command performs MariaDB Agent Manager's diagnostic tests. It is equivalent to Agent Manager's diagnose sub-command and supports the same command-line options.

encrypt-creds

The ros encrypt-creds sub-command encrypts service credentials. It is equivalent to Agent Manager's encrypt-creds sub-command and supports the same command-line options.

init

The ros init sub-command initializes a MariaDB Agent Manager configuration file. It is equivalent to Agent Manager's init sub-command and supports the same command-line options.

install

The ros install sub-command installs MariaDB Agent Manager. It is equivalent to Agent Manager's install sub-command and supports the same command-line options.

start

The ros start sub-command starts MariaDB Agent Manager's monitoring services on the current host. It is equivalent to Agent Manager's start sub-command and supports the same command-line options.

status

The ros status sub-command prints the status of MariaDB Agent Manager's monitoring services on the current host. It is equivalent to Agent Manager's status sub-command and supports the same command-line options.

stop

The ros stop sub-command stops MariaDB Agent Manager's monitoring services on the current host. It is equivalent to Agent Manager's stop sub-command and supports the same command-line options.

uninstall

The ros uninstall sub-command uninstalls MariaDB Agent Manager. It is equivalent to Agent Manager's uninstall sub-command and supports the same command-line options.