roxy
roxy copied to clipboard
marklogic-community
capture help doesn't show all options
$ ./ml capture -h
Usage: ml {env} capture --modules-db=[name of modules database]
Captures the source and REST API configuration for an existing
Application Builder-based application.
modules-db: (required)
The modules database of the App Builder application.
The capture command provides additional options, like --full-ml-config, --ml-config, and --app-builder. Update the help command to show those options and what they do.
I kept them undocumented so far as they were still kind of experimental. If you think they have proven themselves well enough, and are robust enough as they are, then yes, we need to document them. Let me provide a description here now to be sure. How about something like:
Usage #1: ml {env} capture --app-builder=[name of app server]
Captures the modules and REST API configuration for the specified
Application Builder-based application server.
Usage #2: ml {env} capture --modules-db=[name of modules database]
Captures modules files from the specified modules database.
Usage #3: ml {env} capture --full-ml-config
Captures all server and database configurations from the target
environment.
Usage #4: ml {env} capture --ml-config [--databases=...] [--servers=...]
Captures partial server and database configurations from the target
environment. By default those from the current project. Target others
using --databases and --servers using comma-separated names.
I would change usage 4 to:
Captures specified server and database configurations from the target
environment, defaulting to those from the current project. Target others
using --databases and --servers using comma-separated names.
Is it also worthwhile to include a warning that the command may overwrite files in your project, so they should be checked in, or does running the command give that warning?
The config captures write to ml-config-{env}.xml, so don't overwrite ml-config.xml. The modules captures do potentially overwrite files, but that is existing code. Not sure that is giving a warning, might be good to add to the code itself..
Hello, a new Roxy user here. I was just about to file an issue ticket on this exact same thing. I think it would be very helpful to new users to have the complete documentation for "ml capture" returned in the help text -- I knew that roxy could return full configuration information only from googling "roxy capture" and finding a couple of blog posts about using --full-ml-config.
Yeah, the suggested help text in here is most recent, but even that might be little outdated, since I think there was some work done on capturing security stuff as well..