Add generate subcommand to CLI #17790

twalluxio · 2023-07-17T10:02:46Z

Add generate commands to golang CLI as part of #17522

bin/alluxio docGen -> bin/cli generate docs
bin/alluxio bootstrapConf -> bin/cli generate template

to read ALLUXIO_CONF_DIR, also conducted a minor change on env variables.

alluxio-bot · 2023-07-17T10:02:49Z

Thank you for your pull request.
In order for us to evaluate and accept your PR, we ask that you sign a contribution license agreement (CLA).
It's all electronic and will take just a few minutes. Please download CLA form here, sign, and e-mail back to cla@alluxio.org

ChunxuTang · 2023-07-17T21:42:59Z

Hi @twalluxio, could you sign the CLA and let us know when it's done?

Xenorith

also see comments in #17797

Xenorith · 2023-07-19T01:07:44Z

cli/src/alluxio.org/cli/cmd/generate/template.go

+						fmt.Println("Error writing file:", e)
+						return
+					}
+					fmt.Println(targetDir + " is created.")


use log instead of fmt to print to console. check how existing commands are printing to console as an example

Xenorith · 2023-07-19T01:08:51Z

cli/src/alluxio.org/cli/cmd/generate/template.go

+				fmt.Println("Usage: template <alluxio_master_hostname>")
+				return
+			}
+			targetDir := env.ConfAlluxioConfDir.EnvVar + "alluxio-site.properties"


use filepath.Join for file paths instead of concat/adding strings together

cli/src/alluxio.org/cli/cmd/generate/docs.go

cli/src/alluxio.org/cli/cmd/generate/template.go

Xenorith · 2023-07-19T23:27:20Z

cli/src/alluxio.org/cli/cmd/generate/template.go

+			}
+			targetDir := filepath.Join(env.ConfAlluxioConfDir.EnvVar, "alluxio-site.properties")
+			content := "alluxio.master.hostname=" + args[0]
+			if _, err := os.Stat(targetDir); err != nil {


we can reorganize this logic a little bit to make it less nested and easier to understand
current:

if statError if not exists write file if cannot write error writing file and return log file written and return else error reading and return else warn file exists and return

one less nested level and less return statements:

_, statErr := os.Stat(targetDir) if file exists => os.IsExist(err) warn file exists else if file not exists => os.IsNotExist(err) write file if cannot write error writing file log file written else error reading (and naturally return at end of function)

Co-authored-by: Rico Chiu <Xenorith@users.noreply.github.com>

Kai-Zhang · 2023-07-25T09:24:49Z

alluxio-bot, merge this please

alluxio-bot · 2023-07-25T09:24:50Z

merge failed:
Merge refused because pull request does not have label start with type-

Kai-Zhang · 2023-07-25T09:25:28Z

alluxio-bot, merge this please

Add generate commands to golang CLI as part of #17522 bin/alluxio docGen -> bin/cli generate docs bin/alluxio bootstrapConf -> bin/cli generate template to read ALLUXIO_CONF_DIR, also conducted a minor change on env variables. pr-link: #17790 change-id: cid-7027799df01712f8a76735aabad83814dd09ebaf

Add generate commands to golang CLI as part of Alluxio#17522 bin/alluxio docGen -> bin/cli generate docs bin/alluxio bootstrapConf -> bin/cli generate template to read ALLUXIO_CONF_DIR, also conducted a minor change on env variables. pr-link: Alluxio#17790 change-id: cid-7027799df01712f8a76735aabad83814dd09ebaf

- Add cli/ folder containing golang code - Add script to compile code to executable in build/cli/build-cli.sh - Add entrypoint script for development in bin/cli.sh - Add build profile to build the CLI as part of tha maven build via `-PgoCli` - Add `conf` service, consisting of - `bin/cli.sh conf get` as an example command, equivalent to `bin/alluxio getConf` - `bin/cli.sh conf log --name fully.qualified.class.path`, equivalent to `bin/alluxio fsadmin logLevel --logName fully.qualified.class.path` See #17522 for more background info pr-link: #17532 dev docs for defining conventions for the new alluxio cli in golang pr-link: #17530 - Add commands to start/stop individual processes, ex. `bin/cli.sh process start master` - Define process interface and registry - process specific java opts are defined with the process and are dynamically added to env - Add journal format command as part of starting master process - Mount options for worker are not ported because they will be deprecated in the near future pr-link: #17561 Adds `info` subcommand, which contains: - `cache`: worker capacity information, calls the existing `bin/alluxio fsadmin report capacity` command - `collect`: collects cluster information into a single tarball, calls the existing `bin/alluxio collectInfo` command - `master`: master quorum information, calls the existing `bin/alluxio fs masterInfo` command - `report`: cluster information, calls the existing `bin/alluxio fsadmin report` command, excluding the `capacity` category pr-link: #17566 Add journal commands to CLI as part of #17522 pr-link: #17569 Add quorum/HA related commands as part of #17522 pr-link: #17570 Add fs commands to golang CLI as part of #17522 unlike other CLI commands, utilize arguments to maintain the existing structure of filesystem commands (ex. cp, du, ls, mv, rm, etc) pr-link: #17580 Add generate commands to golang CLI as part of #17522 bin/alluxio docGen -> bin/cli generate docs bin/alluxio bootstrapConf -> bin/cli generate template to read ALLUXIO_CONF_DIR, also conducted a minor change on env variables. pr-link: #17790 Add exec commands to golang CLI as part of #17522 `bin/alluxio runClass` -> `bin/cli exec class` `bin/alluxio runTests` -> `bin/cli exec testRun` `bin/alluxio runUfsTests` -> `bin/cli exec testUfs` `bin/alluxio runUfsIOTest` -> `bin/cli exec testUfsIO` `bin/alluxio runHdfsMountTests` -> `bin/cli exec testHdfsMount` `bin/alluxio runHmsTests` -> `bin/cli exec testHms` `bin/alluxio runJournalCrashTest` -> `bin/cli exec testJournalCrash` For command `exec test`, using different `--name` flags can lead to huge difference in other flags and options. To manage flags and options, currently using different commands for different test types. pr-link: #17797 Prepare golang cli for tarball build and replace bin/alluxio allow java 8 or 11 add cli binaries to other tarball profiles Add `process` commands with multiple nodes to golang CLI as part of #17522 `bin/alluxio-start.sh masters` -> `bin/cli.sh process start masters` `bin/alluxio-start.sh job_masters` -> `bin/cli.sh process start job_masters` `bin/alluxio-start.sh workers` -> `bin/cli.sh process start workers` `bin/alluxio-start.sh job_workers` -> `bin/cli.sh process start job_workers` `bin/alluxio-start.sh proxies` -> `bin/cli.sh process start proxies` `bin/alluxio-start.sh all` -> `bin/cli.sh process start all` `bin/alluxio-start.sh local` -> `bin/cli.sh process start local` `bin/alluxio-stop.sh masters` -> `bin/cli.sh process stop masters` `bin/alluxio-stop.sh job_masters` -> `bin/cli.sh process stop job_masters` `bin/alluxio-stop.sh workers` -> `bin/cli.sh process stop workers` `bin/alluxio-stop.sh job_workers` -> `bin/cli.sh process stop job_workers` `bin/alluxio-stop.sh proxies` -> `bin/cli.sh process stop proxies` `bin/alluxio-stop.sh all` -> `bin/cli.sh process stop all` `bin/alluxio-stop.sh local` -> `bin/cli.sh process stop local` For command `process start/stop` on multiple nodes, using crypto's `ssh` package to create an SSH session, connect to masters, workers or all nodes, then send according subcommand on single nodes to these nodes. pr-link: #17887 Add job commands to golang CLI as part of #17522 `bin/alluxio-bash job cancel id` -> `bin/alluxio job cancel --id` `bin/alluxio-bash job leader` -> `bin/alluxio job leader` `bin/alluxio-bash job ls` -> `bin/alluxio job list` `bin/alluxio-bash job getCmdStatus jobControlId` -> `bin/alluxio job cmdStatus --id` `bin/alluxio-bash job stat [-v] id` -> `bin/alluxio job jobStatus [-v] --id` `bin/alluxio-bash fs distributedCp src dst` -> `bin/alluxio job submit --type cp --src --dst` `bin/alluxio-bash fs distributedMv src dst` -> `bin/alluxio job submit --type mv --src --dst` `bin/alluxio-bash fs load path --submit` -> `bin/alluxio job load --path` pr-link: #17931 Clean up multiprocess code - refactor commands launching the same process on multiple hosts into a single struct - simplify the logic to ssh into different hosts with more straightforward handling of error channel - move names.go under its own package to avoid import cycles pr-link: #17947 Add an `info version` subcommand to golang CLI as part of #17522 `bin/alluxio-bash version` -> `bin/alluxio info version` pr-link: #17943 update calls to old bash scripts to refer to alluxio-bash Add `cache` commands to golang CLI as part of #17522 `bin/alluxio-bash formatWorker` -> `bin/cli cache format` `bin/alluxio-bash fs freeWorker` -> `bin/cli cache free --worker` `bin/alluxio-bash fs free` -> `bin/cli cache free [-f] --path` `bin/alluxio-bash fs persist` -> `bin/cli cache persist --path` `bin/alluxio-bash fs setTtl` -> `bin/cli cache ttl --set --duration --action` `bin/alluxio-bash fs unsetTtl` -> `bin/cli cache ttl --unset` pr-link: #17937 backcompat support for start/stop scripts skip mount args in start script backcompat remove unsupported cmds

twalluxio added 3 commits July 17, 2023 17:56

Add generate docs subcommand to CLI

61ed342

Add generate template subcommand to CLI; edited env variables

379c9f3

Add generate command to CLI

b1d201e

alluxio-bot added the cla-missing label Jul 17, 2023

This comment was marked as off-topic.

Sign in to view

Kai-Zhang requested a review from Xenorith July 18, 2023 08:39

Zijian-Zhu removed the cla-missing label Jul 18, 2023

Xenorith requested changes Jul 19, 2023

View reviewed changes

twalluxio added 2 commits July 19, 2023 10:01

use log instead of fmt to print to console, use filepath.Join

1fe162d

removed fetchValue function & format update

49d0626

Xenorith requested changes Jul 19, 2023

View reviewed changes

twalluxio and others added 6 commits July 20, 2023 09:21

Update cli/src/alluxio.org/cli/cmd/generate/docs.go

82e52a8

Co-authored-by: Rico Chiu <Xenorith@users.noreply.github.com>

Update cli/src/alluxio.org/cli/cmd/generate/template.go

06188ed

Co-authored-by: Rico Chiu <Xenorith@users.noreply.github.com>

Update cli/src/alluxio.org/cli/cmd/generate/docs.go

18a94de

Co-authored-by: Rico Chiu <Xenorith@users.noreply.github.com>

Update cli/src/alluxio.org/cli/cmd/generate/template.go

66bafae

Co-authored-by: Rico Chiu <Xenorith@users.noreply.github.com>

Update cli/src/alluxio.org/cli/cmd/generate/template.go

ef5e14f

Co-authored-by: Rico Chiu <Xenorith@users.noreply.github.com>

polished logic in template.go

08aa9c9

Xenorith approved these changes Jul 20, 2023

View reviewed changes

Kai-Zhang added the type-devops Build, deploy, and maintain devops questions label Jul 25, 2023

alluxio-bot merged commit 16f885b into Alluxio:golangCli Jul 25, 2023
17 checks passed

twalluxio deleted the golangCli-generate branch July 25, 2023 10:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add generate subcommand to CLI #17790

Add generate subcommand to CLI #17790

twalluxio commented Jul 17, 2023 •

edited

Loading

alluxio-bot commented Jul 17, 2023

ChunxuTang commented Jul 17, 2023

This comment was marked as off-topic.

Xenorith left a comment

Xenorith Jul 19, 2023

Xenorith Jul 19, 2023

Xenorith Jul 19, 2023

Kai-Zhang commented Jul 25, 2023

alluxio-bot commented Jul 25, 2023

Kai-Zhang commented Jul 25, 2023

Add generate subcommand to CLI #17790

Add generate subcommand to CLI #17790

Conversation

twalluxio commented Jul 17, 2023 • edited Loading

alluxio-bot commented Jul 17, 2023

ChunxuTang commented Jul 17, 2023

This comment was marked as off-topic.

Xenorith left a comment

Choose a reason for hiding this comment

Xenorith Jul 19, 2023

Choose a reason for hiding this comment

Xenorith Jul 19, 2023

Choose a reason for hiding this comment

Xenorith Jul 19, 2023

Choose a reason for hiding this comment

Kai-Zhang commented Jul 25, 2023

alluxio-bot commented Jul 25, 2023

Kai-Zhang commented Jul 25, 2023

twalluxio commented Jul 17, 2023 •

edited

Loading