Storage profiles with tokens

api/client/admin.go

@@ -11,14 +11,14 @@ type Admin struct {
 	client proto.PowergateAdminServiceClient
 }
 
-// CreateInstance creates a new FFS instance, returning the instance ID and auth token.
-func (a *Admin) CreateInstance(ctx context.Context) (*proto.CreateInstanceResponse, error) {
-	return a.client.CreateInstance(ctx, &proto.CreateInstanceRequest{})
+// CreateStorageProfile creates a new Powergate storage profile, returning the instance ID and auth token.
+func (a *Admin) CreateStorageProfile(ctx context.Context) (*proto.CreateStorageProfileResponse, error) {
+	return a.client.CreateStorageProfile(ctx, &proto.CreateStorageProfileRequest{})
 }
 
-// ListInstances returns a list of existing API instances.
-func (a *Admin) ListInstances(ctx context.Context) (*proto.ListInstancesResponse, error) {
-	return a.client.ListInstances(ctx, &proto.ListInstancesRequest{})
+// ListStorageProfiles returns a list of existing API instances.
+func (a *Admin) ListStorageProfiles(ctx context.Context) (*proto.ListStorageProfilesResponse, error) {
+	return a.client.ListStorageProfiles(ctx, &proto.ListStorageProfilesRequest{})
 }
 
 // QueuedStorageJobs returns a list of queued storage jobs.

api/client/admin_test.go

@@ -16,10 +16,10 @@ func TestCreate(t *testing.T) {
 		a, done := setupAdmin(t, "")
 		defer done()
 
-		resp, err := a.CreateInstance(ctx)
+		resp, err := a.CreateStorageProfile(ctx)
 		require.NoError(t, err)
-		require.NotEmpty(t, resp.Id)
-		require.NotEmpty(t, resp.Token)
+		require.NotEmpty(t, resp.AuthEntry.Id)
+		require.NotEmpty(t, resp.AuthEntry.Token)
 	})
 
 	t.Run("WithAdminToken", func(t *testing.T) {
@@ -28,7 +28,7 @@ func TestCreate(t *testing.T) {
 		defer done()
 
 		t.Run("UnauthorizedEmpty", func(t *testing.T) {
-			resp, err := a.CreateInstance(ctx)
+			resp, err := a.CreateStorageProfile(ctx)
 			require.Error(t, err)
 			require.Nil(t, resp)
 		})
@@ -40,7 +40,7 @@ func TestCreate(t *testing.T) {
 			}
 			for _, auth := range wrongAuths {
 				ctx := context.WithValue(ctx, AdminKey, auth)
-				resp, err := a.CreateInstance(ctx)
+				resp, err := a.CreateStorageProfile(ctx)
 				st, ok := status.FromError(err)
 				require.True(t, ok)
 				require.Equal(t, codes.PermissionDenied, st.Code())
@@ -49,10 +49,10 @@ func TestCreate(t *testing.T) {
 		})
 		t.Run("Authorized", func(t *testing.T) {
 			ctx := context.WithValue(ctx, AdminKey, authToken)
-			resp, err := a.CreateInstance(ctx)
+			resp, err := a.CreateStorageProfile(ctx)
 			require.NoError(t, err)
-			require.NotEmpty(t, resp.Id)
-			require.NotEmpty(t, resp.Token)
+			require.NotEmpty(t, resp.AuthEntry.Id)
+			require.NotEmpty(t, resp.AuthEntry.Token)
 		})
 	})
 }

api/server/admin/storageprofiles.go

@@ -0,0 +1,41 @@
+package admin
+
+import (
+	"context"
+
+	proto "github.com/textileio/powergate/proto/admin/v1"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+)
+
+// CreateStorageProfile creates a new managed instance.
+func (a *Service) CreateStorageProfile(ctx context.Context, req *proto.CreateStorageProfileRequest) (*proto.CreateStorageProfileResponse, error) {
+	id, token, err := a.m.Create(ctx)
+	if err != nil {
+		return nil, status.Errorf(codes.Internal, "creating instance: %v", err)
+	}
+	return &proto.CreateStorageProfileResponse{
+		AuthEntry: &proto.AuthEntry{
+			Id:    id.String(),
+			Token: token,
+		},
+	}, nil
+}
+
+// ListStorageProfiles lists all managed instances.
+func (a *Service) ListStorageProfiles(ctx context.Context, req *proto.ListStorageProfilesRequest) (*proto.ListStorageProfilesResponse, error) {
+	lst, err := a.m.List()
+	if err != nil {
+		return nil, status.Errorf(codes.Internal, "listing storage profiles: %v", err)
+	}
+	ins := make([]*proto.AuthEntry, len(lst))
+	for i, v := range lst {
+		ins[i] = &proto.AuthEntry{
+			Id:    v.APIID.String(),
+			Token: v.Token,
+		}
+	}
+	return &proto.ListStorageProfilesResponse{
+		AuthEntries: ins,
+	}, nil
+}

cli-docs/pow/pow_admin.md

@@ -22,11 +22,11 @@ Provides admin commands
 ### SEE ALSO
 
 * [pow](pow.md)	 - A client for storage and retreival of powergate data
-* [pow admin create-instance](pow_admin_create-instance.md)	 - Create a powergate FFS instance.
+* [pow admin create-profile](pow_admin_create-profile.md)	 - Create a Powergate storage profile.
 * [pow admin executing](pow_admin_executing.md)	 - List executing storage jobs
-* [pow admin instances](pow_admin_instances.md)	 - List all powergate FFS instances.
 * [pow admin latest-final](pow_admin_latest-final.md)	 - List the latest final storage jobs
 * [pow admin latest-successful](pow_admin_latest-successful.md)	 - List the latest successful storage jobs
+* [pow admin profiles](pow_admin_profiles.md)	 - List all Powergate storage profiles.
 * [pow admin queued](pow_admin_queued.md)	 - List queued storage jobs
 * [pow admin summary](pow_admin_summary.md)	 - Give a summary of storage jobs in all states
 

cli-docs/pow/pow_admin_create-instance.md → cli-docs/pow/pow_admin_create-profile.md

@@ -1,19 +1,19 @@
-## pow admin create-instance
+## pow admin create-profile
 
-Create a powergate FFS instance.
+Create a Powergate storage profile.
 
 ### Synopsis
 
-Create a powergate FFS instance.
+Create a Powergate storage profile.
 
 ```
-pow admin create-instance [flags]
+pow admin create-profile [flags]
 ```
 
 ### Options
 
 ```
-  -h, --help   help for create-instance
+  -h, --help   help for create-profile
 ```
 
 ### Options inherited from parent commands

cli-docs/pow/pow_admin_instances.md → cli-docs/pow/pow_admin_profiles.md

@@ -1,19 +1,19 @@
-## pow admin instances
+## pow admin profiles
 
-List all powergate FFS instances.
+List all Powergate storage profiles.
 
 ### Synopsis
 
-List all powergate FFS instances.
+List all Powergate storage profiles.
 
 ```
-pow admin instances [flags]
+pow admin profiles [flags]
 ```
 
 ### Options
 
 ```
-  -h, --help   help for instances
+  -h, --help   help for profiles
 ```
 
 ### Options inherited from parent commands

cmd/pow/cmd/admin.go

@@ -46,9 +46,9 @@ var adminCmd = &cobra.Command{
 }
 
 var adminCreateInstanceCmd = &cobra.Command{
-	Use:   "create-instance",
-	Short: "Create a powergate FFS instance.",
-	Long:  `Create a powergate FFS instance.`,
+	Use:   "create-profile",
+	Short: "Create a Powergate storage profile.",
+	Long:  `Create a Powergate storage profile.`,
 	Args:  cobra.NoArgs,
 	PreRun: func(cmd *cobra.Command, args []string) {
 		err := viper.BindPFlags(cmd.Flags())
@@ -58,7 +58,7 @@ var adminCreateInstanceCmd = &cobra.Command{
 		ctx, cancel := context.WithTimeout(context.Background(), cmdTimeout)
 		defer cancel()
 
-		res, err := fcClient.Admin.CreateInstance(adminAuthCtx(ctx))
+		res, err := fcClient.Admin.CreateStorageProfile(adminAuthCtx(ctx))
 		checkErr(err)
 
 		json, err := protojson.MarshalOptions{Multiline: true, Indent: "  ", EmitUnpopulated: true}.Marshal(res)
@@ -69,9 +69,9 @@ var adminCreateInstanceCmd = &cobra.Command{
 }
 
 var adminInstancesCmd = &cobra.Command{
-	Use:   "instances",
-	Short: "List all powergate FFS instances.",
-	Long:  `List all powergate FFS instances.`,
+	Use:   "profiles",
+	Short: "List all Powergate storage profiles.",
+	Long:  `List all Powergate storage profiles.`,
 	Args:  cobra.NoArgs,
 	PreRun: func(cmd *cobra.Command, args []string) {
 		err := viper.BindPFlags(cmd.Flags())
@@ -81,7 +81,7 @@ var adminInstancesCmd = &cobra.Command{
 		ctx, cancel := context.WithTimeout(context.Background(), cmdTimeout)
 		defer cancel()
 
-		res, err := fcClient.Admin.ListInstances(adminAuthCtx(ctx))
+		res, err := fcClient.Admin.ListStorageProfiles(adminAuthCtx(ctx))
 		checkErr(err)
 
 		json, err := protojson.MarshalOptions{Multiline: true, Indent: "  ", EmitUnpopulated: true}.Marshal(res)

cmd/powbench/runner/runner.go

@@ -63,11 +63,11 @@ func sanityCheck(ctx context.Context, c *client.Client) error {
 }
 
 func runSetup(ctx context.Context, c *client.Client, ts TestSetup) error {
-	res, err := c.Admin.CreateInstance(ctx)
+	res, err := c.Admin.CreateStorageProfile(ctx)
 	if err != nil {
 		return fmt.Errorf("creating ffs instance: %s", err)
 	}
-	ctx = context.WithValue(ctx, client.AuthKey, res.Token)
+	ctx = context.WithValue(ctx, client.AuthKey, res.AuthEntry.Token)
 	res2, err := c.FFS.Addrs(ctx)
 	if err != nil {
 		return fmt.Errorf("getting instance info: %s", err)

ffs/auth/auth.go

@@ -26,12 +26,6 @@ type Auth struct {
 	ds   ds.Datastore
 }
 
-type entry struct {
-	Token string
-	APIID ffs.APIID
-	// This can be extended to have permissions
-}
-
 // New returns a new Auth.
 func New(store ds.Datastore) *Auth {
 	return &Auth{
@@ -44,7 +38,7 @@ func (r *Auth) Generate(iid ffs.APIID) (string, error) {
 	log.Infof("generating auth-token for instance %s", iid)
 	r.lock.Lock()
 	defer r.lock.Unlock()
-	e := entry{
+	e := ffs.AuthEntry{
 		Token: uuid.New().String(),
 		APIID: iid,
 	}
@@ -71,15 +65,15 @@ func (r *Auth) Get(token string) (ffs.APIID, error) {
 	if err != nil {
 		return ffs.EmptyInstanceID, fmt.Errorf("getting token %s from datastore: %s", token, err)
 	}
-	var e entry
+	var e ffs.AuthEntry
 	if err := json.Unmarshal(buf, &e); err != nil {
 		return ffs.EmptyInstanceID, fmt.Errorf("unmarshaling %s information from datastore: %s", token, err)
 	}
 	return e.APIID, nil
 }
 
 // List returns a list of all API instances.
-func (r *Auth) List() ([]ffs.APIID, error) {
+func (r *Auth) List() ([]ffs.AuthEntry, error) {
 	r.lock.Lock()
 	defer r.lock.Unlock()
 	q := query.Query{Prefix: ""}
@@ -93,16 +87,16 @@ func (r *Auth) List() ([]ffs.APIID, error) {
 		}
 	}()
 
-	var ret []ffs.APIID
+	var ret []ffs.AuthEntry
 	for r := range res.Next() {
 		if r.Error != nil {
 			return nil, fmt.Errorf("iter next: %s", r.Error)
 		}
-		var e entry
+		var e ffs.AuthEntry
 		if err := json.Unmarshal(r.Entry.Value, &e); err != nil {
 			return nil, fmt.Errorf("unmarshaling query result: %s", err)
 		}
-		ret = append(ret, e.APIID)
+		ret = append(ret, e)
 	}
 	return ret, nil
 }

ffs/manager/manager.go

@@ -169,7 +169,7 @@ func (m *Manager) SetDefaultStorageConfig(dc ffs.StorageConfig) error {
 }
 
 // List returns a list of all existing API instances.
-func (m *Manager) List() ([]ffs.APIID, error) {
+func (m *Manager) List() ([]ffs.AuthEntry, error) {
 	m.lock.Lock()
 	defer m.lock.Unlock()
 

ffs/types.go

@@ -72,6 +72,12 @@ func (i APIID) String() string {
 	return string(i)
 }
 
+// AuthEntry encapsulates auth info for a FFS instance.
+type AuthEntry struct {
+	Token string
+	APIID APIID
+}
+
 // JobStatus is a type for Job statuses.
 type JobStatus int