Skip to content

Commit a24f585

Browse files
authored
Rebuilt lock files and renamed files (#82)
* Rebuilt lock files with no internal sources * Deleted ci-yml file as it exposes oracle info and the file is no longer required * gitignore updated * Fixed Readme with markdown linter * Renamed Readme->README * Updated license in package.json
1 parent f5c0ede commit a24f585

File tree

6 files changed

+4494
-5875
lines changed

6 files changed

+4494
-5875
lines changed

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ _testmain.go
2323
*.test
2424
*.prof
2525

26-
27-
2826
/vendor/**
2927
!/vendor/vendor.json
3028
.DS_Store
@@ -40,3 +38,5 @@ dist/
4038
#Ignore the built tar and zip files
4139
*.tar
4240
*.zip
41+
42+
yarn-error.log

.gitlab-ci.yml

Lines changed: 0 additions & 99 deletions
This file was deleted.

Readme.md renamed to README.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,52 @@
1-
# About OCI Grafana Metrics plugin
2-
1+
# About OCI Grafana Metrics plugin
32

43
## Installation
54

65
### Oracle Cloud Infrastructure Metrics Data Source
6+
77
## Introduction
88

9-
This plugin makes queries to the Oracle Cloud Infrastructure Monitoring Service and displays them on Grafana.
9+
This plugin makes queries to the Oracle Cloud Infrastructure Monitoring
10+
Service and displays them on Grafana.
1011

11-
If you are running Grafana on a machine instance in Oracle Cloud, use the Service Principal with a configured Dynamic Group and policy to allow you to read metrics and compartments.
12+
If you are running Grafana on a machine instance in Oracle Cloud, use the
13+
Service Principal with a configured Dynamic Group and policy to allow you to
14+
read metrics and compartments.
1215

13-
If you are running Grafana anywhere else, make sure you have `~/.oci` configured properly. You can do this by installing the Oracle Cloud CLI and running the setup
16+
If you are running Grafana anywhere else, make sure you have `~/.oci`
17+
configured properly. You can do this by installing the Oracle Cloud CLI and
18+
running the setup.
1419

1520
## Note
1621

17-
If you're using a version of Grafana that's older than 6.0, you will need to download the zip file and install this plugin manually, or chmod the binary that is downloaded to make it executable.
18-
22+
If you're using a version of Grafana that's older than 6.0, you will need to
23+
download the zip file and install this plugin manually, or chmod the binary
24+
that is downloaded to make it executable.
1925

2026
In order to simplify the installation process, we created detailed guides for you to follow:
2127

22-
* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a Linux host using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/linux.md).
23-
* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a MacOS host using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/macos.md).
24-
* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a virtual machine in Oracle Cloud Infrastructure using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/linuxoci.md).
25-
* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a virtual machine in Oracle Cloud Infrastructure using Terraform using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/terraform.md).
26-
* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on Kubernetes in Oracle Cloud Infrastructure using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/kubernetes.md)
28+
* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana
29+
on a Linux host using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/linux.md).
30+
* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana
31+
on a MacOS host using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/macos.md).
32+
* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana
33+
on a virtual machine in Oracle Cloud Infrastructure using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/linuxoci.md).
34+
* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana
35+
on a virtual machine in Oracle Cloud Infrastructure using Terraform using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/terraform.md).
36+
* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana
37+
on Kubernetes in Oracle Cloud Infrastructure using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/kubernetes.md)
2738

28-
Once you have the data source installed, configure your datasource with your tenancy OCID, default region, and where you're running the plugin (Oracle Cloud or elsewhere).
39+
Once you have the data source installed, configure your datasource with your
40+
tenancy OCID, default region, and where you're running the plugin
41+
(Oracle Cloud or elsewhere).
2942

30-
We also have documentation for how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/using.md) walkthrough.
43+
We also have documentation for how to use the newly installed and configured
44+
plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/using.md) walkthrough.
3145

3246
### Debugging
3347

3448
If you want to debug golang backend plugin code, follow the steps below:
49+
3550
* Install [gops](https://github.com/google/gops) to list running go processes on your machine
3651
* Run `gops` and find processId for `oci-plugin_darwin_amd64` process
3752
* Copy this processId to the `.vscode/launch.json`

0 commit comments

Comments
 (0)