Merge branch 'newdocs' into 'master'

Newdocs

See merge request cloudnative/oci-grafana-plugin!15

Author: Faiq Raza

Readme.md

@@ -10,17 +10,19 @@ If you are running Grafana anywhere else, make sure you have `~/.oci` configured
 
 ## Note
 
-If you're using a version of Grafana that's older 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.
+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.
 
 ## Installation Documentation
 
 In order to simplify the installation process, we created detailed guides for you to follow:
 
-* 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/Local%20Installation%20Linux%20-%20Oracle%20Cloud%20Infrastructure%20Data%20Source%20for%20Grafana.md).
-* 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/Local%20Installation%20MacOS%20-%20Oracle%20Cloud%20Infrastructure%20Data%20Source%20for%20Grafana.md).
-* 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/OCI%20Virtual%20Machine%20Installation%20-%20Oracle%20Cloud%20Infrastructure%20Data%20Source%20for%20Grafana.md).
-* 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-Based%20Installation%20-%20Oracle%20Cloud%20Infrastructure%20Data%20Source%20for%20Grafana.md).
-* 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/Oracle%20Kubernetes%20Engine%20Installation%20-%20Oracle%20Cloud%20Infrastructure%20Data%20Source%20for%20Grafana.md)
+* 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).
+* 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).
+* 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).
+* 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).
+* 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)
 
 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).
 
+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.
+

docs/images/Screen Shot 2019-02-15 at 2.53.37 PM.png

@@ -22,8 +22,8 @@ In order to use the the OCI Data Source for Grafana on OKE, the first step is to
 
 Next, create a [policy](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm) named “grafana_policy” in the root compartment of your tenancy to permit instances in the dynamic group to make API calls against Oracle Cloud Infrastructure services. Add the following policy statements:
 
-* `allow group grafana to read metrics in tenancy`
-* `allow group grafana to read compartments in tenancy`
+* `allow dynamicgroup grafana to read metrics in tenancy`
+* `allow dynamicgroup grafana to read compartments in tenancy`
 
    ![Screen Shot 2018-12-17 at 4.01.47 PM](images/Screen%20Shot%202018-12-17%20at%204.01.47%20PM.png)
 
@@ -77,6 +77,7 @@ Click **Save & Test** to return to the home dashboard.
 
 ## Next Steps
 
-Check out how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](docs/Using%20Grafana%20with%20the%20Oracle%20Cloud%20Infrastructure%20Data%20Source.md) walkthrough. 
+Check out how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](using.md) walkthrough. 
+
 
 

docs/images/Screen Shot 2019-02-15 at 2.59.47 PM.png

@@ -6,14 +6,16 @@ Grafana is a popular technology that makes it easy to visualize metrics. The Ora
 
 This walkthrough is intended for use by people who would like to deploy Grafana and the OCI Data Source for Grafana on a local server. 
 
-Make sure you have access to the [Monitoring Service](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm) and that [metrics have been enabled](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/enablingmonitoring.htm) for the resources you are trying to monitor.
+Make sure you have access to the [Monitoring Service](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm) and that [metrics have been enabled](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/enablingmonitoring.htm) for the resources you are trying to monitor.  
 
 ## Install the Oracle Cloud Infrastructure CLI 
 
 The [Oracle Cloud Infrastructure CLI](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/cliconcepts.htm) provides you with a way to perform tasks in OCI from your command line rather than the OCI Console. It does so by making REST calls to the [OCI APIs](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm). We will be using the CLI to authenticate between our local environment hosting Grafana and OCI in order to pull in metrics. The CLI is built on Python (version 2.7.5 or 3.5 or later), running on Mac, Windows, or Linux.
 
 Begin by [installing the Oracle Cloud Infrastructure CLI](https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliinstall.htm). Follow the installation prompts to install the CLI on your local environment. After the installation is complete, use the `oci setup config` command to have the CLI walk you through the first-time setup process. If you haven't already uploaded your public API signing key through the console, follow the instructions [here](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#How2) to do so. 
 
+After the CLI has been configured, move the `~/.oci` folder to `/usr/share/grafana` and then change ownership of the `/usr/share/grafana/.oci folder` to the “grafana” user: `sudo chown -R grafana:grafana /usr/share/grafana/.oci`. 
+
 ## Configure OCI Identity Policies
 
 In the OCI console under **Identity > Groups** click **Create Group** and create a new group called **grafana**. Add the user configured in the OCI CLI to the newly-created group. 
@@ -70,5 +72,5 @@ Click **Save & Test** to return to the home dashboard.
 
 ## Next Steps
 
-Check out how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](docs/Using%20Grafana%20with%20the%20Oracle%20Cloud%20Infrastructure%20Data%20Source.md) walkthrough. 
+Check out how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](using.md) walkthrough. 
 

docs/images/Screen Shot 2019-02-15 at 3.06.49 PM.png

@@ -18,8 +18,8 @@ After creating your VM, the next step is to create a [dynamic group](https://doc
 
 Next, create a [policy](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm) named “grafana_policy” in the root compartment of your tenancy to permit instances in the dynamic group to make API calls against Oracle Cloud Infrastructure services. Add the following policy statements:
 
-* `allow group grafana to read metrics in tenancy`
-* `allow group grafana to read compartments in tenancy`
+* `allow dynamicgroup grafana to read metrics in tenancy`
+* `allow dynamicgroup grafana to read compartments in tenancy`
 
    ![Screen Shot 2018-12-17 at 4.01.47 PM](images/Screen%20Shot%202018-12-17%20at%204.01.47%20PM.png)
 
@@ -66,4 +66,4 @@ Click **Save & Test** to return to the home dashboard.
 
 ## Next Steps
 
-Check out how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](docs/Using%20Grafana%20with%20the%20Oracle%20Cloud%20Infrastructure%20Data%20Source.md) walkthrough. 
+Check out how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](using.md) walkthrough. 

…nfrastructure Data Source for Grafana.md docs/kubernetes.mddocs/Oracle Kubernetes Engine Installation - Oracle Cloud Infrastructure Data Source for Grafana.md renamed to docs/kubernetes.md docs/Oracle Kubernetes Engine Installation - Oracle Cloud Infrastructure Data Source for Grafana.md renamed to docs/kubernetes.md

@@ -71,5 +71,5 @@ Click **Save & Test** to return to the home dashboard.
 
 ## Next Steps
 
-Check out how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](docs/Using%20Grafana%20with%20the%20Oracle%20Cloud%20Infrastructure%20Data%20Source.md) walkthrough. 
+Check out how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](using.md) walkthrough. 
 

…nfrastructure Data Source for Grafana.md docs/linux.mddocs/Local Installation Linux - Oracle Cloud Infrastructure Data Source for Grafana.md renamed to docs/linux.md docs/Local Installation Linux - Oracle Cloud Infrastructure Data Source for Grafana.md renamed to docs/linux.md

@@ -95,4 +95,4 @@ To remove the environment created by the Terraform script, run `terraform destro
 
 ## Next Steps
 
-Check out how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](docs/Using%20Grafana%20with%20the%20Oracle%20Cloud%20Infrastructure%20Data%20Source.md) walkthrough. 
+Check out how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](using.md) walkthrough. 

…nfrastructure Data Source for Grafana.md docs/linuxoci.mddocs/OCI Virtual Machine Installation - Oracle Cloud Infrastructure Data Source for Grafana.md renamed to docs/linuxoci.md docs/OCI Virtual Machine Installation - Oracle Cloud Infrastructure Data Source for Grafana.md renamed to docs/linuxoci.md

@@ -75,7 +75,7 @@ Dimensions can be used to add specificity to your graphs. To use dimensions crea
 
 ## Custom Metrics and Namespaces
 
-Oracle Cloud Infrastructure allows for the creation of custom metrics namespaces, which can be used to ingest data from sources in addition to the native Oracle Cloud Infrastructure resources available by default. For example, an application could be instrumented to gather statistics about individual operations. The resource posting custom metrics must be able to authenticate to Oracle Cloud Infrastructure using either using the Oracle Cloud Infrastructure CLI authentication mentioned above or using [instance principals](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm). In the example below you can see the option to select `custom_namespace` from the **Namespace** drop down. 
+Oracle Cloud Infrastructure allows you to create [custom metrics namespaces](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm), which can be used to ingest data from sources in addition to the native Oracle Cloud Infrastructure resources available by default. For example, an application could be instrumented to gather statistics about individual operations. The resource posting custom metrics must be able to authenticate to Oracle Cloud Infrastructure using either using the Oracle Cloud Infrastructure CLI authentication mentioned above or using [instance principals](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm). In the example below you can see the option to select `custom_namespace` from the **Namespace** drop down. 
 
 ![Screen_Shot_2019-02-15_at_2.53.37_PM](images/Screen_Shot_2019-02-15_at_2.53.37_PM.png)