lxd: add all-projects param to the operation API

client/interfaces.go

@@ -307,6 +307,7 @@ type InstanceServer interface {
  // Operation functions
  GetOperationUUIDs() (uuids []string, err error)
  GetOperations() (operations []api.Operation, err error)
+ GetOperationsAllProjects() (operations []api.Operation, err error)
  GetOperation(uuid string) (op *api.Operation, ETag string, err error)
  GetOperationWait(uuid string, timeout int) (op *api.Operation, ETag string, err error)
  GetOperationWaitSecret(uuid string, secret string, timeout int) (op *api.Operation, ETag string, err error)

client/lxd_operations.go

@@ -42,6 +42,35 @@ func (r *ProtocolLXD) GetOperations() ([]api.Operation, error) {
  return operations, nil
 }
 
+func (r *ProtocolLXD) GetOperationsAllProjects() ([]api.Operation, error) {
+ err := r.CheckExtension("operations_get_query_all_projects")
+ if err != nil {
+ return nil, err
+ }
+
+ apiOperations := map[string][]api.Operation{}
+
+ path := "/operations"
+
+ v := url.Values{}
+ v.Set("recursion", "1")
+ v.Set("all-projects", "true")
+
+ // Fetch the raw value
+ _, err = r.queryStruct("GET", fmt.Sprintf("%s?%s", path, v.Encode()), nil, "", &apiOperations)
+ if err != nil {
+ return nil, err
+ }
+
+ // Turn it into just a list of operations
+ operations := []api.Operation{}
+ for _, v := range apiOperations {
+ operations = append(operations, v...)
+ }
+
+ return operations, nil
+}
+
 // GetOperation returns an Operation entry for the provided uuid.
 func (r *ProtocolLXD) GetOperation(uuid string) (*api.Operation, string, error) {
  op := api.Operation{}

doc/api-extensions.md

@@ -2273,3 +2273,8 @@ This allows copying storage volume snapshots to and from remotes.
 ## `zfs_delegate`
 This implements a new `zfs.delegate` volume Boolean for volumes on a ZFS storage driver.
 When enabled and a suitable system is in use (requires ZFS 2.2 or higher), the ZFS dataset will be delegated to the container, allowing for its use through the `zfs` command line tool.
+
+## `operations_get_query_all_projects`
+
+This adds new support of query param `all-projects` for GET api call of both `/1.0/operations` and `/1.0/operations?recursion=1`,
+which allows to bypass the project name filter.

doc/rest-api.yaml

@@ -12012,6 +12012,16 @@ paths:
  get:
  description: Returns a JSON object of operation type to operation list (URLs).
  operationId: operations_get
+ parameters:
+ - description: Project name
+ example: default
+ in: query
+ name: project
+ type: string
+ - description: Retrieve operations from all projects
+ in: query
+ name: all-projects
+ type: boolean
  produces:
  - application/json
  responses:
@@ -12251,6 +12261,16 @@ paths:
  get:
  description: Returns a list of operations (structs).
  operationId: operations_get_recursion1
+ parameters:
+ - description: Project name
+ example: default
+ in: query
+ name: project
+ type: string
+ - description: Retrieve operations from all projects
+ in: query
+ name: all-projects
+ type: boolean
  produces:
  - application/json
  responses:

lxd/db/operations.go

@@ -10,6 +10,16 @@ import (
  "github.com/canonical/lxd/lxd/db/query"
 )
 
+// GetAllNodesWithOperations returns a list of nodes that have operations of all projects.
+func (c *ClusterTx) GetAllNodesWithOperations(ctx context.Context) ([]string, error) {
+ stmt := `
+ SELECT DISTINCT nodes.address
+ FROM operations
+ JOIN nodes ON nodes.id = operations.node_id
+ `
+ return query.SelectStrings(ctx, c.tx, stmt)
+}
+
 // GetNodesWithOperations returns a list of nodes that have operations.
 func (c *ClusterTx) GetNodesWithOperations(ctx context.Context, project string) ([]string, error) {
  stmt := `

lxd/operations.go

@@ -373,6 +373,16 @@ func operationCancel(s *state.State, r *http.Request, projectName string, op *ap
 // ---
 // produces:
 // - application/json
+// parameters:
+// - in: query
+// name: project
+// description: Project name
+// type: string
+// example: default
+// - in: query
+// name: all-projects
+// description: Retrieve operations from all projects
+// type: boolean
 // responses:
 // "200":
 // description: API endpoints
@@ -419,6 +429,16 @@ func operationCancel(s *state.State, r *http.Request, projectName string, op *ap
 // ---
 // produces:
 // - application/json
+// parameters:
+// - in: query
+// name: project
+// description: Project name
+// type: string
+// example: default
+// - in: query
+// name: all-projects
+// description: Retrieve operations from all projects
+// type: boolean
 // responses:
 // "200":
 // description: API endpoints
@@ -450,9 +470,18 @@ func operationCancel(s *state.State, r *http.Request, projectName string, op *ap
 func operationsGet(d *Daemon, r *http.Request) response.Response {
  s := d.State()
 
- projectName := projectParam(r)
+ projectName := queryParam(r, "project")
+ allProjects := shared.IsTrue(queryParam(r, "all-projects"))
  recursion := util.IsRecursionRequest(r)
 
+ if allProjects && projectName != "" {
+ return response.SmartError(
+ api.StatusErrorf(http.StatusBadRequest, "Cannot specify a project when requesting all projects"),
+ )
+ } else if !allProjects && projectName == "" {
+ projectName = project.Default
+ }
+
  localOperationURLs := func() (shared.Jmap, error) {
  // Get all the operations.
  localOps := operations.Clone()
@@ -461,7 +490,7 @@ func operationsGet(d *Daemon, r *http.Request) response.Response {
  body := shared.Jmap{}
 
  for _, v := range localOps {
- if v.Project() != "" && v.Project() != projectName {
+ if !allProjects && v.Project() != "" && v.Project() != projectName {
  continue
  }
 
@@ -485,7 +514,7 @@ func operationsGet(d *Daemon, r *http.Request) response.Response {
  body := shared.Jmap{}
 
  for _, v := range localOps {
- if v.Project() != "" && v.Project() != projectName {
+ if !allProjects && v.Project() != "" && v.Project() != projectName {
  continue
  }
 
@@ -561,7 +590,11 @@ func operationsGet(d *Daemon, r *http.Request) response.Response {
  err = s.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
  var err error
 
- membersWithOps, err = tx.GetNodesWithOperations(ctx, projectName)
+ if allProjects {
+ membersWithOps, err = tx.GetAllNodesWithOperations(ctx)
+ } else {
+ membersWithOps, err = tx.GetNodesWithOperations(ctx, projectName)
+ }
  if err != nil {
  return fmt.Errorf("Failed getting members with operations: %w", err)
  }
@@ -613,7 +646,12 @@ func operationsGet(d *Daemon, r *http.Request) response.Response {
  }
 
  // Get operation data.
- ops, err := client.UseProject(projectName).GetOperations()
+ var ops []api.Operation
+ if allProjects {
+ ops, err = client.GetOperationsAllProjects()
+ } else {
+ ops, err = client.UseProject(projectName).GetOperations()
+ }
  if err != nil {
  logger.Warn("Failed getting operations from member", logger.Ctx{"address": memberAddress, "err": err})
  continue

shared/version/api.go

@@ -380,6 +380,7 @@ var APIExtensions = []string{
  "network_allocations",
  "storage_api_remote_volume_snapshot_copy",
  "zfs_delegate",
+ "operations_get_query_all_projects",
 }
 
 // APIExtensionsCount returns the number of available API extensions.

test/main.sh

@@ -352,6 +352,8 @@ if [ "${1:-"all"}" != "cluster" ]; then
  run_test test_warnings "Warnings"
  run_test test_metrics "Metrics"
  run_test test_storage_volume_recover "Recover storage volumes"
+ run_test test_operations_get_all "operations_get_all"
+ run_test test_operations_get_by_project "operations_get_by_project"
 fi
 
 # shellcheck disable=SC2034

test/suites/operations.sh

@@ -0,0 +1,62 @@
+test_operations_get_all() {
+ assert_get_all_operations() {
+ (
+ set -e
+ echo "==> get all-projects operations normally"
+ result="$(lxc query "/1.0/operations?all-projects=true" | jq '.success[0]' | wc -l)"
+ test "${result}" -eq 1 || false
+
+ echo "==> get all-projects operations recursively"
+ result="$(lxc query "/1.0/operations?recursion=1&all-projects=true" | jq '.success[0]' | grep -c 'status_code')"
+ test "${result}" -eq 1 || false
+ )
+ }
+
+ ensure_import_testimage
+
+ # create container
+ name=x1
+ lxc launch testimage ${name}
+ lxc list ${name} | grep RUNNING
+
+ # get_all_operations
+ lxc query -X POST -d '{\"command\":[\"touch\",\"/root/foo1\"],\"record-output\":false}' /1.0/instances/${name}/exec
+ sleep 1
+ assert_get_all_operations
+
+ lxc stop "${name}" --force
+ lxc delete "${name}"
+}
+
+test_operations_get_by_project() {
+ assert_get_project_operations() {
+ # $1: query param for project name
+ (
+ set -e
+ echo "==> get $1 operations normally"
+ result="$(lxc query "/1.0/operations?project=$1" | jq '.success[0]' | wc -l)"
+ test "${result}" -eq 1 || false
+
+ echo "==> get $1 operations recursively"
+ result="$(lxc query "/1.0/operations?recursion=1&project=$1" | jq '.success[0]' | grep -c 'status_code')"
+ test "${result}" -eq 1 || false
+ )
+ }
+
+ ensure_import_testimage
+
+ project="default"
+
+ # create container
+ name=x1
+ lxc launch testimage ${name} --project ${project}
+ lxc list ${name} --project ${project} | grep RUNNING
+
+ # get opetaions with project name
+ lxc query -X POST -d '{\"command\":[\"touch\",\"/root/foo1\"],\"record-output\":false}' /1.0/instances/${name}/exec?project=${project}
+ sleep 1
+ assert_get_project_operations ${project}
+
+ lxc stop "${name}" --force --project ${project}
+ lxc delete "${name}" --project ${project}
+}