Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GEODE-7707: Tab completing '--url' on 'connect' gives two default values #5061

Merged
merged 2 commits into from May 8, 2020
Merged

GEODE-7707: Tab completing '--url' on 'connect' gives two default values #5061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
960f33b
GEODE-7707: Tab completing '--url' on 'connect' gives two default values
alb3rtobr May 6, 2020
1a87e32
GEODE-7707: Align examples in doc and code
alb3rtobr May 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 1 addition & 6 deletions geode-core/src/main/java/org/apache/geode/management/internal/i18n/CliStrings.java
View file
Open in desktop
Expand Up @@ -548,13 +548,8 @@ public class CliStrings {
public static final String CONNECT__LOCATOR__HELP =
"Network address of the Locator in the form: host[port].";
public static final String CONNECT__URL = "url";
public static final String CONNECT__DEFAULT_BASE_URL =
"http://localhost:" + DistributionConfig.DEFAULT_HTTP_SERVICE_PORT + "/geode-mgmt/v1";
public static final String CONNECT__DEFAULT_SSL_BASE_URL =
"https://localhost:" + DistributionConfig.DEFAULT_HTTP_SERVICE_PORT + "/geode-mgmt/v1";
public static final String CONNECT__URL__HELP =
"Indicates the base URL to the Manager's HTTP service. For example: 'http://<host>:<port>/gemfire/v1' Default is '"
+ CONNECT__DEFAULT_BASE_URL + "'";
"Indicates the base URL to the Manager's HTTP service. For example: 'http://<host>:<port>/geode-mgmt/v1'";
public static final String CONNECT__USE_HTTP = "use-http";
public static final String CONNECT__USE_HTTP__HELP =
"[Deprecated: inferred by the presence of --url]. Connects to Manager by sending HTTP requests to HTTP service hosting the Management REST API. You must first 'disconnect' in order to reconnect to the Manager via locator or jmx-manager using JMX.";
Expand Down
25 changes: 11 additions & 14 deletions geode-docs/tools_modules/gfsh/command-pages/connect.html.md.erb
View file
Open in desktop
Expand Up @@ -72,16 +72,13 @@ connect [--locator=value] [--jmx-manager=value] [--use-http(=value)?] [--url=val
</tr>
<tr>
<td><span class="keyword parmname">\-\-use-http</span></td>
<td>Connects to a JMX manager HTTP service using the HTTP protocol.</td>
<td><ul>
<li>If the parameter is not specified: <code class="ph codeph">false</code></li>
<li>If the parameter is specified without a value: <code class="ph codeph">true</code></li>
</ul></td>
<td><b>Deprecated: inferred by the presence of --url.</b> Connects to a JMX manager HTTP service using the HTTP protocol.</td>
<td></td>
</tr>
<tr>
<td><span class="keyword parmname">\-\-url</span></td>
<td>URL used to connect to a JMX manager's HTTP service</td>
<td><code class="ph codeph">http://localhost:8080/gemfire/v1</code></td>
<td>URL used to connect to a JMX manager's HTTP service.</td>
<td></td>
</tr>
<tr>
<td><span class="keyword parmname">\-\-user</span></td>
Expand Down Expand Up @@ -178,16 +175,16 @@ gfsh>connect
``` pre
gfsh>connect
Connecting to Locator at [host=localhost, port=10334] ..
Connecting to Manager at [host=GemFireStymon, port=1099] ..
Successfully connected to: [host=GemFireStymon, port=1099]
Connecting to Manager at [host=GeodeStymon, port=1099] ..
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 178 & 179 are just host names, but as they are the only referece left to "GemFire" I changed it to "Geode"

Successfully connected to: [host=GeodeStymon, port=1099]
```

**Example of connecting to a remote locator over HTTP:**

``` pre
gfsh>connect --use-http=true --url="http://myLocatorHost.example.com:8080/gemfire/v1"
Successfully connected to: GemFire Manager's HTTP service @
http://myLocatorHost.example.com:8080/gemfire/v1
gfsh>connect --url="http://myLocatorHost.example.com:8080/geode-mgmt/v1"
Successfully connected to: Geode Manager's HTTP service @
http://myLocatorHost.example.com:8080/geode-mgmt/v1
```

**Error Messages:**
Expand All @@ -196,8 +193,8 @@ http://myLocatorHost.example.com:8080/gemfire/v1
"Locator could not find a JMX Manager";
"jmx password must be specified.";
"Could not connect to : {0}. {1}";
"Could not find a GemFire jmx-manager service running at {0}.";
"Could not find a Geode jmx-manager service running at {0}.";
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have changed lines 196 & 199 to show how these strings really look (they are defined in CliStrings.java)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alb3rtobr @moleske +1 good catch.

"--token requires a value, for example --token=foo";
"--token cannot be combined with --user or --password";
"Could not connect to GemFire Locator service at {0}."
"Could not connect to Geode Locator service at {0}."
```