Merge pull request #8353 from GabrielNagy/PUP-10670/add-serverport-setting

(PUP-10670) Create `serverport` setting and alias

Author: joshcooper

acceptance/tests/environment/can_enumerate_environments.rb

@@ -6,8 +6,8 @@
 
 confine :except, :platform => /osx/ # see PUP-4820
 
-def master_port(agent)
-  setting_on(agent, "agent", "masterport")
+def server_port(agent)
+  setting_on(agent, "agent", "serverport")
 end
 
 def setting_on(host, section, name)
@@ -23,7 +23,7 @@ def full_path(host, path)
 end
 
 def curl_master_from(agent, path, headers = '', &block)
-  url = "https://#{master}:#{master_port(agent)}#{path}"
+  url = "https://#{master}:#{server_port(agent)}#{path}"
   cert_path = full_path(agent, setting_on(agent, "agent", "hostcert"))
   key_path = full_path(agent, setting_on(agent, "agent", "hostprivkey"))
   curl_base = "curl --tlsv1 -sg --cert \"#{cert_path}\" --key \"#{key_path}\" -k -H '#{headers}'"
@@ -59,7 +59,7 @@ def curl_master_from(agent, path, headers = '', &block)
 
 with_puppet_running_on(master, master_opts) do
   step "Ensure that an unauthenticated client cannot access the environments list" do
-    on master, "curl --tlsv1 -ksv https://#{master}:#{master_port(master)}/puppet/v3/environments", :acceptable_exit_codes => [0,7] do
+    on master, "curl --tlsv1 -ksv https://#{master}:#{server_port(master)}/puppet/v3/environments", :acceptable_exit_codes => [0,7] do
       assert_match(/< HTTP\/1\.\d 403/, stderr)
     end
   end

docs/http.md

@@ -234,9 +234,9 @@ The resolver selects a route based on the puppet settings for that service:
 | service    | server setting | port setting |
 |------------|----------------|--------------|
 | ca         | ca_server      | ca_port      |
-| fileserver | server         | masterport   |
+| fileserver | server         | serverport   |
 | report     | report_server  | report_port  |
-| puppet     | server         | masterport   |
+| puppet     | server         | serverport   |
 
 For example, `route_to(:report)` would use `Puppet[:report_server]` and
 `Puppet[:report_port]`.

lib/puppet/application/agent.rb

@@ -103,7 +103,7 @@ def help
 puppet agent [--certname <NAME>] [-D|--daemonize|--no-daemonize]
   [-d|--debug] [--detailed-exitcodes] [--digest <DIGEST>] [--disable [MESSAGE]] [--enable]
   [--fingerprint] [-h|--help] [-l|--logdest syslog|eventlog|<ABS FILEPATH>|console]
-  [--masterport <PORT>] [--noop] [-o|--onetime] [--sourceaddress <IP_ADDRESS>] [-t|--test]
+  [--serverport <PORT>] [--noop] [-o|--onetime] [--sourceaddress <IP_ADDRESS>] [-t|--test]
   [-v|--verbose] [-V|--version] [-w|--waitforcert <SECONDS>]
 
 
@@ -277,8 +277,9 @@ def help
   format.
 
 * --masterport:
-  The port on which to contact the puppet master.
-  (This is a Puppet setting, and can go in puppet.conf.)
+  The port on which to contact the Puppet Server.
+  (This is a Puppet setting, and can go in puppet.conf.
+  Deprecated in favor of the 'serverport' setting.)
 
 * --noop:
   Use 'noop' mode where the daemon runs in a no-op or dry-run mode. This
@@ -294,6 +295,10 @@ def help
   (This is a Puppet setting, and can go in puppet.conf. Note the special 'no-'
   prefix for boolean settings on the command line.)
 
+* --serverport:
+  The port on which to contact the Puppet Server.
+  (This is a Puppet setting, and can go in puppet.conf.)
+
 * --sourceaddress:
   Set the source IP address for transactions. This defaults to automatically selected.
   (This is a Puppet setting, and can go in puppet.conf.)

lib/puppet/defaults.rb

@@ -1353,11 +1353,18 @@ def self.initialize_default_settings!(settings)
       by `puppet`, and should only be set if you're writing your own Puppet
       executable.",
     },
+    :serverport => {
+      :default    => "8140",
+      :desc       => "The default port puppet subcommands use to communicate
+      with Puppet Server. (eg `puppet facts upload`, `puppet agent`). May be
+      overridden by more specific settings (see `ca_port`, `report_port`).",
+    },
     :masterport => {
-      :default    => 8140,
+      :default    => "$serverport",
       :desc       => "The default port puppet subcommands use to communicate
       with Puppet Server. (eg `puppet facts upload`, `puppet agent`). May be
       overridden by more specific settings (see `ca_port`, `report_port`).",
+      :hook => proc { |value| Puppet[:serverport] = value }
     },
     :node_name => {
       :default    => 'cert',
@@ -1719,7 +1726,7 @@ def self.initialize_default_settings!(settings)
       and does not need to horizontally scale.",
     },
     :ca_port => {
-      :default    => "$masterport",
+      :default    => "$serverport",
       :desc       => "The port to use for the certificate authority.",
     },
     :preferred_serialization_format => {
@@ -1808,7 +1815,7 @@ def self.initialize_default_settings!(settings)
       :desc     => "The server to send transaction reports to.",
     },
     :report_port => {
-      :default  => "$masterport",
+      :default  => "$serverport",
       :desc     => "The port to communicate with the report_server.",
     },
     :report => {

lib/puppet/face/status.rb

@@ -26,7 +26,7 @@
 
     Over REST, this action will query the configured puppet master by default.
     To query other servers, including puppet agent nodes started with the
-    <--listen> option, you can set the global <--server> and <--masterport>
+    <--listen> option, you can set the global <--server> and <--serverport>
     options on the command line; note that agent nodes listen on port 8139.
   EOT
   find.short_description <<-EOT

lib/puppet/file_bucket/dipper.rb

@@ -16,7 +16,7 @@ class Puppet::FileBucket::Dipper
   def initialize(hash = {})
     # Emulate the XMLRPC client
     server      = hash[:Server]
-    port        = hash[:Port] || Puppet[:masterport]
+    port        = hash[:Port] || Puppet[:serverport]
 
     if hash.include?(:Path)
       @local_path = hash[:Path]

lib/puppet/http/client.rb

@@ -438,7 +438,7 @@ def build_resolvers
         services.delete(:report)
       end
 
-      resolvers << Puppet::HTTP::Resolver::ServerList.new(self, server_list_setting: server_list_setting, default_port: Puppet[:masterport], services: services)
+      resolvers << Puppet::HTTP::Resolver::ServerList.new(self, server_list_setting: server_list_setting, default_port: Puppet[:serverport], services: services)
     end
 
     resolvers << Puppet::HTTP::Resolver::Settings.new(self)

lib/puppet/http/service/compiler.rb

@@ -22,7 +22,7 @@ class Puppet::HTTP::Service::Compiler < Puppet::HTTP::Service
   #   create the service.
   #
   def initialize(client, session, server, port)
-    url = build_url(API, server || Puppet[:server], port || Puppet[:masterport])
+    url = build_url(API, server || Puppet[:server], port || Puppet[:serverport])
     super(client, session, url)
   end
 

lib/puppet/http/service/file_server.rb

@@ -27,7 +27,7 @@ class Puppet::HTTP::Service::FileServer < Puppet::HTTP::Service
   #   create the service.
   #
   def initialize(client, session, server, port)
-    url = build_url(API, server || Puppet[:server], port || Puppet[:masterport])
+    url = build_url(API, server || Puppet[:server], port || Puppet[:serverport])
     super(client, session, url)
   end
 

lib/puppet/http/service/puppetserver.rb

@@ -14,7 +14,7 @@ class Puppet::HTTP::Service::Puppetserver < Puppet::HTTP::Service
   # @api private
   #
   def initialize(client, session, server, port)
-    url = build_url('', server || Puppet[:server], port || Puppet[:masterport])
+    url = build_url('', server || Puppet[:server], port || Puppet[:serverport])
     super(client, session, url)
   end