Installation and Setup
Overview
This guide describes how to set up the BlueRock Dashboard, configure the required SSL certificate and network access, connect an existing BlueRock Host, and verify that telemetry is reaching the Dashboard.
Prerequisites
Before beginning the installation, ensure that you have:
An Ubuntu Linux VM for the BlueRock Dashboard.
A BlueRock Host that is already deployed and running.
Note: The BlueRock Host must already be deployed and running. For instructions on deploying the BlueRock Host, see the BlueRock Host deployment guide.
SSH access to the required VMs.
Access to the BlueRock container registry and the Dashboard container image for the required release.
Permission to configure the required network access rules.
A hostname or IP address for the Dashboard.
An SSL certificate for the Dashboard, or the information required to create one.
1. Prepare the BlueRock Dashboard VM
The BlueRock Dashboard runs on a generic Ubuntu Linux VM provided by the selected cloud platform.
Provision the BlueRock Dashboard VM using the AWS CLI and an Ubuntu Linux image.
Use the following command to create the VM:
Provision the BlueRock Dashboard VM using the AWS CLI and an Ubuntu Linux image.
Use the following command to create the VM:
Ensure that SSH access on port 22 is allowed for connection from the administrator desktop so that the administrator can SSH to the VM.
Provision the BlueRock Dashboard VM using the Azure CLI and an Ubuntu Linux image.
Use the following command to create the VM:
Ensure that SSH access on port 22 is allowed from the approved administrator IP addresses so that you can connect to the VM.
Provision the BlueRock Dashboard VM using the GCP CLI and an Ubuntu Linux image.
Use the following command to create the VM:
Ensure that SSH access on port 22 is allowed from the approved administrator IP addresses so that you can connect to the VM.
2. Connect to the Dashboard VM
Connect to the Dashboard VM using SSH.
3. Install Docker
The BlueRock Dashboard runs inside a Docker container.
Install Docker on the Dashboard VM:
Add the current user to the Docker group:
Apply the group change:
Verify the Docker installation:
4. Authenticate to the Container Registry and Pull the Dashboard Image
The BlueRock Dashboard container image is hosted in a private container registry.
Important: To access the BlueRock container images, get in touch with BlueRock Support.
Authenticate to the private container registry using the credentials or authentication method provided by BlueRock Support.
After authentication, pull the Dashboard image for the required release:
Verify that the image is available:
5. Configure SSL Certificate
BlueRock Dashboard uses HTTPS to secure communication between the Dashboard and BlueRock Hosts.
You can use either:
A self-signed SSL certificate for internal testing
An SSL certificate issued by a trusted Certificate Authority (CA) for production deployments
Self-signed SSL Certificate
Use a self-signed SSL certificate for internal testing only.
Note: Self-signed SSL certificates are intended for internal testing only and are not recommended for production deployments.
Create a directory for the certificate:
Generate the self-signed certificate:
Replace <DASHBOARD_IP_OR_HOSTNAME> with the hostname or IP address used to access the BlueRock Dashboard.
Set the appropriate permissions on the private key:
Verify the generated certificate:
The certificate and private key are mounted when the Dashboard container is started.
Because the certificate is self-signed, the BlueRock Host must add the server certificate to the ca-certificates trust store to ensure successful HTTPS connection with the Dashboard.
Copy server.crt to the BlueRock Host:
Update the certificate trust store:
Trusted SSL Certificate
For production deployments, use an SSL certificate issued by a trusted Certificate Authority (CA).
You can obtain a certificate from any trusted CA. Let's Encrypt is one example of a CA that provides publicly trusted certificates.
Obtain a publicly trusted certificate for the hostname used to access the BlueRock Dashboard.
Store the certificate and private key on the Dashboard VM as:
Where:
server.crtis the SSL certificate.server.keyis the corresponding private key.
Verify the certificate:
The certificate and private key are mounted when the Dashboard container is started.
If the certificate is issued by a trusted CA, the BlueRock Host does not require additional certificate configuration, provided that the CA is already trusted by the host.
If the certificate uses an intermediate CA, install the required certificate chain on the BlueRock Host.
Note: Ensure that the certificate matches the hostname used to access the BlueRock Dashboard.
6. Start the BlueRock Dashboard
Create the persistent data directory:
Start the Dashboard container:
7. Configure Network Access
After the Dashboard container is running, configure the required network access for the Dashboard VM.
The following application ports are exposed for inbound connection from external clients:
443
Dashboard HTTPS
Authorized Dashboard users
4318
OTLP telemetry
BlueRock Hosts
8443
Policy distribution
BlueRock Hosts
Configure the corresponding firewall, security group, or network security group rules according to your cloud platform.
Allow access only from the trusted client source address and subnets.
Security: Restrict ports
4318and8443to trusted BlueRock Host networks or CIDR ranges.
Note: SSH access on port
22is required for VM administration and should already be allowed from the approved administrator IP addresses.
8. Verify the Dashboard
Verify that the Dashboard container is running:
Check the Dashboard container logs:
The container should be running without errors.
Open the Dashboard using the HTTPS hostname or IP address configured for your deployment:
Verify that the Dashboard loads successfully.
9. Configure BlueRock Host Connectivity
The BlueRock Host must already be deployed and running.
Ensure that the BlueRock Host can reach the Dashboard on the following ports:
4318
OTLP telemetry
8443
Policy distribution
Update the bluerockd.toml configuration on the BlueRock Host with the Dashboard endpoint provided for your deployment.
Configure the following Dashboard endpoints:
OTLP endpoint: Used to send telemetry from the BlueRock Host to the Dashboard.
Policy endpoint: Used to retrieve policies from the Dashboard.
Replace <DASHBOARD_ENDPOINT> with the Dashboard hostname or IP address configured for your deployment.
Replace <POLICY_CHANNEL> with the policy channel configured for your deployment.
Update bluerockd.toml as follows:
Save the configuration after updating the Dashboard endpoint and policy channel.
10. Restart the BlueRock Service
After updating bluerockd.toml, restart the bluerockd service:
Verify that the service is running:
11. Verify Telemetry
Verify that telemetry is being transferred from the BlueRock Host to the BlueRock Dashboard.
Check the bluerockd logs:
Verify that there are no certificate or connectivity errors.
Open the BlueRock Dashboard and navigate to Graph Explorer to verify that activity from the BlueRock Host is being received.
Troubleshoot Dashboard Connectivity
If telemetry is not reaching the Dashboard or a connectivity error occurs, use the following command to troubleshoot the OTLP endpoint from the BlueRock Host:
A successful response returns:
If the request fails, check for certificate or connectivity errors.
For a self-signed certificate, verify that server.crt has been added to the BlueRock Host trust store and that the certificate trust store has been updated.
For a trusted certificate, if the certificate is issued by an intermediate CA, ensure the certificate chain is added to the BlueRock Host trust store.

Last updated