Skip to content

Commit 7e7b5b0

Browse files
author
Mattia Moretti
authored
documentation maintenance (#258)
1 parent 0a0b232 commit 7e7b5b0

File tree

6 files changed

+16
-28
lines changed

6 files changed

+16
-28
lines changed

docs/grafanacloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Make sure you have access to the [Monitoring Service](https://docs.cloud.oracle.
1010

1111
## Getting OCI Configuration values
1212

13-
To configure OCI Metrics Grafana Data Source, you'll need to get the necessary provider and resource settings. Please note that with **Grafana Cloud** only version 4.x.x and above are supported. If you are configuring the plugin to work in Multitenancy Mode, you will need to repeat the following steps for each of the Tenancies you want to configure with the plugin (up to 5 additional Tenancies are supported).
13+
To configure OCI Metrics Grafana Data Source, you'll need to get the necessary provider and resource settings. Please note that with **Grafana Cloud** only version 5.x.x and above are supported. If you are configuring the plugin to work in Multitenancy Mode, you will need to repeat the following steps for each of the Tenancies you want to configure with the plugin (up to 5 additional Tenancies are supported).
1414

1515
### Getting the Region
1616

docs/images/search_plugin.png

80.4 KB
Loading

docs/linux.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Make sure you have access to the [Monitoring Service](https://docs.cloud.oracle.
1010

1111
## Getting OCI Configuration values
1212

13-
To configure OCI Metrics Grafana Data Source, you'll need to get the necessary provider and resource settings. Please note that Migrating from version 3.x.x to 4.x.x will require to migrate the existing data source configuration: using version 4.x.x of the plugin with the data source configuration of version 3.x.x is **not possible**. In case you are migrating from previous version 3.x.x of the OCI Metrics Grafana Plugin, you can refer to the [**Migration Instructions for Grafana OCI Metrics Data Source Settings (User Principals and Single Tenancy mode only)**](migration.md). If you are configuring the plugin to work in Multitenancy Mode, you will need to repeat the following steps for each of the Tenancies you want to configure with the plugin (up to 5 additional Tenancies are supported).
13+
To configure OCI Metrics Grafana Data Source, you'll need to get the necessary provider and resource settings. Please note that Migrating from version 3.x.x to version 4.x.x and above will require to migrate the existing data source configuration: using version 4.x.x and above of the plugin with the data source configuration of version 3.x.x is **not possible**. In case you are migrating from previous version 3.x.x of the OCI Metrics Grafana Plugin, you can refer to the [**Migration Instructions for Grafana OCI Metrics Data Source Settings (User Principals and Single Tenancy mode only)**](migration.md). If you are configuring the plugin to work in Multitenancy Mode, you will need to repeat the following steps for each of the Tenancies you want to configure with the plugin (up to 5 additional Tenancies are supported).
1414

1515
### Getting the Region
1616

@@ -87,17 +87,13 @@ Under the **Policy** tab click **Create Policy** and create a policy allowing th
8787

8888
![Screen Shot 2018-12-19 at 3.00.10 PM](images/Screen%20Shot%202018-12-19%20at%203.00.10%20PM.png)
8989

90-
## Install Grafana and the OCI Metrics Plugin for Grafana
90+
## Install Grafana and the OCI Metrics Plugin for Grafana 8 and above
9191

92-
To [install OCI Metrics Plugin](https://grafana.com/grafana/plugins/oci-metrics-datasource/) make sure you are running [Grafana 8**](https://grafana.com/get). Use the [grafana-cli tool](http://docs.grafana.org/plugins/installation/) to install the Oracle Cloud Infrastructure Data Source for Grafana from the command line:
92+
To [install OCI Metrics Plugin](https://grafana.com/grafana/plugins/oci-metrics-datasource/) make sure you are running [Grafana 8**](https://grafana.com/get) or above. The latest version of the plugin 5.x.x is available on Grafana Catalogue. Go to Administration on main Grafana menu, and choose plugin. Then you can search for oracle and you will find the plugin:
9393

94-
```
95-
grafana-cli plugins install oci-metrics-datasource
96-
```
97-
98-
**NOTE** Today the latest version of the plugin 4.x.x is available only with Grafana CLI. We will release its binary on [its Github repo](https://github.com/oracle/oci-grafana-plugin) very soon.
94+
![Search plugin](images/search_plugin.png)
9995

100-
The plugin will be installed into your Grafana plugins directory, which by default is located at /var/lib/grafana/plugins. [Here is more information on the CLI tool](http://docs.grafana.org/plugins/installation/).
96+
Click on the metrics plugin to install. The plugin will be installed into your Grafana plugins directory, which by default is located at /var/lib/grafana/plugins. [Here is more information on the CLI tool](http://docs.grafana.org/plugins/installation/).
10197

10298
### Manual installation for previous Grafana Server versions(<8)
10399

docs/linuxoci.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,13 @@ Next, create a [policy](https://docs.cloud.oracle.com/iaas/Content/Identity/Conc
2323

2424
![Screen Shot 2018-12-17 at 4.01.47 PM](images/Screen%20Shot%202018-12-17%20at%204.01.47%20PM.png)
2525

26-
## Install Grafana and the OCI Metrics Plugin for Grafana
26+
## Install Grafana and the OCI Metrics Plugin for Grafana 8 and above
2727

28-
To [install OCI Metrics Plugin](https://grafana.com/grafana/plugins/oci-metrics-datasource/) make sure you are running [Grafana 8**](https://grafana.com/get). Use the [grafana-cli tool](http://docs.grafana.org/plugins/installation/) to install the Oracle Cloud Infrastructure Data Source for Grafana from the command line:
28+
To [install OCI Metrics Plugin](https://grafana.com/grafana/plugins/oci-metrics-datasource/) make sure you are running [Grafana 8**](https://grafana.com/get) or above. The latest version of the plugin 5.x.x is available on Grafana Catalogue. Go to Administration on main Grafana menu, and choose plugin. Then you can search for oracle and you will find the plugin:
2929

30-
```
31-
grafana-cli plugins install oci-metrics-datasource
32-
```
33-
34-
**NOTE** Today the latest version of the plugin 4.x.x is available only with Grafana CLI. We will release it's binary on [its Github repo](https://github.com/oracle/oci-grafana-plugin) very soon.
30+
![Search plugin](images/search_plugin.png)
3531

36-
The plugin will be installed into your Grafana plugins directory, which by default is located at /var/lib/grafana/plugins. [Here is more information on the CLI tool](http://docs.grafana.org/plugins/installation/).
32+
Click on the metrics plugin to install. The plugin will be installed into your Grafana plugins directory, which by default is located at /var/lib/grafana/plugins. [Here is more information on the CLI tool](http://docs.grafana.org/plugins/installation/).
3733

3834
### Manual installation for previous Grafana Server versions(<8)
3935

docs/macos.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Make sure you have access to the [Monitoring Service](https://docs.cloud.oracle.
1010

1111
## Getting OCI Configuration values
1212

13-
To configure OCI Metrics Grafana Data Source, you'll need to get the necessary provider and resource settings. Please note that Migrating from version 3.x.x to 4.x.x will require to migrate the existing data source configuration: using version 4.x.x of the plugin with the data source configuration of version 3.x.x is **not possible**. In case you are migrating from previous version 3.x.x of the OCI Metrics Grafana Plugin, you can refer to the [**Migration Instructions for Grafana OCI Metrics Data Source Settings (User Principals and Single Tenancy mode only)**](migration.md). If you are configuring the plugin to work in Multitenancy Mode, you will need to repeat the following steps for each of the Tenancies you want to configure with the plugin (up to 5 additional Tenancies are supported).
13+
To configure OCI Metrics Grafana Data Source, you'll need to get the necessary provider and resource settings. Please note that Migrating from version 3.x.x to version 4.x.x and above will require to migrate the existing data source configuration: using version 4.x.x and above of the plugin with the data source configuration of version 3.x.x is **not possible**. In case you are migrating from previous version 3.x.x of the OCI Metrics Grafana Plugin, you can refer to the [**Migration Instructions for Grafana OCI Metrics Data Source Settings (User Principals and Single Tenancy mode only)**](migration.md). If you are configuring the plugin to work in Multitenancy Mode, you will need to repeat the following steps for each of the Tenancies you want to configure with the plugin (up to 5 additional Tenancies are supported).
1414

1515
### Getting the Region
1616

@@ -88,17 +88,13 @@ Under the **Policy** tab click **Create Policy** and create a policy allowing th
8888

8989
![Screen Shot 2018-12-19 at 3.00.10 PM](images/Screen%20Shot%202018-12-19%20at%203.00.10%20PM.png)
9090

91-
## Install Grafana and the OCI Metrics Plugin for Grafana
91+
## Install Grafana and the OCI Metrics Plugin for Grafana 8 and above
9292

93-
To [install OCI Metrics Plugin](https://grafana.com/grafana/plugins/oci-metrics-datasource/) make sure you are running [Grafana 8**](https://grafana.com/get). Use the [grafana-cli tool](http://docs.grafana.org/plugins/installation/) to install the Oracle Cloud Infrastructure Data Source for Grafana from the command line:
93+
To [install OCI Metrics Plugin](https://grafana.com/grafana/plugins/oci-metrics-datasource/) make sure you are running [Grafana 8**](https://grafana.com/get) or above. The latest version of the plugin 5.x.x is available on Grafana Catalogue. Go to Administration on main Grafana menu, and choose plugin. Then you can search for oracle and you will find the plugin:
9494

95-
```
96-
grafana-cli plugins install oci-metrics-datasource
97-
```
98-
99-
**NOTE** Today the latest version of the plugin 4.x.x is available only with Grafana CLI. We will release its binary on [its Github repo](https://github.com/oracle/oci-grafana-plugin) very soon.
95+
![Search plugin](images/search_plugin.png)
10096

101-
The plugin will be installed into your Grafana plugins directory, which by default is located at /var/lib/grafana/plugins. [Here is more information on the CLI tool](http://docs.grafana.org/plugins/installation/).
97+
Click on the metrics plugin to install. The plugin will be installed into your Grafana plugins directory, which by default is located at /var/lib/grafana/plugins. [Here is more information on the CLI tool](http://docs.grafana.org/plugins/installation/).
10298

10399
### Manual installation for previous Grafana Server versions(<8)
104100

docs/migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ Before starting the migration process, please make sure you have the following:
3737

3838
### Conclusion
3939

40-
By following these steps, you should have successfully migrated the data from the `.oci/config` file to the Grafana OCI Metrics data source settings (User Principals and Single Tenancy mode only) for the specified variables and the ID key. Please note that the process cannot be reverted, and rollback to previous configuration with the config file is not possible. Also, once migrated to version 4.x.x of the plugin, moving back to version 3.x.x is not possible.
40+
By following these steps, you should have successfully migrated the data from the `.oci/config` file to the Grafana OCI Metrics data source settings (User Principals and Single Tenancy mode only) for the specified variables and the ID key. Please note that the process cannot be reverted, and rollback to previous configuration with the config file is not possible. Also, once migrated to version 4.x.x and above of the plugin, moving back to version 3.x.x is not possible.

0 commit comments

Comments
 (0)