From de934b5e7234aaaec71b4be7f2ec2cdf6a0be3b8 Mon Sep 17 00:00:00 2001 From: Abhishek Kekane Date: Fri, 4 Jun 2021 06:18:47 +0000 Subject: [PATCH] Spec Lite: CLI support for new cache APIs Change-Id: Ife55e6b1efa66bca1e0efc5a7efb3ba130a1e33f --- specs/xena/approved/index.rst | 8 ++++ .../python-glanceclient/cache-api-cli.rst | 43 +++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 specs/xena/approved/python-glanceclient/cache-api-cli.rst diff --git a/specs/xena/approved/index.rst b/specs/xena/approved/index.rst index e66f1ef9..1d66dde0 100644 --- a/specs/xena/approved/index.rst +++ b/specs/xena/approved/index.rst @@ -21,3 +21,11 @@ Xena approved specs for glance store: :maxdepth: 1 glance_store/* + +Xena approved specs for Glance Client: + +.. toctree:: + :glob: + :maxdepth: 1 + + python-glanceclient/* diff --git a/specs/xena/approved/python-glanceclient/cache-api-cli.rst b/specs/xena/approved/python-glanceclient/cache-api-cli.rst new file mode 100644 index 00000000..b82efa5f --- /dev/null +++ b/specs/xena/approved/python-glanceclient/cache-api-cli.rst @@ -0,0 +1,43 @@ +.. + This work is licensed under a Creative Commons Attribution 3.0 Unported + License. + + http://creativecommons.org/licenses/by/3.0/legalcode + +========================================= +Spec Lite: CLI support for new cache APIs +========================================= + +:project: python-glanceclient + +:problem: In Xena we are deprecating `glance-cache-manage` CLI utility as + we are moving caching operations under glance-api by introducing + new API endpoints for cache related operations. + +:solution: We need to add new CLI commands; `cache-queue`, `cache-list`, + `cache-delete`, `cache-delete-all` to support new cache APIs. + +:impacts: APIImpact, DocImpact + +:how: We will add new CLI interface for `cache-queue`, `cache-list`, + `cache-delete`, `cache-delete-all` commands. As caching is + local to each glance node and most of the deployments configures glance + nodes behind the load-balancers, operator/user need to pass actual + endpoint of the glance node. Existing optional command line option + `--os-image-url` will be used to provide the actual endpoint to the + client. The default value for `--os-image-url` can also be set to + using `OS_IMAGE_URL` environment variable. If this optional parameter + is not provided while executing above new commands or is using default + value set using `OS_IMAGE_URL` environment variable all of the above + commands should exit with appropriate error message. + + +:alternatives: None + +:timeline: Xena Milestone 2 + +:link: https://review.opendev.org/c/openstack/glance-specs/+/665258 + +:reviewers: dansmith, abhishek-kekane, cyril-roelandt + +:assignee: jokke