Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Generate list of clouds from API, include in CLI docs #675

Merged
merged 5 commits into from Apr 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions Makefile
Expand Up @@ -83,3 +83,6 @@ service-type-config-grafana:
service-type-config-influxdb:
python "$(SOURCEDIR)/scripts/aiven/service_type_config.py" "influxdb" > includes/config-influxdb.rst

# (Re)Generate cloud listing
cloud-list:
python "$(SOURCEDIR)/scripts/aiven/clouds.py" > includes/clouds-list.rst
4 changes: 4 additions & 0 deletions _toc.yml
Expand Up @@ -39,6 +39,10 @@ entries:
- file: docs/platform/howto/integrations/prometheus-metrics
- file: docs/platform/howto/integrations/datadog-increase-metrics-limit
- file: docs/platform/howto/static-ip-addresses.rst
- file: docs/platform/reference
title: Reference
entries:
- glob: docs/platform/reference/*


# --------- GLOBAL -----------
Expand Down
6 changes: 6 additions & 0 deletions docs/platform/reference.rst
@@ -0,0 +1,6 @@
Reference
=========

Useful reference materials for working with the Aiven platform.

.. tableofcontents::
11 changes: 11 additions & 0 deletions docs/platform/reference/list_of_clouds.rst
@@ -0,0 +1,11 @@
List of available cloud regions
===============================

A reference list of the default available cloud regions.

.. Note::

The list of available clouds might differ per project. Furthermore not all Aiven services are available in all cloud vendors and regions.


.. include:: /includes/clouds-list.rst
8 changes: 6 additions & 2 deletions docs/tools/cli/cloud.rst
Expand Up @@ -25,15 +25,19 @@ Lists cloud regions with related geographical region, latitude and longitude.
* - ``--project``
- The project to fetch details for

**Example:** Show the details of the currently selected project.
**Example:** Show the clouds available to the currently selected project.

::

avn cloud list


**Example:** Show the details of a named project.
**Example:** Show the clouds available to a named project.

::

avn cloud list --project my-project


A reference of the cloud regions is available in the :doc:`dedicated document </docs/platform/reference/list_of_clouds>`.