diff --git a/404.html b/404.html index 0028a4e..d576c9f 100644 --- a/404.html +++ b/404.html @@ -423,6 +423,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/arlas_cloud/index.html b/arlas_cloud/index.html new file mode 100644 index 0000000..bd5bd32 --- /dev/null +++ b/arlas_cloud/index.html @@ -0,0 +1,585 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Configuring ARLAS Cloud - ARLAS Command Line (arlas_cli) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Configuring ARLAS Cloud

    + +

    To configure arlas_cli for your cloud.arlas.io account:

    +

    First, set the following environment variables by changing appropriately SET_THIS_VALUE: +

    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
+

    +
    arlas_cli confs \ + create cloud.arlas.io \ + --server "https://cloud.arlas.io/arlas/server" \ + --headers "arlas-org-filter:${MY_ORGANIZATION}" \ + --headers "Content-Type:application/json" \ + --no-allow-delete \ + --auth-token-url https://cloud.arlas.io/arlas/iam/session \ + --auth-login "${ARLAS_USER}" \ + --auth-password "${ARLAS_PWD}" \ + --auth-headers "Content-Type:application/json;charset=utf-8" \ + --auth-org "${MY_ORGANIZATION}" \ + --elastic "${ELASTIC_ENDPOINT}" \ + --elastic-headers "Content-Type:application/json" \ + --elastic-login "${ELASTIC_USER}" \ + --elastic-password "${ELASTIC_PWD}" \ + --elastic-headers "Content-Type:application/json" \ + --auth-headers "Content-Type:application/json;charset=utf-8" \ + --persistence "https://cloud.arlas.io/arlas/persistence" \ + --persistence-headers "Content-Type:application/json" \ + --auth-arlas-iam
    + +

    Check the configuration exists:

    +
    arlas_cli confs list
    + +

    You can now try the configuration:

    +
    arlas_cli collections --config cloud.arlas.io list
    + +
    arlas_cli indices --config cloud.arlas.io list
    + +
    arlas_cli persist --config cloud.arlas.io groups config.json
    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/collections/index.html b/collections/index.html index fdea33d..db6c8c1 100644 --- a/collections/index.html +++ b/collections/index.html @@ -499,6 +499,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/collections_1/index.html b/collections_1/index.html index 1d08fbe..eccf118 100644 --- a/collections_1/index.html +++ b/collections_1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/collections_2/index.html b/collections_2/index.html index 4282896..541260b 100644 --- a/collections_2/index.html +++ b/collections_2/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/collections_3/index.html b/collections_3/index.html index 814ac9a..3777769 100644 --- a/collections_3/index.html +++ b/collections_3/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/collections_4/index.html b/collections_4/index.html index b503956..10df65f 100644 --- a/collections_4/index.html +++ b/collections_4/index.html @@ -425,6 +425,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/confs/index.html b/confs/index.html index 7525218..122a880 100644 --- a/confs/index.html +++ b/confs/index.html @@ -490,6 +490,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + @@ -573,7 +593,7 @@

    Create a configuration

    Danger

    By default, it is not possible to run the delete command on an elasticsearch with arlas_cli. This is to prevent accidental data loass. In order to allow delete on a configuration, use the --allow-delete option.

    -
    arlas_cli confs create --helpUsage: python -m arlas.cli.cli confs create [OPTIONS] NAME

    Add a configuration

    Arguments:
    NAME Name of the configuration [required]

    Options:
    --server TEXT ARLAS Server url [required]
    --persistence TEXT ARLAS Persistence url
    --headers TEXT header (name:value)
    --elastic TEXT dictionary of name/es resources
    --elastic-login TEXT elasticsearch login
    --elastic-password TEXT elasticsearch password
    --elastic-headers TEXT header (name:value)
    --allow-delete / --no-allow-delete
    Is delete command allowed for this
    configuration? [default: no-allow-delete]
    --auth-token-url TEXT Token URL of the authentication service
    --auth-headers TEXT header (name:value)
    --auth-login TEXT login
    --auth-password TEXT password
    --auth-client-id TEXT Client ID
    --auth-client-secret TEXT Client secret
    --auth-grant-type TEXT Grant type (e.g. password)
    --auth-arlas-iam / --no-auth-arlas-iam
    Is it an ARLAS IAM service? [default: auth-
    arlas-iam]
    --help Show this message and exit.
    +
    arlas_cli confs create --helpUsage: python -m arlas.cli.cli confs create [OPTIONS] NAME

    Add a configuration

    Arguments:
    NAME Name of the configuration [required]

    Options:
    --server TEXT ARLAS Server url [required]
    --headers TEXT header (name:value)
    --persistence TEXT ARLAS Persistence url
    --persistence-headers TEXT header (name:value)
    --elastic TEXT dictionary of name/es resources
    --elastic-login TEXT elasticsearch login
    --elastic-password TEXT elasticsearch password
    --elastic-headers TEXT header (name:value)
    --allow-delete / --no-allow-delete
    Is delete command allowed for this
    configuration? [default: no-allow-delete]
    --auth-token-url TEXT Token URL of the authentication service
    --auth-headers TEXT header (name:value)
    --auth-org TEXT ARLAS IAM Organization
    --auth-login TEXT login
    --auth-password TEXT password
    --auth-client-id TEXT Client ID
    --auth-client-secret TEXT Client secret
    --auth-grant-type TEXT Grant type (e.g. password)
    --auth-arlas-iam / --no-auth-arlas-iam
    Is it an ARLAS IAM service? [default: auth-
    arlas-iam]
    --help Show this message and exit.
    diff --git a/confs_1/index.html b/confs_1/index.html index c99b5e0..c748c58 100644 --- a/confs_1/index.html +++ b/confs_1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/confs_2/index.html b/confs_2/index.html index 19fc4ba..d5a924c 100644 --- a/confs_2/index.html +++ b/confs_2/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/confs_3/index.html b/confs_3/index.html index e9ca113..3a66f55 100644 --- a/confs_3/index.html +++ b/confs_3/index.html @@ -425,6 +425,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/help/index.html b/help/index.html index 41a8722..881b5bd 100644 --- a/help/index.html +++ b/help/index.html @@ -481,6 +481,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/index.html b/index.html index a6471e1..6563345 100644 --- a/index.html +++ b/index.html @@ -444,6 +444,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/indices/index.html b/indices/index.html index 4e35988..1f3c228 100644 --- a/indices/index.html +++ b/indices/index.html @@ -508,6 +508,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + @@ -590,10 +610,10 @@

    List index management commands

    Generate mapping from a data file

    To generate a mapping, you need to provide a NDJSON file (New line delimiter JSON). The first N lines are used for infering the mapping. If the mapping is wrong, you can overwrite the typing with the --field-mapping option. Once you're happy with the mapping, you can directly push it on elasticsearch (--push-on).

    -
    arlas_cli indices --config local mapping --helpUsage: python -m arlas.cli.cli indices mapping [OPTIONS] FILE

    Generate the mapping based on the data

    Arguments:
    FILE Path to the file conaining the data. Format: NDJSON [required]

    Options:
    --nb-lines INTEGER Number of line to consider for generating the mapping.
    Avoid going over 10. [default: 2]
    --field-mapping TEXT Overide the mapping with the provided field/type.
    Example: fragment.location:geo_point
    --push-on TEXT Push the generated mapping for the provided index name
    --help Show this message and exit.
    +
    arlas_cli indices --config local mapping --helpUsage: python -m arlas.cli.cli indices mapping [OPTIONS] FILE

    Generate the mapping based on the data

    Arguments:
    FILE Path to the file conaining the data. Format: NDJSON [required]

    Options:
    --nb-lines INTEGER Number of line to consider for generating the mapping.
    Avoid going over 10. [default: 2]
    --field-mapping TEXT Overide the mapping with the provided field path/type.
    Example: fragment.location:geo_point. Important: the
    full field path must be provided.
    --no-fulltext TEXT List of keyword or text fields that should not be in
    the fulltext search. Important: the field name only
    must be provided.
    --push-on TEXT Push the generated mapping for the provided index name
    --help Show this message and exit.

    Create an index with its mapping

    -
    arlas_cli indices --config local create --helpUsage: python -m arlas.cli.cli indices create [OPTIONS] INDEX [ADD_UUID]

    Create an index

    Arguments:
    INDEX index's name [required]
    [ADD_UUID] Set a UUID for the provided json path field

    Options:
    --mapping TEXT Name of the mapping within your configuration, or URL or
    file path [required]
    --shards INTEGER Number of shards for the index [default: 1]
    --help Show this message and exit.
    +
    arlas_cli indices --config local create --helpUsage: python -m arlas.cli.cli indices create [OPTIONS] INDEX

    Create an index

    Arguments:
    INDEX index's name [required]

    Options:
    --mapping TEXT Name of the mapping within your configuration, or URL or
    file path [required]
    --shards INTEGER Number of shards for the index [default: 1]
    --help Show this message and exit.

    Index data

    For indexing data, you'll need to provide one ore several NDJSON file(s). Indexing uses bulks for optimal performances.

    diff --git a/indices_1/index.html b/indices_1/index.html index 94779b1..3bcf0bd 100644 --- a/indices_1/index.html +++ b/indices_1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/indices_2/index.html b/indices_2/index.html index 1e6b0e5..cf7915f 100644 --- a/indices_2/index.html +++ b/indices_2/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/indices_3/index.html b/indices_3/index.html index 5d5ecfd..68c7cff 100644 --- a/indices_3/index.html +++ b/indices_3/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/indices_4/index.html b/indices_4/index.html index 81b0240..fc9d358 100644 --- a/indices_4/index.html +++ b/indices_4/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/indices_5/index.html b/indices_5/index.html index 5a3bdf3..69a99bd 100644 --- a/indices_5/index.html +++ b/indices_5/index.html @@ -425,6 +425,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/install/index.html b/install/index.html index a8edbca..f7ae2ce 100644 --- a/install/index.html +++ b/install/index.html @@ -488,6 +488,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + @@ -549,16 +569,16 @@

    Installation

    Prerequisite

    +

    If you manage your own ARLAS stack, you will also need: +- ARLAS

    Install

    pip install arlas_cli

    In a new terminal, you should be able to run it:

    -
    arlas_cli --version0.2.8
    +
    arlas_cli --versionX.X.X
    diff --git a/model/index.html b/model/index.html index 998f359..9393a48 100644 --- a/model/index.html +++ b/model/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-arlas-iam-url-anyof-1/index.html b/model/model-defs-arlas-properties-arlas-iam-url-anyof-1/index.html index 7031053..ec762ef 100644 --- a/model/model-defs-arlas-properties-arlas-iam-url-anyof-1/index.html +++ b/model/model-defs-arlas-properties-arlas-iam-url-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-arlas-iam-url/index.html b/model/model-defs-arlas-properties-arlas-iam-url/index.html index c053e88..420912a 100644 --- a/model/model-defs-arlas-properties-arlas-iam-url/index.html +++ b/model/model-defs-arlas-properties-arlas-iam-url/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-arlas-persistence-server-anyof-1/index.html b/model/model-defs-arlas-properties-arlas-persistence-server-anyof-1/index.html index 2608a57..cad0864 100644 --- a/model/model-defs-arlas-properties-arlas-persistence-server-anyof-1/index.html +++ b/model/model-defs-arlas-properties-arlas-persistence-server-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-arlas-persistence-server/index.html b/model/model-defs-arlas-properties-arlas-persistence-server/index.html index ca1cbde..7527386 100644 --- a/model/model-defs-arlas-properties-arlas-persistence-server/index.html +++ b/model/model-defs-arlas-properties-arlas-persistence-server/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-arlas-server/index.html b/model/model-defs-arlas-properties-arlas-server/index.html index c99f346..a980094 100644 --- a/model/model-defs-arlas-properties-arlas-server/index.html +++ b/model/model-defs-arlas-properties-arlas-server/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-dictionary-of-namees-resources-anyof-1/index.html b/model/model-defs-arlas-properties-dictionary-of-namees-resources-anyof-1/index.html index 2741413..a096ace 100644 --- a/model/model-defs-arlas-properties-dictionary-of-namees-resources-anyof-1/index.html +++ b/model/model-defs-arlas-properties-dictionary-of-namees-resources-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-dictionary-of-namees-resources/index.html b/model/model-defs-arlas-properties-dictionary-of-namees-resources/index.html index c4c4199..834007a 100644 --- a/model/model-defs-arlas-properties-dictionary-of-namees-resources/index.html +++ b/model/model-defs-arlas-properties-dictionary-of-namees-resources/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-0/index.html b/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-0/index.html index c0cfb43..cc866ad 100644 --- a/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-0/index.html +++ b/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-0/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-1/index.html b/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-1/index.html index d917052..3fb66e2 100644 --- a/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-1/index.html +++ b/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration/index.html b/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration/index.html index 1056d4e..8a433f9 100644 --- a/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration/index.html +++ b/model/model-defs-arlas-properties-is-delete-command-allowed-for-this-configuration/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-keycloak-url-anyof-1/index.html b/model/model-defs-arlas-properties-keycloak-url-anyof-1/index.html index c6a4bb5..19783e2 100644 --- a/model/model-defs-arlas-properties-keycloak-url-anyof-1/index.html +++ b/model/model-defs-arlas-properties-keycloak-url-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas-properties-keycloak-url/index.html b/model/model-defs-arlas-properties-keycloak-url/index.html index 02583ab..f486db8 100644 --- a/model/model-defs-arlas-properties-keycloak-url/index.html +++ b/model/model-defs-arlas-properties-keycloak-url/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-arlas/index.html b/model/model-defs-arlas/index.html index ab0cff4..57cf9c8 100644 --- a/model/model-defs-arlas/index.html +++ b/model/model-defs-arlas/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-client-id-anyof-0/index.html b/model/model-defs-authorizationservice-properties-client-id-anyof-0/index.html index 8afada1..321eedc 100644 --- a/model/model-defs-authorizationservice-properties-client-id-anyof-0/index.html +++ b/model/model-defs-authorizationservice-properties-client-id-anyof-0/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-client-id-anyof-1/index.html b/model/model-defs-authorizationservice-properties-client-id-anyof-1/index.html index 721dcf8..c1de8e6 100644 --- a/model/model-defs-authorizationservice-properties-client-id-anyof-1/index.html +++ b/model/model-defs-authorizationservice-properties-client-id-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-client-id/index.html b/model/model-defs-authorizationservice-properties-client-id/index.html index 4be0422..adb35a9 100644 --- a/model/model-defs-authorizationservice-properties-client-id/index.html +++ b/model/model-defs-authorizationservice-properties-client-id/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-client-secret-anyof-0/index.html b/model/model-defs-authorizationservice-properties-client-secret-anyof-0/index.html index 437c98e..106addf 100644 --- a/model/model-defs-authorizationservice-properties-client-secret-anyof-0/index.html +++ b/model/model-defs-authorizationservice-properties-client-secret-anyof-0/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-client-secret-anyof-1/index.html b/model/model-defs-authorizationservice-properties-client-secret-anyof-1/index.html index 1b36443..7bf5919 100644 --- a/model/model-defs-authorizationservice-properties-client-secret-anyof-1/index.html +++ b/model/model-defs-authorizationservice-properties-client-secret-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-client-secret/index.html b/model/model-defs-authorizationservice-properties-client-secret/index.html index c28bd52..e7f26f3 100644 --- a/model/model-defs-authorizationservice-properties-client-secret/index.html +++ b/model/model-defs-authorizationservice-properties-client-secret/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-0/index.html b/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-0/index.html index d87dd82..b84ac72 100644 --- a/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-0/index.html +++ b/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-0/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-1/index.html b/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-1/index.html index 8512ab3..1e6a4bf 100644 --- a/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-1/index.html +++ b/model/model-defs-authorizationservice-properties-grant-type-eg-password-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-grant-type-eg-password/index.html b/model/model-defs-authorizationservice-properties-grant-type-eg-password/index.html index 43c5223..0b0eae3 100644 --- a/model/model-defs-authorizationservice-properties-grant-type-eg-password/index.html +++ b/model/model-defs-authorizationservice-properties-grant-type-eg-password/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-0/index.html b/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-0/index.html index d9e6071..a3c2923 100644 --- a/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-0/index.html +++ b/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-0/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-1/index.html b/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-1/index.html index 8e706ad..336ff25 100644 --- a/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-1/index.html +++ b/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service/index.html b/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service/index.html index 51cadcb..f0ebc33 100644 --- a/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service/index.html +++ b/model/model-defs-authorizationservice-properties-is-it-an-arlas-iam-service/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-login/index.html b/model/model-defs-authorizationservice-properties-login/index.html index b8b660d..a0ab5cf 100644 --- a/model/model-defs-authorizationservice-properties-login/index.html +++ b/model/model-defs-authorizationservice-properties-login/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-password/index.html b/model/model-defs-authorizationservice-properties-password/index.html index 0abab03..e80bff4 100644 --- a/model/model-defs-authorizationservice-properties-password/index.html +++ b/model/model-defs-authorizationservice-properties-password/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice-properties-token-url-of-the-authentication-service/index.html b/model/model-defs-authorizationservice-properties-token-url-of-the-authentication-service/index.html index 2dc1779..8684735 100644 --- a/model/model-defs-authorizationservice-properties-token-url-of-the-authentication-service/index.html +++ b/model/model-defs-authorizationservice-properties-token-url-of-the-authentication-service/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-authorizationservice/index.html b/model/model-defs-authorizationservice/index.html index 898c96c..ba125b7 100644 --- a/model/model-defs-authorizationservice/index.html +++ b/model/model-defs-authorizationservice/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + @@ -531,20 +551,6 @@

    AuthorizationService Properties

    Settings -login -string -Optional -cannot be null -Settings - - -password -string -Optional -cannot be null -Settings - - client_id Merged Optional @@ -596,42 +602,6 @@

    token_url Type

    -

    login

    -

    login

    - -

    login Type

    -

    string (login)

    -

    password

    -

    password

    - -

    password Type

    -

    string (password)

    client_id

    client_id

    diff --git a/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0-additionalproperties/index.html b/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0-additionalproperties/index.html index ab2c270..d5b51b7 100644 --- a/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0-additionalproperties/index.html +++ b/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0-additionalproperties/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0/index.html b/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0/index.html index 06c8268..d88ce9e 100644 --- a/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0/index.html +++ b/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-0/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-1/index.html b/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-1/index.html index a13eb2a..a0f60d9 100644 --- a/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-1/index.html +++ b/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-default/index.html b/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-default/index.html new file mode 100644 index 0000000..cc6b3f6 --- /dev/null +++ b/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests-default/index.html @@ -0,0 +1,589 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Untitled undefined type in Settings Schema - ARLAS Command Line (arlas_cli) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Untitled undefined type in Settings Schema

    +
    airs_model#/$defs/Resource/properties/headers/default
+
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
    Can be instantiatedNoUnknown statusUnknown identifiabilityForbiddenAllowednonemodel.schema.json*
    +

    default Type

    +

    unknown

    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests/index.html b/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests/index.html index c34bab6..e50d0a4 100644 --- a/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests/index.html +++ b/model/model-defs-resource-properties-list-of-headers-if-needed-for-https-requests/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + @@ -463,6 +483,15 @@ + + +
  • + + + headers Default Value + + +
    • @@ -520,6 +549,10 @@

    headers Type

    Untitled null in Settings

    +

    headers Default Value

    +

    The default value is:

    +
    {}
+
    diff --git a/model/model-defs-resource-properties-pasword-anyof-0/index.html b/model/model-defs-resource-properties-pasword-anyof-0/index.html index 1a7e9dd..3a22d54 100644 --- a/model/model-defs-resource-properties-pasword-anyof-0/index.html +++ b/model/model-defs-resource-properties-pasword-anyof-0/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-resource-properties-pasword-anyof-1/index.html b/model/model-defs-resource-properties-pasword-anyof-1/index.html index 70521e0..e303d2f 100644 --- a/model/model-defs-resource-properties-pasword-anyof-1/index.html +++ b/model/model-defs-resource-properties-pasword-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-resource-properties-pasword/index.html b/model/model-defs-resource-properties-pasword/index.html index 627ed97..e76348c 100644 --- a/model/model-defs-resource-properties-pasword/index.html +++ b/model/model-defs-resource-properties-pasword/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-resource-properties-user-anyof-0/index.html b/model/model-defs-resource-properties-user-anyof-0/index.html index f9a41c5..b2d7f7f 100644 --- a/model/model-defs-resource-properties-user-anyof-0/index.html +++ b/model/model-defs-resource-properties-user-anyof-0/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-resource-properties-user-anyof-1/index.html b/model/model-defs-resource-properties-user-anyof-1/index.html index 0d9ff61..d982876 100644 --- a/model/model-defs-resource-properties-user-anyof-1/index.html +++ b/model/model-defs-resource-properties-user-anyof-1/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-resource-properties-user/index.html b/model/model-defs-resource-properties-user/index.html index 04ef112..c8ed22b 100644 --- a/model/model-defs-resource-properties-user/index.html +++ b/model/model-defs-resource-properties-user/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-defs-resource/index.html b/model/model-defs-resource/index.html index a72528c..c7bbf6d 100644 --- a/model/model-defs-resource/index.html +++ b/model/model-defs-resource/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + @@ -598,6 +618,10 @@

    headers Type

    Untitled null in Settings

    +

    headers Default Value

    +

    The default value is:

    +
    {}
+

    login

    login

    diff --git a/model/model-properties-dictionary-of-namearlas-configurations/index.html b/model/model-properties-dictionary-of-namearlas-configurations/index.html index 8790d69..49aa0a2 100644 --- a/model/model-properties-dictionary-of-namearlas-configurations/index.html +++ b/model/model-properties-dictionary-of-namearlas-configurations/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-properties-dictionary-of-namemapping-resources/index.html b/model/model-properties-dictionary-of-namemapping-resources/index.html index ba921d5..5f0b119 100644 --- a/model/model-properties-dictionary-of-namemapping-resources/index.html +++ b/model/model-properties-dictionary-of-namemapping-resources/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model-properties-dictionary-of-namemodel-resources/index.html b/model/model-properties-dictionary-of-namemodel-resources/index.html index fec6b02..906c639 100644 --- a/model/model-properties-dictionary-of-namemodel-resources/index.html +++ b/model/model-properties-dictionary-of-namemodel-resources/index.html @@ -430,6 +430,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + diff --git a/model/model.schema.json b/model/model.schema.json index 3e79297..9ea950b 100644 --- a/model/model.schema.json +++ b/model/model.schema.json @@ -1 +1 @@ -{"$defs": {"ARLAS": {"properties": {"persistence": {"anyOf": [{"$ref": "#/$defs/Resource"}, {"type": "null"}], "default": null, "title": "ARLAS Persistence Server"}, "server": {"allOf": [{"$ref": "#/$defs/Resource"}], "title": "ARLAS Server"}, "authorization": {"anyOf": [{"$ref": "#/$defs/AuthorizationService"}, {"type": "null"}], "default": null, "title": "Keycloak URL"}, "elastic": {"anyOf": [{"$ref": "#/$defs/Resource"}, {"type": "null"}], "default": null, "title": "dictionary of name/es resources"}, "allow_delete": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "title": "Is delete command allowed for this configuration?"}}, "required": ["server"], "title": "ARLAS", "type": "object"}, "AuthorizationService": {"properties": {"token_url": {"allOf": [{"$ref": "#/$defs/Resource"}], "default": null, "title": "Token URL of the authentication service"}, "login": {"default": null, "title": "login", "type": "string"}, "password": {"default": null, "title": "password", "type": "string"}, "client_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": null, "title": "Client ID"}, "client_secret": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": null, "title": "Client secret"}, "grant_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": null, "title": "Grant type (e.g. password)"}, "arlas_iam": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": true, "title": "Is it an ARLAS IAM service?"}}, "title": "AuthorizationService", "type": "object"}, "Resource": {"properties": {"location": {"default": null, "title": "file or http location", "type": "string"}, "headers": {"anyOf": [{"additionalProperties": {"type": "string"}, "type": "object"}, {"type": "null"}], "default": null, "title": "List of headers, if needed, for http(s) requests"}, "login": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": null, "title": "user"}, "password": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": null, "title": "pasword"}}, "title": "Resource", "type": "object"}}, "properties": {"arlas": {"additionalProperties": {"$ref": "#/$defs/ARLAS"}, "default": null, "title": "dictionary of name/arlas configurations", "type": "object"}, "mappings": {"additionalProperties": {"$ref": "#/$defs/Resource"}, "default": null, "title": "dictionary of name/mapping resources", "type": "object"}, "models": {"additionalProperties": {"$ref": "#/$defs/Resource"}, "default": null, "title": "dictionary of name/model resources", "type": "object"}}, "title": "Settings", "type": "object", "$id": "airs_model"} +{"$defs": {"ARLAS": {"properties": {"persistence": {"anyOf": [{"$ref": "#/$defs/Resource"}, {"type": "null"}], "default": null, "title": "ARLAS Persistence Server"}, "server": {"allOf": [{"$ref": "#/$defs/Resource"}], "title": "ARLAS Server"}, "authorization": {"anyOf": [{"$ref": "#/$defs/AuthorizationService"}, {"type": "null"}], "default": null, "title": "Keycloak URL"}, "elastic": {"anyOf": [{"$ref": "#/$defs/Resource"}, {"type": "null"}], "default": null, "title": "dictionary of name/es resources"}, "allow_delete": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": false, "title": "Is delete command allowed for this configuration?"}}, "required": ["server"], "title": "ARLAS", "type": "object"}, "AuthorizationService": {"properties": {"token_url": {"allOf": [{"$ref": "#/$defs/Resource"}], "default": null, "title": "Token URL of the authentication service"}, "client_id": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": null, "title": "Client ID"}, "client_secret": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": null, "title": "Client secret"}, "grant_type": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": null, "title": "Grant type (e.g. password)"}, "arlas_iam": {"anyOf": [{"type": "boolean"}, {"type": "null"}], "default": true, "title": "Is it an ARLAS IAM service?"}}, "title": "AuthorizationService", "type": "object"}, "Resource": {"properties": {"location": {"default": null, "title": "file or http location", "type": "string"}, "headers": {"anyOf": [{"additionalProperties": {"type": "string"}, "type": "object"}, {"type": "null"}], "default": {}, "title": "List of headers, if needed, for http(s) requests"}, "login": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": null, "title": "user"}, "password": {"anyOf": [{"type": "string"}, {"type": "null"}], "default": null, "title": "pasword"}}, "title": "Resource", "type": "object"}}, "properties": {"arlas": {"additionalProperties": {"$ref": "#/$defs/ARLAS"}, "default": null, "title": "dictionary of name/arlas configurations", "type": "object"}, "mappings": {"additionalProperties": {"$ref": "#/$defs/Resource"}, "default": null, "title": "dictionary of name/mapping resources", "type": "object"}, "models": {"additionalProperties": {"$ref": "#/$defs/Resource"}, "default": null, "title": "dictionary of name/model resources", "type": "object"}}, "title": "Settings", "type": "object", "$id": "airs_model"} diff --git a/model/model/index.html b/model/model/index.html index fd47486..e073827 100644 --- a/model/model/index.html +++ b/model/model/index.html @@ -18,6 +18,8 @@ + + @@ -481,6 +483,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + + @@ -857,20 +879,6 @@

    Definitions group AuthorizationS Settings -login -string -Optional -cannot be null -Settings - - -password -string -Optional -cannot be null -Settings - - client_id Merged Optional @@ -922,42 +930,6 @@

    token_url Type

    -

    login

    -

    login

    - -

    login Type

    -

    string (login)

    -

    password

    -

    password

    - -

    password Type

    -

    string (password)

    client_id

    client_id

    -

    login

    +

    headers Default Value

    +

    The default value is:

    +
    {}
+
    +

    login

    login

    -

    login Type

    +

    login Type

    merged type (user)

    any of

    -

    password

    +

    password

    password

    -

    password Type

    +

    password Type

    merged type (pasword)

    any of

    @@ -978,14 +998,14 @@

    Getting started

    Prerequisite

    -

    For running the various examples bellow, ARLAS and elasticsearch must be running on the local machine.

    +

    For running the various examples bellow, ARLAS and elasticsearch must be running on the local machine: clone the ARLAS Stack Exploration project and run ./start.sh .

    Initial configuration

    -

    arlas_cli uses a yaml file for storing various ARLAS and elasticsearch configurations. By default, the file is located in ~/.arlas/cli/configuration.yaml. One is automatically created for your convinience at the first launch. It contains the ARLAS demo endpoint and the local ARLAS and elasticsearch endpoints.

    +

    arlas_cli uses a yaml file for storing various ARLAS and elasticsearch configurations. By default, the file is located in ~/.arlas/cli/configuration.yaml. One is automatically created for your convenience at the first launch. It contains the ARLAS demo endpoint and the local ARLAS and elasticsearch endpoints.

    The configuration can also contain references to collection models for creating collections. A default one is provided for ARLAS EO. A reference can be an http url or a path to a local file. It can also contain references to index mappings for creating indices. A default one is provided for ARLAS EO.

    Running

    -
    arlas_cli --version0.2.8
    Warning : no configuration file found, we created an empty one for
    you (~/.arlas/cli/configuration.yaml).
    +
    arlas_cli --versionX.X.X
    Warning : no configuration file found, we created an empty one for
    you (~/.arlas/cli/configuration.yaml).

    Examples

    In the following examples, you will see how to:

    @@ -1042,13 +1062,13 @@

    Generate the elasticsearch mapping --mapping mapping.json

    List indices

    -
    arlas_cli indices --config local list --config local +----------+--------+-------+--------+
    | name | status | count | size |
    +----------+--------+-------+--------+
    | .arlas | open | 4 | 11.9kb |
    | courses | open | 0 | 249b |
    +----------+--------+-------+--------+
    +
    arlas_cli indices --config local list+----------+--------+-------+--------+
    | name | status | count | size |
    +----------+--------+-------+--------+
    | .arlas | open | 4 | 11.9kb |
    | courses | open | 0 | 249b |
    +----------+--------+-------+--------+

    Add data

    -
    arlas_cli indices --config local data courses sample.json --config local
    +
    arlas_cli indices --config local data courses sample.json

    Describe an index

    -
    arlas_cli indices --config local describe courses --config local +----------------------------------------------------+-----------+
    | 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 |
    +----------------------------------------------------+-----------+
    +
    arlas_cli indices --config local describe 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 |
    +----------------------------------------------------+-----------+

    Add a collection

    arlas_cli collections \ diff --git a/version/index.html b/version/index.html index 5ae5c15..1859401 100644 --- a/version/index.html +++ b/version/index.html @@ -435,6 +435,26 @@ + + + + + + +
  • + + + + + Configuring ARLAS Cloud + + + + +
    • + + +
    @@ -469,7 +489,7 @@

    arlas_cli version

    ARLAS Version: -0.3.8

    +0.4.0