Skip to content

Commit

Permalink
Add ingest data page
Browse files Browse the repository at this point in the history
  • Loading branch information
WilliGautier committed Jan 2, 2025
1 parent fbc0aee commit c97b062
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 0 deletions.
Binary file added docs/docs/images/index_collection_schema.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/ingest_data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions docs/docs/ingest_data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Ingest data

`ARLAS CLI` can be used to ingest data in ARLAS and make it explorable in ARLAS Dashboards.

![Ingest Data](images/ingest_data.png)
<p align="center" style="font-style: italic;">
Ingest Data in ARLAS Dashboards
</p>

## ARLAS Data structure

To be explored in ARLAS dashboards, the data has to be indexed in an [Elasticsearch](concepts.md#elasticsearch) (ES) [index](concepts.md#es-index).

An index contains the data and a model ([mapping](concepts.md#es-mapping)) to describe how fields have to be interpreted (types).

ARLAS [collections](concepts.md#arlas-collection) are built on top of indices.
They describe the basic data structure for its visualization and elements needed for the data access policy.

![Data indices and collections in ARLAS](images/index_collection_schema.png)
<p align="center" style="font-style: italic;">
Data indices and collections in ARLAS
</p>

## Ingest with ARLAS CLI

Once you have installed ARLAS CLI (see [Installation Guide](install.md)) and configured it with your ARLAS instance (see [Configuration Guide](configuration.md)), you can ingest data using the following commands:

- **Create an Index with a Mapping**:
- Use [arlas_cli indices mapping](indices.md#mapping) to infer the data model from a data sample and create an empty index.

- **Ingest Data into the Index**:
Use [arlas_cli indices data](indices.md#data) to populate the created index with your data.

- **Create a Collection**:
Use [arlas_cli collections create](collections.md#create) to define a collection based on the index.


To get started with data ingestion using a tutorial sample, check out the [ARLAS CLI Getting Started Guide](started.md#tutorial).


1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ nav:
- Getting started: started.md
- Installation: install.md
- Configuration: configuration.md
- Ingest Data: ingest_data.md
- Commands:
- Getting help: help.md
- confs: confs.md
Expand Down

0 comments on commit c97b062

Please sign in to comment.