Allocation autocomplete, client api #2995

chelseakomlo · 2017-08-09T13:49:09Z

This PR introduces two changes:

Autocomplete of nomad alloc-status for allocation ids
API pkg for resource list

One thing to consider is that we use the term resource in #2964, but this term already exists in for machine resources in /api/resources. I used /api/job_resources to differentiate, but let me know if this should be named something differently or included in /api/resources

dadgar · 2017-08-09T20:23:43Z

api/job_resources.go

+	"github.com/hashicorp/nomad/nomad/structs"
+)
+
+type JobResources struct {


Why JobResources and not just Resources. The object can list more than just jobs.

Yes, that was one thing I wasn't sure about, as currently a resource in the api package is commented as "Resource encapsulates the required resources of a given task or task group."

dadgar · 2017-08-09T20:24:00Z

api/job_resources.go

+}
+
+// List returns a list of all resources for a particular context. If a
+// context is not specified, matches for all contezts are returned.


contezts -> contexts

dadgar · 2017-08-09T20:24:49Z

api/job_resources.go

+
+// List returns a list of all resources for a particular context. If a
+// context is not specified, matches for all contezts are returned.
+func (j *JobResources) List(prefix string, context string) (*structs.ResourceListResponse, error) {


Don't want to take or return anything from structs in this package. Create a copy of the ListResponse here.

dadgar · 2017-08-09T20:27:02Z

nomad/resources_endpoint.go

@@ -73,6 +73,15 @@ func getResourceIter(context, prefix string, ws memdb.WatchSet, state *state.Sta
 	}
 }

+// If the length of a string is odd, return a subset of the string to the last
+// even character
+func roundDownIfOdd(s string) string {


I am fine with this if it is a place holder to a slightly more advanced implementation. My concern here is two fold:

Jobs don't need to be rounded, only UUIDs.

If I do a prefix of ab1 and I get a return of: ["ab12..", "ab23...", "ab34", ...] something seems broken :)

Ok, understood. So we can round the UUID for the query, and then use a filter function for the remaining character.

jippi · 2017-08-10T06:46:12Z

api/job_resources.go

+	var resp structs.ResourceListResponse
+	req := &structs.ResourceListRequest{Prefix: prefix, Context: context}
+
+	_, err := j.client.write("/v1/resources/", req, &resp, nil)


is /v1/resources a new endpoint?

We renamed it to /v1/search in a later commit, but this is a new endpoint.

dadgar · 2017-08-10T21:31:15Z

api/search.go

+
+// List returns a list of matches for a particular context and prefix. If a
+// context is not specified, matches for all contexts are returned.
+func (s *Search) List(prefix, context string) (*structs.SearchResponse, error) {


List -> PrefixSearch

dadgar · 2017-08-10T21:32:36Z

api/search.go

+import (
+	"github.com/hashicorp/nomad/nomad/structs"
+)
+


Can we add consts for the various contexts and use them in the commands pkg

Definitely. These should live in the api package?

Probably both where API pkg defines them from structs

dadgar · 2017-08-10T21:34:07Z

nomad/search_endpoint.go

+	if len(prefix)%2 == 0 {
+		return prefix
+	}
+	return prefix[:len(prefix)-1]


l := len(prefix) return prefix[:l-l%2]

dadgar · 2017-08-10T21:34:49Z

nomad/search_endpoint.go

 			continue
 		}

+		if !isSubset(prefix, id) {
+			break


break or continue?

Yes, I caught this after pushing.

dadgar · 2017-08-11T22:07:10Z

nomad/search_endpoint.go

+	st "github.com/hashicorp/nomad/nomad/structs"
+)
+
+// truncateLimit is the maximum number of matches that will be returned for a


Put comment over field

dadgar · 2017-08-11T22:07:56Z

nomad/search_endpoint.go

+
+	memdb "github.com/hashicorp/go-memdb"
+	"github.com/hashicorp/nomad/nomad/state"
+	st "github.com/hashicorp/nomad/nomad/structs"


Can you keep it as structs. Avoid named imports unless there is a conflict or the name is terribly long

dadgar · 2017-08-11T22:09:04Z

nomad/search_endpoint.go

+			continue
+		}
+
+		if !isSubset(prefix, id) {


https://golang.org/pkg/strings/#HasPrefix

dadgar · 2017-08-11T22:10:06Z

nomad/search_endpoint.go

+				contexts = []st.Context{args.Context}
+			}
+
+			for _, e := range contexts {


e -> context or ctx

dadgar · 2017-08-11T22:12:20Z

nomad/structs/structs.go

@@ -89,6 +89,17 @@ const (
 	GetterModeDir  = "dir"
 )

+// Context is a type which is searchable via a unique identifier.


Comment doesn't make much sense.

Context defines the scope in which a search for Nomad object operates

small refactors

comment updates

only applies to uuids, not jobs

refactor for simplicity

fix up endpoints

dadgar · 2017-08-14T18:22:39Z

api/search.go

+}
+
+// PrefixSearch returns a list of matches for a particular context and prefix. If a
+// context is not specified, matches for all contexts are returned.


Nit: Might be worth deleting the last line of the comment since we now assume there will always be a context, just contexts.All

github-actions · 2023-03-26T02:15:22Z

I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

chelseakomlo force-pushed the f-allocation-autocomplete branch from b971ee2 to cc97937 Compare August 9, 2017 14:37

chelseakomlo changed the title ~~Allocation autocomplete, client api~~ WIP- Allocation autocomplete, client api Aug 9, 2017

chelseakomlo force-pushed the f-allocation-autocomplete branch from cc97937 to 3630cbc Compare August 9, 2017 16:36

chelseakomlo changed the title ~~WIP- Allocation autocomplete, client api~~ Allocation autocomplete, client api Aug 9, 2017

chelseakomlo force-pushed the f-allocation-autocomplete branch from e67d6a3 to e255d75 Compare August 9, 2017 20:25

dadgar reviewed Aug 9, 2017

View reviewed changes

jippi reviewed Aug 10, 2017

View reviewed changes

chelseakomlo changed the title ~~Allocation autocomplete, client api~~ WIP: Allocation autocomplete, client api Aug 10, 2017

chelseakomlo force-pushed the f-allocation-autocomplete branch 3 times, most recently from 438c137 to 7b6f82e Compare August 10, 2017 20:41

dadgar reviewed Aug 10, 2017

View reviewed changes

chelseakomlo force-pushed the f-allocation-autocomplete branch 2 times, most recently from 8518a9a to e59e21a Compare August 11, 2017 21:41

chelseakomlo changed the title ~~WIP: Allocation autocomplete, client api~~ Allocation autocomplete, client api Aug 11, 2017

dadgar reviewed Aug 11, 2017

View reviewed changes

chelseakomlo force-pushed the f-allocation-autocomplete branch 2 times, most recently from cc5a49f to 26c8aea Compare August 14, 2017 14:55

chelseakomlo added 11 commits August 14, 2017 17:35

round down odd prefixes

4d711cb

autocomplete for allocation ids

34bb3d3

fix failing test assertion

a45bf60

small refactors

rename to cluster search

787f7bc

comment updates

even in rounding down for queries, full prefixes are matched against ids

0fdc461

only applies to uuids, not jobs

update comments

c3f2490

refactor for simplicity

change endpoint to /v1/search

7c5ef64

code refactoring and fixups

553d8ad

use constants for contexts

01b3338

using contexts constants in replace of string contexts

4edc38d

fix up endpoints

context constants should be in both api and structs pkg

c770119

chelseakomlo force-pushed the f-allocation-autocomplete branch from 26c8aea to fad3d3d Compare August 14, 2017 17:44

fixups from code review

3319fb5

chelseakomlo force-pushed the f-allocation-autocomplete branch from fad3d3d to 3319fb5 Compare August 14, 2017 18:01

dadgar approved these changes Aug 14, 2017

View reviewed changes

update comment for revised contexts

ffdea26

chelseakomlo merged commit 49bf7f9 into master Aug 14, 2017

chelseakomlo deleted the f-allocation-autocomplete branch August 14, 2017 19:26

github-actions bot locked as resolved and limited conversation to collaborators Mar 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allocation autocomplete, client api #2995

Allocation autocomplete, client api #2995

chelseakomlo commented Aug 9, 2017

dadgar Aug 9, 2017

chelseakomlo Aug 9, 2017

dadgar Aug 9, 2017

dadgar Aug 9, 2017

dadgar Aug 9, 2017

chelseakomlo Aug 9, 2017

jippi Aug 10, 2017

chelseakomlo Aug 10, 2017 •

edited

Loading

dadgar Aug 10, 2017

dadgar Aug 10, 2017

chelseakomlo Aug 10, 2017 •

edited

Loading

dadgar Aug 10, 2017

dadgar Aug 10, 2017

dadgar Aug 10, 2017

chelseakomlo Aug 10, 2017

dadgar Aug 11, 2017

dadgar Aug 11, 2017

dadgar Aug 11, 2017

dadgar Aug 11, 2017

dadgar Aug 11, 2017

dadgar Aug 11, 2017

dadgar Aug 14, 2017

github-actions bot commented Mar 26, 2023

Allocation autocomplete, client api #2995

Allocation autocomplete, client api #2995

Conversation

chelseakomlo commented Aug 9, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chelseakomlo Aug 10, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chelseakomlo Aug 10, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Mar 26, 2023

chelseakomlo Aug 10, 2017 •

edited

Loading

chelseakomlo Aug 10, 2017 •

edited

Loading