diff --git a/docs/docs/iam.md b/docs/docs/iam.md
index cd9176c..efa731b 100644
--- a/docs/docs/iam.md
+++ b/docs/docs/iam.md
@@ -13,6 +13,11 @@
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ add Create organisation with the given name │
+│ add-apikey Add and return an new API Key with │
+│ permissions associated to provided groups. │
+│ Use the key id and key secret with the │
+│ arlas-api-key-id and arlas-api-key-secret │
+│ headers. │
│ add_group Add a group to the organisation │
│ add_permission Add a permission to the organisation │
│ add_permission_to_group Add a permission to a group within the │
@@ -21,8 +26,12 @@
│ optionally within groups │
│ add_user_to_group Add a user to a group within the │
│ organisation │
+│ authorize Remove an organisation name from the │
+│ forbidden list. │
+│ check Check if user's organisation exists │
│ collections List the collections of the organisation │
│ delete Delete the organisation │
+│ delete-apikey Delete an API Key │
│ delete_group Remove the group from the organisation │
│ delete_permission Remove the permission from the organisation │
│ delete_permission_from_group Remove a permission to a group within the │
@@ -30,6 +39,8 @@
│ delete_user Remove the user from the organisation │
│ delete_user_from_group Remove a user from a group within the │
│ organisation │
+│ forbid Forbid an organisation name. │
+│ forbidden List forbidden organisations. │
│ groups List the groups of the organisation │
│ list List organisations │
│ permissions List the permissions of the organisation │
@@ -50,10 +61,13 @@
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
-│ activate Activate user account │
-│ add Create user │
-│ deactivate Deactivate user account │
-│ delete Delete user │
+│ activate Activate user account │
+│ add Create user │
+│ deactivate Deactivate user account │
+│ delete Delete user │
+│ describe Describe user │
+│ reset-password Launch reset user's password process │
+│ update Update user │
╰────────────────────────────────────────────────────────────────────────────╯
```
diff --git a/docs/site/iam/index.html b/docs/site/iam/index.html
index 1bb045f..0d8eff5 100644
--- a/docs/site/iam/index.html
+++ b/docs/site/iam/index.html
@@ -611,10 +611,10 @@
Identity & Access Management
Manage organisations, users, permissions and groups
-arlas_cli iam --config local orgs --help
Usage: arlas_cli iam orgs [OPTIONS] COMMAND [ARGS]...
╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ add Create organisation with the given name │
│ add_group Add a group to the organisation │
│ add_permission Add a permission to the organisation │
│ add_permission_to_group Add a permission to a group within the │
│ organisation │
│ add_user Add a user to the organisation, and │
│ optionally within groups │
│ add_user_to_group Add a user to a group within the │
│ organisation │
│ collections List the collections of the organisation │
│ delete Delete the organisation │
│ delete_group Remove the group from the organisation │
│ delete_permission Remove the permission from the organisation │
│ delete_permission_from_group Remove a permission to a group within the │
│ organisation │
│ delete_user Remove the user from the organisation │
│ delete_user_from_group Remove a user from a group within the │
│ organisation │
│ groups List the groups of the organisation │
│ list List organisations │
│ permissions List the permissions of the organisation │
│ users List the users of the organisation │
╰────────────────────────────────────────────────────────────────────────────╯
+arlas_cli iam --config local orgs --help
Usage: arlas_cli iam orgs [OPTIONS] COMMAND [ARGS]...
╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ add Create organisation with the given name │
│ add-apikey Add and return an new API Key with │
│ permissions associated to provided groups. │
│ Use the key id and key secret with the │
│ arlas-api-key-id and arlas-api-key-secret │
│ headers. │
│ add_group Add a group to the organisation │
│ add_permission Add a permission to the organisation │
│ add_permission_to_group Add a permission to a group within the │
│ organisation │
│ add_user Add a user to the organisation, and │
│ optionally within groups │
│ add_user_to_group Add a user to a group within the │
│ organisation │
│ authorize Remove an organisation name from the │
│ forbidden list. │
│ check Check if user's organisation exists │
│ collections List the collections of the organisation │
│ delete Delete the organisation │
│ delete-apikey Delete an API Key │
│ delete_group Remove the group from the organisation │
│ delete_permission Remove the permission from the organisation │
│ delete_permission_from_group Remove a permission to a group within the │
│ organisation │
│ delete_user Remove the user from the organisation │
│ delete_user_from_group Remove a user from a group within the │
│ organisation │
│ forbid Forbid an organisation name. │
│ forbidden List forbidden organisations. │
│ groups List the groups of the organisation │
│ list List organisations │
│ permissions List the permissions of the organisation │
│ users List the users of the organisation │
╰────────────────────────────────────────────────────────────────────────────╯
Create, delete, activate / deactivate users
-arlas_cli iam --config local users --help
Usage: arlas_cli iam users [OPTIONS] COMMAND [ARGS]...
╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ activate Activate user account │
│ add Create user │
│ deactivate Deactivate user account │
│ delete Delete user │
╰────────────────────────────────────────────────────────────────────────────╯
+arlas_cli iam --config local users --help
Usage: arlas_cli iam users [OPTIONS] COMMAND [ARGS]...
╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ activate Activate user account │
│ add Create user │
│ deactivate Deactivate user account │
│ delete Delete user │
│ describe Describe user │
│ reset-password Launch reset user's password process │
│ update Update user │
╰────────────────────────────────────────────────────────────────────────────╯
diff --git a/docs/site/search/search_index.json b/docs/site/search/search_index.json
index 5d35b7f..0cd7b0a 100644
--- a/docs/site/search/search_index.json
+++ b/docs/site/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"About arlas_cli","text":"ARLAS Command Line Interface (arlas_cli) is a tool to manage data and configurations in ARLAS.
arlas_cli is a Python command line for:
- Managing Elasticsearch indices:
- Generate an index mapping based on NDJSON data{:target=\"_blank\"}
- Create an index
- List indices
- Describe an index
- Clone an index
- Migrate an index
- Delete an index
- Managing ARLAS collections
- Create a collection
- List collections
- Describe a collection
- Delete a collection
- Managing arlas_cli configurations
- Register an ARLAS/Elasticsearch configuration, with headers and authentication parameters
- Login to your ARLAS Cloud account
- List your configurations
- Delete a configuration
- Managing ARLAS Dashboards in persistence
- Create a dashboard from a configuration file
- List available dashboard
- Describe a dashboard
- Delete a dashboard
- Get the groups accessing dashboards
- Managing ARLAS Identity and Access (ARLAS IAM)
- List organisations
- Add an organisation
- Within an organisation:
- List visible collections
- List groups
- List users
- List permissions
- Add/delete a permission
- Add/delete a group
- Add/delete a permission to/from a group
- Add/delete a user
- Add/delete a user to/from a group
- Create a user
- Activate a user
- Deactivate a user
Follow the Getting Started Guide to begin using ARLAS CLI.
"},{"location":"collections/","title":"collections","text":""},{"location":"collections/#arlas-collections","title":"ARLAS Collections","text":"ARLAS collections are built on top of elasticsearch (ES) index. They describe the basic data structure for its visualization and elements needed for the data access policy.
arlas_cli provide tools to manage the ARLAS collections with the collections command.
List collections management commands
arlas_cli collections --help Usage: arlas_cli collections [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --config TEXT Name of the ARLAS configuration to use from your \u2502\u2502 configuration file \u2502\u2502 (/Users/gaudan/.arlas/cli/configuration.yaml). \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 count Count the number of hits within a collection (or all collection \u2502\u2502 if not provided) \u2502\u2502 create Create a collection \u2502\u2502 delete Delete a collection \u2502\u2502 describe Describe a collection \u2502\u2502 list List collections \u2502\u2502 name Set the collection display name \u2502\u2502 private Set collection visibility to private \u2502\u2502 public Set collection visibility to public \u2502\u2502 sample Display a sample of a collection \u2502\u2502 set_alias Set the field display name \u2502\u2502 share Share the collection with the organisation \u2502\u2502 unshare Unshare the collection with the organisation \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"collections/#create","title":"create","text":"An ARLAS Collection is linked to an index or even an index pattern.
The command line options let you specify how the index should be used by the collection.
arlas_cli collections --config local create --help Usage: arlas_cli collections create [OPTIONS] COLLECTION Create a collection \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --model TEXT Name of the model within your \u2502\u2502 configuration, or URL or file path \u2502\u2502 [default: None] \u2502\u2502 --index TEXT Name of the index referenced by \u2502\u2502 the collection \u2502\u2502 [default: None] \u2502\u2502 --display-name TEXT Display name of the collection \u2502\u2502 [default: None] \u2502\u2502 --public --no-public Whether the collection is public \u2502\u2502 or not \u2502\u2502 [default: no-public] \u2502\u2502 --owner TEXT Organisation's owner \u2502\u2502 [default: None] \u2502\u2502 --orgs TEXT List of organisations accessing \u2502\u2502 the collection \u2502\u2502 --id-path TEXT Override the JSON path to the id \u2502\u2502 field. \u2502\u2502 [default: None] \u2502\u2502 --centroid-path TEXT Override the JSON path to the \u2502\u2502 centroid field. \u2502\u2502 [default: None] \u2502\u2502 --geometry-path TEXT Override the JSON path to the \u2502\u2502 geometry field. \u2502\u2502 [default: None] \u2502\u2502 --date-path TEXT Override the JSON path to the date \u2502\u2502 field. \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Collection visibility
The visibility options (--public, --private, --owner and --orgs) allow you to choose who can access the collection.
--owner
If ARLAS is used with ARLAS IAM (for example with ARLAS Cloud), then a collection must be associated to an organisation.
Example:
--owner your.organisation.com
By default, the organisation referenced in your config is used as owner.
"},{"location":"collections/#create-an-arlas-collection","title":"Create an ARLAS collection","text":"The collection has to reference an available ES index or index pattern with the arlas_cli configuration.
The index option sets the targeted index:--index index_name
Index pattern
The collection can target an index pattern. Instead of an index name, the target is an expression using * to reference multiple ES indices.
Example:
--index index_name_prefix*
All the indices have to share exactly the same data mapping.
The data contained in all referenced indices are then explorable together in ARLAS.
The collection also describe a basic structure for spatio-temporel datasets:
- ID path: A data field containing unique element identifier.
--id-path unique_id_field - Centroid path: A data field containing a point geometry used for aggregations
--centroid-path point_geom_field - Geometry path: A data field containing a geometry representing the element
--geometry-path element_geom_field - Date path: A data field containing the date associated to each element
--date-path date_field
Pretty name
A pretty name for the collection can be set at the creation with the display-name option
Example:
--display-name \"Pretty Collection Name\"
To create the collection, run the following command:
arlas_cli collections \\ --config {local} \\ create {collection_name} \\ --index {index_name} \\ --id-path {unique_id_field} \\ --centroid-path {point_geom_field} \\ --geometry-path {element_geom_field} \\ --date-path {date_field} \\ --display-name {\"Pretty Collection Name\"}"},{"location":"collections/#name","title":"name","text":"The collection can be defined by a pretty name. It can be set with name subcommand:
arlas_cli collections --config local name --help Usage: arlas_cli collections name [OPTIONS] COLLECTION NAME Set the collection display name \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2502 * name TEXT The display name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#set-a-pretty-name-for-the-collection","title":"Set a pretty name for the collection","text":"The pretty name can be used in ARLAS to display the collection. It can also be set by the --display-name option at the collection creation.
To set it with the name subcommand:
> arlas_cli collections \\\n --config {local} \\\n name {collection_name} {\"Pretty Collection Name\"}\n
"},{"location":"collections/#set_alias","title":"set_alias","text":"The data fields are sometimes not very suitable in ARLAS Exploration dashboards. You can set aliases to improve their display in the interface.
arlas_cli collections --config local set_alias --help Usage: arlas_cli collections set_alias [OPTIONS] COLLECTION FIELD_PATH [DISPLAY_NAME] Set the field display name \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] \u2502\u2502 [required] \u2502\u2502 * field_path TEXT The field path [default: None] \u2502\u2502 [required] \u2502\u2502 display_name [DISPLAY_NAME] The field's display name. If none \u2502\u2502 provided, then the alias is removed \u2502\u2502 if it existed \u2502\u2502 [default: None] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#set-a-pretty-name-for-a-data-field","title":"Set a pretty name for a data field","text":"Each field of the data has a raw name. It can be replaced by a pretty name to display. For example:
> arlas_cli collections \\\n --config {local} \\\n set_alias {collection_name} \\\n {raw_field_name} {\"Pretty Field Name (unit)\"}\n
"},{"location":"collections/#list","title":"list","text":""},{"location":"collections/#list-available-collections","title":"List available collections","text":"You can access the list of available collections with the list subcommand:
arlas_cli collections --config local set_alias --helpUsage: arlas_cli collections list [OPTIONS] List collectionsOptions: --help Show this message and exit."},{"location":"collections/#describe","title":"describe","text":""},{"location":"collections/#describe-a-collection","title":"Describe a collection","text":"The describe command line provides a description of the collection's structure (fields) and its metadata.
arlas_cli collections --config local describe --help Usage: arlas_cli collections describe [OPTIONS] COLLECTION Describe a collection \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#count","title":"count","text":""},{"location":"collections/#count-the-number-of-element-within-a-collection","title":"Count the number of element within a collection","text":"The count command show the total number of elements (data rows) accessible in a collection.
arlas_cli collections --config local count --help Usage: arlas_cli collections count [OPTIONS] [COLLECTION] Count the number of hits within a collection (or all collection if not provided) \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 collection [COLLECTION] Collection's name [default: None] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#sample","title":"sample","text":""},{"location":"collections/#display-a-sample-of-the-collection-data","title":"Display a sample of the collection data","text":"The sample command show few data rows accessible in a collection.
arlas_cli collections --config local sample --help Usage: arlas_cli collections sample [OPTIONS] COLLECTION Display a sample of a collection \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --pretty --no-pretty [default: pretty] \u2502\u2502 --size INTEGER [default: 10] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Note
The number of rows to display can be set with --size option
"},{"location":"collections/#private","title":"private","text":"By default, a collection is private, it can only be seen by the members of the owner or shared organisation.
In that case, an ARLAS user has to be logged and have the correct authorisations.
"},{"location":"collections/#set-the-collection-as-private","title":"Set the collection as private","text":"To switch a collection from public to private, use the private command:
arlas_cli collections --config local private --help Usage: arlas_cli collections private [OPTIONS] COLLECTION Set collection visibility to private \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#public","title":"public","text":"A public collection can be accessed in ARLAS dashboards without being logged. It can be used to host demo dashboards for example.
"},{"location":"collections/#set-the-collection-as-public","title":"Set the collection as public","text":"To switch a collection from private to public, use the public command:
arlas_cli collections --config local public --help Usage: arlas_cli collections public [OPTIONS] COLLECTION Set collection visibility to public \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#share","title":"share","text":"A collection can be shared between different organisations to make it available for its users.
"},{"location":"collections/#share-collections-between-organisations","title":"Share collections between organisations","text":"A collection can be shared to other organisation with the share command:
arlas_cli collections --config local share --help Usage: arlas_cli collections share [OPTIONS] COLLECTION ORGANISATION Share the collection with the organisation \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2502 * organisation TEXT Organisation's name [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#unshare","title":"unshare","text":"The right to access a collection can be removed to the users of an organisation.
"},{"location":"collections/#remove-collection-access-for-an-organisation","title":"Remove collection access for an organisation","text":"The access to a collection can be removed with the unshare command:
arlas_cli collections --config local unshare --help Usage: arlas_cli collections unshare [OPTIONS] COLLECTION ORGANISATION Unshare the collection with the organisation \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2502 * organisation TEXT Organisation's name [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#delete","title":"delete","text":"A collection can be deleted. It doesn't delete the data (ES index can still exist) but it will no longer be accessible in ARLAS.
"},{"location":"collections/#delete-a-collection","title":"Delete a collection","text":"The collection can be removed with the delete command:
arlas_cli collections --config local delete --help Usage: arlas_cli collections delete [OPTIONS] COLLECTION Delete a collection \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"configuration/","title":"Configuration","text":"arlas_cli uses a yaml file for storing various ARLAS and elasticsearch configurations.
"},{"location":"configuration/#initial-configuration","title":"Initial configuration","text":"At its first launch, arlas_cli will create a first configuration file for you.
arlas_cli --versionX.X.XWarning : no configuration file found, we created an empty one for you (~/.arlas/cli/configuration.yaml). By default, the file is located in $HOME/.arlas/cli/configuration.yaml.
It contains one ARLAS configuration linked to a local deployment.
Warning
If you used the ARLAS Exploration Stack, it is possible that you already have a directory named $HOME/.arlas. This directory has been created by docker as root.
The owner of the directory must be changed to the local user (sudo chown ${USER}: $HOME/.arlas).
"},{"location":"configuration/#arlas-cloud-configuration","title":"ARLAS Cloud configuration","text":"If you have an ARLAS cloud account, you can directly create the configurations to access your space with arlas_cli login.
Provided by Gisa\u00efa
Gisa\u00efa provides the following variables for your account:
ORGANIZATION: The name of your organization.ELASTIC_ENDPOINT, ELASTIC_USER, ELASTIC_PWD: The elasticsearch credentials associated with your account.
Personal ARLAS account
You will also need the credentials for your personal ARLAS account:
ARLAS_USER: Your login, typically your email address.ARLAS_PWD: The password you created when setting up your account.
To create the cloud.arlas.io.{USER_NAME} configuration, replace the placeholder variables with your actual values and run the following command:
arlas_cli confs login ${ARLAS_USER} ${ELASTIC_USER} ${ELASTIC_ENDPOINT} --auth-password ${ARLAS_PWD} --auth-org ${MY_ORGANIZATION} --elastic-password ${ELASTIC_PWD} --allow-delete\n
Once the configuration is created, verify its existence by listing all configurations:
arlas_cli confs list\n
Default configuration
The configuration linked to your ARLAS Cloud account is automatically used as the default.
You do not need to specify the --config option when using arlas_cli.
For example, to list the available collections, use the following command:
arlas_cli collections list\n
"},{"location":"configuration/#configurations-file","title":"Configurations file","text":""},{"location":"configuration/#default-configurations-file","title":"Default configurations file","text":"By default, the command line uses the ${HOME}/.arlas/cli/configuration.yaml configuration file.
For example, the default configuration file with only the local configuration looks like:
arlas:\n local:\n allow_delete: true\n authorization: null\n elastic:\n location: http://localhost:9200\n ...\n persistence:\n location: http://localhost/persist\n ...\n server:\n location: http://localhost/arlas\n ...\n
The arlas section contains the different deployment configurations (here only local).
Each deployment configuration is defined by:
- authorization: The authentication system configuration
- elastic: The link to the elasticsearch cluster
- persistence: The link to ARLAS persistence
- server: The link to ARLAS server
You can interact with this configuration file directly with the command line itself with the arlas_cli confs commands:
- confs list: List the available configurations
- confs describe: Describe the content of a configuration
- confs create: Create a new configuration
- confs delete: Delete a configuration
- confs login: Create an ARLAS Cloud configuration (see ARLAS Cloud configuration)
"},{"location":"configuration/#custom-configuration-file-path","title":"Custom configuration file path","text":"It is possible to use a different configuration file than the one placed in your home directory ($HOME/.arlas/cli/configuration.yaml):
arlas_cli --config-file /tmp/config.yaml Warning : no configuration file found, we created a default one with a 'local' confs accessing local ARLAS exploration stack (/tmp/config.yaml). All the arlas_cli commands can then be run on this configuration file, for example to list the available confs:
arlas_cli --config-file /tmp/config.yaml confs list+-------+------------------------+| name | url |+-------+------------------------+| local | http://localhost/arlas |+-------+------------------------+"},{"location":"confs/","title":"Configurations","text":""},{"location":"confs/#arlas-configurations","title":"ARLAS configurations","text":"An ARLAS Configuration tells arlas_cli how to contact ARLAS Server and Elasticsearch.
See more information about configuration.
It is possible, with the arlas_cli confs command lines, to manage the ARLAS configurations.
List configurations (confs) management commands
arlas_cli confs --help Usage: arlas_cli confs [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 check Check the services of a configuration \u2502\u2502 create Add a configuration \u2502\u2502 default Display the default configuration \u2502\u2502 delete Delete a configuration \u2502\u2502 describe Describe a configuration \u2502\u2502 list List configurations \u2502\u2502 login Add a configuration for ARLAS Cloud \u2502\u2502 set Set default configuration among existing configurations \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"confs/#create","title":"create","text":"arlas_cli is meant to communicate with a deployed ARLAS. This link is configured by creating a new configuration.
arlas_cli confs create --help Usage: arlas_cli confs create [OPTIONS] NAME Add a configuration \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * name TEXT Name of the configuration [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * --server TEXT ARLAS Server url \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2502 --headers TEXT header (name:value) \u2502\u2502 --persistence TEXT ARLAS Persistence \u2502\u2502 url \u2502\u2502 [default: None] \u2502\u2502 --persistence-head\u2026 TEXT header (name:value) \u2502\u2502 --elastic TEXT elasticsearch url \u2502\u2502 [default: None] \u2502\u2502 --elastic-login TEXT elasticsearch login \u2502\u2502 [default: None] \u2502\u2502 --elastic-password TEXT elasticsearch \u2502\u2502 password \u2502\u2502 [default: None] \u2502\u2502 --elastic-headers TEXT header (name:value) \u2502\u2502 --allow-delete --no-allow-delete Is delete command \u2502\u2502 allowed for this \u2502\u2502 configuration? \u2502\u2502 [default: \u2502\u2502 no-allow-delete] \u2502\u2502 --auth-token-url TEXT Token URL of the \u2502\u2502 authentication \u2502\u2502 service \u2502\u2502 [default: None] \u2502\u2502 --auth-headers TEXT header (name:value) \u2502\u2502 --auth-org TEXT ARLAS IAM \u2502\u2502 Organization \u2502\u2502 [default: None] \u2502\u2502 --auth-login TEXT login \u2502\u2502 [default: None] \u2502\u2502 --auth-password TEXT password \u2502\u2502 [default: None] \u2502\u2502 --auth-client-id TEXT Client ID \u2502\u2502 [default: None] \u2502\u2502 --auth-client-secr\u2026 TEXT Client secret \u2502\u2502 [default: None] \u2502\u2502 --auth-grant-type TEXT Grant type (e.g. \u2502\u2502 password) \u2502\u2502 [default: None] \u2502\u2502 --auth-arlas-iam --no-auth-arlas-iam Is it an ARLAS IAM \u2502\u2502 service? \u2502\u2502 [default: \u2502\u2502 auth-arlas-iam] \u2502\u2502 --help Show this message \u2502\u2502 and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"confs/#create-a-new-configuration","title":"Create a new configuration","text":"The arlas_cli confs create command has to be filled with options specific to your ARLAS deployment.
Those options can be filled as described in the following sections.
"},{"location":"confs/#arlas-authentication","title":"ARLAS Authentication","text":"For ARLAS, keycloak and ARLAS IAM authentications are supported.
ARLAS IAMKeycloak To create a configuration using ARLAS IAM, the following parameters have to be set with your values:
- The IAM session url
IAM_URL - Your IAM user
ARLAS_USER - Your IAM password
ARLAS_PWD - Your ARLAS organization
ARLAS_ORGANIZATION
The following options are used by confs create sub-command to generate the conf:
--auth-arlas-iam\n--auth-token-url {IAM_URL}\n--auth-login {ARLAS_USER}\n--auth-password {ARLAS_PWD}\n--auth-headers \"Content-Type:application/json;charset=utf-8\"\n--auth-org {ARLAS_ORGANIZATION}\n
By default, the authentication is supposed to be with ARLAS IAM. For Keycloak, use --no-auth-arlas-iam
Keycloak authentication details coming soon...
"},{"location":"confs/#arlas-server-and-persistence","title":"ARLAS Server and Persistence","text":"The ARLAS server URL (ARLAS_SERVER_URL) and the ARLAS persistence server URL (ARLAS_PERSISTENCE_URL) have to be set in the configuration using the following options in the confs create sub-command:
--server {ARLAS_SERVER_URL}\n--headers \"Content-Type:application/json\"\n--persistence {ARLAS_PERSISTENCE_URL}\n--persistence-headers \"Content-Type:application/json\"\n
"},{"location":"confs/#elasticsearch","title":"Elasticsearch","text":"The used Elasticsearch instance and your credentials has to be set in the configuration:
ELASTIC_ENDPOINT: The used Elasticsearch endpoint (eg: http://localhost:9200)ELASTIC_USER: Your ES user nameELASTIC_PWD: Your ES user password
The link to the ES instance is configured by using the following options in the confs create sub-command:
--elastic {ELASTIC_ENDPOINT}\n--elastic-headers \"Content-Type:application/json\"\n--elastic-login {ELASTIC_USER}\n--elastic-password {ELASTIC_PWD}\n
"},{"location":"confs/#allow-data-deletion","title":"Allow data deletion","text":"By default, it is not possible to run the indices delete command on an elasticsearch with arlas_cli. This is to prevent accidental data loss.
--allow-delete
In order to allow to delete on a configuration, use the --allow-delete option.
"},{"location":"confs/#login","title":"login","text":""},{"location":"confs/#create-configuration-for-arlas-cloud","title":"Create configuration for ARLAS Cloud","text":"The confs longin allows to create a configuration linked to an ARLAS Cloud account:
arlas_cli confs login --help Usage: arlas_cli confs login [OPTIONS] AUTH_LOGIN ELASTIC_LOGIN ELASTIC Add a configuration for ARLAS Cloud \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * auth_login TEXT ARLAS login [default: None] [required] \u2502\u2502 * elastic_login TEXT Elasticsearch login [default: None] \u2502\u2502 [required] \u2502\u2502 * elastic TEXT Elasticsearch url [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --auth-org TEXT ARLAS IAM Organization, \u2502\u2502 default is your email \u2502\u2502 domain name \u2502\u2502 [default: None] \u2502\u2502 --allow-delete --no-allow-delete Is delete command allowed \u2502\u2502 for this configuration? \u2502\u2502 [default: allow-delete] \u2502\u2502 --auth-password TEXT ARLAS password \u2502\u2502 [default: None] \u2502\u2502 --elastic-password TEXT elasticsearch password \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and \u2502\u2502 exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Only your own ES and ARLAS credentials have to be set, the configuration is directly linked to the ARLAS Cloud instance.
It creates a configuration based on your username (extracted from your ARLAS login) : cloud.arlas.io.{USER_NAME}
Note
This created configuration is used as default.
You no longer need to declare the --config in the arlas_cli commands
See the ARLAS Cloud configuration guide.
"},{"location":"confs/#delete","title":"delete","text":""},{"location":"confs/#delete-an-existing-configuration","title":"Delete an existing configuration","text":"An existing configuration can be deleted with the confs delete sub command:
arlas_cli confs delete --help Usage: arlas_cli confs delete [OPTIONS] CONFIG Delete a configuration \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * config TEXT Name of the configuration [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ To remove an existing configuration from the default configuration file, simply run the following command:
arlas_cli confs delete {conf_name}\n
The configuration will no longer appear in the configuration file.
Warning
Once deleted, the configuration cannot be retrieved.
"},{"location":"confs/#describe","title":"describe","text":""},{"location":"confs/#describe-the-content-of-a-configuration","title":"Describe the content of a configuration","text":"The content of a configuration can be detailed with confs describe sub command:
arlas_cli confs describe --help Usage: arlas_cli confs describe [OPTIONS] CONFIG Describe a configuration \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * config TEXT Name of the configuration [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ For example, the default local configuration looks like:
arlas_cli confs describe localallow_delete: trueauthorization: nullelastic: headers: Content-Type: application/json location: http://localhost:9200 login: null password: nullpersistence: headers: Content-Type: application/json location: http://localhost/persist login: null password: nullserver: headers: Content-Type: application/json location: http://localhost/arlas login: null password: null We get the different elements of the configurations:
- authorization: The authentication system configuration
- elastic: The link to Elasticsearch cluster
- persistence: The link to ARLAS persistence
- server: The link to ARLAS server
See more about the configuration.
"},{"location":"confs/#list","title":"list","text":""},{"location":"confs/#list-the-available-configurations","title":"List the available configurations","text":"The list of available configurations can be obtained with confs list sub command:
arlas_cli confs list --help Usage: arlas_cli confs list [OPTIONS] List configurations \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ The confs list sub-command returns the list of available configuration names and their ARLAS server url.
For example:
arlas_cli confs list+-------+------------------------+| name | url |+-------+------------------------+| local | http://localhost/arlas |+-------+------------------------+"},{"location":"confs/#default","title":"default","text":""},{"location":"confs/#get-the-current-default-configuration","title":"Get the current default configuration","text":"The default arlas_cli configuration can be obtained with the confs default subcommand:
arlas_cli confs default --help Usage: arlas_cli confs default [OPTIONS] Display the default configuration \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Note
When a configuration is set as default, you do not need to specify --config option in arlas_cli commands.
To identify which configuration is currently set as the default, run:
arlas_cli confs default\n
"},{"location":"confs/#set","title":"set","text":""},{"location":"confs/#set-the-default-configuration","title":"Set the default configuration","text":"The default arlas_cli configuration can be set with the confs set subcommand:
arlas_cli confs set --help Usage: arlas_cli confs set [OPTIONS] NAME Set default configuration among existing configurations \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * name TEXT Name of the configuration to become default \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Note
When a configuration is set as default, you do not need to specify --config option in arlas_cli commands.
To set a configuration conf_name as the default, run:
arlas_cli confs set {conf_name}\n
"},{"location":"confs/#check","title":"check","text":""},{"location":"confs/#check-the-services-of-a-configuration","title":"Check the services of a configuration","text":"You can verify the services accessible through a specific configuration using the confs check subcommand:
arlas_cli confs check --help Usage: arlas_cli confs check [OPTIONS] NAME Check the services of a configuration \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * name TEXT Configuration to be checked [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ This command validates that the addresses and credentials defined in the configuration are correct and ensures successful access to the services.
The following services are validated:
- ARLAS Server
- ARLAS Persistence
- ARLAS IAM
- Elasticsearch
Success
Example:
arlas_cli confs check cloud.arlas.io.userARLAS Server: ... okARLAS Persistence: ... okARLAS IAM: ... okElasticsearch: ... ok
All services are up and running, and the configuration is correctly set up.
"},{"location":"help/","title":"Getting help","text":""},{"location":"help/#getting-help","title":"Getting help","text":"At any time, if you need some help on how to use the command line or one of its sub command, simply add --help.
Whether you are at the top level:
arlas_cli --help Usage: arlas_cli [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --config-file TEXT Path to the configuration file \u2502\u2502 if you do not want to use the \u2502\u2502 default one: \u2502\u2502 .arlas/cli/configuration.yaml. \u2502\u2502 [default: None] \u2502\u2502 --print-curl --no-print-curl Print curl command \u2502\u2502 [default: no-print-curl] \u2502\u2502 --version Print command line version \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 collections \u2502\u2502 confs \u2502\u2502 iam \u2502\u2502 indices \u2502\u2502 persist \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f or within a sub command:
arlas_cli indices --config local mapping --help Usage: arlas_cli indices mapping [OPTIONS] FILE Generate the mapping based on the data \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * file TEXT Path to the file containing the data. Format: NDJSON \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --nb-lines INTEGER Number of line to consider for generating \u2502\u2502 the mapping. Avoid going over 10. \u2502\u2502 [default: 2] \u2502\u2502 --field-mapping TEXT Override the mapping with the provided \u2502\u2502 field path/type. Example: \u2502\u2502 fragment.location:geo_point. Important: \u2502\u2502 the full field path must be provided. \u2502\u2502 --no-fulltext TEXT List of keyword or text fields that should \u2502\u2502 not be in the fulltext search. Important: \u2502\u2502 the field name only must be provided. \u2502\u2502 --no-index TEXT List of fields that should not be indexed. \u2502\u2502 --push-on TEXT Push the generated mapping for the \u2502\u2502 provided index name \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"iam/","title":"Identity & Access Management","text":""},{"location":"iam/#manage-organisations-users-permissions-and-groups","title":"Manage organisations, users, permissions and groups","text":"arlas_cli iam --config local orgs --help Usage: arlas_cli iam orgs [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 add Create organisation with the given name \u2502\u2502 add_group Add a group to the organisation \u2502\u2502 add_permission Add a permission to the organisation \u2502\u2502 add_permission_to_group Add a permission to a group within the \u2502\u2502 organisation \u2502\u2502 add_user Add a user to the organisation, and \u2502\u2502 optionally within groups \u2502\u2502 add_user_to_group Add a user to a group within the \u2502\u2502 organisation \u2502\u2502 collections List the collections of the organisation \u2502\u2502 delete Delete the organisation \u2502\u2502 delete_group Remove the group from the organisation \u2502\u2502 delete_permission Remove the permission from the organisation \u2502\u2502 delete_permission_from_group Remove a permission to a group within the \u2502\u2502 organisation \u2502\u2502 delete_user Remove the user from the organisation \u2502\u2502 delete_user_from_group Remove a user from a group within the \u2502\u2502 organisation \u2502\u2502 groups List the groups of the organisation \u2502\u2502 list List organisations \u2502\u2502 permissions List the permissions of the organisation \u2502\u2502 users List the users of the organisation \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"iam/#create-delete-activate-deactivate-users","title":"Create, delete, activate / deactivate users","text":"arlas_cli iam --config local users --help Usage: arlas_cli iam users [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 activate Activate user account \u2502\u2502 add Create user \u2502\u2502 deactivate Deactivate user account \u2502\u2502 delete Delete user \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"indices/","title":"Indices","text":""},{"location":"indices/#elasticsearch-index","title":"Elasticsearch index","text":"To be explored in ARLAS dashboards, the data has to be indexed in an Elasticsearch (ES) index. An index contains the data and a mapping to describe how fields have to be interpreted (types).
arlas_cli provide tools to infer mapping from data and manage the ES indices with the indices command.
List index management commands
arlas_cli indices --help Usage: arlas_cli indices [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --config TEXT Name of the ARLAS configuration to use from your \u2502\u2502 configuration file \u2502\u2502 (/Users/gaudan/.arlas/cli/configuration.yaml). \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 clone Clone an index and set its name \u2502\u2502 create Create an index \u2502\u2502 data Index data \u2502\u2502 delete Delete an index \u2502\u2502 describe Describe an index \u2502\u2502 list List indices \u2502\u2502 mapping Generate the mapping based on the data \u2502\u2502 migrate Migrate an index on another arlas configuration, and set the \u2502\u2502 target index name \u2502\u2502 sample Display a sample of an index \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"indices/#mapping","title":"mapping","text":"arlas_cli provide tools to infer the ES mapping directly from a data file.
arlas_cli indices --config local mapping --help Usage: arlas_cli indices mapping [OPTIONS] FILE Generate the mapping based on the data \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * file TEXT Path to the file containing the data. Format: NDJSON \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --nb-lines INTEGER Number of line to consider for generating \u2502\u2502 the mapping. Avoid going over 10. \u2502\u2502 [default: 2] \u2502\u2502 --field-mapping TEXT Override the mapping with the provided \u2502\u2502 field path/type. Example: \u2502\u2502 fragment.location:geo_point. Important: \u2502\u2502 the full field path must be provided. \u2502\u2502 --no-fulltext TEXT List of keyword or text fields that should \u2502\u2502 not be in the fulltext search. Important: \u2502\u2502 the field name only must be provided. \u2502\u2502 --no-index TEXT List of fields that should not be indexed. \u2502\u2502 --push-on TEXT Push the generated mapping for the \u2502\u2502 provided index name \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#data-file","title":"Data file","text":"To generate a mapping, you need to provide a NDJSON file (New line delimiter JSON).
The values of the first lines of the files are used to infer the mapping for each field of the data.
--nb_lines
The indices mapping function uses the first rows to infer mapping. If a field is not present in the first rows, it will not appear in the mapping.
Make sure to take enough rows to get all the fields with the option --nb_lines
"},{"location":"indices/#type-identification","title":"Type identification","text":"The mapping associates to each field of the data a type (see Elasticsearch type)
A geometry is identified as such if
- it is a geojson
- it is a WKT string
- the field name contains
geohash - it is a string containing two float separated by a comma
A date is identified as such if
- its name is one of
timestamp, date, start or end and that it can be parsed as a date - its name contains
timestamp, date, start or end and its values are number within [631152000, 4102444800] or [631152000000, 4102444800000] (year 1990 to 2100)
--field-mapping
If the mapping is wrong, you can overwrite the typing with the --field-mapping option.
It has the structure field_name:field_type (see Elasticsearch type)
Examples:
--field-mapping field_point:geo_point--field-mapping field_geometry:geo_shape--field-mapping field_short_text:keyword--field-mapping field_long_text:text--field-mapping field_float:double--field-mapping field_int:long
The date fields have a format that can be specified as field_name:date-format with all format accepted by Elasticsearch date type
Examples:
--field-mapping field_time_epoch_second:date-epoch_second--field-mapping field_time_epoch_millisecond:date-epoch_millis--field-mapping field_time_pattern:date-\"yyyy-MM-dd HH:mm:ss\"
By default, the keywords and text fields are searchable as fulltext to be accessible in the search bar.
--no-fulltext
If searching through a field value is not needed, it can be deactivated. That would result in better performances for the fulltext search.
Example:
--no-fulltext field_keyword
--no-index
If a field doesn't need to be explored in the dashboard, it should be removed before indexing the data.
Alternatively, you can explicitly exclude the field from being indexed using the --no-index option.
Example:
The field will remain in the data but will not be indexed.
"},{"location":"indices/#created-mapping","title":"Created mapping","text":"By default, the arlas_cli indices mapping directly returns the mapping in the command line.
Once you're happy with the mapping, you can either store it in a file or directly push it on elasticsearch.
Store mapping in a file
To store the created mapping in a mapping.json file, simply use > as the end of your command.
Example:
arlas_cli indices \\ --config {local} \\ mapping {path/to/data.json} \\ --field-mapping {timestamps.start:date-epoch_second} \\ --field-mapping {timestamps.end:date-epoch_second} \\ > {path/to/mapping.json}
--push-on
To push the inferred mapping directly in an Elasticsearch index, use the --push-on option with the target index name.
Example:
arlas_cli indices \\ --config {local} \\ mapping {path/to/data.json} \\ --push-on {index_name}
The index is then created and the index creation command can be skipped.
"},{"location":"indices/#create","title":"create","text":"Before putting the data in an elasticsearch index, the index has to be initialised with the correct mapping.
The indices create sub-function create the index from a mapping json file.
arlas_cli indices --config local create --help Usage: arlas_cli indices create [OPTIONS] INDEX Create an index \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * index TEXT index's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * --mapping TEXT Name of the mapping within your \u2502\u2502 configuration, or URL or file path \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2502 --shards INTEGER Number of shards for the index [default: 1] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#create-an-es-index-with-its-mapping","title":"Create an ES index with its mapping","text":"The index name and the path to the mapping json file have to be used to create the ES index.
Warning
If the ARLAS deployment uses ARLAS IAM for authentication, the index must be associated with an organisation.
The index_name must follow the pattern {organisation}@{data_index_name} (e.g., gisaia.com@ais_courses).
The indices create sub-function create the index from a mapping json file.
Example:
arlas_cli indices \\ --config local \\ create {index_name} \\ --mapping {path/to/mapping.json} Once the index is created, Elasticsearch can index data to fill that index.
"},{"location":"indices/#data","title":"data","text":"To explore data in ARLAS, it has to be indexed in the created ES index.
The indices data sub-function ingest the data in a given index.
arlas_cli indices --config local data --help Usage: arlas_cli indices data [OPTIONS] INDEX FILES... Index data \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * index TEXT index's name [default: None] [required] \u2502\u2502 * files FILES... List of paths to the file(s) containing the \u2502\u2502 data. Format: NDJSON \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --bulk INTEGER Bulk size for indexing data [default: 5000] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#ingest-data","title":"Ingest data","text":"To index data, you'll need to provide one or several NDJSON (New line delimiter JSON) file(s). Indexing uses bulks for optimal performances.
Example:
arlas_cli indices \\ --config {local} \\ data {index_name} {path/to/data.json} Tip
The data can be split in different NDJSON files in a folder:
part-00000-[...].json\npart-00001-[...].json\n...\n
In practice, the files argument can be filed with a pattern such as path/to/data.json/part-0000*.json to reference all the different files. Warning
If the index already contains data, the data is added to the index.
To reindex the same data, delete the index, and do not forget to recreate it with the correct mapping before ingesting the data.
--bulk
Indexing uses bulks for optimal performances.
The size of bulk can be changed with the --bulk option
"},{"location":"indices/#list","title":"list","text":"To list the available ES indices, simply use the indices list sub-function. No arguments are required.
arlas_cli indices --config local list --help Usage: arlas_cli indices list [OPTIONS] List indices \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#list-available-es-indices","title":"List available ES indices","text":"It displays for each ES index its status, the number of elements it contains and the size of the index.
Example:
> arlas_cli indices --config {local} list\n+--------------+--------+-------+--------+\n| name | status | count | size |\n+--------------+--------+-------+--------+\n| .arlas | open | 4 | 11.9kb |\n| index_name | open | 100 | 1mb |\n+--------------+--------+-------+--------+\n
"},{"location":"indices/#describe","title":"describe","text":"Once the index is created, the description of the fields it contains (corresponding to the mapping) can be displayed with the indices describe sub function:
arlas_cli indices --config local data --help Usage: arlas_cli indices data [OPTIONS] INDEX FILES... Index data \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * index TEXT index's name [default: None] [required] \u2502\u2502 * files FILES... List of paths to the file(s) containing the \u2502\u2502 data. Format: NDJSON \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --bulk INTEGER Bulk size for indexing data [default: 5000] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#describe-the-index-mapping","title":"Describe the index mapping","text":"For a given index, the description of its fields and their type can be displayed.
For example:
> arlas_cli indices --config {local} describe {index_name}\n+------------------+-----------+\n| field name | type |\n+------------------+-----------+\n| field_keyword | keyword |\n| field_point | geo_point |\n| field_long | long |\n| field_shape | geo_shape |\n| field_double | double |\n| field_date | date |\n| field_text | text |\n| field_object | object |\n| field_boolean | boolean |\n+------------------+-----------+\n
"},{"location":"indices/#sample","title":"sample","text":"The first rows of the data contained in an index can be displayed with the indices sample sub function.
arlas_cli indices --config local delete --help Usage: arlas_cli indices delete [OPTIONS] INDEX Delete an index \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * index TEXT index's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#visualize-few-rows-of-your-dataset","title":"Visualize few rows of your dataset","text":"For a given index index_name, the first rows of data can be displayed as a valid json dictionary.
--size
The number of rows to display (default 100) can be changed
Example:
> arlas_cli indices --config {local} sample {index_name} --size {10}\n
By default, the json representation of the data is pretty printed (clear indentation and one line per field)
--no-pretty
The pretty printing can be deactivated and data is displayed in a compact way
Example:
> arlas_cli indices --config {local} sample {index_name} --no-pretty\n
"},{"location":"indices/#clone","title":"clone","text":""},{"location":"indices/#duplicate-an-index-with-a-new-index-name","title":"Duplicate an index with a new index name","text":"An ES index can be cloned on the same ES deployment with the indices clone sub-command:
arlas_cli indices --config local clone --help Usage: arlas_cli indices clone [OPTIONS] SOURCE TARGET Clone an index and set its name \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * source TEXT Source index name [default: None] [required] \u2502\u2502 * target TEXT Target cloned index name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Both indices co-exist with exactly the same mapping and data content.
"},{"location":"indices/#migrate","title":"migrate","text":""},{"location":"indices/#copy-an-index-in-another-arlas-configuration","title":"Copy an index in another arlas configuration","text":"An index can be copied from an ES instance to another.
Note
The two instances have to be accessible by arlas_cli with two configurations (see Configuration guide).
The target configuration and the name of the new created index are given to the indices migrate sub-command.
arlas_cli indices --config local clone --help Usage: arlas_cli indices clone [OPTIONS] SOURCE TARGET Clone an index and set its name \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * source TEXT Source index name [default: None] [required] \u2502\u2502 * target TEXT Target cloned index name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Both indices co-exist with exactly the same mapping and data content.
"},{"location":"indices/#delete","title":"delete","text":"The ES index can be deleted with indices delete sub command to free space on the ES cluster.
arlas_cli indices --config local delete --help Usage: arlas_cli indices delete [OPTIONS] INDEX Delete an index \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * index TEXT index's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#delete-an-es-index","title":"Delete an ES index","text":"To delete an ES index index_name on local configuration, run the following command:
arlas_cli indices --config {local} delete {index_name} Warning
A deleted index cannot be restored.
Note
By default, it is not allowed to delete an index for a given configuration.
To allow deleting, edit the configuration file and set allow_delete to True.
Good practice: Set admin confs
For a given ARLAS deployment, it is advised to set two configurations, with only the admin one that can delete an index.
For example:
+----------------------+------------------------------------------+\n| name | url |\n+----------------------+------------------------------------------+\n| cloud.arlas.io | https://cloud.arlas.io/arlas/server |\n| cloud.arlas.io-admin | https://cloud.arlas.io/arlas/server |\n| local | http://localhost/arlas |\n+----------------------+------------------------------------------+\n
Here the configuration --config cloud.arlas.io-admin has to be used to delete any index.
"},{"location":"ingest_data/","title":"Ingest data","text":"The ARLAS CLI allows you to ingest data into ARLAS and make it accessible through ARLAS Dashboards.
Ingest Data in ARLAS
"},{"location":"ingest_data/#arlas-data-structure","title":"ARLAS Data structure","text":"To be explored in ARLAS dashboards, the data has to be indexed in an Elasticsearch (ES) index.
An index contains the data and a model (mapping) to describe how fields have to be interpreted (types).
ARLAS collections 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
"},{"location":"ingest_data/#ingest-with-arlas-cli","title":"Ingest with ARLAS CLI","text":"Once you have installed ARLAS CLI (see Installation Guide) and configured it with your ARLAS instance (see Configuration Guide), you can ingest data using the following commands:
-
Create an Index with a Mapping: Use arlas_cli indices 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 to populate the created index with your data.
-
Create a Collection: Use arlas_cli collections 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.
"},{"location":"install/","title":"Installation","text":""},{"location":"install/#prerequisites","title":"Prerequisites","text":""},{"location":"install/#install","title":"Install","text":""},{"location":"install/#install-arlas_cli","title":"Install arlas_cli","text":"Simply run in a terminal:
pip install arlas_cli Microsoft Windows
For Windows users, the installation has to be made in a python virtual environment, follow the venv guide before installing.
Success
In a new Terminal/Powershell, you should be able to run it:
arlas_cli --versionX.Y.Z
The version of arlas_cli is X.Y.Z where X is ARLAS Stack main version and Y.Z is the increment of arlas_cli version.
"},{"location":"install/#python-virtual-environment","title":"Python Virtual environment","text":"Particularly on Windows, it is advised to create a python virtual environment with venv before installing arlas_cli
WindowsLinux/Mac with cmd:
.\\env_arlas_cli\\Scripts\\Activate.bat\n
with PowerShell: .\\env_arlas_cli\\Scripts\\Activate.ps1\n
Tip
On Microsoft Windows, it may be required to enable the Activate.ps1 script by setting the execution policy for the user.
You can do this by issuing the following PowerShell command:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser\n
See venv documentation for more information. source env_arlas_cli/bin/activate (Can be added to .bashrc or .zshrc)\n
"},{"location":"install/#arlas","title":"ARLAS","text":"arlas_cli is meant to interact with a deployed ARLAS stack.
"},{"location":"install/#arlas-cloud","title":"ARLAS Cloud","text":"If you want to connect arlas_cli to an existing ARLAS Cloud account, simply follow the configuration guide.
"},{"location":"install/#run-arlas-locally","title":"Run ARLAS Locally","text":"To run the simplest ARLAS stack and Elasticsearch on the local machine, clone the ARLAS Stack Exploration project and run the stack:
git clone https://github.com/gisaia/ARLAS-Exploration-stack.gitcd ARLAS-Exploration-stack./start.sh More details about deployment can be found on ARLAS Stack Exploration project.
"},{"location":"persist/","title":"persist","text":""},{"location":"persist/#arlas-persistence","title":"ARLAS Persistence","text":"ARLAS Persistence allows you to place files within zones.
A zone is a group of files of the same nature (configurations, dashboard previews, bookmarks, ...)
A zone is visible by groups.
It is also possible to set who can access the file.
The main persistence zone is the config.json which contains the dashboard configurations.
An entry is an element stored in the persistence.
arlas_cli persist --help Usage: arlas_cli persist [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --config TEXT Name of the ARLAS configuration to use from your \u2502\u2502 configuration file \u2502\u2502 (/Users/gaudan/.arlas/cli/configuration.yaml). \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 add Add an entry, returns its ID \u2502\u2502 delete Delete an entry \u2502\u2502 describe Describe an entry \u2502\u2502 get Retrieve an entry \u2502\u2502 groups List groups allowed to access a zone \u2502\u2502 zone List entries within a zone \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"persist/#add","title":"add","text":"The persist add sub-command allows to create an entry from a file.
arlas_cli persist --config local add --help Usage: arlas_cli persist add [OPTIONS] FILE ZONE Add an entry, returns its ID \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * file TEXT File path [default: None] [required] \u2502\u2502 * zone TEXT zone [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --name TEXT name [default: none] \u2502\u2502 --reader TEXT Readers \u2502\u2502 --writer TEXT writers \u2502\u2502 --encode --no-encode Encode in BASE64 [default: no-encode] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#add-an-entry-from-a-file","title":"Add an entry from a file","text":"For example to create an ARLAS dashboard directly from a json file, run the following command to add the entry to the config.json zone:
arlas_cli persist \\ --config {local} \\ add {path/to/config.dashboard.json} config.json \\ --name {dashboard_name}32d2624b-d7cd-11ee-9a91-0242ac130004 The returned identifier is the entry unique identifier.
Note
The config.dashboard.json file has to contain all the dashboard configurations merged (config.json and config.map.json).
"},{"location":"persist/#zone","title":"zone","text":"The available entries in a zone can be listed with the persist zone sub-command:
arlas_cli persist --config local zone --help Usage: arlas_cli persist zone [OPTIONS] ZONE List entries within a zone \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * zone TEXT Zone name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#list-entries-within-a-zone","title":"List entries within a zone","text":"For example, to list all the available ARLAS dashboards (config.json zone), run the following command:
arlas_cli persist --config {local} zone config.json+--------------------------------------+-------------------+-------------+------------------+-----------+| id | name | zone | last_update_date | owner |+--------------------------------------+-------------------+-------------+------------------+-----------+| 66984014-d0a1-11ee-b41c-0242ac190004 | Courses | config.json | 1708510231303 | anonymous |...+--------------------------------------+-------------------+-------------+------------------+-----------+ The id is the unique identifier of the entry.
"},{"location":"persist/#describe","title":"describe","text":"An entry (defined by its unique identifier) can be described with the persist describe sub-command:
arlas_cli persist --config local describe --help Usage: arlas_cli persist describe [OPTIONS] ID Describe an entry \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * id TEXT entry identifier [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#describe-an-entry","title":"Describe an entry","text":"For example, a dashboard configuration can be described by its metadata with the following command:
arlas_cli persist --config {local} describe {99acb6b7-3cfd-11ef-aee2-2e6497b109c4}+------------------+--------------------------------------------+| metadata | value |+------------------+--------------------------------------------+| ID | 99acb6b7-3cfd-11ef-aee2-2e6497b109c4 || name | AIS Course || zone | config.json || last_update_date | 2024-10-21T18:02:59.456000 || owner | 6ce7f1f2-2ee3-4532-987d-26079c1b3043 || organization | gisaia.com || ispublic | False || updatable | True || readers | group/config.json/gisaia.com, group/public || writers | group/config.json/gisaia.com |+------------------+--------------------------------------------+ In the metadata, we can find which organisation own the dashboard and which groups can access the dashboard as readers and writers.
"},{"location":"persist/#get","title":"get","text":"The content of an entry can be accessed with the persist get sub-command:
arlas_cli persist --config local get --help Usage: arlas_cli persist get [OPTIONS] ID Retrieve an entry \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * id TEXT entry identifier [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#get-an-entry-value","title":"Get an entry value","text":"The content of the configuration file of an ARLAS dashboard can be read directly from its entry unique identifier:
arlas_cli persist --config {local} get {32d2624b-d7cd-11ee-9a91-0242ac130004}{ \"arlas\": { \"web\": { \"contributors\": [...}"},{"location":"persist/#groups","title":"groups","text":"The groups accessing a zone can be listed with the persist groups sub-command:
arlas_cli persist --config local groups --help Usage: arlas_cli persist groups [OPTIONS] ZONE List groups allowed to access a zone \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * zone TEXT Zone name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#list-groups-accessing-a-zone","title":"List groups accessing a zone","text":"For example, the groups accessing the dashboards config.json zone can be listed with the following command:
arlas_cli persist --config {local} groups config.json+-------------------------------+| group |+-------------------------------+| group/config.json/gisaia.com || group/public |+-------------------------------+"},{"location":"persist/#delete","title":"delete","text":"An entry defined by its unique identifier can be deleted with the persist delete sub-command:
arlas_cli persist --config local delete --help Usage: arlas_cli persist delete [OPTIONS] ID Delete an entry \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * id TEXT entry identifier [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#delete-an-entry","title":"Delete an entry","text":"For example, to delete a dashboard from its identifier, run the following command:
arlas_cli persist --config {local} delete {32d2624b-d7cd-11ee-9a91-0242ac130004}Resource 32d2624b-d7cd-11ee-9a91-0242ac130004 deleted. Warning
A deleted entry cannot be restored.
"},{"location":"started/","title":"Getting started with ARLAS CLI","text":""},{"location":"started/#install-arlas_cli","title":"Install arlas_cli","text":"To install arlas_cli, run the following command from the command line:
pip install arlas_cli\n
For more details, in particular for installation on Microsoft Windows, see the Installation Guide.
"},{"location":"started/#configuration","title":"Configuration","text":"Prerequisite
For running the various examples below, ARLAS and Elasticsearch must be running on the local machine:
Clone the ARLAS Stack Exploration project and run ./start.sh at project root.
Tip
If you want to connect arlas_cli to an existing ARLAS Cloud account, simply follow the configuration guide.
By default, the local configuration is created during the installation.
To list the available configurations, run the following command from the command line:
arlas_cli confs list+----------------------+------------------------------------------+| name | url |+----------------------+------------------------------------------+| local | http://localhost/arlas |+----------------------+------------------------------------------+ Success
At least the local configuration has to be here
It will be used in the tutorial as --config local
For more details, see the Configuration Guide.
"},{"location":"started/#tutorial","title":"Tutorial","text":"In the following tutorial, you will see how to:
- Generate an Elasticsearch mapping based on json objects
- Add the mapping in Elasticsearch
- List the Elasticsearch indices
- Add (index) data in the Elasticsearch index
- Get the structure of the mapping
- Add a collection in ARLAS
- List the ARLAS collections
- Get the structure of a ARLAS collection
- Delete a collection from ARLAS
- Delete a mapping from Elasticsearch
- Add, describe, get, list and delete an entry from ARLAS Persistence
- List, create, describe and delete a configuration for
arlas_cli
... with the arlas_cli command line only!
Prerequisite
First, let's get a sample data file:
curl -X GET https://raw.githubusercontent.com/gisaia/arlas-cli/master/tests/sample.json -o sample.json
The downloaded sample.json contains a sample of processed AIS data.
"},{"location":"started/#generate-the-elasticsearch-mapping","title":"Generate the Elasticsearch mapping","text":"Writing the elasticsearch mapping for an index can be laborious. arlas_cli does it for you. arlas_cli can inspect a NDJSON file (one json object per line) and generate the corresponding elasticsearch mapping file.
To generate the mapping file based on that sample, run the following command:
arlas_cli indices \\ --config local \\ mapping sample.json By inspecting the mapping, we notice that the three timestamps are not identified as datetime by arlas_cli.
--field-mapping
The --field-mapping option allows to overwrite the detected type.
To generate the mapping with forced types, run the following command:
arlas_cli indices \\ --config local \\ mapping sample.json \\ --field-mapping track.timestamps.center:date-epoch_second \\ --field-mapping track.timestamps.start:date-epoch_second \\ --field-mapping track.timestamps.end:date-epoch_second \\ --nb-lines 20 The three timestamps are now well identified as datetime.
For more details, see the Indices Mapping Guide.
"},{"location":"started/#create-an-empty-index-from-inferred-mapping","title":"Create an empty index from inferred mapping","text":"Once the inferred mapping is fine, an elasticsearch index based on this mapping has to be created.
--push-on
In the previous arlas_cli indices mapping command, the --push-on option registers the mapping in the specified index.
An empty index is created with the inferred mapping
To create the associated empty index ais_courses with the --push-on option, run the following command:
arlas_cli indices \\ --config local \\ mapping sample.json \\ --field-mapping track.timestamps.center:date-epoch_second \\ --field-mapping track.timestamps.start:date-epoch_second \\ --field-mapping track.timestamps.end:date-epoch_second \\ --push-on ais_courses For more details, see the Indices Mapping Guide.
"},{"location":"started/#inspect-the-created-indices","title":"Inspect the created indices","text":"To check that the index has been created, list the existing index:
arlas_cli indices --config local list+--------------+--------+-------+--------+| name | status | count | size |+--------------+--------+-------+--------+| .arlas | open | 4 | 11.9kb || ais_courses | open | 0 | 249b |+--------------+--------+-------+--------+ Success
The ais_courses index exists and contains 0 elements
To describe the fields of the index, use the arlas_cli indices describe command:
arlas_cli indices --config local describe ais_courses+----------------------------------------------------+-----------+| field name | type |+----------------------------------------------------+-----------+| arrival.address.country | keyword || arrival.address.port | keyword || arrival.location | geo_point |...| track.timestamps.start | date || track.trail | geo_shape || track.trail_geohashes_6 | geo_point || track.visibility.proportion | double |+----------------------------------------------------+-----------+ It corresponds to the inferred mapping.
"},{"location":"started/#add-data-to-index","title":"Add data to index","text":"To add data to the created ais_courses index, use the arlas_cli indices data command with the data file sample.json
arlas_cli indices --config local data ais_courses sample.json To check that data has been correctly indexed, inspect the indices with:
arlas_cli indices --config local list+--------------+--------+-------+--------+| name | status | count | size |+--------------+--------+-------+--------+| .arlas | open | 4 | 11.9kb || ais_courses | open | 100 | 1mb |+--------------+--------+-------+--------+ Success
The ais_courses index now contains 100 elements.
"},{"location":"started/#create-a-collection","title":"Create a collection","text":"To explore the data in ARLAS, a collection has to be defined on top of an index.
To create an ais_courses collection based on the ais_courses index, run the following command:
arlas_cli collections \\ --config local \\ create ais_courses \\ --index ais_courses \\ --display-name \"AIS Courses\" \\ --id-path track.id \\ --centroid-path track.location \\ --geometry-path track.trail \\ --date-path track.timestamps.center The --index option define the index to use and the --display-name define a pretty name used for collection in ARLAS.
Several elements define the data structure:
-
--id-path: The data field used as unique id of each element
-
--centroid-path: The data field containing a point geometry summarizing the location of each element (used for aggregation)
-
--geometry-path: The data field containing a geometry to represent the element (can be point, linestring, polygon)
-
--date-path: The data field containing the date associated to each element (used for timeline)
For more details, see the Collection Creation Guide.
"},{"location":"started/#inspect-the-created-collections","title":"Inspect the created collections","text":"To list the available collections, run the following command:
arlas_cli collections --config local list +-------------+-------------+| name | index |+-------------+-------------+| ais_courses | ais_courses |+-------------+-------------+ Success
The ais_courses collection is now created
To describe the fields of the collection, use the arlas_cli collections describe command:
arlas_cli collections --config local describe ais_courses+----------------------------------------------------+-----------+| field name | type |+----------------------------------------------------+-----------+| arrival.address.country | KEYWORD || arrival.address.port | KEYWORD || arrival.location | GEO_POINT || arrival.stop_after.duration_s | LONG |...| track.timestamps.start | DATE || track.trail | GEO_SHAPE || track.trail_geohashes_6 | GEO_POINT || track.visibility.proportion | FLOAT |+----------------------------------------------------+-----------+ It corresponds to the mapping of the data within the collection
"},{"location":"started/#delete-an-index","title":"Delete an index","text":"To remove the indexed data from the local Elasticsearch instance, remove the index with the following command:
arlas_cli indices --config local delete ais_courses Check that ais_courses index no longer exists:
arlas_cli indices --config local list+--------------+--------+-------+--------+| name | status | count | size |+--------------+--------+-------+--------+| .arlas | open | 4 | 11.9kb |+--------------+--------+-------+--------+ Tip
Before reindexing data, do not forget to recreate the empty index from inferred mapping
Collection does not need to be declared again.
"},{"location":"started/#delete-a-collection","title":"Delete a collection","text":"To delete the ais_courses course collection
arlas_cli collections --config local delete courses"},{"location":"started/#add-an-arlas-dashboard-from-configuration-file","title":"Add an ARLAS Dashboard from configuration file","text":"The configuration of an ARLAS Dashboard describes all its elements (widgets, map layers...). Such a file can be directly imported to create a dashboard.
First, let's get an example of a dashboard configuration file:
curl -X GET https://raw.githubusercontent.com/gisaia/arlas-cli/master/tests/dashboard.json -o dashboard.json The downloaded dashboard.json contains the configuration of a dashboard to explore AIS data.
arlas_cli persist --config local add ./dashboard.json config.json --name courses_dashboard32d2624b-d7cd-11ee-9a91-0242ac130004 Note
The dashboard generated unique identifier is returned
"},{"location":"started/#list-available-dashboards","title":"List available dashboards","text":"The available dashboards can be list with the following command:
arlas_cli persist --config local zone config.json+--------------------------------------+-------------------+-------------+------------------+-----------+| id | name | zone | last_update_date | owner |+--------------------------------------+-------------------+-------------+------------------+-----------+| 32d2624b-d7cd-11ee-9a91-0242ac130004 | courses_dashboard | config.json | 1708510231303 | anonymous |...+--------------------------------------+-------------------+-------------+------------------+-----------+ Note
The created dashboards can be accessed and managed in ARLAS Hub and edited with ARLAS Builder.
The arlas_cli commands to manage dashboards are detailed in Persistence Documentation.
"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"About arlas_cli","text":"ARLAS Command Line Interface (arlas_cli) is a tool to manage data and configurations in ARLAS.
arlas_cli is a Python command line for:
- Managing Elasticsearch indices:
- Generate an index mapping based on NDJSON data{:target=\"_blank\"}
- Create an index
- List indices
- Describe an index
- Clone an index
- Migrate an index
- Delete an index
- Managing ARLAS collections
- Create a collection
- List collections
- Describe a collection
- Delete a collection
- Managing arlas_cli configurations
- Register an ARLAS/Elasticsearch configuration, with headers and authentication parameters
- Login to your ARLAS Cloud account
- List your configurations
- Delete a configuration
- Managing ARLAS Dashboards in persistence
- Create a dashboard from a configuration file
- List available dashboard
- Describe a dashboard
- Delete a dashboard
- Get the groups accessing dashboards
- Managing ARLAS Identity and Access (ARLAS IAM)
- List organisations
- Add an organisation
- Within an organisation:
- List visible collections
- List groups
- List users
- List permissions
- Add/delete a permission
- Add/delete a group
- Add/delete a permission to/from a group
- Add/delete a user
- Add/delete a user to/from a group
- Create a user
- Activate a user
- Deactivate a user
Follow the Getting Started Guide to begin using ARLAS CLI.
"},{"location":"collections/","title":"collections","text":""},{"location":"collections/#arlas-collections","title":"ARLAS Collections","text":"ARLAS collections are built on top of elasticsearch (ES) index. They describe the basic data structure for its visualization and elements needed for the data access policy.
arlas_cli provide tools to manage the ARLAS collections with the collections command.
List collections management commands
arlas_cli collections --help Usage: arlas_cli collections [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --config TEXT Name of the ARLAS configuration to use from your \u2502\u2502 configuration file \u2502\u2502 (/Users/gaudan/.arlas/cli/configuration.yaml). \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 count Count the number of hits within a collection (or all collection \u2502\u2502 if not provided) \u2502\u2502 create Create a collection \u2502\u2502 delete Delete a collection \u2502\u2502 describe Describe a collection \u2502\u2502 list List collections \u2502\u2502 name Set the collection display name \u2502\u2502 private Set collection visibility to private \u2502\u2502 public Set collection visibility to public \u2502\u2502 sample Display a sample of a collection \u2502\u2502 set_alias Set the field display name \u2502\u2502 share Share the collection with the organisation \u2502\u2502 unshare Unshare the collection with the organisation \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"collections/#create","title":"create","text":"An ARLAS Collection is linked to an index or even an index pattern.
The command line options let you specify how the index should be used by the collection.
arlas_cli collections --config local create --help Usage: arlas_cli collections create [OPTIONS] COLLECTION Create a collection \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --model TEXT Name of the model within your \u2502\u2502 configuration, or URL or file path \u2502\u2502 [default: None] \u2502\u2502 --index TEXT Name of the index referenced by \u2502\u2502 the collection \u2502\u2502 [default: None] \u2502\u2502 --display-name TEXT Display name of the collection \u2502\u2502 [default: None] \u2502\u2502 --public --no-public Whether the collection is public \u2502\u2502 or not \u2502\u2502 [default: no-public] \u2502\u2502 --owner TEXT Organisation's owner \u2502\u2502 [default: None] \u2502\u2502 --orgs TEXT List of organisations accessing \u2502\u2502 the collection \u2502\u2502 --id-path TEXT Override the JSON path to the id \u2502\u2502 field. \u2502\u2502 [default: None] \u2502\u2502 --centroid-path TEXT Override the JSON path to the \u2502\u2502 centroid field. \u2502\u2502 [default: None] \u2502\u2502 --geometry-path TEXT Override the JSON path to the \u2502\u2502 geometry field. \u2502\u2502 [default: None] \u2502\u2502 --date-path TEXT Override the JSON path to the date \u2502\u2502 field. \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Collection visibility
The visibility options (--public, --private, --owner and --orgs) allow you to choose who can access the collection.
--owner
If ARLAS is used with ARLAS IAM (for example with ARLAS Cloud), then a collection must be associated to an organisation.
Example:
--owner your.organisation.com
By default, the organisation referenced in your config is used as owner.
"},{"location":"collections/#create-an-arlas-collection","title":"Create an ARLAS collection","text":"The collection has to reference an available ES index or index pattern with the arlas_cli configuration.
The index option sets the targeted index:--index index_name
Index pattern
The collection can target an index pattern. Instead of an index name, the target is an expression using * to reference multiple ES indices.
Example:
--index index_name_prefix*
All the indices have to share exactly the same data mapping.
The data contained in all referenced indices are then explorable together in ARLAS.
The collection also describe a basic structure for spatio-temporel datasets:
- ID path: A data field containing unique element identifier.
--id-path unique_id_field - Centroid path: A data field containing a point geometry used for aggregations
--centroid-path point_geom_field - Geometry path: A data field containing a geometry representing the element
--geometry-path element_geom_field - Date path: A data field containing the date associated to each element
--date-path date_field
Pretty name
A pretty name for the collection can be set at the creation with the display-name option
Example:
--display-name \"Pretty Collection Name\"
To create the collection, run the following command:
arlas_cli collections \\ --config {local} \\ create {collection_name} \\ --index {index_name} \\ --id-path {unique_id_field} \\ --centroid-path {point_geom_field} \\ --geometry-path {element_geom_field} \\ --date-path {date_field} \\ --display-name {\"Pretty Collection Name\"}"},{"location":"collections/#name","title":"name","text":"The collection can be defined by a pretty name. It can be set with name subcommand:
arlas_cli collections --config local name --help Usage: arlas_cli collections name [OPTIONS] COLLECTION NAME Set the collection display name \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2502 * name TEXT The display name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#set-a-pretty-name-for-the-collection","title":"Set a pretty name for the collection","text":"The pretty name can be used in ARLAS to display the collection. It can also be set by the --display-name option at the collection creation.
To set it with the name subcommand:
> arlas_cli collections \\\n --config {local} \\\n name {collection_name} {\"Pretty Collection Name\"}\n
"},{"location":"collections/#set_alias","title":"set_alias","text":"The data fields are sometimes not very suitable in ARLAS Exploration dashboards. You can set aliases to improve their display in the interface.
arlas_cli collections --config local set_alias --help Usage: arlas_cli collections set_alias [OPTIONS] COLLECTION FIELD_PATH [DISPLAY_NAME] Set the field display name \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] \u2502\u2502 [required] \u2502\u2502 * field_path TEXT The field path [default: None] \u2502\u2502 [required] \u2502\u2502 display_name [DISPLAY_NAME] The field's display name. If none \u2502\u2502 provided, then the alias is removed \u2502\u2502 if it existed \u2502\u2502 [default: None] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#set-a-pretty-name-for-a-data-field","title":"Set a pretty name for a data field","text":"Each field of the data has a raw name. It can be replaced by a pretty name to display. For example:
> arlas_cli collections \\\n --config {local} \\\n set_alias {collection_name} \\\n {raw_field_name} {\"Pretty Field Name (unit)\"}\n
"},{"location":"collections/#list","title":"list","text":""},{"location":"collections/#list-available-collections","title":"List available collections","text":"You can access the list of available collections with the list subcommand:
arlas_cli collections --config local set_alias --helpUsage: arlas_cli collections list [OPTIONS] List collectionsOptions: --help Show this message and exit."},{"location":"collections/#describe","title":"describe","text":""},{"location":"collections/#describe-a-collection","title":"Describe a collection","text":"The describe command line provides a description of the collection's structure (fields) and its metadata.
arlas_cli collections --config local describe --help Usage: arlas_cli collections describe [OPTIONS] COLLECTION Describe a collection \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#count","title":"count","text":""},{"location":"collections/#count-the-number-of-element-within-a-collection","title":"Count the number of element within a collection","text":"The count command show the total number of elements (data rows) accessible in a collection.
arlas_cli collections --config local count --help Usage: arlas_cli collections count [OPTIONS] [COLLECTION] Count the number of hits within a collection (or all collection if not provided) \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 collection [COLLECTION] Collection's name [default: None] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#sample","title":"sample","text":""},{"location":"collections/#display-a-sample-of-the-collection-data","title":"Display a sample of the collection data","text":"The sample command show few data rows accessible in a collection.
arlas_cli collections --config local sample --help Usage: arlas_cli collections sample [OPTIONS] COLLECTION Display a sample of a collection \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --pretty --no-pretty [default: pretty] \u2502\u2502 --size INTEGER [default: 10] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Note
The number of rows to display can be set with --size option
"},{"location":"collections/#private","title":"private","text":"By default, a collection is private, it can only be seen by the members of the owner or shared organisation.
In that case, an ARLAS user has to be logged and have the correct authorisations.
"},{"location":"collections/#set-the-collection-as-private","title":"Set the collection as private","text":"To switch a collection from public to private, use the private command:
arlas_cli collections --config local private --help Usage: arlas_cli collections private [OPTIONS] COLLECTION Set collection visibility to private \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#public","title":"public","text":"A public collection can be accessed in ARLAS dashboards without being logged. It can be used to host demo dashboards for example.
"},{"location":"collections/#set-the-collection-as-public","title":"Set the collection as public","text":"To switch a collection from private to public, use the public command:
arlas_cli collections --config local public --help Usage: arlas_cli collections public [OPTIONS] COLLECTION Set collection visibility to public \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#share","title":"share","text":"A collection can be shared between different organisations to make it available for its users.
"},{"location":"collections/#share-collections-between-organisations","title":"Share collections between organisations","text":"A collection can be shared to other organisation with the share command:
arlas_cli collections --config local share --help Usage: arlas_cli collections share [OPTIONS] COLLECTION ORGANISATION Share the collection with the organisation \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2502 * organisation TEXT Organisation's name [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#unshare","title":"unshare","text":"The right to access a collection can be removed to the users of an organisation.
"},{"location":"collections/#remove-collection-access-for-an-organisation","title":"Remove collection access for an organisation","text":"The access to a collection can be removed with the unshare command:
arlas_cli collections --config local unshare --help Usage: arlas_cli collections unshare [OPTIONS] COLLECTION ORGANISATION Unshare the collection with the organisation \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT Collection's name [default: None] [required] \u2502\u2502 * organisation TEXT Organisation's name [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"collections/#delete","title":"delete","text":"A collection can be deleted. It doesn't delete the data (ES index can still exist) but it will no longer be accessible in ARLAS.
"},{"location":"collections/#delete-a-collection","title":"Delete a collection","text":"The collection can be removed with the delete command:
arlas_cli collections --config local delete --help Usage: arlas_cli collections delete [OPTIONS] COLLECTION Delete a collection \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * collection TEXT collection's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"configuration/","title":"Configuration","text":"arlas_cli uses a yaml file for storing various ARLAS and elasticsearch configurations.
"},{"location":"configuration/#initial-configuration","title":"Initial configuration","text":"At its first launch, arlas_cli will create a first configuration file for you.
arlas_cli --versionX.X.XWarning : no configuration file found, we created an empty one for you (~/.arlas/cli/configuration.yaml). By default, the file is located in $HOME/.arlas/cli/configuration.yaml.
It contains one ARLAS configuration linked to a local deployment.
Warning
If you used the ARLAS Exploration Stack, it is possible that you already have a directory named $HOME/.arlas. This directory has been created by docker as root.
The owner of the directory must be changed to the local user (sudo chown ${USER}: $HOME/.arlas).
"},{"location":"configuration/#arlas-cloud-configuration","title":"ARLAS Cloud configuration","text":"If you have an ARLAS cloud account, you can directly create the configurations to access your space with arlas_cli login.
Provided by Gisa\u00efa
Gisa\u00efa provides the following variables for your account:
ORGANIZATION: The name of your organization.ELASTIC_ENDPOINT, ELASTIC_USER, ELASTIC_PWD: The elasticsearch credentials associated with your account.
Personal ARLAS account
You will also need the credentials for your personal ARLAS account:
ARLAS_USER: Your login, typically your email address.ARLAS_PWD: The password you created when setting up your account.
To create the cloud.arlas.io.{USER_NAME} configuration, replace the placeholder variables with your actual values and run the following command:
arlas_cli confs login ${ARLAS_USER} ${ELASTIC_USER} ${ELASTIC_ENDPOINT} --auth-password ${ARLAS_PWD} --auth-org ${MY_ORGANIZATION} --elastic-password ${ELASTIC_PWD} --allow-delete\n
Once the configuration is created, verify its existence by listing all configurations:
arlas_cli confs list\n
Default configuration
The configuration linked to your ARLAS Cloud account is automatically used as the default.
You do not need to specify the --config option when using arlas_cli.
For example, to list the available collections, use the following command:
arlas_cli collections list\n
"},{"location":"configuration/#configurations-file","title":"Configurations file","text":""},{"location":"configuration/#default-configurations-file","title":"Default configurations file","text":"By default, the command line uses the ${HOME}/.arlas/cli/configuration.yaml configuration file.
For example, the default configuration file with only the local configuration looks like:
arlas:\n local:\n allow_delete: true\n authorization: null\n elastic:\n location: http://localhost:9200\n ...\n persistence:\n location: http://localhost/persist\n ...\n server:\n location: http://localhost/arlas\n ...\n
The arlas section contains the different deployment configurations (here only local).
Each deployment configuration is defined by:
- authorization: The authentication system configuration
- elastic: The link to the elasticsearch cluster
- persistence: The link to ARLAS persistence
- server: The link to ARLAS server
You can interact with this configuration file directly with the command line itself with the arlas_cli confs commands:
- confs list: List the available configurations
- confs describe: Describe the content of a configuration
- confs create: Create a new configuration
- confs delete: Delete a configuration
- confs login: Create an ARLAS Cloud configuration (see ARLAS Cloud configuration)
"},{"location":"configuration/#custom-configuration-file-path","title":"Custom configuration file path","text":"It is possible to use a different configuration file than the one placed in your home directory ($HOME/.arlas/cli/configuration.yaml):
arlas_cli --config-file /tmp/config.yaml Warning : no configuration file found, we created a default one with a 'local' confs accessing local ARLAS exploration stack (/tmp/config.yaml). All the arlas_cli commands can then be run on this configuration file, for example to list the available confs:
arlas_cli --config-file /tmp/config.yaml confs list+-------+------------------------+| name | url |+-------+------------------------+| local | http://localhost/arlas |+-------+------------------------+"},{"location":"confs/","title":"Configurations","text":""},{"location":"confs/#arlas-configurations","title":"ARLAS configurations","text":"An ARLAS Configuration tells arlas_cli how to contact ARLAS Server and Elasticsearch.
See more information about configuration.
It is possible, with the arlas_cli confs command lines, to manage the ARLAS configurations.
List configurations (confs) management commands
arlas_cli confs --help Usage: arlas_cli confs [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 check Check the services of a configuration \u2502\u2502 create Add a configuration \u2502\u2502 default Display the default configuration \u2502\u2502 delete Delete a configuration \u2502\u2502 describe Describe a configuration \u2502\u2502 list List configurations \u2502\u2502 login Add a configuration for ARLAS Cloud \u2502\u2502 set Set default configuration among existing configurations \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"confs/#create","title":"create","text":"arlas_cli is meant to communicate with a deployed ARLAS. This link is configured by creating a new configuration.
arlas_cli confs create --help Usage: arlas_cli confs create [OPTIONS] NAME Add a configuration \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * name TEXT Name of the configuration [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * --server TEXT ARLAS Server url \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2502 --headers TEXT header (name:value) \u2502\u2502 --persistence TEXT ARLAS Persistence \u2502\u2502 url \u2502\u2502 [default: None] \u2502\u2502 --persistence-head\u2026 TEXT header (name:value) \u2502\u2502 --elastic TEXT elasticsearch url \u2502\u2502 [default: None] \u2502\u2502 --elastic-login TEXT elasticsearch login \u2502\u2502 [default: None] \u2502\u2502 --elastic-password TEXT elasticsearch \u2502\u2502 password \u2502\u2502 [default: None] \u2502\u2502 --elastic-headers TEXT header (name:value) \u2502\u2502 --allow-delete --no-allow-delete Is delete command \u2502\u2502 allowed for this \u2502\u2502 configuration? \u2502\u2502 [default: \u2502\u2502 no-allow-delete] \u2502\u2502 --auth-token-url TEXT Token URL of the \u2502\u2502 authentication \u2502\u2502 service \u2502\u2502 [default: None] \u2502\u2502 --auth-headers TEXT header (name:value) \u2502\u2502 --auth-org TEXT ARLAS IAM \u2502\u2502 Organization \u2502\u2502 [default: None] \u2502\u2502 --auth-login TEXT login \u2502\u2502 [default: None] \u2502\u2502 --auth-password TEXT password \u2502\u2502 [default: None] \u2502\u2502 --auth-client-id TEXT Client ID \u2502\u2502 [default: None] \u2502\u2502 --auth-client-secr\u2026 TEXT Client secret \u2502\u2502 [default: None] \u2502\u2502 --auth-grant-type TEXT Grant type (e.g. \u2502\u2502 password) \u2502\u2502 [default: None] \u2502\u2502 --auth-arlas-iam --no-auth-arlas-iam Is it an ARLAS IAM \u2502\u2502 service? \u2502\u2502 [default: \u2502\u2502 auth-arlas-iam] \u2502\u2502 --help Show this message \u2502\u2502 and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"confs/#create-a-new-configuration","title":"Create a new configuration","text":"The arlas_cli confs create command has to be filled with options specific to your ARLAS deployment.
Those options can be filled as described in the following sections.
"},{"location":"confs/#arlas-authentication","title":"ARLAS Authentication","text":"For ARLAS, keycloak and ARLAS IAM authentications are supported.
ARLAS IAMKeycloak To create a configuration using ARLAS IAM, the following parameters have to be set with your values:
- The IAM session url
IAM_URL - Your IAM user
ARLAS_USER - Your IAM password
ARLAS_PWD - Your ARLAS organization
ARLAS_ORGANIZATION
The following options are used by confs create sub-command to generate the conf:
--auth-arlas-iam\n--auth-token-url {IAM_URL}\n--auth-login {ARLAS_USER}\n--auth-password {ARLAS_PWD}\n--auth-headers \"Content-Type:application/json;charset=utf-8\"\n--auth-org {ARLAS_ORGANIZATION}\n
By default, the authentication is supposed to be with ARLAS IAM. For Keycloak, use --no-auth-arlas-iam
Keycloak authentication details coming soon...
"},{"location":"confs/#arlas-server-and-persistence","title":"ARLAS Server and Persistence","text":"The ARLAS server URL (ARLAS_SERVER_URL) and the ARLAS persistence server URL (ARLAS_PERSISTENCE_URL) have to be set in the configuration using the following options in the confs create sub-command:
--server {ARLAS_SERVER_URL}\n--headers \"Content-Type:application/json\"\n--persistence {ARLAS_PERSISTENCE_URL}\n--persistence-headers \"Content-Type:application/json\"\n
"},{"location":"confs/#elasticsearch","title":"Elasticsearch","text":"The used Elasticsearch instance and your credentials has to be set in the configuration:
ELASTIC_ENDPOINT: The used Elasticsearch endpoint (eg: http://localhost:9200)ELASTIC_USER: Your ES user nameELASTIC_PWD: Your ES user password
The link to the ES instance is configured by using the following options in the confs create sub-command:
--elastic {ELASTIC_ENDPOINT}\n--elastic-headers \"Content-Type:application/json\"\n--elastic-login {ELASTIC_USER}\n--elastic-password {ELASTIC_PWD}\n
"},{"location":"confs/#allow-data-deletion","title":"Allow data deletion","text":"By default, it is not possible to run the indices delete command on an elasticsearch with arlas_cli. This is to prevent accidental data loss.
--allow-delete
In order to allow to delete on a configuration, use the --allow-delete option.
"},{"location":"confs/#login","title":"login","text":""},{"location":"confs/#create-configuration-for-arlas-cloud","title":"Create configuration for ARLAS Cloud","text":"The confs longin allows to create a configuration linked to an ARLAS Cloud account:
arlas_cli confs login --help Usage: arlas_cli confs login [OPTIONS] AUTH_LOGIN ELASTIC_LOGIN ELASTIC Add a configuration for ARLAS Cloud \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * auth_login TEXT ARLAS login [default: None] [required] \u2502\u2502 * elastic_login TEXT Elasticsearch login [default: None] \u2502\u2502 [required] \u2502\u2502 * elastic TEXT Elasticsearch url [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --auth-org TEXT ARLAS IAM Organization, \u2502\u2502 default is your email \u2502\u2502 domain name \u2502\u2502 [default: None] \u2502\u2502 --allow-delete --no-allow-delete Is delete command allowed \u2502\u2502 for this configuration? \u2502\u2502 [default: allow-delete] \u2502\u2502 --auth-password TEXT ARLAS password \u2502\u2502 [default: None] \u2502\u2502 --elastic-password TEXT elasticsearch password \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and \u2502\u2502 exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Only your own ES and ARLAS credentials have to be set, the configuration is directly linked to the ARLAS Cloud instance.
It creates a configuration based on your username (extracted from your ARLAS login) : cloud.arlas.io.{USER_NAME}
Note
This created configuration is used as default.
You no longer need to declare the --config in the arlas_cli commands
See the ARLAS Cloud configuration guide.
"},{"location":"confs/#delete","title":"delete","text":""},{"location":"confs/#delete-an-existing-configuration","title":"Delete an existing configuration","text":"An existing configuration can be deleted with the confs delete sub command:
arlas_cli confs delete --help Usage: arlas_cli confs delete [OPTIONS] CONFIG Delete a configuration \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * config TEXT Name of the configuration [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ To remove an existing configuration from the default configuration file, simply run the following command:
arlas_cli confs delete {conf_name}\n
The configuration will no longer appear in the configuration file.
Warning
Once deleted, the configuration cannot be retrieved.
"},{"location":"confs/#describe","title":"describe","text":""},{"location":"confs/#describe-the-content-of-a-configuration","title":"Describe the content of a configuration","text":"The content of a configuration can be detailed with confs describe sub command:
arlas_cli confs describe --help Usage: arlas_cli confs describe [OPTIONS] CONFIG Describe a configuration \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * config TEXT Name of the configuration [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ For example, the default local configuration looks like:
arlas_cli confs describe localallow_delete: trueauthorization: nullelastic: headers: Content-Type: application/json location: http://localhost:9200 login: null password: nullpersistence: headers: Content-Type: application/json location: http://localhost/persist login: null password: nullserver: headers: Content-Type: application/json location: http://localhost/arlas login: null password: null We get the different elements of the configurations:
- authorization: The authentication system configuration
- elastic: The link to Elasticsearch cluster
- persistence: The link to ARLAS persistence
- server: The link to ARLAS server
See more about the configuration.
"},{"location":"confs/#list","title":"list","text":""},{"location":"confs/#list-the-available-configurations","title":"List the available configurations","text":"The list of available configurations can be obtained with confs list sub command:
arlas_cli confs list --help Usage: arlas_cli confs list [OPTIONS] List configurations \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ The confs list sub-command returns the list of available configuration names and their ARLAS server url.
For example:
arlas_cli confs list+-------+------------------------+| name | url |+-------+------------------------+| local | http://localhost/arlas |+-------+------------------------+"},{"location":"confs/#default","title":"default","text":""},{"location":"confs/#get-the-current-default-configuration","title":"Get the current default configuration","text":"The default arlas_cli configuration can be obtained with the confs default subcommand:
arlas_cli confs default --help Usage: arlas_cli confs default [OPTIONS] Display the default configuration \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Note
When a configuration is set as default, you do not need to specify --config option in arlas_cli commands.
To identify which configuration is currently set as the default, run:
arlas_cli confs default\n
"},{"location":"confs/#set","title":"set","text":""},{"location":"confs/#set-the-default-configuration","title":"Set the default configuration","text":"The default arlas_cli configuration can be set with the confs set subcommand:
arlas_cli confs set --help Usage: arlas_cli confs set [OPTIONS] NAME Set default configuration among existing configurations \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * name TEXT Name of the configuration to become default \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Note
When a configuration is set as default, you do not need to specify --config option in arlas_cli commands.
To set a configuration conf_name as the default, run:
arlas_cli confs set {conf_name}\n
"},{"location":"confs/#check","title":"check","text":""},{"location":"confs/#check-the-services-of-a-configuration","title":"Check the services of a configuration","text":"You can verify the services accessible through a specific configuration using the confs check subcommand:
arlas_cli confs check --help Usage: arlas_cli confs check [OPTIONS] NAME Check the services of a configuration \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * name TEXT Configuration to be checked [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ This command validates that the addresses and credentials defined in the configuration are correct and ensures successful access to the services.
The following services are validated:
- ARLAS Server
- ARLAS Persistence
- ARLAS IAM
- Elasticsearch
Success
Example:
arlas_cli confs check cloud.arlas.io.userARLAS Server: ... okARLAS Persistence: ... okARLAS IAM: ... okElasticsearch: ... ok
All services are up and running, and the configuration is correctly set up.
"},{"location":"help/","title":"Getting help","text":""},{"location":"help/#getting-help","title":"Getting help","text":"At any time, if you need some help on how to use the command line or one of its sub command, simply add --help.
Whether you are at the top level:
arlas_cli --help Usage: arlas_cli [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --config-file TEXT Path to the configuration file \u2502\u2502 if you do not want to use the \u2502\u2502 default one: \u2502\u2502 .arlas/cli/configuration.yaml. \u2502\u2502 [default: None] \u2502\u2502 --print-curl --no-print-curl Print curl command \u2502\u2502 [default: no-print-curl] \u2502\u2502 --version Print command line version \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 collections \u2502\u2502 confs \u2502\u2502 iam \u2502\u2502 indices \u2502\u2502 persist \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f or within a sub command:
arlas_cli indices --config local mapping --help Usage: arlas_cli indices mapping [OPTIONS] FILE Generate the mapping based on the data \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * file TEXT Path to the file containing the data. Format: NDJSON \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --nb-lines INTEGER Number of line to consider for generating \u2502\u2502 the mapping. Avoid going over 10. \u2502\u2502 [default: 2] \u2502\u2502 --field-mapping TEXT Override the mapping with the provided \u2502\u2502 field path/type. Example: \u2502\u2502 fragment.location:geo_point. Important: \u2502\u2502 the full field path must be provided. \u2502\u2502 --no-fulltext TEXT List of keyword or text fields that should \u2502\u2502 not be in the fulltext search. Important: \u2502\u2502 the field name only must be provided. \u2502\u2502 --no-index TEXT List of fields that should not be indexed. \u2502\u2502 --push-on TEXT Push the generated mapping for the \u2502\u2502 provided index name \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"iam/","title":"Identity & Access Management","text":""},{"location":"iam/#manage-organisations-users-permissions-and-groups","title":"Manage organisations, users, permissions and groups","text":"arlas_cli iam --config local orgs --help Usage: arlas_cli iam orgs [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 add Create organisation with the given name \u2502\u2502 add-apikey Add and return an new API Key with \u2502\u2502 permissions associated to provided groups. \u2502\u2502 Use the key id and key secret with the \u2502\u2502 arlas-api-key-id and arlas-api-key-secret \u2502\u2502 headers. \u2502\u2502 add_group Add a group to the organisation \u2502\u2502 add_permission Add a permission to the organisation \u2502\u2502 add_permission_to_group Add a permission to a group within the \u2502\u2502 organisation \u2502\u2502 add_user Add a user to the organisation, and \u2502\u2502 optionally within groups \u2502\u2502 add_user_to_group Add a user to a group within the \u2502\u2502 organisation \u2502\u2502 authorize Remove an organisation name from the \u2502\u2502 forbidden list. \u2502\u2502 check Check if user's organisation exists \u2502\u2502 collections List the collections of the organisation \u2502\u2502 delete Delete the organisation \u2502\u2502 delete-apikey Delete an API Key \u2502\u2502 delete_group Remove the group from the organisation \u2502\u2502 delete_permission Remove the permission from the organisation \u2502\u2502 delete_permission_from_group Remove a permission to a group within the \u2502\u2502 organisation \u2502\u2502 delete_user Remove the user from the organisation \u2502\u2502 delete_user_from_group Remove a user from a group within the \u2502\u2502 organisation \u2502\u2502 forbid Forbid an organisation name. \u2502\u2502 forbidden List forbidden organisations. \u2502\u2502 groups List the groups of the organisation \u2502\u2502 list List organisations \u2502\u2502 permissions List the permissions of the organisation \u2502\u2502 users List the users of the organisation \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"iam/#create-delete-activate-deactivate-users","title":"Create, delete, activate / deactivate users","text":"arlas_cli iam --config local users --help Usage: arlas_cli iam users [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 activate Activate user account \u2502\u2502 add Create user \u2502\u2502 deactivate Deactivate user account \u2502\u2502 delete Delete user \u2502\u2502 describe Describe user \u2502\u2502 reset-password Launch reset user's password process \u2502\u2502 update Update user \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"indices/","title":"Indices","text":""},{"location":"indices/#elasticsearch-index","title":"Elasticsearch index","text":"To be explored in ARLAS dashboards, the data has to be indexed in an Elasticsearch (ES) index. An index contains the data and a mapping to describe how fields have to be interpreted (types).
arlas_cli provide tools to infer mapping from data and manage the ES indices with the indices command.
List index management commands
arlas_cli indices --help Usage: arlas_cli indices [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --config TEXT Name of the ARLAS configuration to use from your \u2502\u2502 configuration file \u2502\u2502 (/Users/gaudan/.arlas/cli/configuration.yaml). \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 clone Clone an index and set its name \u2502\u2502 create Create an index \u2502\u2502 data Index data \u2502\u2502 delete Delete an index \u2502\u2502 describe Describe an index \u2502\u2502 list List indices \u2502\u2502 mapping Generate the mapping based on the data \u2502\u2502 migrate Migrate an index on another arlas configuration, and set the \u2502\u2502 target index name \u2502\u2502 sample Display a sample of an index \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"indices/#mapping","title":"mapping","text":"arlas_cli provide tools to infer the ES mapping directly from a data file.
arlas_cli indices --config local mapping --help Usage: arlas_cli indices mapping [OPTIONS] FILE Generate the mapping based on the data \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * file TEXT Path to the file containing the data. Format: NDJSON \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --nb-lines INTEGER Number of line to consider for generating \u2502\u2502 the mapping. Avoid going over 10. \u2502\u2502 [default: 2] \u2502\u2502 --field-mapping TEXT Override the mapping with the provided \u2502\u2502 field path/type. Example: \u2502\u2502 fragment.location:geo_point. Important: \u2502\u2502 the full field path must be provided. \u2502\u2502 --no-fulltext TEXT List of keyword or text fields that should \u2502\u2502 not be in the fulltext search. Important: \u2502\u2502 the field name only must be provided. \u2502\u2502 --no-index TEXT List of fields that should not be indexed. \u2502\u2502 --push-on TEXT Push the generated mapping for the \u2502\u2502 provided index name \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#data-file","title":"Data file","text":"To generate a mapping, you need to provide a NDJSON file (New line delimiter JSON).
The values of the first lines of the files are used to infer the mapping for each field of the data.
--nb_lines
The indices mapping function uses the first rows to infer mapping. If a field is not present in the first rows, it will not appear in the mapping.
Make sure to take enough rows to get all the fields with the option --nb_lines
"},{"location":"indices/#type-identification","title":"Type identification","text":"The mapping associates to each field of the data a type (see Elasticsearch type)
A geometry is identified as such if
- it is a geojson
- it is a WKT string
- the field name contains
geohash - it is a string containing two float separated by a comma
A date is identified as such if
- its name is one of
timestamp, date, start or end and that it can be parsed as a date - its name contains
timestamp, date, start or end and its values are number within [631152000, 4102444800] or [631152000000, 4102444800000] (year 1990 to 2100)
--field-mapping
If the mapping is wrong, you can overwrite the typing with the --field-mapping option.
It has the structure field_name:field_type (see Elasticsearch type)
Examples:
--field-mapping field_point:geo_point--field-mapping field_geometry:geo_shape--field-mapping field_short_text:keyword--field-mapping field_long_text:text--field-mapping field_float:double--field-mapping field_int:long
The date fields have a format that can be specified as field_name:date-format with all format accepted by Elasticsearch date type
Examples:
--field-mapping field_time_epoch_second:date-epoch_second--field-mapping field_time_epoch_millisecond:date-epoch_millis--field-mapping field_time_pattern:date-\"yyyy-MM-dd HH:mm:ss\"
By default, the keywords and text fields are searchable as fulltext to be accessible in the search bar.
--no-fulltext
If searching through a field value is not needed, it can be deactivated. That would result in better performances for the fulltext search.
Example:
--no-fulltext field_keyword
--no-index
If a field doesn't need to be explored in the dashboard, it should be removed before indexing the data.
Alternatively, you can explicitly exclude the field from being indexed using the --no-index option.
Example:
The field will remain in the data but will not be indexed.
"},{"location":"indices/#created-mapping","title":"Created mapping","text":"By default, the arlas_cli indices mapping directly returns the mapping in the command line.
Once you're happy with the mapping, you can either store it in a file or directly push it on elasticsearch.
Store mapping in a file
To store the created mapping in a mapping.json file, simply use > as the end of your command.
Example:
arlas_cli indices \\ --config {local} \\ mapping {path/to/data.json} \\ --field-mapping {timestamps.start:date-epoch_second} \\ --field-mapping {timestamps.end:date-epoch_second} \\ > {path/to/mapping.json}
--push-on
To push the inferred mapping directly in an Elasticsearch index, use the --push-on option with the target index name.
Example:
arlas_cli indices \\ --config {local} \\ mapping {path/to/data.json} \\ --push-on {index_name}
The index is then created and the index creation command can be skipped.
"},{"location":"indices/#create","title":"create","text":"Before putting the data in an elasticsearch index, the index has to be initialised with the correct mapping.
The indices create sub-function create the index from a mapping json file.
arlas_cli indices --config local create --help Usage: arlas_cli indices create [OPTIONS] INDEX Create an index \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * index TEXT index's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * --mapping TEXT Name of the mapping within your \u2502\u2502 configuration, or URL or file path \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2502 --shards INTEGER Number of shards for the index [default: 1] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#create-an-es-index-with-its-mapping","title":"Create an ES index with its mapping","text":"The index name and the path to the mapping json file have to be used to create the ES index.
Warning
If the ARLAS deployment uses ARLAS IAM for authentication, the index must be associated with an organisation.
The index_name must follow the pattern {organisation}@{data_index_name} (e.g., gisaia.com@ais_courses).
The indices create sub-function create the index from a mapping json file.
Example:
arlas_cli indices \\ --config local \\ create {index_name} \\ --mapping {path/to/mapping.json} Once the index is created, Elasticsearch can index data to fill that index.
"},{"location":"indices/#data","title":"data","text":"To explore data in ARLAS, it has to be indexed in the created ES index.
The indices data sub-function ingest the data in a given index.
arlas_cli indices --config local data --help Usage: arlas_cli indices data [OPTIONS] INDEX FILES... Index data \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * index TEXT index's name [default: None] [required] \u2502\u2502 * files FILES... List of paths to the file(s) containing the \u2502\u2502 data. Format: NDJSON \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --bulk INTEGER Bulk size for indexing data [default: 5000] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#ingest-data","title":"Ingest data","text":"To index data, you'll need to provide one or several NDJSON (New line delimiter JSON) file(s). Indexing uses bulks for optimal performances.
Example:
arlas_cli indices \\ --config {local} \\ data {index_name} {path/to/data.json} Tip
The data can be split in different NDJSON files in a folder:
part-00000-[...].json\npart-00001-[...].json\n...\n
In practice, the files argument can be filed with a pattern such as path/to/data.json/part-0000*.json to reference all the different files. Warning
If the index already contains data, the data is added to the index.
To reindex the same data, delete the index, and do not forget to recreate it with the correct mapping before ingesting the data.
--bulk
Indexing uses bulks for optimal performances.
The size of bulk can be changed with the --bulk option
"},{"location":"indices/#list","title":"list","text":"To list the available ES indices, simply use the indices list sub-function. No arguments are required.
arlas_cli indices --config local list --help Usage: arlas_cli indices list [OPTIONS] List indices \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#list-available-es-indices","title":"List available ES indices","text":"It displays for each ES index its status, the number of elements it contains and the size of the index.
Example:
> arlas_cli indices --config {local} list\n+--------------+--------+-------+--------+\n| name | status | count | size |\n+--------------+--------+-------+--------+\n| .arlas | open | 4 | 11.9kb |\n| index_name | open | 100 | 1mb |\n+--------------+--------+-------+--------+\n
"},{"location":"indices/#describe","title":"describe","text":"Once the index is created, the description of the fields it contains (corresponding to the mapping) can be displayed with the indices describe sub function:
arlas_cli indices --config local data --help Usage: arlas_cli indices data [OPTIONS] INDEX FILES... Index data \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * index TEXT index's name [default: None] [required] \u2502\u2502 * files FILES... List of paths to the file(s) containing the \u2502\u2502 data. Format: NDJSON \u2502\u2502 [default: None] \u2502\u2502 [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --bulk INTEGER Bulk size for indexing data [default: 5000] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#describe-the-index-mapping","title":"Describe the index mapping","text":"For a given index, the description of its fields and their type can be displayed.
For example:
> arlas_cli indices --config {local} describe {index_name}\n+------------------+-----------+\n| field name | type |\n+------------------+-----------+\n| field_keyword | keyword |\n| field_point | geo_point |\n| field_long | long |\n| field_shape | geo_shape |\n| field_double | double |\n| field_date | date |\n| field_text | text |\n| field_object | object |\n| field_boolean | boolean |\n+------------------+-----------+\n
"},{"location":"indices/#sample","title":"sample","text":"The first rows of the data contained in an index can be displayed with the indices sample sub function.
arlas_cli indices --config local delete --help Usage: arlas_cli indices delete [OPTIONS] INDEX Delete an index \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * index TEXT index's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#visualize-few-rows-of-your-dataset","title":"Visualize few rows of your dataset","text":"For a given index index_name, the first rows of data can be displayed as a valid json dictionary.
--size
The number of rows to display (default 100) can be changed
Example:
> arlas_cli indices --config {local} sample {index_name} --size {10}\n
By default, the json representation of the data is pretty printed (clear indentation and one line per field)
--no-pretty
The pretty printing can be deactivated and data is displayed in a compact way
Example:
> arlas_cli indices --config {local} sample {index_name} --no-pretty\n
"},{"location":"indices/#clone","title":"clone","text":""},{"location":"indices/#duplicate-an-index-with-a-new-index-name","title":"Duplicate an index with a new index name","text":"An ES index can be cloned on the same ES deployment with the indices clone sub-command:
arlas_cli indices --config local clone --help Usage: arlas_cli indices clone [OPTIONS] SOURCE TARGET Clone an index and set its name \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * source TEXT Source index name [default: None] [required] \u2502\u2502 * target TEXT Target cloned index name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Both indices co-exist with exactly the same mapping and data content.
"},{"location":"indices/#migrate","title":"migrate","text":""},{"location":"indices/#copy-an-index-in-another-arlas-configuration","title":"Copy an index in another arlas configuration","text":"An index can be copied from an ES instance to another.
Note
The two instances have to be accessible by arlas_cli with two configurations (see Configuration guide).
The target configuration and the name of the new created index are given to the indices migrate sub-command.
arlas_cli indices --config local clone --help Usage: arlas_cli indices clone [OPTIONS] SOURCE TARGET Clone an index and set its name \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * source TEXT Source index name [default: None] [required] \u2502\u2502 * target TEXT Target cloned index name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ Both indices co-exist with exactly the same mapping and data content.
"},{"location":"indices/#delete","title":"delete","text":"The ES index can be deleted with indices delete sub command to free space on the ES cluster.
arlas_cli indices --config local delete --help Usage: arlas_cli indices delete [OPTIONS] INDEX Delete an index \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * index TEXT index's name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"indices/#delete-an-es-index","title":"Delete an ES index","text":"To delete an ES index index_name on local configuration, run the following command:
arlas_cli indices --config {local} delete {index_name} Warning
A deleted index cannot be restored.
Note
By default, it is not allowed to delete an index for a given configuration.
To allow deleting, edit the configuration file and set allow_delete to True.
Good practice: Set admin confs
For a given ARLAS deployment, it is advised to set two configurations, with only the admin one that can delete an index.
For example:
+----------------------+------------------------------------------+\n| name | url |\n+----------------------+------------------------------------------+\n| cloud.arlas.io | https://cloud.arlas.io/arlas/server |\n| cloud.arlas.io-admin | https://cloud.arlas.io/arlas/server |\n| local | http://localhost/arlas |\n+----------------------+------------------------------------------+\n
Here the configuration --config cloud.arlas.io-admin has to be used to delete any index.
"},{"location":"ingest_data/","title":"Ingest data","text":"The ARLAS CLI allows you to ingest data into ARLAS and make it accessible through ARLAS Dashboards.
Ingest Data in ARLAS
"},{"location":"ingest_data/#arlas-data-structure","title":"ARLAS Data structure","text":"To be explored in ARLAS dashboards, the data has to be indexed in an Elasticsearch (ES) index.
An index contains the data and a model (mapping) to describe how fields have to be interpreted (types).
ARLAS collections 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
"},{"location":"ingest_data/#ingest-with-arlas-cli","title":"Ingest with ARLAS CLI","text":"Once you have installed ARLAS CLI (see Installation Guide) and configured it with your ARLAS instance (see Configuration Guide), you can ingest data using the following commands:
-
Create an Index with a Mapping: Use arlas_cli indices 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 to populate the created index with your data.
-
Create a Collection: Use arlas_cli collections 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.
"},{"location":"install/","title":"Installation","text":""},{"location":"install/#prerequisites","title":"Prerequisites","text":""},{"location":"install/#install","title":"Install","text":""},{"location":"install/#install-arlas_cli","title":"Install arlas_cli","text":"Simply run in a terminal:
pip install arlas_cli Microsoft Windows
For Windows users, the installation has to be made in a python virtual environment, follow the venv guide before installing.
Success
In a new Terminal/Powershell, you should be able to run it:
arlas_cli --versionX.Y.Z
The version of arlas_cli is X.Y.Z where X is ARLAS Stack main version and Y.Z is the increment of arlas_cli version.
"},{"location":"install/#python-virtual-environment","title":"Python Virtual environment","text":"Particularly on Windows, it is advised to create a python virtual environment with venv before installing arlas_cli
WindowsLinux/Mac with cmd:
.\\env_arlas_cli\\Scripts\\Activate.bat\n
with PowerShell: .\\env_arlas_cli\\Scripts\\Activate.ps1\n
Tip
On Microsoft Windows, it may be required to enable the Activate.ps1 script by setting the execution policy for the user.
You can do this by issuing the following PowerShell command:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser\n
See venv documentation for more information. source env_arlas_cli/bin/activate (Can be added to .bashrc or .zshrc)\n
"},{"location":"install/#arlas","title":"ARLAS","text":"arlas_cli is meant to interact with a deployed ARLAS stack.
"},{"location":"install/#arlas-cloud","title":"ARLAS Cloud","text":"If you want to connect arlas_cli to an existing ARLAS Cloud account, simply follow the configuration guide.
"},{"location":"install/#run-arlas-locally","title":"Run ARLAS Locally","text":"To run the simplest ARLAS stack and Elasticsearch on the local machine, clone the ARLAS Stack Exploration project and run the stack:
git clone https://github.com/gisaia/ARLAS-Exploration-stack.gitcd ARLAS-Exploration-stack./start.sh More details about deployment can be found on ARLAS Stack Exploration project.
"},{"location":"persist/","title":"persist","text":""},{"location":"persist/#arlas-persistence","title":"ARLAS Persistence","text":"ARLAS Persistence allows you to place files within zones.
A zone is a group of files of the same nature (configurations, dashboard previews, bookmarks, ...)
A zone is visible by groups.
It is also possible to set who can access the file.
The main persistence zone is the config.json which contains the dashboard configurations.
An entry is an element stored in the persistence.
arlas_cli persist --help Usage: arlas_cli persist [OPTIONS] COMMAND [ARGS]... \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --config TEXT Name of the ARLAS configuration to use from your \u2502\u2502 configuration file \u2502\u2502 (/Users/gaudan/.arlas/cli/configuration.yaml). \u2502\u2502 [default: None] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 add Add an entry, returns its ID \u2502\u2502 delete Delete an entry \u2502\u2502 describe Describe an entry \u2502\u2502 get Retrieve an entry \u2502\u2502 groups List groups allowed to access a zone \u2502\u2502 zone List entries within a zone \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f"},{"location":"persist/#add","title":"add","text":"The persist add sub-command allows to create an entry from a file.
arlas_cli persist --config local add --help Usage: arlas_cli persist add [OPTIONS] FILE ZONE Add an entry, returns its ID \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * file TEXT File path [default: None] [required] \u2502\u2502 * zone TEXT zone [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --name TEXT name [default: none] \u2502\u2502 --reader TEXT Readers \u2502\u2502 --writer TEXT writers \u2502\u2502 --encode --no-encode Encode in BASE64 [default: no-encode] \u2502\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#add-an-entry-from-a-file","title":"Add an entry from a file","text":"For example to create an ARLAS dashboard directly from a json file, run the following command to add the entry to the config.json zone:
arlas_cli persist \\ --config {local} \\ add {path/to/config.dashboard.json} config.json \\ --name {dashboard_name}32d2624b-d7cd-11ee-9a91-0242ac130004 The returned identifier is the entry unique identifier.
Note
The config.dashboard.json file has to contain all the dashboard configurations merged (config.json and config.map.json).
"},{"location":"persist/#zone","title":"zone","text":"The available entries in a zone can be listed with the persist zone sub-command:
arlas_cli persist --config local zone --help Usage: arlas_cli persist zone [OPTIONS] ZONE List entries within a zone \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * zone TEXT Zone name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#list-entries-within-a-zone","title":"List entries within a zone","text":"For example, to list all the available ARLAS dashboards (config.json zone), run the following command:
arlas_cli persist --config {local} zone config.json+--------------------------------------+-------------------+-------------+------------------+-----------+| id | name | zone | last_update_date | owner |+--------------------------------------+-------------------+-------------+------------------+-----------+| 66984014-d0a1-11ee-b41c-0242ac190004 | Courses | config.json | 1708510231303 | anonymous |...+--------------------------------------+-------------------+-------------+------------------+-----------+ The id is the unique identifier of the entry.
"},{"location":"persist/#describe","title":"describe","text":"An entry (defined by its unique identifier) can be described with the persist describe sub-command:
arlas_cli persist --config local describe --help Usage: arlas_cli persist describe [OPTIONS] ID Describe an entry \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * id TEXT entry identifier [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#describe-an-entry","title":"Describe an entry","text":"For example, a dashboard configuration can be described by its metadata with the following command:
arlas_cli persist --config {local} describe {99acb6b7-3cfd-11ef-aee2-2e6497b109c4}+------------------+--------------------------------------------+| metadata | value |+------------------+--------------------------------------------+| ID | 99acb6b7-3cfd-11ef-aee2-2e6497b109c4 || name | AIS Course || zone | config.json || last_update_date | 2024-10-21T18:02:59.456000 || owner | 6ce7f1f2-2ee3-4532-987d-26079c1b3043 || organization | gisaia.com || ispublic | False || updatable | True || readers | group/config.json/gisaia.com, group/public || writers | group/config.json/gisaia.com |+------------------+--------------------------------------------+ In the metadata, we can find which organisation own the dashboard and which groups can access the dashboard as readers and writers.
"},{"location":"persist/#get","title":"get","text":"The content of an entry can be accessed with the persist get sub-command:
arlas_cli persist --config local get --help Usage: arlas_cli persist get [OPTIONS] ID Retrieve an entry \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * id TEXT entry identifier [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#get-an-entry-value","title":"Get an entry value","text":"The content of the configuration file of an ARLAS dashboard can be read directly from its entry unique identifier:
arlas_cli persist --config {local} get {32d2624b-d7cd-11ee-9a91-0242ac130004}{ \"arlas\": { \"web\": { \"contributors\": [...}"},{"location":"persist/#groups","title":"groups","text":"The groups accessing a zone can be listed with the persist groups sub-command:
arlas_cli persist --config local groups --help Usage: arlas_cli persist groups [OPTIONS] ZONE List groups allowed to access a zone \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * zone TEXT Zone name [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#list-groups-accessing-a-zone","title":"List groups accessing a zone","text":"For example, the groups accessing the dashboards config.json zone can be listed with the following command:
arlas_cli persist --config {local} groups config.json+-------------------------------+| group |+-------------------------------+| group/config.json/gisaia.com || group/public |+-------------------------------+"},{"location":"persist/#delete","title":"delete","text":"An entry defined by its unique identifier can be deleted with the persist delete sub-command:
arlas_cli persist --config local delete --help Usage: arlas_cli persist delete [OPTIONS] ID Delete an entry \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 * id TEXT entry identifier [default: None] [required] \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\u2502 --help Show this message and exit. \u2502\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/"},{"location":"persist/#delete-an-entry","title":"Delete an entry","text":"For example, to delete a dashboard from its identifier, run the following command:
arlas_cli persist --config {local} delete {32d2624b-d7cd-11ee-9a91-0242ac130004}Resource 32d2624b-d7cd-11ee-9a91-0242ac130004 deleted. Warning
A deleted entry cannot be restored.
"},{"location":"started/","title":"Getting started with ARLAS CLI","text":""},{"location":"started/#install-arlas_cli","title":"Install arlas_cli","text":"To install arlas_cli, run the following command from the command line:
pip install arlas_cli\n
For more details, in particular for installation on Microsoft Windows, see the Installation Guide.
"},{"location":"started/#configuration","title":"Configuration","text":"Prerequisite
For running the various examples below, ARLAS and Elasticsearch must be running on the local machine:
Clone the ARLAS Stack Exploration project and run ./start.sh at project root.
Tip
If you want to connect arlas_cli to an existing ARLAS Cloud account, simply follow the configuration guide.
By default, the local configuration is created during the installation.
To list the available configurations, run the following command from the command line:
arlas_cli confs list+----------------------+------------------------------------------+| name | url |+----------------------+------------------------------------------+| local | http://localhost/arlas |+----------------------+------------------------------------------+ Success
At least the local configuration has to be here
It will be used in the tutorial as --config local
For more details, see the Configuration Guide.
"},{"location":"started/#tutorial","title":"Tutorial","text":"In the following tutorial, you will see how to:
- Generate an Elasticsearch mapping based on json objects
- Add the mapping in Elasticsearch
- List the Elasticsearch indices
- Add (index) data in the Elasticsearch index
- Get the structure of the mapping
- Add a collection in ARLAS
- List the ARLAS collections
- Get the structure of a ARLAS collection
- Delete a collection from ARLAS
- Delete a mapping from Elasticsearch
- Add, describe, get, list and delete an entry from ARLAS Persistence
- List, create, describe and delete a configuration for
arlas_cli
... with the arlas_cli command line only!
Prerequisite
First, let's get a sample data file:
curl -X GET https://raw.githubusercontent.com/gisaia/arlas-cli/master/tests/sample.json -o sample.json
The downloaded sample.json contains a sample of processed AIS data.
"},{"location":"started/#generate-the-elasticsearch-mapping","title":"Generate the Elasticsearch mapping","text":"Writing the elasticsearch mapping for an index can be laborious. arlas_cli does it for you. arlas_cli can inspect a NDJSON file (one json object per line) and generate the corresponding elasticsearch mapping file.
To generate the mapping file based on that sample, run the following command:
arlas_cli indices \\ --config local \\ mapping sample.json By inspecting the mapping, we notice that the three timestamps are not identified as datetime by arlas_cli.
--field-mapping
The --field-mapping option allows to overwrite the detected type.
To generate the mapping with forced types, run the following command:
arlas_cli indices \\ --config local \\ mapping sample.json \\ --field-mapping track.timestamps.center:date-epoch_second \\ --field-mapping track.timestamps.start:date-epoch_second \\ --field-mapping track.timestamps.end:date-epoch_second \\ --nb-lines 20 The three timestamps are now well identified as datetime.
For more details, see the Indices Mapping Guide.
"},{"location":"started/#create-an-empty-index-from-inferred-mapping","title":"Create an empty index from inferred mapping","text":"Once the inferred mapping is fine, an elasticsearch index based on this mapping has to be created.
--push-on
In the previous arlas_cli indices mapping command, the --push-on option registers the mapping in the specified index.
An empty index is created with the inferred mapping
To create the associated empty index ais_courses with the --push-on option, run the following command:
arlas_cli indices \\ --config local \\ mapping sample.json \\ --field-mapping track.timestamps.center:date-epoch_second \\ --field-mapping track.timestamps.start:date-epoch_second \\ --field-mapping track.timestamps.end:date-epoch_second \\ --push-on ais_courses For more details, see the Indices Mapping Guide.
"},{"location":"started/#inspect-the-created-indices","title":"Inspect the created indices","text":"To check that the index has been created, list the existing index:
arlas_cli indices --config local list+--------------+--------+-------+--------+| name | status | count | size |+--------------+--------+-------+--------+| .arlas | open | 4 | 11.9kb || ais_courses | open | 0 | 249b |+--------------+--------+-------+--------+ Success
The ais_courses index exists and contains 0 elements
To describe the fields of the index, use the arlas_cli indices describe command:
arlas_cli indices --config local describe ais_courses+----------------------------------------------------+-----------+| field name | type |+----------------------------------------------------+-----------+| arrival.address.country | keyword || arrival.address.port | keyword || arrival.location | geo_point |...| track.timestamps.start | date || track.trail | geo_shape || track.trail_geohashes_6 | geo_point || track.visibility.proportion | double |+----------------------------------------------------+-----------+ It corresponds to the inferred mapping.
"},{"location":"started/#add-data-to-index","title":"Add data to index","text":"To add data to the created ais_courses index, use the arlas_cli indices data command with the data file sample.json
arlas_cli indices --config local data ais_courses sample.json To check that data has been correctly indexed, inspect the indices with:
arlas_cli indices --config local list+--------------+--------+-------+--------+| name | status | count | size |+--------------+--------+-------+--------+| .arlas | open | 4 | 11.9kb || ais_courses | open | 100 | 1mb |+--------------+--------+-------+--------+ Success
The ais_courses index now contains 100 elements.
"},{"location":"started/#create-a-collection","title":"Create a collection","text":"To explore the data in ARLAS, a collection has to be defined on top of an index.
To create an ais_courses collection based on the ais_courses index, run the following command:
arlas_cli collections \\ --config local \\ create ais_courses \\ --index ais_courses \\ --display-name \"AIS Courses\" \\ --id-path track.id \\ --centroid-path track.location \\ --geometry-path track.trail \\ --date-path track.timestamps.center The --index option define the index to use and the --display-name define a pretty name used for collection in ARLAS.
Several elements define the data structure:
-
--id-path: The data field used as unique id of each element
-
--centroid-path: The data field containing a point geometry summarizing the location of each element (used for aggregation)
-
--geometry-path: The data field containing a geometry to represent the element (can be point, linestring, polygon)
-
--date-path: The data field containing the date associated to each element (used for timeline)
For more details, see the Collection Creation Guide.
"},{"location":"started/#inspect-the-created-collections","title":"Inspect the created collections","text":"To list the available collections, run the following command:
arlas_cli collections --config local list +-------------+-------------+| name | index |+-------------+-------------+| ais_courses | ais_courses |+-------------+-------------+ Success
The ais_courses collection is now created
To describe the fields of the collection, use the arlas_cli collections describe command:
arlas_cli collections --config local describe ais_courses+----------------------------------------------------+-----------+| field name | type |+----------------------------------------------------+-----------+| arrival.address.country | KEYWORD || arrival.address.port | KEYWORD || arrival.location | GEO_POINT || arrival.stop_after.duration_s | LONG |...| track.timestamps.start | DATE || track.trail | GEO_SHAPE || track.trail_geohashes_6 | GEO_POINT || track.visibility.proportion | FLOAT |+----------------------------------------------------+-----------+ It corresponds to the mapping of the data within the collection
"},{"location":"started/#delete-an-index","title":"Delete an index","text":"To remove the indexed data from the local Elasticsearch instance, remove the index with the following command:
arlas_cli indices --config local delete ais_courses Check that ais_courses index no longer exists:
arlas_cli indices --config local list+--------------+--------+-------+--------+| name | status | count | size |+--------------+--------+-------+--------+| .arlas | open | 4 | 11.9kb |+--------------+--------+-------+--------+ Tip
Before reindexing data, do not forget to recreate the empty index from inferred mapping
Collection does not need to be declared again.
"},{"location":"started/#delete-a-collection","title":"Delete a collection","text":"To delete the ais_courses course collection
arlas_cli collections --config local delete courses"},{"location":"started/#add-an-arlas-dashboard-from-configuration-file","title":"Add an ARLAS Dashboard from configuration file","text":"The configuration of an ARLAS Dashboard describes all its elements (widgets, map layers...). Such a file can be directly imported to create a dashboard.
First, let's get an example of a dashboard configuration file:
curl -X GET https://raw.githubusercontent.com/gisaia/arlas-cli/master/tests/dashboard.json -o dashboard.json The downloaded dashboard.json contains the configuration of a dashboard to explore AIS data.
arlas_cli persist --config local add ./dashboard.json config.json --name courses_dashboard32d2624b-d7cd-11ee-9a91-0242ac130004 Note
The dashboard generated unique identifier is returned
"},{"location":"started/#list-available-dashboards","title":"List available dashboards","text":"The available dashboards can be list with the following command:
arlas_cli persist --config local zone config.json+--------------------------------------+-------------------+-------------+------------------+-----------+| id | name | zone | last_update_date | owner |+--------------------------------------+-------------------+-------------+------------------+-----------+| 32d2624b-d7cd-11ee-9a91-0242ac130004 | courses_dashboard | config.json | 1708510231303 | anonymous |...+--------------------------------------+-------------------+-------------+------------------+-----------+ Note
The created dashboards can be accessed and managed in ARLAS Hub and edited with ARLAS Builder.
The arlas_cli commands to manage dashboards are detailed in Persistence Documentation.
"}]}
\ No newline at end of file
diff --git a/docs/site/sitemap.xml b/docs/site/sitemap.xml
index 086f12e..737ff64 100644
--- a/docs/site/sitemap.xml
+++ b/docs/site/sitemap.xml
@@ -2,57 +2,57 @@
https://gisaia.github.io/arlas_cli/
- 2025-01-31
+ 2025-02-20
daily
https://gisaia.github.io/arlas_cli/collections/
- 2025-01-31
+ 2025-02-20
daily
https://gisaia.github.io/arlas_cli/configuration/
- 2025-01-31
+ 2025-02-20
daily
https://gisaia.github.io/arlas_cli/confs/
- 2025-01-31
+ 2025-02-20
daily
https://gisaia.github.io/arlas_cli/help/
- 2025-01-31
+ 2025-02-20
daily
https://gisaia.github.io/arlas_cli/iam/
- 2025-01-31
+ 2025-02-20
daily
https://gisaia.github.io/arlas_cli/indices/
- 2025-01-31
+ 2025-02-20
daily
https://gisaia.github.io/arlas_cli/ingest_data/
- 2025-01-31
+ 2025-02-20
daily
https://gisaia.github.io/arlas_cli/install/
- 2025-01-31
+ 2025-02-20
daily
https://gisaia.github.io/arlas_cli/persist/
- 2025-01-31
+ 2025-02-20
daily
https://gisaia.github.io/arlas_cli/started/
- 2025-01-31
+ 2025-02-20
daily
\ No newline at end of file
diff --git a/docs/site/sitemap.xml.gz b/docs/site/sitemap.xml.gz
index 9390782..a9580d6 100644
Binary files a/docs/site/sitemap.xml.gz and b/docs/site/sitemap.xml.gz differ
diff --git a/version.txt b/version.txt
index cdda43f..ce0a05a 100644
--- a/version.txt
+++ b/version.txt
@@ -1 +1 @@
-26.3.5
+26.3.7