feat: multi instance support by TobiaszCudnik · Pull Request #178 · instill-ai/cli

TobiaszCudnik · 2023-09-15T13:06:14Z

Because

user can have more than 1 instance of Instill AI

This commit

adds instance management and switching

Changes

instances management
- add, edit, list, remove, set-default
markdown tables
tests
typed config (for hosts)
default config when empty
hostname validation
breaking dependabot updates
readme

linear · 2023-09-15T13:06:16Z

INS-1661 CLI: multi-instance support

add / remove / select a target host
integrate with auth
- oauth hostname differs from the API hostname (for the same instance)
aggregate results from >1 source
- eg --local --cloud --all
- ability to select --all as a default

# examin existing instances
$ inst instances list
+--------------+-------------------+-------------------+----------------------------+
| Type         | API Hostname      | Oauth2 Hostname   | Issuer                     |
+--------------+-------------------+-------------------+----------------------------+
| cloud        | api.instill.tech  | auth.instill.tech | https://auth.instill.tech/ |
+--------------+-------------------+-------------------+----------------------------+
| local        | instill.localhost |                   |                            |
+--------------+-------------------+-------------------+----------------------------+

# set the local instance (http)
$ inst instances set local instill.localhost

# set the cloud instance (https)
$ inst instances set cloud api.instill.tech \
		--oauth auth.instill.tech \
		--issuer https://auth.instill.tech/

Later

support for >1 local instance
support for >1 cloud instance

codecov · 2023-09-15T13:07:42Z

Codecov Report

Patch coverage: 54.84% and project coverage change: +0.96% 🎉

Comparison is base (b9e1db9) 50.13% compared to head (f23e835) 51.09%.
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #178      +/-   ##
==========================================
+ Coverage   50.13%   51.09%   +0.96%     
==========================================
  Files          48       54       +6     
  Lines        3700     4196     +496     
==========================================
+ Hits         1855     2144     +289     
- Misses       1674     1833     +159     
- Partials      171      219      +48

Flag	Coverage Δ
unittests	`51.09% <54.84%> (+0.96%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
internal/config/config_file.go	`57.60% <ø> (ø)`
internal/config/config_type.go	`96.07% <ø> (ø)`
pkg/cmd/auth/status/status.go	`28.57% <0.00%> (ø)`
pkg/cmd/root/help_topic.go	`84.61% <ø> (ø)`
pkg/cmd/root/root.go	`0.00% <0.00%> (ø)`
pkg/cmdutil/errors.go	`26.31% <ø> (ø)`
pkg/cmdutil/output.go	`0.00% <0.00%> (ø)`
pkg/cmd/auth/login/login.go	`42.30% <18.51%> (-2.14%)`	⬇️
internal/config/from_file.go	`53.17% <33.58%> (-11.27%)`	⬇️
pkg/cmd/instances/instances.go	`40.74% <40.74%> (ø)`
... and 15 more

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

internal/config/stub.go

Signed-off-by: Tobias Cudnik <[email protected]> fix GH workflows Signed-off-by: Tobias Cudnik <[email protected]> fix GH workflows Signed-off-by: Tobias Cudnik <[email protected]> fix GH workflows Signed-off-by: Tobias Cudnik <[email protected]> fix GH workflows Signed-off-by: Tobias Cudnik <[email protected]> fix GH workflows Signed-off-by: Tobias Cudnik <[email protected]> ci: fix workflows - missing auth0 vars - .env for local dev - aligned build system - instill-dev.eu tenant working Signed-off-by: Tobias Cudnik <[email protected]> update go/mods Signed-off-by: Tobias Cudnik <[email protected]>

- wip: list cmd - table renderer - markdown output Signed-off-by: Tobias Cudnik <[email protected]>

- typed host config - list cmd - add cmd Signed-off-by: Tobias Cudnik <[email protected]>

- edit cmd - remove cmd - save config Signed-off-by: Tobias Cudnik <[email protected]>

- missing oauth fields - bound auth to config - default config on bootstrap Signed-off-by: Tobias Cudnik <[email protected]>

Signed-off-by: Tobias Cudnik <[email protected]>

- fixed default hostname - fixed table urls - params validation Signed-off-by: Tobias Cudnik <[email protected]>

- `api` config integration Signed-off-by: Tobias Cudnik <[email protected]>

Signed-off-by: Tobias Cudnik <[email protected]>

- added `instances set-default` - fixed partial edits - re-fixed urls in tables (rebase) - fixed hostname parsing - dependabot updates Signed-off-by: Tobias Cudnik <[email protected]>

Signed-off-by: Tobias Cudnik <[email protected]>

internal/config/stub.go

Signed-off-by: Tobias Cudnik <[email protected]>

pinglin

Please see the comments and suggested changes.

cmd/instill/main.go

internal/config/stub.go

internal/instance/host.go

internal/config/stub.go

internal/oauth2/auth_code_flow.go

pkg/cmd/auth/login/login.go

pkg/cmd/instances/add_test.go

pkg/cmd/instances/edit_test.go

- imports - renames Signed-off-by: Tobias Cudnik <[email protected]>

internal/config/stub.go

+			Oauth2Hostname:     "auth.instill.tech",
+			Oauth2Audience:     "https://api.instill.tech",
+			Oauth2Issuer:       "https://auth.instill.tech/",
+			Oauth2ClientSecret: "foobar",


Signed-off-by: Tobias Cudnik <[email protected]>

TobiaszCudnik · 2023-09-22T08:09:58Z

Please see the comments and suggested changes.

@pinglin Ive implemented the renames and formatted imports. Im happy theres no concerns regarding the code itself. We should incorporate goimports into the pipeline.

pinglin · 2023-09-22T08:23:57Z

Please see the comments and suggested changes.

@pinglin Ive implemented the renames and formatted imports. Im happy theres no concerns regarding the code itself. We should incorporate goimports into the pipeline.

Yeah, that will be very ideal. @praharshjain has proposed and tried it before actually. Any guideline for this?

TobiaszCudnik · 2023-09-22T08:53:33Z

This seems to be the right source:
https://github.com/dnephin/pre-commit-golang

Import order should be linted, like any other required conventions. AFAIK we're using the default golangci-lint config.

Signed-off-by: Tobias Cudnik <[email protected]>

pinglin

LGTM

Because - user can have more than 1 instance of Instill AI This commit - adds instance management and switching - instances management - `add`, `edit`, `list`, `remove`, `set-default` - markdown tables - tests - typed config (for hosts) - default config when empty - hostname validation - breaking dependabot updates - readme --------- Signed-off-by: Tobias Cudnik <[email protected]>

droplet-bot added the 🗿 instill-base label Sep 15, 2023

github-advanced-security bot found potential problems Sep 15, 2023

View reviewed changes

internal/config/stub.go Fixed Show fixed Hide fixed

TobiaszCudnik added 11 commits September 15, 2023 15:16

feat: instances support

49e536c

- wip: list cmd - table renderer - markdown output Signed-off-by: Tobias Cudnik <[email protected]>

feat: instances support

a0fa0c4

- typed host config - list cmd - add cmd Signed-off-by: Tobias Cudnik <[email protected]>

feat: instances support

8c78aa0

- edit cmd - remove cmd - save config Signed-off-by: Tobias Cudnik <[email protected]>

feat: instances support

842d9bc

- missing oauth fields - bound auth to config - default config on bootstrap Signed-off-by: Tobias Cudnik <[email protected]>

fix: oauth2 compilation

642c21f

Signed-off-by: Tobias Cudnik <[email protected]>

fix: default hostname

df1d5f1

Signed-off-by: Tobias Cudnik <[email protected]>

feat: instances support

207c35a

- fixed default hostname - fixed table urls - params validation Signed-off-by: Tobias Cudnik <[email protected]>

feat: instances support

d88d3d1

- `api` config integration Signed-off-by: Tobias Cudnik <[email protected]>

test: fixed existing tests

bc7826d

Signed-off-by: Tobias Cudnik <[email protected]>

ci: pull yml from main

f32830e

Signed-off-by: Tobias Cudnik <[email protected]>

TobiaszCudnik force-pushed the tobias/ins-1661-cli-multi-instance-support branch from dbfb605 to f32830e Compare September 15, 2023 13:17

TobiaszCudnik added 4 commits September 15, 2023 15:20

chore: go.mod

f25e9c4

Signed-off-by: Tobias Cudnik <[email protected]>

ci: dependabot weekly

a27e17b

Signed-off-by: Tobias Cudnik <[email protected]>

feat: instances support

1cc30fa

- added `instances set-default` - fixed partial edits - re-fixed urls in tables (rebase) - fixed hostname parsing - dependabot updates Signed-off-by: Tobias Cudnik <[email protected]>

chore: linter

38dfef1

Signed-off-by: Tobias Cudnik <[email protected]>

This was referenced Sep 19, 2023

chore(deps): bump github.com/ory/x from 0.0.364 to 0.0.589 #176

Closed

chore(deps): bump github.com/AlecAivazis/survey/v2 from 2.3.2 to 2.3.7 #168

Closed

test: instances coverage

96a8f40

Signed-off-by: Tobias Cudnik <[email protected]>

github-advanced-security bot found potential problems Sep 20, 2023

View reviewed changes

internal/config/stub.go Fixed Show fixed Hide fixed

TobiaszCudnik added 4 commits September 20, 2023 10:46

test: config coverage

e43f603

Signed-off-by: Tobias Cudnik <[email protected]>

test: coverage

9dc70d3

Signed-off-by: Tobias Cudnik <[email protected]>

chore: readme

9205149

Signed-off-by: Tobias Cudnik <[email protected]>

test: fix config overwrite

79fe2de

Signed-off-by: Tobias Cudnik <[email protected]>

TobiaszCudnik marked this pull request as ready for review September 20, 2023 11:00

TobiaszCudnik requested a review from heiruwu as a code owner September 20, 2023 11:00

TobiaszCudnik requested a review from pinglin as a code owner September 20, 2023 11:00

pinglin requested changes Sep 21, 2023

View reviewed changes

fix: review comments

bf811c4

- imports - renames Signed-off-by: Tobias Cudnik <[email protected]>

github-advanced-security bot found potential problems Sep 22, 2023

View reviewed changes

chore: format imports

fd3a765

Signed-off-by: Tobias Cudnik <[email protected]>

TobiaszCudnik added 2 commits September 22, 2023 11:02

fix: review renames

a407d98

Signed-off-by: Tobias Cudnik <[email protected]>

chore: remove old env vars refs

f23e835

Signed-off-by: Tobias Cudnik <[email protected]>

TobiaszCudnik requested a review from pinglin September 22, 2023 13:04

pinglin approved these changes Sep 22, 2023

View reviewed changes

TobiaszCudnik merged commit d683002 into main Sep 22, 2023

TobiaszCudnik deleted the tobias/ins-1661-cli-multi-instance-support branch September 22, 2023 17:09

Conversation

TobiaszCudnik commented Sep 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

linear bot commented Sep 15, 2023

Later

Uh oh!

codecov bot commented Sep 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

pinglin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check failure

TobiaszCudnik commented Sep 22, 2023

Uh oh!

pinglin commented Sep 22, 2023

Uh oh!

TobiaszCudnik commented Sep 22, 2023

Uh oh!

pinglin left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

TobiaszCudnik commented Sep 15, 2023 •

edited

Loading

codecov bot commented Sep 15, 2023 •

edited

Loading