Got bash, grep, cat and wc and want the the simplest commands to select, run and administer your Aiven services? Learn how.
John Hammink
|RSS FeedDeveloper Advocate at Aiven
Subscribe for the latest news and insights on open source, Aiven offerings, and more.
Things have moved on since 2019, and we've continued improving the Aiven command line tool.
There's a new blog post at Get things done with the Aiven CLI which explains how to get started, and how to manage a PostgreSQL® service from start to finish. It also gives examples of using the--jsonswitch and thejqtool to extract data in a more powerful way than withgrepand friends.
You can do most of your Aiven service administration straight from your Aiven Console. However, for those times when you need to run a quick shell command on our CLI (command line interface) to check service status, power on or off services, filter through available plans or clouds, upgrade some of your services or watch for patterns in event logs, this guide is for you.
You can also use these commands for scripting and automation, as a basis for constructing your own commands or aliases, or even to dig deeper into the CLI for more possibilities. In this article, we’ll focus more on grepping through the sometimes rather lengthy and / or verbose avn outputs to find specific information more easily — although there are some admin and service deployment commands included.
While intended for use with our CLI, we also hope you’ll find this as a useful guide to get familiar with — or to revisit -- some basic bash scripting.
Feel free to copy / paste, but remember to adjust to the variables you need, for example your --cloud, and/or your --project setting depending on what you’re trying to do. Other variables may include such items as your login name as well as your chosen project and service instance names. Also, while we've specified writing to files or stdout; or clearing screens for aesthetic purposes, feel free to customize the commands you need.
Our list of commands here isn’t exhaustive but is complementary to the one on the Aiven client’s github profile, with some overlapping on the basic stuff. Be sure to check out both!
Finally, we’ll share the lot on github and include a few keyboard-friendly aliases for useful commands that you can use as a basis for some of your own Aiven service deployment and DevOps infrastructure.
You’ll need at least Python 3.7 or newer versions, with pip installed.
Loading code...
See the Aiven Client documentation on Github for instructions for other platforms.
NOTE: you’ll be prompted for your password.
Loading code...
Note: we now recommend logging in with an access token (using the
--tokenswitch) - see Log in to Aiven withavnin the 2022 article.
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
NOTE: writes a file (ca_clouds)
Loading code...
NOTE: writes to a file (not_ca_not_fi_clouds)
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
This command is useful for troubleshooting a slowly-restarting service.
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
If you are using a command often, it might be useful to create an alias or a shell function for it. You can add these to .bashrc or to a shell script in your path. Here are some examples:
Loading code...
Loading code...
Loading code...
Loading code...
Loading code...
In this piece, we looked at many things you can do with the Aiven command-line interface (CLI) including installation and authentication, viewing clouds, services, regions and plans, working with event logs, getting help, and even creating aliases for frequently-used functions.
We hope that you'll find this not only helpful as a comprehensive primer for Aiven CLI, but also as a general, basic bash reference.
As mentioned before, our CLI is only one of many ways to interact with our globally-available, open source services. Want to try them out? Check out our free 30 day trial. To stay apace with new developments, you can also subscribe to our blog and changelog RSS feeds, or follow us on Twitter or LinkedIn!
python -m pip install aiven-clientavn user login <user@aiven.io>avn user -havn user infoavn logoutavn service typesavn cloud listavn cloud list | grep Unitedavn cloud list | grep United | tail -5avn cloud list | grep United | head -5avn cloud list | grep United | head -20avn cloud list | grep -E "California" > ca_clouds && cat ca_cloudsavn cloud list | grep -Ev "California|Finland" > not_ca_not_fi_clouds && cat not_ca_not_fi_cloudsavn cloud list | grep -E "California" > ca_clouds && wc -l ca_cloudsregions=('africa' 'australia' 'europe')
for r in "${regions[@]}"
do
avn cloud list | grep $r
doneclear && avn cloud list | grep -E 'europe|north america' | grep 'aws-'avn cloud list | grep -Ev 'CLOUD_DESCRIPTION|=' > clouds_adjusted && wc -l clouds_adjustedproviders=('aws-' 'azure-' 'do-' 'google' 'packet')
for p in "${providers[@]}"
do
avn cloud list | grep $p
doneavn service plans --cloud do-sfoavn service plans --cloud do-sfo | grep -E 'hobbyist'avn service plans --cloud do-sfo | grep -E 'kafka:'clear && avn service plans --cloud do-sfo | grep -E 'pg:|kafka:' | grep -E '8 CPU|16 CPU'avn service plans --cloud do-sfo | grep -E 'cassandra:|opensearch:|grafana:|influxdb:|kafka:|mysql:|pg:|redis:' > plans_on_this_cloud && wc -l plans_on_this_cloudavn service plans --cloud do-sfo | grep -Ev '\$\d\d.\d{3}/h' | grep -E 'cassandra:|opensearch:|grafana:|influxdb:|kafka:|mysql:|pg:|redis:' > cheap_plans && wc -l cheap_plansavn service plans --cloud do-sfo | grep -Ev '\$\d\d.\d{3}/h' > cheap_plans && cat cheap_plansclear && avn service plans --cloud do-sfo | grep -Ev '\$\d\d.\d{3}/h' | moreclear && avn service plans --cloud do-sfo | grep -E '\$\d\d.\d{3}/h'avn service create mypg -t pg --plan hobbyistavn service create mycass -t cassandra --plan startup-4avn service create mykafka -t kafka --plan business-4avn service create mycass -t cassandra --plan startup-4 && avn service create mykafka -t kafka --plan business-4avn service update mycass --plan startup-8avn service update mycass --plan startup-8 --cloud aws-us-west-1avn service listavn service update myes1 --power-on && avn service update myes2 --power-onavn service list | grep POWERONavn service list | grep POWEROFFavn service list | grep REBUILDING | grep -Eo '\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{6})?((\+\d\d:\d\d)|Z)'avn service list | grep POWEROFF | grep -Eo '\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{6})?((\+\d\d:\d\d)|Z)'avn service list | grep RUNNING | grep -Eo '\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{6})?((\+\d\d:\d\d)|Z)'avn service update myes --power-off && avn service listservices=('mycass' 'mykafka' 'myes')
for s in "${services[@]}"
do
avn service update $s --power-off
doneavn service terminate mycass && avn service terminate mykafkaavn eventsavn events | grep -Ev 'TIME|=' | head -5avn events | grep -E '_maintenance'avn events | grep -E '_delete'avn events | grep -Ev 'TIME|=' > events && wc -l eventsavn events | grep power > power_events && cat power_eventsavn events | grep -Ev power > live_events && cat live_eventsavn helpavn -havn card -havn cloud -havn credits -havn events -havn project -havn service -havn service create -havn card listavn credits listavn project listavn project detailsavn vpc listshow_my_clouds() {
clear
regions=('australia' 'europe' 'north')
for r in "${regions[@]}"
do
avn cloud list | grep $r
done }get_cheap_plans() {
clear && avn service plans --cloud do-sfo | grep -Ev '\$\d\d.\d{3}/h' | more
}alias turnon_service='avn service update myes --power-on'alias turnoff_service='avn service update myes --power-off'alias get_timestamps='avn service list | grep -Eo "\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(.\d{6})?((\+\d\d:\d\d)|Z)"'