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.

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

Update documentation to cover both new and classic config formats #161

Merged
merged 80 commits into from
Mar 23, 2016

Conversation

michaelklishin
Copy link
Member

@michaelklishin michaelklishin added this to the n/a milestone Feb 24, 2016
<pre class="example">
%% advanced.config
%% See HTTP backend docs for details
{rabbitmq_auth_backend_http,
Copy link
Contributor

Choose a reason for hiding this comment

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

http.user_path
http.vhost_path
http.resource_path
are defined in http backend plugin schema rabbitmq/rabbitmq-auth-backend-http@571937f
will look like

http.user_path = http://my-authenticator-app/auth/user
http.vhost_path = http://my-authenticator-app/auth/vhost
http.resource_path = http://my-authenticator-app/auth/resource

documentation</a>.
<p>Default: <code>[]</code></p>
<p>Default: <code>none</code></p>
Copy link
Contributor

Choose a reason for hiding this comment

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

If none is defined, none of other options will work.
For example:

ssl_options = none
ssl_options.verify = verify_peer

Equivalent to

ssl_options = none

Copy link
Member Author

Choose a reason for hiding this comment

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

The only idea I have is to set "undefined", which can lead to exactly the same problem. Yeah, I don't think many will fall into this trap.

Copy link
Member

Choose a reason for hiding this comment

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

To be consistent with other examples, you should recall the parameter:

<p>Default: <code>ssl_options = none</code></p>

@hairyhum
Copy link
Contributor

@michaelklishin: do we want auth_backends, auth_mechanisms and cluster_nodes to have none option?

@michaelklishin
Copy link
Member Author

@hairyhum I think it would be helpful in case someone uncomments/uses the default value unintentionally.

@michaelklishin
Copy link
Member Author

for auth_backends and auth_mechanisms, having no value will reject all client connections, so that probably should fail validation.

@hairyhum
Copy link
Contributor

So it's better to leave it without none

loopback_users = none
</pre>

Or, in the <a href="/configure.html#erlang-term-config-file">classic config file format</a> (<code>rabbitmq.config</code>):
Copy link
Member

Choose a reason for hiding this comment

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

I would use "legacy" instead of "classic" to designate the old file formar.

Copy link
Member Author

Choose a reason for hiding this comment

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

We still support this format, and it is still used in the advanced config. It would be odd to call something legacy and then use it for both backwards compatibility and advanced cases.

@@ -105,7 +105,7 @@ Or using classic config format:

<pre class="code">
listeners.tcp.1 = 127.0.0.1:5672
listeners.tcp.2 = ::1:5672
listeners.tcp.2 = [::1]:5672
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be added to example snippets in rabbitmq_tests

Copy link
Member Author

Choose a reason for hiding this comment

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

I've added it and waiting for the test suite to finish.

Copy link
Member Author

Choose a reason for hiding this comment

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

I reverted that change due to basho/cuttlefish#216. We'll work on that later.

This reverts commit 1a06ba5.

Due to basho/cuttlefish#216. We will deal
with that later. FWIW values such as ::1:5672 parse successfully.
@@ -83,12 +83,18 @@ Disabling disk free space monitoring</pre>
required to be free on the database partition. (See the description of
<a href="/relocate.html">file locations</a> for the default location).
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure from the context here what the "default location" is referring to. Is it the free disk space limit?

Copy link
Member Author

Choose a reason for hiding this comment

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

Default database location.

On 22 mar 2016, at 21:48, Brandon Shroyer [email protected] wrote:

In site/disk-alarms.xml:

@@ -83,12 +83,18 @@ Disabling disk free space monitoring
required to be free on the database partition. (See the description of
file locations for the default location).
I'm not sure from the context here what the "default location" is referring to. Is it the free disk space limit?


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub

@michaelklishin michaelklishin merged commit d1f5f4a into master Mar 23, 2016
@gerhard gerhard deleted the rabbitmq-server-550 branch May 19, 2017 12:30
jeffweiss pushed a commit to jeffweiss/rabbitmq-website that referenced this pull request Jul 10, 2018
Remove unnecessary to_i in worker.rb in ruby tutorials
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants