Nebari Typer CLI #1443

asmijafar20 · 2022-09-20T15:07:51Z

* Nebari cli: Add files _init.py and main.py * run pre-commit Co-authored-by: iameskild <eskild@doublee.io>

* Nebari typer cli commands * add validate command * Change validate command * add precommit

* Nebari Render Command * add render_template * Add dry-run

* Nebari deploy and destroy commands * Add typer confirm to destroy command * Run pre-commit Co-authored-by: eskild <42120229+iameskild@users.noreply.github.com> Co-authored-by: iameskild <eskild@doublee.io>

* Nebari deploy and destroy commands * Add typer confirm to destroy command * Add deploy arguments and change repository default value * Add rendre design * Run pre-commit Co-authored-by: eskild <42120229+iameskild@users.noreply.github.com> Co-authored-by: iameskild <eskild@doublee.io>

iameskild · 2022-09-21T04:39:54Z

@asmijafar20 based on today's feedback from the team, we need to make the following updates:

Undo dotenv work, replace with os.environ["ENV"] = "VAR" for now
Combine guided-init and init
Flesh out the questions and add more links to our docs
Combine CLI commands into sections

* Remove Usage: dotenv [OPTIONS] COMMAND [ARGS] * Remove pathlib

* Add , , and commands. * Add pre-commit * Add pre-commit * Add pre-commit * Add rich print * Change do_keycloak function * Create two keycloak subcommands Co-authored-by: iameskild <eskild@doublee.io> Co-authored-by: eskild <42120229+iameskild@users.noreply.github.com>

trallard · 2022-09-27T13:02:54Z

Hey folks reminder here that we also need instructions for folks in the team to use this new CLI + docs in the main docs page

iameskild · 2022-10-03T22:09:54Z

Thanks a bunch @pavithraes for the thorough review.

After selecting a cloud provider in the "Where would you like to deploy your Nebari cluster?" question, we get prompts for "Please enter your GOOGLE_CREDENTIALS:", "Please enter your PROJECT_ID:", etc. -- Things typed/pasted here aren't visible to me, but seem to still get registered. Not sure if this is intentional, but I'd personally prefer to know if I typed/pasted the right thing and didn't make any typos here. :)

This is indeed intentional. Would it be better without? I might also change the verbiage to something like Paste your ...

Using CTRL+C to exit the wizard raises a very long error message. I think this can be slightly intimidating to new users, especially the AttributeError at the very end. Would it be possible to simplify this?

Good call! I made a few changes and this shouldn't happen any more 🤘

At the very end (when we display the validate and nebari init commands), maybe we can also include a sentence about next steps, something like:
You can now deploy your Nebari instance with:

$ nebari deploy -c nebari-config.yaml

For more information, run `nebari deploy --help` or check out the documentation: https://www.nebari.dev/how-tos/

Added :)

The white exclamation marks used across the new CLI weren't distinguishable when I was using light mode. We may want to use a different color here?

Definitely, good catch! Just swapped it out for ❗️

The comments (ones starting with the potted plant emoji) seem to be related to questions following it, but are visually closer to the previous questions. Maybe it's worth spacing them equidistant or closer to the following questions?

More space added.

iameskild · 2022-10-03T22:55:20Z

@trallard thanks again for the thorough review :)

I believe I responded to all of your comments. I also opened an issue with a list of possible enhancements: #1478

* Add version Options to Nebari * Add pre-commit Co-authored-by: eskild <42120229+iameskild@users.noreply.github.com>

asmijafar20 · 2022-10-04T13:29:07Z

I think the green colour for links is good. I just made it bold and it's visible in the light theme as well. I preferred green because it follows the Nebari logo colour theme which is really good. I have attached screenshots to decide on which looks better.

asmijafar20 · 2022-10-04T15:39:12Z

Just a mistake in the commit message it is spring_green to green

trallard · 2022-10-04T17:33:13Z

qhub/cli/_init.py

+    if inputs.kubernetes_version == "latest":
+        inputs.kubernetes_version = None


righto - it is fine - what we need to make sure is to add a disclaimer / output saying that the latest available Kubernetes version will be installed as none was provided

trallard · 2022-10-04T17:37:03Z

qhub/cli/_init.py

+    rich.print(
+        (
+            "\n 🪴  Nebari comes with [green]Keycloak[/green], an open-source identity and access management tool. This is how users, groups and roles "
+            "are managed on the platform. To connect Keycloak with an identity provider, you can select one now.\n\n"


yup that will work - might want to add a TODO: in this bit to remind us that it needs doing

trallard · 2022-10-04T17:37:49Z

qhub/cli/_init.py

+        if git_provider == "github.com":
+            inputs.repository_auto_provision = questionary.confirm(
+                f"Would you like the following git repository to be automatically created: {inputs.repository}?",
+                default=False,
+                qmark=qmark,
+            ).ask()


so if I say "no" would it still initialise the local git repo?

trallard · 2022-10-04T17:39:22Z

qhub/cli/_init.py

+        if git_provider == "github.com":
+            inputs.repository_auto_provision = questionary.confirm(
+                f"Would you like the following git repository to be automatically created: {inputs.repository}?",
+                default=False,
+                qmark=qmark,
+            ).ask()


To remove ambiguity I'd suggest something like "Would you like nebari to create a remote repository on f{GIT-provider}?" <- however that variable is

trallard · 2022-10-04T17:39:36Z

qhub/cli/_init.py

+        inputs.namespace = questionary.text(
+            "What namespace would like to use?",
+            default=inputs.namespace,
+            qmark=qmark,
+        ).ask()


much better

qhub/cli/_init.py

viniciusdc · 2022-10-07T01:39:33Z

LGTM, already!! I reviewed the code and couldn't find any flaws, once #1480 is integrated we can do the final review and merge (as the CI will be doing the end-to-end test for deploy and destroy)

trallard

I think we can merge for now - there are plenty of improvements and suggestions in #1478

qhub/cli/_keycloak.py

* Update CI to use new nebari cli entrypoint * Add --disable-prompt to nebari init * Update name of keycloak subcommands * Reorder command * Update command * Minor update to test_e2e * Update hostname used for test_deployment * Another minor update to the tests_e2e * Add --disable-prompt to nebari destroy * use --disable-prompt in ci test * Update .github/workflows/kubernetes_test.yaml Co-authored-by: Vinicius D. Cerutti <51954708+viniciusdc@users.noreply.github.com> * Update kubernetes_test.yaml * Update .github/workflows/kubernetes_test.yaml Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Update qhub/cli/main.py Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Fix yaml * Fix yaml again Co-authored-by: Vinicius D. Cerutti <51954708+viniciusdc@users.noreply.github.com> Co-authored-by: Tania Allard <taniar.allard@gmail.com>

iameskild and others added 14 commits August 28, 2022 21:10

Initial typer CLI implmentation

a122688

edit logic

eb8523f

Nebari cli: Add files _init.py and main.py (#1423)

731bc14

* Nebari cli: Add files _init.py and main.py * run pre-commit Co-authored-by: iameskild <eskild@doublee.io>

Order CLI commands

372fa85

Nebari typer cli commands (#1432)

a9fac68

* Nebari typer cli commands * add validate command * Change validate command * add precommit

Nebari Render Command (#1433)

a445389

* Nebari Render Command * add render_template * Add dry-run

Updates to init

c6142d0

More work on init

9164c20

Nebari deploy and destroy commands (#1436)

6259384

* Nebari deploy and destroy commands * Add typer confirm to destroy command * Run pre-commit Co-authored-by: eskild <42120229+iameskild@users.noreply.github.com> Co-authored-by: iameskild <eskild@doublee.io>

Add guided-init

d3a5877

Nebari Typer CLI

6a31dee

Add pre-commit

decb7b0

Merge branch 'main' into typer_cli

9468910

iameskild added type: enhancement 💅🏼 New feature or request area: user experience 👩🏻‍💻 impact: high 🟥 This issue affects most of the nebari users or is a critical issue status: in review 👀 This PR is currently being reviewed by the team area: nebari-cli labels Sep 22, 2022

Add disable_checks in deploy command

4e66894

iameskild mentioned this pull request Sep 22, 2022

ENH - Run schema validation during qhub init #1267

Closed

iameskild and others added 7 commits September 22, 2022 15:12

Combine guided-init and init, part 1

eafe6f5

Remove dotenv work. (#1472)

fd6a227

* Remove Usage: dotenv [OPTIONS] COMMAND [ARGS] * Remove pathlib

Merge branch 'typer_cli' of github.com:Quansight/qhub into typer_cli

8f93e4a

guided-init clean up

a9ba966

Merge branch 'main' into typer_cli

0e15458

clean up

5a771e4

iameskild added 3 commits October 3, 2022 15:10

Changes from review, part 3

44ef8df

Minor update

edcb910

Changes based review, part 4

4285ebf

iameskild requested review from trallard, pavithraes and iameskild October 3, 2022 23:00

iameskild and others added 2 commits October 3, 2022 19:29

more clean up

8a5739c

Add version options to Nebari CLI (#1476)

6ba50e6

* Add version Options to Nebari * Add pre-commit Co-authored-by: eskild <42120229+iameskild@users.noreply.github.com>

Change colour from blue1 to green and spring_green to blue

acfe29d

trallard requested changes Oct 4, 2022

View reviewed changes

trallard added needs: changes 🧱 Review completed - some changes are needed before merging status: in review 👀 This PR is currently being reviewed by the team and removed status: in review 👀 This PR is currently being reviewed by the team labels Oct 4, 2022

asmijafar20 added 2 commits October 5, 2022 01:45

Add suggested changes, Remove extra spaces

3fbf044

Add pre-commit

54119a9

asmijafar20 added needs: review 👀 This PR is complete and ready for reviewing and removed needs: changes 🧱 Review completed - some changes are needed before merging labels Oct 4, 2022

asmijafar20 commented Oct 6, 2022

View reviewed changes

qhub/cli/_init.py Outdated Show resolved Hide resolved

change kubernetes msg

089da20

iameskild added this to the Release v0.4.5 milestone Oct 7, 2022

trallard mentioned this pull request Oct 7, 2022

META - CLI enhancements #1478

Open

trallard approved these changes Oct 7, 2022

View reviewed changes

qhub/cli/_keycloak.py Show resolved Hide resolved

viniciusdc merged commit 440a75d into main Oct 7, 2022

iameskild deleted the typer_cli branch October 7, 2022 19:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Nebari Typer CLI #1443

Nebari Typer CLI #1443

asmijafar20 commented Sep 20, 2022

iameskild commented Sep 21, 2022 •

edited

trallard commented Sep 27, 2022

iameskild commented Oct 3, 2022

iameskild commented Oct 3, 2022

asmijafar20 commented Oct 4, 2022

asmijafar20 commented Oct 4, 2022

trallard Oct 4, 2022

trallard Oct 4, 2022

trallard Oct 4, 2022

trallard Oct 4, 2022

trallard Oct 4, 2022

viniciusdc commented Oct 7, 2022

trallard left a comment

		if inputs.kubernetes_version == "latest":
		inputs.kubernetes_version = None

Nebari Typer CLI #1443

Nebari Typer CLI #1443

Conversation

asmijafar20 commented Sep 20, 2022

iameskild commented Sep 21, 2022 • edited

trallard commented Sep 27, 2022

iameskild commented Oct 3, 2022

iameskild commented Oct 3, 2022

asmijafar20 commented Oct 4, 2022

asmijafar20 commented Oct 4, 2022

trallard Oct 4, 2022

Choose a reason for hiding this comment

trallard Oct 4, 2022

Choose a reason for hiding this comment

trallard Oct 4, 2022

Choose a reason for hiding this comment

trallard Oct 4, 2022

Choose a reason for hiding this comment

trallard Oct 4, 2022

Choose a reason for hiding this comment

viniciusdc commented Oct 7, 2022

trallard left a comment

Choose a reason for hiding this comment

iameskild commented Sep 21, 2022 •

edited