Adding initial Grafana content: overview, get started, first tasks

.github/styles/Vocab/Docs/accept.txt

@@ -3,13 +3,13 @@ ACLs
 Aiven
 API
 APIs
-[Bb]usiness
 [Bb]oolean
+[Bb]usiness
 cyber
-[Dd]ashboards
 datacenter
 datasource
 datastore
+[Dd]ashboards
 Distro
 downsampled
 downsampling
@@ -18,15 +18,18 @@ Epicurious
 etcd
 failover
 fileset[s]?
+Geomap
 geospatial
 [Gg]o
 Grafana
 hardcoded
-Hillyer
+Heatmap
 [Hh]obbyist
 [Hh]ostname
-hyperloglogs
+Hillyer
 httpie
+hyperloglogs
+Instana
 jq
 Kaggle
 Karapace
@@ -40,13 +43,15 @@ Memorystore
 NodeJS
 npm
 Okta
+[Oo]perator
 OpenSearch
+Pagerduty
 Pagila
 parallelization
-[Oo]perator
 pgAdmin
 PgBouncer
 plaintext
+Plotly
 pooler
 PostgreSQL
 Postman
@@ -60,6 +65,8 @@ schemaless
 scriptable
 sharding
 signups
+Singlestat
+Statusmap
 Telegraf
 Terraform
 Terraforming
@@ -70,3 +77,5 @@ unencrypted
 Untrusted
 [Uu]naggregated
 wget
+Zabbix
+Zipkin

_toc.yml

@@ -146,6 +146,18 @@ entries:
         entries:
           - glob: docs/products/redis/howto/*
 
-
+  - file: docs/products/grafana/index
+    title: Grafana
+    entries:
+      - file: docs/products/grafana/get-started
+      - file: docs/products/grafana/howto
+        title: HowTo
+        entries:
+          - glob: docs/products/grafana/howto/*
+      - file: docs/products/grafana/reference
+        title: Reference
+        entries:
+          - glob: docs/products/grafana/reference/*
+
   # -------- AUXILIARY
   - file: docs/community

docs/products/grafana/get-started.rst

@@ -0,0 +1,66 @@
+Get started with Aiven for Grafana
+===================================
+
+Get up and running with Aiven for Grafana. This article shows you how to set up a Grafana service in Aiven, connect to it, view your default dashboards.
+
+
+.. Add Step 1: Check the basics
+
+
+
+Step 1: Create a new Aiven service
+-----------------------------------
+
+You can add services for Grafana in the Aiven web console.
+
+
+.. image:: /images/products/grafana/get-started-grafana.gif
+    :width: 500px
+
+
+To create a new Aiven for Grafana service:
+
+1. Log in to the `Aiven web console <https://console.aiven.io/>`_.
+
+2. On the *Services* page, click **Create a new service**.
+
+   This opens a new page with the available service options.
+
+3. Select the main properties for your service:
+
+   a. Select the service type.
+
+      If there are several versions available, select the version that you want to use. By default, the latest available version is selected.
+
+   b. Select the cloud provider and region that you want to run your service on.
+
+      .. Note::
+          The pricing for the same service may vary between different providers and regions. The service summary on the right side of the console shows you the pricing for your selected options.
+
+   c. Select a service plan.
+
+      This defines the number of servers and what kind of memory, CPU, and disk resources are allocated to your service.
+
+   d. Enter a name for your service.
+
+      A random name is provided by default, but you can enter a more recognizable name to distinguish it from other services.
+
+
+4. Click **Create Service** under the summary on the right side of the console.
+
+   This brings you back to the **Services** view. Your new service is listed with a status indicator to show that it is being created.
+
+5. Click the service name.
+
+   The *Overview* page for the service opens. This view shows you the connection parameters for your service, its current status, and the configuration options.
+
+   The status is *REBUILDING* while the service is being created for you. Once the service is ready, the status changes to *RUNNING*. While services typically start up in a couple of minutes, the performance varies between cloud providers and regions, and it may take longer in some circumstances.
+
+
+
+Step 2: Log in to Grafana
+--------------------------
+
+You can log in easily to your Aiven for Grafana service from the console. See :doc:`how to log in <howto/log-in>`.
+
+.. Add the following (Step 4: Display default dashboards in Aiven for Grafana)

docs/products/grafana/howto.rst

@@ -0,0 +1,10 @@
+HowTo
+=====
+
+In this section we have collected some step-by-step instructions for Aiven for Grafana.
+
+.. tableofcontents::
+
+
+
+

docs/products/grafana/howto/log-in.rst

@@ -0,0 +1,30 @@
+Log in to Aiven for Grafana
+===========================
+
+Log in to Aiven for Grafana to start monitoring your data sources. 
+
+.. Tip::
+        Your InfluxDB or OpenSearch services in the same Aiven project are automatically configured as data sources, and you can easily start visualizing the data from them.
+
+
+.. image:: /images/products/grafana/log-in-grafana.gif
+    :width: 500px
+
+
+To log in:
+
+1. Log in to the `Aiven web console <https://console.aiven.io/>`_.
+
+2. On the *Services* page, click the Grafana service you want to log in to.
+
+   This opens your Grafana *Overview* page.
+
+3. Note down your **User** and **Password** from the **Connection information**. 
+
+4. Click the **Service URI** to open the Grafana login page.
+
+5. Type in your user name and password, and click **Log in**.
+
+    This opens your Grafana user interface. 
+
+You can now start visualizing your data sources by using the default dashboards, or create your own. 

docs/products/grafana/howto/send-emails.rst

@@ -0,0 +1,49 @@
+Send emails from Aiven for Grafana
+==================================
+
+Use the Aiven API or the Aiven client to configure the Simple Mail Transfer Protocol (SMTP) server settings and send the following emails from Aiven for Grafana: invite emails, reset password emails, and alert messages.
+
+What you need
+----------------
+
+* Aiven client installed
+
+* Aiven for Grafana service created
+
+* SMTP server IP or hostname
+
+* SMTP server port
+
+* Username for authentication (if authentication is in use - highly recommended)
+
+* Password for authentication
+
+* Sender email address (i.e., email address shown in "From" field)
+
+* (optionally) sender name
+
+
+Configure the SMTP server for Grafana
+-------------------------------------
+
+To configure the Aiven for Grafana service:
+
+1. Open the Aiven client, and log in::
+
+    $ avn user login <you@example.com> --token
+
+2. configure the service using your own SMTP values::
+
+    avn service update --project yourprojectname yourservicename \
+    -c smtp_server.host=smtp.example.com \
+    -c smtp_server.port=465 \
+    -c smtp_server.username=emailsenderuser \
+    -c smtp_server.password=emailsenderpass \
+    -c smtp_server.from_address="grafana@yourcompany.com" 
+
+3. (optionally) Review all available custom option, and configure as needed::
+
+    avn service types -v
+
+
+You have now set up your Aiven for Grafana to send emails. 

docs/products/grafana/index.rst

@@ -0,0 +1,47 @@
+Aiven for Grafana
+==================
+
+What is Aiven for Grafana?
+---------------------------
+
+Aiven for Grafana is a fully managed **analytics and monitoring solution**,, deployable in the cloud of your choice which can bring unlimited scalability and high-availability to your monitoring environment and other time series applications.
+
+
+Why Grafana?
+------------
+
+Grafana is a multi-platform open source analytics and interactive visualization web application. It provides charts, graphs, and alerts for the web when connected to supported data sources.
+
+Read more about `the open source Grafana <https://grafana.com/oss/grafana/>`_ or check out the `Grafana GitHub repository <https://github.com/grafana/grafana>`_.
+
+
+Get started with Aiven for Grafana
+--------------------------------------
+
+Take your first steps with Aiven for Grafana by following our :doc:`get-started` article, or browse through our full list of articles:
+
+
+.. panels::
+
+
+    💻 :doc:`howto`
+
+
+Integrates with your existing Aiven tools
+------------------------------------------
+
+Grafana is highly compatible with other Aiven products. You can set up your other Aiven services as data sources for Grafana, and monitor their health.
+
+
+Check out all the features on our `Grafana product page <https://aiven.io/grafana#full-feature-list>`_. 
+
+
+
+Grafana resources
+---------------------
+
+* `Open source Grafana page <https://grafana.com/oss/grafana/>`_
+
+* `Grafana docs <https://grafana.com/docs/>`_
+
+* `Aiven Terraform Provider - Grafana resource docs <https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/grafana>`_ and `Grafana data source docs <https://registry.terraform.io/providers/aiven/aiven/latest/docs/data-sources/grafana>`_

docs/products/grafana/reference.rst

@@ -0,0 +1,6 @@
+Grafana reference
+#################
+
+Reference materials for configuration, plugins and other reference materials relating to Aiven for Grafana.
+
+.. tableofcontents::

docs/products/grafana/reference/plugins.rst

@@ -0,0 +1,60 @@
+List of available plugins
+=========================
+
+The following plugins are available in all installations of Aiven for Grafana, and they are updated at intervals. To request additional plugins, please reach out to our support team.
+
+- AJAX
+- Alert list
+- Annotations list
+- Azure Monitor
+- Bar chart
+- Bar gauge
+- Carpet plot
+- Clock
+- CloudWatch
+- D3 Gauge
+- Dashboard list
+- Diagram
+- Discrete
+- Elasticsearch
+- Gauge
+- Geomap
+- Getting Started
+- Google BigQuery
+- Google Cloud Monitoring
+- Google Sheets
+- Grafana Image Renderer
+- Graphite
+- Heatmap
+- Histogram
+- InfluxDB
+- Instana
+- Jaeger
+- Logs
+- Loki
+- Microsoft SQL Server
+- MySQL
+- News
+- Node Graph
+- OpenTSDB
+- Pagerduty
+- Pie chart
+- Plotly
+- Plugin list
+- PostgreSQL
+- Prometheus
+- SimpleJson
+- Singlestat Math
+- Stat
+- State timeline
+- Status Panel
+- Status history
+- Statusmap
+- Table
+- Tempo
+- TestData DB
+- Text
+- Time series
+- Welcome
+- Zabbix
+- Zipkin