https://github.com/aiven/aiven-client

aiven-client (avn) is the official command-line client for Aiven
https://github.com/aiven/aiven-client

aiven cli client

Last synced: 1 day ago
JSON representation

aiven-client (avn) is the official command-line client for Aiven

• Host: GitHub
• URL: https://github.com/aiven/aiven-client
• Owner: aiven
• License: apache-2.0
• Created: 2015-12-28T15:26:21.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2025-01-13T17:02:16.000Z (6 days ago)
• Last Synced: 2025-01-13T18:23:58.178Z (6 days ago)
• Topics: aiven, cli, client
• Language: Python
• Size: 1.33 MB
• Stars: 86
• Watchers: 77
• Forks: 33
• Open Issues: 16
• Metadata Files:
  • Readme: README.rst
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
Aiven Client |BuildStatus|_

###########################

.. |BuildStatus| image:: https://github.com/aiven/aiven-client/workflows/Build%20Aiven%20Client/badge.svg?branch=main

.. _BuildStatus: https://github.com/aiven/aiven-client/actions

Aiven is a next-generation managed cloud services platform.  Its focus is in

ease of adoption, high fault resilience, customer's peace of mind and

advanced features at competitive price points.  See https://aiven.io/ for

more information about the backend service.

aiven-client (``avn``) is the official command-line client for Aiven.

.. contents::

.. _platform-requirements:

Getting Started

===============

Requirements:

*  Python 3.8 or later

*  Requests_

*  For Windows and OSX, certifi_ is also needed

.. _`Requests`: http://www.python-requests.org/

.. _`certifi`: https://github.com/certifi/python-certifi

.. _installation:

Install from PyPi

-----------------

Pypi installation is the recommended route for most users::

  $ python3 -m pip install aiven-client

Build an RPM Package

--------------------

It is also possible to build an RPM::

  $ make rpm

Check Installation

------------------

To check that the tool is installed and working, run it without arguments::

  $ avn

If you see usage output, you're all set.

  **Note:** On Windows you may need to use ``python3 -m aiven.client`` instead of ``avn``.

Log In

------

The simplest way to use Aiven CLI is to authenticate with the username and

password you use on Aiven::

  $ avn user login 

The command will prompt you for your password.

You can also use an access token generated in the Aiven Console::

  $ avn user login  --token

You will be prompted for your access token as above.

If you are registered on Aiven through the AWS or GCP marketplace, then you need to specify an additional argument ``--tenant``. Currently the supported value are ``aws`` and ``gcp``, for example::

  $ avn user login  --tenant aws

.. _help-command:

.. _basic-usage:

Usage

=====

Some handy hints that work with all commands:

*  The ``avn help`` command shows all commands and can *search* for a command,

   so for example ``avn help kafka topic`` shows commands with kafka *and*

   topic in their description.

*  Passing ``-h`` or ``--help`` gives help output for any command. Examples:

   ``avn --help`` or ``avn service --help``.

*  All commands will output the raw REST API JSON response with ``--json``,

   we use this extensively ourselves in conjunction with

   `jq `__.

.. _login-and-users:

Authenticate: Logins and Tokens

-------------------------------

Login::

  $ avn user login 

Logout (revokes current access token, other sessions remain valid)::

  $ avn user logout

Expire all authentication tokens for your user, logs out all web console sessions, etc.

You will need to login again after this::

 $ avn user tokens-expire

Manage individual access tokens::

 $ avn user access-token list

 $ avn user access-token create --description  [--max-age-seconds ] [--extend-when-used]

 $ avn user access-token update  --description 

 $ avn user access-token revoke 

Note that the system has hard limits for the number of tokens you can create. If you're

permanently done using a token you should always use ``user access-token revoke`` operation

to revoke the token so that it does not count towards the quota.

Alternatively, you can add 2 JSON files, first create a default config in ``~/.config/aiven/aiven-credentials.json`` containing the JSON with an ``auth_token``::

  {

      "auth_token": "ABC1+123...TOKEN==",

      "user_email": "[email protected]"

  }

Second create a default config in ``~/.config/aiven/aiven-client.json`` containing the json with the ``default_project``::

  {"default_project": "yourproject-abcd"}

.. _clouds:

Choose your Cloud

-----------------

List available cloud regions::

  $ avn cloud list

.. _projects:

Working with Projects

---------------------

List projects you are a member of::

  $ avn project list

Project commands operate on the currently active project or the project

specified with the ``--project NAME`` switch. The active project cab be changed

with the ``project switch`` command::

  $ avn project switch 

Show active project's details::

  $ avn project details

Create a project and set the default cloud region for it::

  $ avn project create myproject --cloud aws-us-east-1

Delete an empty project::

  $ avn project delete myproject

List authorized users in a project::

  $ avn project user-list

Invite an existing Aiven user to a project::

  $ avn project user-invite [email protected]

Remove a user from the project::

  $ avn project user-remove [email protected]

View project management event log::

  $ avn events

.. _services:

Explore Existing Services

-------------------------

List services (of the active project)::

  $ avn service list

List services in a specific project::

  $ avn service list --project proj2

List only a specific service::

  $ avn service list db1

Verbose list (includes connection information, etc.)::

  $ avn service list db1 -v

Full service information in JSON, as it is returned by the Aiven REST API::

  $ avn service list db1 --json

Only a specific field in the output, custom formatting::

  $ avn service list db1 --format "The service is at {service_uri}"

View service log entries (most recent entries and keep on following logs, other options can be used to get history)::

  $ avn service logs db1 -f

.. _launching-services:

Launch Services

---------------

View available service plans::

  $ avn service plans

Launch a PostgreSQL service::

  $ avn service create mydb -t pg --plan hobbyist

View service type specific options, including examples on how to set them::

  $ avn service types -v

Launch a PostgreSQL service of a specific version (see above command)::

  $ avn service create mydb96 -t pg --plan hobbyist -c pg_version=9.6

Update a service's list of allowed client IP addresses. Note that a list of multiple

values is provided as a comma separated list::

  $ avn service update mydb96 -c ip_filter=10.0.1.0/24,10.0.2.0/24,1.2.3.4/32

Open psql client and connect to the PostgreSQL service (also available for InfluxDB)::

  $ avn service cli mydb96

Update a service to a different plan AND move it to another cloud region::

  $ avn service update mydb --plan startup-4 --cloud aws-us-east-1

Power off a service::

  $ avn service update mydb --power-off

Power on a service::

  $ avn service update mydb --power-on

Terminate a service (all data will be gone!)::

  $ avn service terminate mydb

Managing service users

----------------------

Some service types support multiple users (e.g. PostgreSQL database users).

List, add and delete service users::

  $ avn service user-list

  $ avn service user-create

  $ avn service user-delete

For Valkey services it's possible to create users with ACLs_::

  $ avn service user-create --username new_user --valkey-acl-keys="prefix* another_key" --valkey-acl-commands="+set" --valkey-acl-categories="-@all +@admin" --valkey-acl-channels="prefix* some_chan" my-valkey-service

.. _`ACLs`: https://valkey.io/docs/topics/acl

Service users are created with strong random passwords.

Service Integrations

--------------------

`Service integrations `_ allow to link Aiven services to other Aiven services or to services

offered by other companies for example for logging. Some examples for various diffenent integrations:

`Google cloud logging`_, `AWS Cloudwatch logging`_, `Remote syslog integration`_ and `Getting started with Datadog`_.

.. _`Google cloud logging`: https://help.aiven.io/en/articles/4209837-sending-service-logs-to-google-cloud-logging

.. _`AWS Cloudwatch logging`: https://help.aiven.io/en/articles/4134821-sending-service-logs-to-aws-cloudwatch

.. _`Remote syslog integration`: https://help.aiven.io/en/articles/2933115-remote-syslog-integration

.. _`Getting started with Datadog`: https://help.aiven.io/en/articles/1759208-getting-started-with-datadog

List service integration endpoints::

    $ avn service integration-endpoint-list

List all available integration endpoint types for given project::

    $ avn service integration-endpoint-types-list --project 

Create a service integration endpoint::

    $ avn service integration-endpoint-create --project  --endpoint-type  --endpoint-name  --user-config-json 

    $ avn service integration-endpoint-create --project  --endpoint-type  --endpoint-name  -c 

Update a service integration endpoint::

    $ avn service integration-endpoint-update --project  --user-config-json  

    $ avn service integration-endpoint-update --project  -c  

Delete a service integration endpoint::

    $ avn service integration-endpoint-delete --project   

List service integrations::

    $ avn service integration-list 

List all available integration types for given project::

    $ avn service integration-types-list --project 

Create a service integration::

    $ avn service integration-create --project  -t  -s  -d  -S  -D  --user-config-json 

    $ avn service integration-create --project  -t  -s  -d  -S  -D  -c 

Update a service integration::

    $ avn service integration-update --project  --user-config-json  

    $ avn service integration-update --project  -c  

Delete a service integration::

    $ avn service integration-delete --project  

Custom Files

------------

Listing files::

    $ avn service custom-file list --project  

Reading file::

    $ avn service custom-file get --project  --file_id  [--target_filepath ] [--stdout_write] 

Uploading new files::

    $ avn service custom-file upload --project  --file_type  --file_path  --file_name  

Updating existing files::

    $ avn service custom-file update --project  --file_path  --file_id  

.. _teams:

Working with Teams

------------------

List account teams::

  $ avn account team list 

Create a team::

  $ avn account team create --team-name  

Delete a team::

  $ avn account team delete --team-id  

Attach team to a project::

  $ avn account team project-attach --team-id  --project   --team-type 

Detach team from project::

  $ avn account team project-detach --team-id  --project  

List projects associated to the team::

  $ avn account team project-list --team-id  

List members of the team::

  $ avn account team user-list --team-id  

Invite a new member to the team::

  $ avn account team user-invite --team-id   

See the list of pending invitations::

  $ avn account team user-list-pending --team-id  

Remove user from the team::

  $ avn account team user-delete --team-id  --user-id  

.. _oauth2-clients:

Configuring OAuth2 Clients

--------------------------

List configured OAuth2 clients::

  $ avn account oauth2-client list 

Get a configured OAuth2 client's configuration::

  $ avn account oauth2-client list  --oauth2-client-id 

Create a new OAuth2 client information::

  $ avn account oauth2-client create  --name  -d  --redirect-uri 

Delete an OAuth2 client::

  $ avn account oauth2-client delete  --oauth2-client-id 

List an OAuth2 client's redirect URIs::

  $ avn account oauth2-client redirect-list  --oauth2-client-id 

Create a new OAuth2 client redirect URI::

  $ avn account oauth2-client redirect-create  --oauth2-client-id  --redirect-uri 

Delete an OAuth2 client redirect URI::

  $ avn account oauth2-client redirect-delete  --oauth2-client-id  --redirect-uri-id 

List an OAuth2 client's secrets::

  $ avn account oauth2-client secret-list  --oauth2-client-id 

Create a new OAUth2 client secret::

  $ avn account oauth2-client secret-create  --oauth2-client-id 

Delete an OAuth2 client's secret::

  $ avn account oauth2-client secret-delete  --oauth2-client-id  --secret-id 

Extra Features

==============

.. _shell-completions:

Autocomplete

------------

avn supports shell completions. It requires an optional dependency: argcomplete. Install it::

  $ python3 -m pip install argcomplete

To use completions in bash, add following line to ``~/.bashrc``::

  eval "$(register-python-argcomplete avn)"

For more information (including completions usage in other shells) see https://kislyuk.github.io/argcomplete/.

Auth Helpers

------------

When you spin up a new service, you'll want to connect to it. The ``--json`` option combined with the `jq `_ utility is a good way to grab the fields you need for your specific service. Try this to get the connection string::

  $ avn service get --json  | jq ".service_uri"

Each project has its own CA cert, and other services (notably Kafka) use mutualTLS so you will also need the ``service.key`` and ``service.cert`` files too for those. Download all three files to the local directory::

  $ avn service user-creds-download --username avnadmin 

For working with `kcat `_ (see also our `help article `_ ) or the command-line tools that ship with Kafka itself, a keystore and trustore are needed. By specifying which user's creds to use, and a secret, you can generate these via ``avn`` too::

  $ avn service user-kafka-java-creds --username avnadmin -p t0pS3cr3t 

Contributing

============

Check the `CONTRIBUTING `_ guide for details on how to contribute to this repository.

Keep Reading

============

We maintain some other resources that you may also find useful:

* `Command Line Magic with avn `__

* `Managing Billing Groups via CLI `__