-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added Directory grafana-on-oci (#53)
- Loading branch information
Showing
12 changed files
with
123 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
# Grafana on OCI | ||
|
||
## Overview | ||
|
||
This OCI Resource Manager (RM) Stack deploys a pre-configured Grafana Linux instance on OCI. It automates the setup of a Linux instance, Grafana installation, security configurations, polices and OCI metric integration. | ||
|
||
## Prerequisites | ||
|
||
Before deploying this stack, ensure you have: | ||
|
||
1. An active OCI account with necessary permissions | ||
2. Access to OCI Console | ||
3. A Compartment for the Grafana instance | ||
4. A public VCN | ||
5. SSH public key for instance access | ||
|
||
## Stack Components | ||
|
||
This stack deploys and configures the following resources: | ||
|
||
- Linux compute instance with Grafana | ||
- Dynamic group and policy | ||
- Security list configurations for Grafana access | ||
|
||
## Deployment Instructions | ||
|
||
### Step 1: Prepare Required Information | ||
|
||
Gather the following information before deployment: | ||
|
||
- Compartment Name | ||
- Availability Domain name | ||
- Virtual Cloud Name | ||
- Subnet Name (Public) | ||
- SSH public key | ||
- Desired hostname for the instance | ||
- Dynamic group name | ||
- Policy name | ||
|
||
### Step 2: Using and Configuring the Marketplace image | ||
|
||
1. Log in to OCI Console | ||
2. Navigate to Marketplace > All Applications | ||
3. Search for *Grafana* | ||
4. Choose the compartment and version and click Launch Instance | ||
5. Fill in the required variables as prompted: | ||
|
||
- General Configuration: | ||
- Compartment Name | ||
- Availability Domain | ||
- Virtual Cloud Network | ||
- Subnet | ||
![General config](Images/RM-GenConfig.jpg) | ||
|
||
- Instance Configuration: | ||
- Hostname | ||
- Linux Image (Oracle-Linux-8.9-2024.05.29-0 recommended and tested) | ||
- Linux Instance Shape (Choose from list, to suite your monitoring requirements). Minimum requirements; memory:512MB, CPU:1. | ||
- Number of OCPUs (for flexible shapes) | ||
- Memory in GBs (for flexible shapes) | ||
- Assign Public IP (default: true) | ||
- SSH Public Key | ||
![Instance Config1](Images/RM-InstanceConfig.jpg) | ||
|
||
- Policy Name: | ||
- Dynamic Group Name | ||
- Policy Name | ||
![Instance Config2](Images/RM-InstanceSSHkey.jpg) | ||
|
||
## Post-Deployment Configuration | ||
|
||
### Accessing Grafana | ||
|
||
1. Locate the public IP address of the deployed instance in the job output | ||
2. Open a web browser and navigate to `http://<instance_public_ip>:3000` | ||
|
||
### Changing Default Password | ||
|
||
1. Log in with the default credentials: | ||
- Username: admin | ||
- Password: admin | ||
2. You will be prompted to change the password on first login | ||
![Password Change](Images/GF-passwd.jpg) | ||
|
||
### Configuring OCI Monitoring Data Source to add Instance Principle | ||
|
||
1. Navigate to the Menu on the left > Connections > Data Sources | ||
2. Click on Add data source | ||
![AddDataSource](Images/GF-AddDataSource.jpg) | ||
3. In the Search box type : oracle | ||
4. Click on Oracle Cloud Infrastructure Metrics | ||
![MetricSource](Images/GF-OCIMetricDataSource.jpg) | ||
5. Click on Authentication Provider under Connection Details and select OCI Instance | ||
![Instance](Images/GF-Connection.jpg) | ||
6. Click on Save & test and verify Success | ||
![Success](Images/GF-ConnectionSuccess.jpg) | ||
|
||
### Adding Custom Dashboards | ||
|
||
After deployment, you can import custom dashboards in Grafana to visualise your OCI metrics. | ||
All dashboards are located in the Dashboards directory (<https://github.com/Mesh44/Grafana-Install/tree/main/Dashboards>) | ||
|
||
1. Click on one of dashboard json files (for example Stack_Monitoring.json) | ||
2. Copy the content the content. | ||
![copyjson](Images/GH-dashboardjson.jpg) | ||
3. On the Grafana install click on Dashboards and New > Import | ||
![Import](Images/GF-Import.jpg) | ||
4. Past the copied content (from step 2) to the section under "Import via dashboard JSON model" and click Load | ||
![LoadImport](Images/GF-LoadImport.jpg) | ||
Ensure to choose oci-metrics-datasource as the Default data source. | ||
|
||
## Troubleshooting | ||
|
||
1. **Cannot access Grafana**: Verify that port 3000 is open in your VCN's security list and the instance's firewall. | ||
2. **OCI Monitoring Data Source not working**: Check that the dynamic group and policies are correctly configured to allow metric reading. | ||
|
||
## Support and Contribution | ||
|
||
For support, please open an issue in the project's GitHub repository. Contributions to improve the stack are welcome via pull requests. | ||
|
||
## License | ||
|
||
[Include license information] |