Disabling and enabling the Security plugin

The Security plugin is installed by default with SmartObserve, but you can temporarily disable it or remove it altogether. Disabling the plugin involves a change to the smartobserve.yml file; you may want to do this to streamline testing. A more substantive change is required to remove the Security plugin completely. You might want to remove it if, for example, you are using your own security solution or need to remove it for development purposes.

Disabling or removing the plugin exposes the configuration index for the Security plugin. If the index contains sensitive information, make sure to protect it through some other means. If you no longer need the index, delete it.

Disabling, removing, or installing the Security plugin requires a full cluster restart because during this process, the individual nodes are not able to communicate with each other.

Disabling/enabling the Security plugin

You can disable the Security plugin by editing the smartobserve.yml file:

plugins.security.disabled: true

You can then enable the plugin by removing the plugins.security.disabled setting.

Removing and adding the Security plugin

You can completely remove the Security plugin from your SmartObserve instance. Note that SmartObserve Dashboards can only run against a secure cluster, so if you uninstall the Security plugin, you’ll also need to uninstall the SmartObserve Dashboards plugin.

Removing the Security plugin from SmartObserve

Do the following to remove the plugin from SmartObserve.

Disable shard allocation and stop all nodes so that shards don’t move when the cluster is restarted:

curl -XPUT "https://localhost:9200/_cluster/settings" -u "admin:<password>" -H 'Content-Type: application/json' -d '{
   "transient": {
      "cluster.routing.allocation.enable": "none"
   }
}'

Delete all plugins.security.* configuration entries from smartobserve.yml.
Uninstall the Security plugin by using the following command:
```
./bin/smartobserve-plugin remove smartobserve-security
```

Restart the nodes and enable shard allocation:

curl -XPUT "http://localhost:9200/_cluster/settings" -H 'Content-Type: application/json' -d '{
 "transient": {
   "cluster.routing.allocation.enable": "all"
   }
}'

To perform these steps on the Docker image, see Working with plugins.

Removing the Security plugin from SmartObserve Dashboards

If you disable the Security plugin in smartobserve.yml and still want to use SmartObserve Dashboards, you must remove the corresponding SmartObserve Dashboards Security plugin. For more information, see Remove plugins.

Refer to the following installation types to remove the SmartObserve Dashboards plugin.

Docker

Remove all Security plugin configuration settings from smartobserve_dashboards.yml or move the example file to the same folder as the Dockerfile:
```
---
server.name: smartobserve-dashboards
server.host: "0.0.0.0"
smartobserve.hosts: http://localhost:9200
```

Create a new Dockerfile:

FROM smartobserveproject/smartobserve-dashboards:3.3.0
RUN /usr/share/smartobserve-dashboards/bin/smartobserve-dashboards-plugin remove securityDashboards
COPY --chown=smartobserve-dashboards:smartobserve-dashboards smartobserve_dashboards.yml /usr/share/smartobserve-dashboards/config/

To build the new Docker image, run the following command:

docker build --tag=smartobserve-dashboards-no-security .

In docker-compose.yml, change smartobserveproject/smartobserve-dashboards:3.3.0 to smartobserve-dashboards-no-security.
Change OPENSEARCH_HOSTS or smartobserve.hosts to http:// rather than https://.
Enter docker compose up.

Tarball

Navigate to the /bin directory in your SmartObserve Dashboards installation folder and stop the running SmartObserve Dashboards instance by pressing Ctrl + C.

Run the following command to uninstall the Security plugin:

./bin/smartobserve-dashboards-plugin remove securityDashboards

Remove all Security plugin configuration settings from the smartobserve_dashboards.yml file or use the following example file:
```
---
server.name: smartobserve-dashboards
server.host: "0.0.0.0"
smartobserve.hosts: http://localhost:9200
```
Start SmartObserve Dashboards:
```
./bin/smartobserve-dashboards
```

RPM and Debian

Stop the running instance of SmartObserve Dashboards by using the following command:
```
sudo systemctl stop smartobserve-dashboards
```
Navigate to the SmartObserve Dashboards folder /usr/share/smartobserve-dashboards and run the following command to uninstall the Security plugin:
```
./bin/smartobserve-dashboards-plugin remove securityDashboards
```
Remove all Security plugin configuration settings from the smartobserve_dashboards.yml file or place the example file in the /etc/smartobserve_dashboards folder:
```
---
server.name: smartobserve-dashboards
server.host: "0.0.0.0"
smartobserve.hosts: http://localhost:9200
```

Start SmartObserve Dashboards:

sudo systemctl start smartobserve-dashboards

Installing the Security plugin

Use the following steps to reinstall the plugin:

Disable shard allocation and stop all nodes so that shards don’t move when the cluster is restarted:

 curl -XPUT "http://localhost:9200/_cluster/settings" -H 'Content-Type: application/json' -d '{
   "transient": {
     "cluster.routing.allocation.enable": "none"
     }
  }'

Install the Security plugin on all nodes in your cluster using one of the installation methods:
```
 bin/smartobserve-plugin install smartobserve-security
```
Add the necessary configuration to smartobserve.yml for TLS encryption. See Configuration for information about the settings that need to be configured.
Create the OPENSEARCH_INITIAL_ADMIN_PASSWORD variable. For more information, see Setting up a custom admin password.

Restart the nodes and reenable shard allocation:

curl -XPUT "https://localhost:9200/_cluster/settings" -u "admin:<password>" -H 'Content-Type: application/json' -d '{
  "transient": {
   "cluster.routing.allocation.enable": "all"
  }
}'

Installing the Security plugin on SmartObserve Dashboards

Use the following steps to reinstall the plugin on SmartObserve Dashboards:

Stop running your SmartObserve Dashboards cluster.

Install the Security plugin:

   ./bin/smartobserve-dashboards-plugin install securityDashboards

Add the necessary configuration settings in the smartobserve_dashboards.yml file.
Start SmartObserve Dashboards. If the plugin was successfully installed, you’ll be prompted to enter your login credentials.

Disabling/enabling the Security plugin
Removing and adding the Security plugin