Skip to content

Configuration

arlas_cli uses a yaml file for storing various ARLAS and elasticsearch configurations.

Initial configuration

At its first launch, arlas_cli will create a first configuration file for you.

> arlas_cli --version
X.X.X
Warning : 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).

Configurations file

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:
  local:
    allow_delete: true
    authorization: null
    elastic:
      location: http://localhost:9200
      ...
    persistence:
      location: http://localhost/persist
      ...
    server:
      location: http://localhost/arlas
      ...

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:

Custom configuration file path

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 |
+-------+------------------------+

ARLAS Cloud configuration

If you have an ARLAS cloud account, you can directly create the configurations to access your space with arlas_cli login.

First, set the environment variables provided by Gisaïa and change appropriately SET_THIS_VALUE with your own ARLAS user login/password:

export MY_ORGANIZATION=<SET_THIS_VALUE>
export ARLAS_USER=<SET_THIS_VALUE>
export ARLAS_PWD=<SET_THIS_VALUE>
export ELASTIC_ENDPOINT=<SET_THIS_VALUE>
export ELASTIC_USER=<SET_THIS_VALUE>
export ELASTIC_PWD=<SET_THIS_VALUE>

Then run the command arlas_cli confs create with all the parameters to create the cloud.arlas.io.{USER_NAME} configuration:

arlas_cli confs \
    login ${ARLAS_USER} ${ELASTIC_USER} ${ELASTIC_ENDPOINT} \
    --auth-password "${ARLAS_PWD}" \
    --auth-org "${MY_ORGANIZATION}" \
    --elastic-password "${ELASTIC_PWD}" \
    --allow-delete

$env:MY_ORGANIZATION = "<SET_THIS_VALUE>"
$env:ARLAS_USER = "<SET_THIS_VALUE>"
$env:ARLAS_PWD = "<SET_THIS_VALUE>"
$env:ELASTIC_ENDPOINT = "<SET_THIS_VALUE>"
$env:ELASTIC_USER = "<SET_THIS_VALUE>"
$env:ELASTIC_PWD = "<SET_THIS_VALUE>"

Then run the command arlas_cli confs create with all the parameters to create the cloud.arlas.io.{USER_NAME} configuration:

arlas_cli confs `
    login $env:ARLAS_USER $env:ELASTIC_USER $env:ELASTIC_ENDPOINT `
    --auth-password "$env:ARLAS_PWD" `
    --auth-org "$env:MY_ORGANIZATION" `
    --elastic-password "$env:ELASTIC_PWD" `
    --allow-delete

Check that the configuration exist:

arlas_cli confs list

You can now, for example, list the available collections:

arlas_cli collections list