From 3d5eae4b4756af3abb5f9a35a7f75ef849885eaa Mon Sep 17 00:00:00 2001 From: Tomi Juvonen Date: Wed, 1 May 2019 19:36:42 +0300 Subject: [PATCH] Update download related documentation story: 2004147 Task: #30690 Change-Id: I993ad8b617a86279beca8ddae8ec06a139c601f4 Signed-off-by: Tomi Juvonen --- doc/source/api-ref/v1/maintenance.inc | 12 +--------- doc/source/api-ref/v1/parameters.yaml | 13 +++++++++-- .../create-maintenance-session-post.json | 22 ++++++++++--------- 3 files changed, 24 insertions(+), 23 deletions(-) diff --git a/doc/source/api-ref/v1/maintenance.inc b/doc/source/api-ref/v1/maintenance.inc index e7e6c98..96fb861 100644 --- a/doc/source/api-ref/v1/maintenance.inc +++ b/doc/source/api-ref/v1/maintenance.inc @@ -14,15 +14,6 @@ maintained or have an empty list to indicate those should be self-discovered. You need to have an initial state for the workflow in 'state'. 'workflow' indicates the name of a Python plug-in to be used in the maintenance. -Planned future functionality ----------------------------- - -'download' can contain a list of URLs from where the needed software changes -are downloaded. It can also provide plug-ins to be used. - -'actions' can contain a list of action plug-ins to be called before maintenance -starts, on each host or after the maintenance. - Request ------- @@ -134,5 +125,4 @@ Future On top of some expected changes mentioned above, it will also be handy to get detailed information about the steps run already in the maintenance session. This will be helpful when need to figure out any correcting actions to -successfully finish a failed session. There is ongoing work to have everything -kept in a database and that will be a key feature to enable these changes. +successfully finish a failed session. diff --git a/doc/source/api-ref/v1/parameters.yaml b/doc/source/api-ref/v1/parameters.yaml index 58293cb..40d3e76 100644 --- a/doc/source/api-ref/v1/parameters.yaml +++ b/doc/source/api-ref/v1/parameters.yaml @@ -102,11 +102,20 @@ metadata: upgrade-list: description: | - List of needed SW upgrades + List of needed SW upgrades: + + Default download directory is /tmp/. Download URL with filename + including 'workflow' or 'actions' are automatically extracted to + /tmp//. Plugins will be used straight from those + irectories if Fenix did not have a plugin with the same name. Your plugin can + have other files also that it is going to need, everything will be extracted + under those defined directories with the directory hiararchy inside the package. + Download directory and the content will be recursively removed when the session + is deleted by the admin. + in: body required: false type: list of dictionaries - min_version: \> 1 uuid: description: | diff --git a/doc/source/api-ref/v1/samples/create-maintenance-session-post.json b/doc/source/api-ref/v1/samples/create-maintenance-session-post.json index 24c15a8..a15b587 100644 --- a/doc/source/api-ref/v1/samples/create-maintenance-session-post.json +++ b/doc/source/api-ref/v1/samples/create-maintenance-session-post.json @@ -1,17 +1,19 @@ { - "hosts": ["overcloud-novacompute-1.opnfvlf.org", - "overcloud-novacompute-2.opnfvlf.org", - "overcloud-novacompute-3.opnfvlf.org"], + "hosts": [], "state": "MAINTENANCE", "maintenance_at": "2018-02-28 06:06:03", - "metadata": {"openstack_release": "Queens"}, + "metadata": {"openstack_release": "Stein"}, "workflow": "default", - "download": ["https://my.sw.upgrades.com/SW1.tar.gz", - "https://my.sw.upgrades.com/ESW1.tar.gz", - "https://my.sw.upgrades.com/plugins1.tar.gz"], + "download": ["https://my.sw.upgrades.com/compute.tar.gz", + "https://my.sw.upgrades.com/controller.tar.gz", + "https://my.sw.upgrades.com/esw.tar.gz", + "https://my.sw.upgrades.com/os.tar.gz", + "https://my.sw.upgrades.com/actions.tar.gz"], "actions": [ {"plugin": "prepare", "type": "pre"}, - {"plugin": "esw_upgrade", "type": "host", "metadata": {"upgrade": "ESW1"}}, - {"plugin": "os_upgrade", "type": "host", "metadata": {"upgrade": "SW1"}}, + {"plugin": "compute", "type": " compute ", "metadata": {"upgrade": " compute.tar.gz "}}, + {"plugin": "controller", "type": " controller ", "metadata": {"upgrade": " controller.tar.gz "}}, + {"plugin": "esw_upgrade", "type": "host", "metadata": {"upgrade": "esw.tar.gz"}}, + {"plugin": "os_upgrade", "type": "host", "metadata": {"upgrade": "os.tar.gz"}}, {"plugin": "finalize", "type": "post"}] -} \ No newline at end of file +}