From 9b86c148a210707bd576e05341a994838b72ffd9 Mon Sep 17 00:00:00 2001 From: Sylvain Gaudan Date: Mon, 26 Aug 2024 14:04:33 +0200 Subject: [PATCH] Deployed 0b166c6 with MkDocs version: 1.6.0 --- 404.html | 21 + arlas_cloud/index.html | 21 + collections/index.html | 21 + collections_1/index.html | 21 + collections_2/index.html | 21 + collections_3/index.html | 21 + collections_4/index.html | 21 + confs/index.html | 23 +- confs_1/index.html | 21 + confs_2/index.html | 21 + confs_3/index.html | 21 + help/index.html | 45 +- iam/index.html | 653 ++++++++++++++++++ iam_1/index.html | 582 ++++++++++++++++ iam_2/index.html | 583 ++++++++++++++++ iam_3/index.html | 558 +++++++++++++++ index.html | 41 ++ indices/index.html | 21 + indices_1/index.html | 21 + indices_2/index.html | 21 + indices_3/index.html | 21 + indices_4/index.html | 21 + indices_5/index.html | 21 + install/index.html | 21 + model/index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + model/model-defs-arlas/index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + model/model-defs-resource/index.html | 21 + model/model-defs/index.html | 21 + .../index.html | 21 + .../index.html | 21 + .../index.html | 21 + model/model/index.html | 21 + persist/index.html | 23 +- persist_1/index.html | 21 + persist_2/index.html | 21 + sitemap.xml | 164 +++-- sitemap.xml.gz | Bin 739 -> 755 bytes started/index.html | 21 + version/index.html | 21 + 79 files changed, 4045 insertions(+), 76 deletions(-) create mode 100644 iam/index.html create mode 100644 iam_1/index.html create mode 100644 iam_2/index.html create mode 100644 iam_3/index.html diff --git a/404.html b/404.html index d576c9f..8399ced 100644 --- a/404.html +++ b/404.html @@ -381,6 +381,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • diff --git a/arlas_cloud/index.html b/arlas_cloud/index.html index d666db4..a682319 100644 --- a/arlas_cloud/index.html +++ b/arlas_cloud/index.html @@ -385,6 +385,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • diff --git a/collections/index.html b/collections/index.html index db6c8c1..549cf71 100644 --- a/collections/index.html +++ b/collections/index.html @@ -457,6 +457,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • diff --git a/collections_1/index.html b/collections_1/index.html index eccf118..e813d2e 100644 --- a/collections_1/index.html +++ b/collections_1/index.html @@ -388,6 +388,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • diff --git a/collections_2/index.html b/collections_2/index.html index 541260b..fc3eccc 100644 --- a/collections_2/index.html +++ b/collections_2/index.html @@ -388,6 +388,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • diff --git a/collections_3/index.html b/collections_3/index.html index 3777769..a705c09 100644 --- a/collections_3/index.html +++ b/collections_3/index.html @@ -388,6 +388,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • diff --git a/collections_4/index.html b/collections_4/index.html index 10df65f..07652db 100644 --- a/collections_4/index.html +++ b/collections_4/index.html @@ -383,6 +383,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • diff --git a/confs/index.html b/confs/index.html index 122a880..36406c3 100644 --- a/confs/index.html +++ b/confs/index.html @@ -15,7 +15,7 @@ - + @@ -392,6 +392,27 @@ + + +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + diff --git a/confs_1/index.html b/confs_1/index.html index c748c58..bae509e 100644 --- a/confs_1/index.html +++ b/confs_1/index.html @@ -388,6 +388,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • diff --git a/confs_2/index.html b/confs_2/index.html index d5a924c..f70fc0b 100644 --- a/confs_2/index.html +++ b/confs_2/index.html @@ -388,6 +388,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • diff --git a/confs_3/index.html b/confs_3/index.html index 3a66f55..618e9cb 100644 --- a/confs_3/index.html +++ b/confs_3/index.html @@ -383,6 +383,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • diff --git a/help/index.html b/help/index.html index 881b5bd..c02891e 100644 --- a/help/index.html +++ b/help/index.html @@ -439,6 +439,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • @@ -554,10 +575,30 @@

    Getting help

    Getting help

    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]...

    ╭─ Options ──────────────────────────────────────────────────────────╮
    │ --config-file TEXT Path to the configuration file if you │
    │ do not want to use the default one: │
    │ .arlas/cli/configuration.yaml. │
    │ [default: None] │
    │ --version Print command line version │
    │ --help Show this message and exit. │
    ╰────────────────────────────────────────────────────────────────────╯
    ╭─ Commands ─────────────────────────────────────────────────────────╮
    │ collections │
    │ confs │
    │ indices │
    │ persist │
    ╰────────────────────────────────────────────────────────────────────╯
    +
    arlas_cli --helpUsage: arlas_cli [OPTIONS] COMMAND [ARGS]...

    Options:
    --config-file TEXT Path to the configuration file if you do not want to use
    the default one: .arlas/cli/configuration.yaml.
    --version Print command line version
    --help Show this message and exit.

    Commands:
    collections
    confs
    iam
    indices
    persist

    or within a sub command:

    -
    arlas_cli indices --config demo mapping --help╭─ Arguments ────────────────────────────────────────────────────────╮
    │ * file TEXT Path to the file conaining the data. Format: │
    │ NDJSON │
    │ [default: None] │
    │ [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 │
    │ [default: None] │
    │ --help Show this message and exit. │
    ╰────────────────────────────────────────────────────────────────────╯

    + +

    ```shell

    +
    +

    arlas_cli indices --config demo mapping --help +Usage: arlas_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. + ```

    diff --git a/iam/index.html b/iam/index.html new file mode 100644 index 0000000..95898b2 --- /dev/null +++ b/iam/index.html @@ -0,0 +1,653 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Identity & Access - ARLAS Command Line (arlas_cli) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Identity & Access

    + +

    Manage organisations, users, permissions and groups

    +
    arlas_cli iam --config local orgs --helpUsage: python -m arlas.cli.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...
    add_user_to_group Add a user to a group within the...
    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...
    delete_user_from_group Remove a user from a group within the...
    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 --helpUsage: python -m arlas.cli.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
    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/iam_1/index.html b/iam_1/index.html new file mode 100644 index 0000000..74d5184 --- /dev/null +++ b/iam_1/index.html @@ -0,0 +1,582 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Iam 1 - ARLAS Command Line (arlas_cli) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Iam 1

    + +

    Manage organisations, users, permissions and groups

    + +

    ```shell

    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/iam_2/index.html b/iam_2/index.html new file mode 100644 index 0000000..a07e6a6 --- /dev/null +++ b/iam_2/index.html @@ -0,0 +1,583 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Iam 2 - ARLAS Command Line (arlas_cli) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Iam 2

    + +

    ```

    +

    Create, delete, activate / deactivate users

    + +

    ```shell

    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/iam_3/index.html b/iam_3/index.html new file mode 100644 index 0000000..25371cd --- /dev/null +++ b/iam_3/index.html @@ -0,0 +1,558 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Iam 3 - ARLAS Command Line (arlas_cli) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Iam 3

    + +

    ```

    + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/index.html b/index.html index 6563345..d72b5da 100644 --- a/index.html +++ b/index.html @@ -402,6 +402,27 @@ +
  • + + + + + Identity & Access + + + + +
    • + + + + + + + + + +
  • @@ -524,6 +545,26 @@

    About arlas_cli

  • get the groups accessing a zone
    • +
  • managing ARLAS Identity and Access (ARLAS IAM)
      +
    • list organisations
      • +
    • add an organisation
      • +
    • within an oganisation:
        +
      • 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
      • +
    +
  • managing configurations