Skip to content

Commit

Permalink
Chore: Improve directory layout of images
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Feb 21, 2024
1 parent abc5746 commit 309a95b
Show file tree
Hide file tree
Showing 34 changed files with 50 additions and 50 deletions.
18 changes: 9 additions & 9 deletions docs/integrate/streamsets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,23 +75,23 @@ Using CrateDB as a Destination

Firstly, create a new Data Collector Pipeline:

.. figure:: /_assets/img/integrations/streamsets-new-pipeline.png
.. figure:: /_assets/img/integrations/streamsets/streamsets-new-pipeline.png
:align: center

You can then add an origin for the pipeline. In this case, you will be reading
from the .csv file you downloaded earlier. To do this, add a **Directory** origin
for the pipeline. You should then configure the directory origin so that it picks
up the New York taxi CSV file:

.. figure:: /_assets/img/integrations/streamsets-directory-files.png
.. figure:: /_assets/img/integrations/streamsets/streamsets-directory-files.png
:align: center

You can then also configure the data format of the file. The data format
should be **delimited**, with the format type being **Default CSV**. The CSV
file also includes a header line, so ensure the header line setting is **With
Header Line**:

.. figure:: /_assets/img/integrations/streamsets-directory-format.png
.. figure:: /_assets/img/integrations/streamsets/streamsets-directory-format.png
:align: center

Before you can ingest this data into CrateDB, you need to perform some lightweight
Expand All @@ -103,7 +103,7 @@ To do this, add a new **Field Type Converter** processor that connects to the
Directory origin you created in the previous step. Once created, add the
following field conversions to the field type converter's configuration:

.. figure:: /_assets/img/integrations/streamsets-field-type-conversions.png
.. figure:: /_assets/img/integrations/streamsets/streamsets-field-type-conversions.png
:align: center

Once configured, you can finally add CrateDB as a destination for the pipeline.
Expand All @@ -113,27 +113,27 @@ connect to your CrateDB instance.

The JDBC settings should be as follows:

.. figure:: /_assets/img/integrations/streamsets-jdbc-producer-settings.png
.. figure:: /_assets/img/integrations/streamsets/streamsets-jdbc-producer-settings.png
:align: center

.. figure:: /_assets/img/integrations/streamsets-jdbc-producer-credentials.png
.. figure:: /_assets/img/integrations/streamsets/streamsets-jdbc-producer-credentials.png
:align: center

You can also look at the external libraries of the JDBC producer to ensure
the CrateDB JDBC driver is present:

.. figure:: /_assets/img/integrations/streamsets-jdbc-driver.png
.. figure:: /_assets/img/integrations/streamsets/streamsets-jdbc-driver.png
:align: center

Once created, your pipeline should look something like this:

.. figure:: /_assets/img/integrations/streamsets-pipeline.png
.. figure:: /_assets/img/integrations/streamsets/streamsets-pipeline.png
:align: center

You can now start the pipeline by clicking the **Start** button, and data will
flow from the CSV file, through the type transformer and into CrateDB:

.. figure:: /_assets/img/integrations/streamsets-running-pipeline.png
.. figure:: /_assets/img/integrations/streamsets/streamsets-running-pipeline.png
:align: center

You can verify that the data is now in CrateDB:
Expand Down
28 changes: 14 additions & 14 deletions docs/topic/analysis/grafana.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To visualize data with Grafana, a dataset is needed first. In this sample,
demo data is added directly via the CrateDB Cloud Console. To import the data
go to the Overview page of your deployed cluster.

.. image:: ../../_assets/img/integrations/cloud-cluster-overview.png
.. image:: /_assets/img/integrations/cloud-cluster-overview.png
:alt: Cloud Console Clusters overview

Once on the Overview page, click on the *import the demo data* link in the
Expand All @@ -41,15 +41,15 @@ statement imports the data into the table created in the first step. These
statements must be executed in the shown order. First "1. Create the table"
and then "2. Import the data".

.. image:: ../../_assets/img/integrations/grafana/grafana-import.png
.. image:: /_assets/img/integrations/grafana/grafana-import.png
:alt: Importing data to Admin UI

When you click on either of the *Execute* buttons, you will be brought to the
CrateDB Admin UI which is the admin UI of your cluster. When accessing it for
the first time, you will need the username and password that you set when you
deployed the cluster.

.. image:: ../../_assets/img/integrations/grafana/grafana-admin-create-table.png
.. image:: /_assets/img/integrations/grafana/grafana-admin-create-table.png
:alt: Creating table in Admin UI

After executing the second SQL statement, the "nyc_taxi" table will be
Expand All @@ -74,27 +74,27 @@ Connect Grafana to CrateDB Cloud
After setting up and logging into Grafana, you should be greeted by
Grafana Home page.

.. image:: ../../_assets/img/integrations/grafana/grafana-welcome.png
.. image:: /_assets/img/integrations/grafana/grafana-welcome.png
:alt: Grafana Home page

To visualize the data, you must add a data source. To do this, click on the
cogwheel "Settings" icon in the left menu bar. This should take you to the
Data sources Configuration page.

.. image:: ../../_assets/img/integrations/grafana/grafana-settings.png
.. image:: /_assets/img/integrations/grafana/grafana-settings.png
:alt: Grafana Settings

Once there, click on the *Add data source* button. Here, look up and choose
"PostgreSQL".

.. image:: ../../_assets/img/integrations/grafana/grafana-search.png
.. image:: /_assets/img/integrations/grafana/grafana-search.png
:alt: Grafana integrations

Once "PostgreSQL" is chosen, you will be brought to a form that you must fill
out to connect to the CrateDB Cloud. A completed example might look like the
screenshot below.

.. image:: ../../_assets/img/integrations/grafana/grafana-connection.png
.. image:: /_assets/img/integrations/grafana/grafana-connection.png
:alt: Grafana connection form

The *host* and *user* credentials may appear differently to you. The host can
Expand All @@ -107,7 +107,7 @@ something like:
samplecluster.aks1.eastus.azure.cratedb-dev.net
.. image:: ../../_assets/img/integrations/grafana/grafana-psql.png
.. image:: /_assets/img/integrations/grafana/grafana-psql.png
:alt: Grafana psql connection

After submitting all that to the Grafana connection form, it should return
Expand All @@ -126,7 +126,7 @@ Dashboards. To create a new dashboard click on the *Create your first
dashboard* on the Grafana homepage. You will be greeted by a dashboard
creation page.

.. image:: ../../_assets/img/integrations/grafana/grafana-new-dashboard.png
.. image:: /_assets/img/integrations/grafana/grafana-new-dashboard.png
:alt: Grafana Dashboard creation

In Grafana, dashboards are composed of individual blocks called panels, to
Expand All @@ -142,7 +142,7 @@ recommended to look into the documentation on `Grafana panels`_.
To create a panel, you start by defining the query. To do that click on the
*Edit SQL* button.

.. image:: ../../_assets/img/integrations/grafana/grafana-new-panel.png
.. image:: /_assets/img/integrations/grafana/grafana-new-panel.png
:alt: Grafana panel creation

A console into which you write the SQL statements will appear. This panel will
Expand Down Expand Up @@ -177,15 +177,15 @@ make:

After that, you should get a panel similar to this:

.. image:: ../../_assets/img/integrations/grafana/grafana-panel1.png
.. image:: /_assets/img/integrations/grafana/grafana-panel1.png
:alt: Grafana panel 1

When you're satisfied with the look of the panel, click *Apply*. This will
bring you back to the overview of the dashboard. Now it will have 1 panel
created in it. Click on the *Add panel* in the top menu bar and you can create
another one.

.. image:: ../../_assets/img/integrations/grafana/grafana-add-panel.png
.. image:: /_assets/img/integrations/grafana/grafana-add-panel.png
:alt: Grafana add another panel to dashboard

Another question worth asking might be: What was the average distance per ride
Expand All @@ -209,13 +209,13 @@ show only the value we are interested in. Also, in the right menu under "Graph
style" select "Bars" once again. After that, you should have a panel similar
to this:

.. image:: ../../_assets/img/integrations/grafana/grafana-panel2.png
.. image:: /_assets/img/integrations/grafana/grafana-panel2.png
:alt: Grafana panel 2

When you're happy with the panel, click *Apply*. Now, when brought back to the
Dashboard overview, you will have a collection of two very useful graphs.

.. image:: ../../_assets/img/integrations/grafana/grafana-dashboard-final.png
.. image:: /_assets/img/integrations/grafana/grafana-dashboard-final.png
:alt: Grafana completed dashboard

Now you know how to get started with data visualization in Grafana. To find
Expand Down
12 changes: 6 additions & 6 deletions docs/topic/analysis/metabase.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ choose, the first step will be adding your CrateDB cluster as a new database.
To do that, go to the ``Admin Settings`` -> ``Setup``, and choose
the ``Add a database`` option.

.. image:: ../../_assets/img/integrations/metabase/metabase-add-database.png
.. image:: /_assets/img/integrations/metabase/metabase-add-database.png
:alt: Add new database

Database configuration is relatively simple, these are the necessary fields:
Expand All @@ -51,14 +51,14 @@ Database configuration is relatively simple, these are the necessary fields:
Make sure you also select "Use a secure connection (SSL)" option, unless
your cluster is not configured for SSL.

.. image:: ../../_assets/img/integrations/metabase/metabase-database-configuration.png
.. image:: /_assets/img/integrations/metabase/metabase-database-configuration.png
:alt: Configure new database

After submitting your details, Metabase will sync with your CrateDB cluster for
a few moments. When that completes, you will get a message saying, "Syncing
complete".

.. image:: ../../_assets/img/integrations/metabase/metabase-sync-done.png
.. image:: /_assets/img/integrations/metabase/metabase-sync-done.png
:alt: Database sync complete

.. _integration-metabase-questions:
Expand All @@ -75,19 +75,19 @@ database and a table from it.
As an example, we ask about the Average tip amount,
sorted by the passenger count.

.. image:: ../../_assets/img/integrations/metabase/metabase-question.png
.. image:: /_assets/img/integrations/metabase/metabase-question.png
:alt: Asking a question

Metabase then provides a visualization of that question.

.. image:: ../../_assets/img/integrations/metabase/metabase-answer.png
.. image:: /_assets/img/integrations/metabase/metabase-answer.png
:alt: Answer

The answer that you get can be saved. When you save a question, you will also
be asked if you want to add it to a dashboard. Dashboards provide an easy way
to monitor your data.

.. image:: ../../_assets/img/integrations/metabase/metabase-dashboard.png
.. image:: /_assets/img/integrations/metabase/metabase-dashboard.png
:alt: Dashboard

.. _integration-metabase-conclusion:
Expand Down
16 changes: 8 additions & 8 deletions docs/topic/analysis/powerbi-desktop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,13 +100,13 @@ Creating a DSN for CrateDB
First, verify that you have installed the PostgreSQL ODBC driver by searching
for and opening the ODBC Data Sources application for your architecture:

.. figure:: /_assets/img/integrations/powerbi-start-menu.png
.. figure:: /_assets/img/integrations/powerbi/powerbi-start-menu.png
:align: center

Navigate to the drivers tab, where you should see the PostgreSQL ODBC drivers
you have installed:

.. figure:: /_assets/img/integrations/powerbi-postgres-drivers.png
.. figure:: /_assets/img/integrations/powerbi/powerbi-postgres-drivers.png
:align: center

If this is correct, you can add a User DSN by navigating to the User DSN tab
Expand All @@ -119,7 +119,7 @@ are using a 64-bit Windows. Otherwise, select *PostgreSQL Unicode(x32)*.
<cratedb-powerbi-service>` integration document, then you should create
this DSN as a **System DSN**, not a **User DSN**.

.. figure:: /_assets/img/integrations/powerbi-driver-select.png
.. figure:: /_assets/img/integrations/powerbi/powerbi-driver-select.png
:align: center

Set up the data source with the following parameters:
Expand All @@ -140,7 +140,7 @@ If your CrateDB instance uses SSL, enable the SSL mode. If the CrateDB user
you're connecting with is password protected, add its password to the Password
field.

.. figure:: /_assets/img/integrations/powerbi-dsn-setup.png
.. figure:: /_assets/img/integrations/powerbi/powerbi-dsn-setup.png
:align: center

You can click *Test* to verify that the DSN is configured correctly. Once this
Expand All @@ -153,18 +153,18 @@ Connecting Power BI to CrateDB
Once you have created the DSN, open up Power BI and click *Get Data* from the
menu ribbon. Select *ODBC* from the list of available data sources:

.. figure:: /_assets/img/integrations/powerbi-source.png
.. figure:: /_assets/img/integrations/powerbi/powerbi-source.png
:align: center

Select CrateDB from the DSN list and click *OK*:

.. figure:: /_assets/img/integrations/powerbi-crate-dsn.png
.. figure:: /_assets/img/integrations/powerbi/powerbi-crate-dsn.png
:align: center

Within the ``doc`` schema, you should see and be able to add the
``population_data`` table:

.. figure:: /_assets/img/integrations/powerbi-table-navigator.png
.. figure:: /_assets/img/integrations/powerbi/powerbi-table-navigator.png
:align: center

From here you can transform the data as you wish, or click *Load* to load
Expand All @@ -184,7 +184,7 @@ panel into the *Legend* section of the visualizations tab.

The pie chart will be updated automatically, and will produce the following:

.. figure:: /_assets/img/integrations/powerbi-pie-chart.png
.. figure:: /_assets/img/integrations/powerbi/powerbi-pie-chart.png
:align: center


Expand Down
Loading

0 comments on commit 309a95b

Please sign in to comment.