From f5c64331a89f92553e9107cb7bae3234e1655e87 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Thu, 21 Dec 2023 18:31:08 +0100 Subject: [PATCH 1/6] Delete instructions for removed CLI commands --- .../account/account-authentication-method.rst | 126 ------------------ docs/tools/cli/card.rst | 99 -------------- 2 files changed, 225 deletions(-) delete mode 100644 docs/tools/cli/account/account-authentication-method.rst delete mode 100644 docs/tools/cli/card.rst diff --git a/docs/tools/cli/account/account-authentication-method.rst b/docs/tools/cli/account/account-authentication-method.rst deleted file mode 100644 index 4995959497..0000000000 --- a/docs/tools/cli/account/account-authentication-method.rst +++ /dev/null @@ -1,126 +0,0 @@ -``avn account authentication-method`` -======================================================== - -Here you'll find the full list of commands for ``avn account authentication-method``. - - -Manage account authentication methods -------------------------------------- - -Commands for managing Aiven accounts authentication methods. - -``avn account authentication-method create`` -'''''''''''''''''''''''''''''''''''''''''''' - -Creates a new authentication method. More information about authentication methods creation is available at the `dedicated page `_ - -.. list-table:: - :header-rows: 1 - :align: left - - * - Parameter - - Information - * - ``account_id`` - - The id of the account - * - ``--name`` - - New authentication method name - * - ``--type`` - - The type of the new authentication method. Currently only ``saml`` is available - * - ``-c`` - - Additional configuration option (in the ``KEY=VALUE`` format) - * - ``-f`` - - Path to file containing additional configuration options (in the ``KEY=VALUE`` format) - -**Example:** Create a new ``saml`` authentication method named ``My Authentication Method`` for the account id ``123456789123``. - -.. code:: - - avn account authentication-method create 123456789123 \ - --name "My Authentication Method" \ - --type saml - -``avn account authentication-method delete`` -'''''''''''''''''''''''''''''''''''''''''''' - -Deletes an existing authentication method. - -.. list-table:: - :header-rows: 1 - :align: left - - * - Parameter - - Information - * - ``account_id`` - - The id of the account - * - ``authentication_id`` - - Id of the authentication method - -**Example:** Delete the authentication method with id ``88888888888`` belonging to the account id ``123456789123``. - -.. code:: - - avn account authentication-method delete 123456789123 88888888888 - -``avn account authentication-method list`` -'''''''''''''''''''''''''''''''''''''''''''' - -Lists the existing authentication methods. - -.. list-table:: - :header-rows: 1 - :align: left - - * - Parameter - - Information - * - ``account_id`` - - The id of the account - -**Example:** List all the authentication methods belonging to the account id ``123456789123``. - -.. code:: - - avn account authentication-method list 123456789123 - -An example of account authentication-method list output: - -.. code:: text - - ACCOUNT_ID AUTHENTICATION_METHOD_ENABLED AUTHENTICATION_METHOD_ID AUTHENTICATION_METHOD_NAME AUTHENTICATION_METHOD_TYPE STATE CREATE_TIME UPDATE_TIME - ============ ============================= ======================== ========================== ========================== ===================== ==================== ==================== - 123456789123 true am2exxxxxxxxx Okta saml active 2020-10-13T16:48:29Z 2021-08-10T08:33:15Z - 123456789123 true am2wwwwwwwwww Centrify saml active 2020-09-28T10:22:50Z 2020-09-28T12:06:06Z - 123456789123 true am2qqqqqqqqqq Azure saml active 2020-09-22T12:30:19Z 2020-09-22T12:34:02Z - 123456789123 true am2yyyyyyyyyy Platform authentication internal active 2020-09-09T20:28:44Z 2020-09-09T20:28:44Z - - -``avn account authentication-method update`` -'''''''''''''''''''''''''''''''''''''''''''' - -Updates an existing authentication method. - -.. list-table:: - :header-rows: 1 - :align: left - - * - Parameter - - Information - * - ``account_id`` - - The id of the account - * - ``authentication_id`` - - Id of the authentication method - * - ``--name`` - - New authentication method name - * - ``--enable`` - - Enables the authentication method - * - ``--disable`` - - Disables the authentication method - * - ``-c`` - - Additional configuration option (in the ``KEY=VALUE`` format) - * - ``-f`` - - Path to file containing additional configuration options (in the ``KEY=VALUE`` format) - -**Example:** Disable the authentication method with id ``am2exxxxxxxxx`` for the account id ``123456789123``. - -.. code:: - - avn account authentication-method update 123456789123 am2exxxxxxxxx --disable diff --git a/docs/tools/cli/card.rst b/docs/tools/cli/card.rst deleted file mode 100644 index 140a3956f5..0000000000 --- a/docs/tools/cli/card.rst +++ /dev/null @@ -1,99 +0,0 @@ -``avn card`` -=============================== - -This article has the full list of commands for managing credit card details using ``avn card``. - -``avn card add`` -'''''''''''''''' - -Adds a new credit card. - -.. list-table:: - :header-rows: 1 - :align: left - - * - Parameter - - Information - * - ``--cvc`` - - Credit card security code - * - ``--exp-month`` - - Card expiration month (1-12) - * - ``--exp-year`` - - Card expiration year - * - ``--name`` - - Name on the credit card - * - ``--number`` - - Credit card number - * - ``--update-project`` - - Assign card to a project - -**Example:** - -.. code:: shell - - avn card add --cvc 123 \ - --exp-month 01 \ - --exp-year 2031 \ - --name "Name Surname" \ - --number 4111111111111111 - -``avn card list`` -''''''''''''''''' - -Lists all credit cards: - -.. code:: shell - - avn card list - - -``avn card remove`` -''''''''''''''''''' - -Removes a credit card. - -.. list-table:: - :header-rows: 1 - :align: left - - * - Parameter - - Information - * - ``card-id`` - - The ID shown for this card in the ``list`` command output - - -**Example:** - -.. code:: shell - - avn card remove AAAAAAAA-BBBB-CCCC-DDDD-0123456789AB - -``avn card update`` -''''''''''''''''''' - -Updates a credit card. - -.. list-table:: - :header-rows: 1 - :align: left - - * - Parameter - - Information - * - ``card-id`` - - The ID shown for this card in the ``list`` command output - * - ``--exp-month`` - - Card expiration month (1-12) - * - ``--exp-year`` - - Card expiration year (YYYY) - * - ``--name`` - - Name on the credit card - - -**Example:** - -.. code:: shell - - avn card update AAAAAAAA-BBBB-CCCC-DDDD-0123456789AB \ - --exp-month 01 \ - --exp-year 2031 \ - --name "Name Surname" From 6c1680057cc1dee0b7ccbdd32f4fbc5fb663db4f Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Thu, 21 Dec 2023 18:34:36 +0100 Subject: [PATCH 2/6] Redirect deleted articles --- _redirects | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_redirects b/_redirects index 4ebe313db2..893739c5e0 100644 --- a/_redirects +++ b/_redirects @@ -85,6 +85,8 @@ /docs/tools/terraform/reference/cookbook/postgres-clickhouse-integration-recipe https://aiven.io/developer/postgresql-source-for-clickhouse /docs/community/challenge/catch-the-bus https://aiven.io/community/ /docs/community/challenge/the-rolling-challenge https://aiven.io/community/ +/docs/tools/cli/account/account-authentication-method /docs/tools/cli/account +/docs/tools/cli/card /docs/tools/cli/account # Redirect from .index.html to specific page names for landing From 61e83da193fc0bd56da0e5bdb02b0e7e221bb495 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Thu, 21 Dec 2023 18:37:12 +0100 Subject: [PATCH 3/6] Update TOC --- _toc.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/_toc.yml b/_toc.yml index 66bad8e288..9c16c8cca8 100644 --- a/_toc.yml +++ b/_toc.yml @@ -246,7 +246,6 @@ entries: entries: - glob: docs/tools/cli/account/* - file: docs/tools/cli/billing-group - - file: docs/tools/cli/card - file: docs/tools/cli/cloud - file: docs/tools/cli/credits - file: docs/tools/cli/events From a00e691ce33fa8824325fe6a44e03e5208225061 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Thu, 21 Dec 2023 18:47:07 +0100 Subject: [PATCH 4/6] Remove link to deleted file --- docs/platform/howto/add-authentication-method.rst | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/platform/howto/add-authentication-method.rst b/docs/platform/howto/add-authentication-method.rst index 165ad3d6ae..1ca5f2d334 100644 --- a/docs/platform/howto/add-authentication-method.rst +++ b/docs/platform/howto/add-authentication-method.rst @@ -10,7 +10,4 @@ To add an authentication method for your user account in the `Aiven Console `. \ No newline at end of file +After authorizing access, the new method is shown in the list. \ No newline at end of file From 8e5d616ffaa0787fd08b237e3cbdf3a430cc3d53 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Thu, 21 Dec 2023 18:56:58 +0100 Subject: [PATCH 5/6] Remove link to deleted card file --- docs/tools/cli.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/tools/cli.rst b/docs/tools/cli.rst index 91a3683819..5fb2022f5c 100644 --- a/docs/tools/cli.rst +++ b/docs/tools/cli.rst @@ -66,14 +66,6 @@ A set of administrative commands to set up billing groups and manage which proje The billing group command also enables access to the credit code features, and detailed invoice line data. -``card`` -'''''''' - -Manage the payment cards on your account. - -:doc:`See detailed command information `. - - ``cloud`` ''''''''' From 1eeea103122498cdb9aa85968d71fe91a12c0a61 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Thu, 21 Dec 2023 19:06:25 +0100 Subject: [PATCH 6/6] Remove link --- docs/tools/cli/account.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/tools/cli/account.rst b/docs/tools/cli/account.rst index 17fd9af1cc..8a5a04b1c5 100644 --- a/docs/tools/cli/account.rst +++ b/docs/tools/cli/account.rst @@ -5,11 +5,6 @@ This article has the full list of commands for managing organization or organiza Check out the full description of :doc:`Aiven's security model ` for more information. -``avn account authentication-method`` -''''''''''''''''''''''''''''''''''''' - -A full list of commands is available in a :doc:`separate article for managing authentication methods in the CLI `. - ``avn account create`` '''''''''''''''''''''''