Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API endpoints for pools (query only) #417

Closed
4 tasks done
nphilipp opened this issue May 25, 2022 · 0 comments · Fixed by #436
Closed
4 tasks done

API endpoints for pools (query only) #417

nphilipp opened this issue May 25, 2022 · 0 comments · Fixed by #436
Assignees
@nphilipp
Labels
API nice to have a stretch goal, not necessary for the MVP
Projects
Duffy v3 Deployment

Comments

@nphilipp
Copy link
Collaborator

nphilipp commented May 25, 2022 •
edited
Loading

Story

As a user or operator of Duffy,
I want to be able to query what pools are available and properties of pools,
so that I don't have to guess or query the DB directly.

Acceptance Criteria

  • The Duffy app serves …
    • … an endpoint /api/v1/pools which returns a dictionary mapping pool names to e.g. fill-level, number of nodes in states ready, provisioning, …
    • … api/v1/pools/{poolname} endpoints which carry the same information, just for a single pool.
  • Suitable duffy client list-pools, duffy client show-pool … commands are added which wrap these endpoints for CLI use.
@nphilipp nphilipp created this issue from a note in Q4/2021 Initiative (To do) May 25, 2022
@nphilipp nphilipp removed this from To do in Q4/2021 Initiative May 25, 2022
@nphilipp nphilipp added this to New / Unrefined in Duffy v3 Deployment via automation May 25, 2022
@nphilipp nphilipp added API nice to have a stretch goal, not necessary for the MVP labels May 25, 2022
@nphilipp nphilipp moved this from New / Unrefined to To Do in Duffy v3 Deployment May 25, 2022
@nphilipp nphilipp moved this from To Do to In Progress in Duffy v3 Deployment Jun 7, 2022
@nphilipp nphilipp self-assigned this Jun 7, 2022
@nphilipp nphilipp linked a pull request Jun 7, 2022 that will close this issue
Pool endpoints & CLI commands #436
Merged
@nphilipp nphilipp changed the title API endpoint for pools (query only) API endpoints for pools (query only) Jun 8, 2022
nphilipp added a commit to nphilipp/duffy that referenced this issue Jun 8, 2022
@nphilipp
Add pool controller
d031569 
This lets API users list pools and query individual ones.

In the course, sort the API online doc sections a little.

Related: CentOS#417

Signed-off-by: Nils Philippsen <nils@redhat.com>
nphilipp added a commit to nphilipp/duffy that referenced this issue Jun 8, 2022
@nphilipp
Add duffy client commands for pools
ac33b78 
This lets CLI users retrieve information about the configuration and
current status of node pools.

Fixes: CentOS#417

Signed-off-by: Nils Philippsen <nils@redhat.com>
@nphilipp nphilipp moved this from In Progress to In Review in Duffy v3 Deployment Jun 8, 2022
Duffy v3 Deployment automation moved this from In Review to Done Jun 8, 2022
nphilipp added a commit that referenced this issue Jun 8, 2022
@nphilipp
Add pool controller
d17593b 
This lets API users list pools and query individual ones.

In the course, sort the API online doc sections a little.

Related: #417

Signed-off-by: Nils Philippsen <nils@redhat.com>
nphilipp added a commit that referenced this issue Jun 8, 2022
@nphilipp
Add duffy client commands for pools
5ea1454 
This lets CLI users retrieve information about the configuration and
current status of node pools.

Fixes: #417

Signed-off-by: Nils Philippsen <nils@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nphilipp nphilipp

Labels
API nice to have a stretch goal, not necessary for the MVP
Projects
Duffy v3 Deployment
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Pool endpoints & CLI commands nphilipp/duffy
1 participant
@nphilipp