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

Include ports in example URLs #2304

Closed
nicklewis opened this issue Oct 29, 2020 · 1 comment · Fixed by #2334
Closed

Include ports in example URLs #2304

nicklewis opened this issue Oct 29, 2020 · 1 comment · Fixed by #2334
Labels
Docs Documentation, hands-on lab, and examples.

Comments

@nicklewis
Copy link
Contributor

nicklewis commented Oct 29, 2020 •
edited by lucywyman
Loading

Describe the Change You Would Like

Everywhere that we document example URLs for services that require ports, we should include the default port. This is
at least an issue for service-url for the pcp transport. We should audit and make sure we update any other examples like that.

As part of this we can raise a warning when puppetdb urls and orchestrator urls don't have a port and instruct users to add a port. Silence this warning by just putting 443.
@nicklewis nicklewis added the Docs Documentation, hands-on lab, and examples. label Oct 29, 2020
@nicklewis
Copy link
Contributor Author

This is also a problem in the bolt_shim module's instructions on connecting Bolt to PE.

lucywyman added a commit to lucywyman/bolt that referenced this issue Nov 11, 2020
@lucywyman
(puppetlabsGH-2304) Set default ports for Puppet services if not spec…
4087b1f 
…ified

Previously, the docs contained a few examples of the `service-url`
config needed to connect Bolt to the Orchestrator that didn't include
the port. Users assumed this meant the port didn't need to be set in
config, and tried to connect to the orchestrator using the default HTTPS
port 443 instead of the typical Orchestrator port 8143. This updates the
documentation to include the port for URLs that don't have standard
ports (80 for HTTP, 443 for HTTPS). It also sets the default ports for
both PuppetDB URLs and Orchestrator URLs to 8081 and 8143 respectively
if the user does not specify a port.

!feature

* **Set default ports for PuppetDB and Orchestrator** ([2304](puppetlabs#2304))

  We now set the ports for PuppetDB `server_urls` and Orchestrator
  `service-url` to 8081 and 8143 respectively if the port is not set in
  config.
@lucywyman lucywyman mentioned this issue Nov 11, 2020
Merged
lucywyman added a commit to lucywyman/bolt that referenced this issue Nov 11, 2020
@lucywyman
(puppetlabsGH-2304) Set default ports for Puppet services if not spec…
9cdc012 
…ified

Previously, the docs contained a few examples of the `service-url`
config needed to connect Bolt to the Orchestrator that didn't include
the port. Users assumed this meant the port didn't need to be set in
config, and tried to connect to the orchestrator using the default HTTPS
port 443 instead of the typical Orchestrator port 8143. This updates the
documentation to include the port for URLs that don't have standard
ports (80 for HTTP, 443 for HTTPS). It also sets the default ports for
both PuppetDB URLs and Orchestrator URLs to 8081 and 8143 respectively
if the user does not specify a port.

!feature

* **Set default ports for PuppetDB and Orchestrator** ([2304](puppetlabs#2304))

  We now set the ports for PuppetDB `server_urls` and Orchestrator
  `service-url` to 8081 and 8143 respectively if the port is not set in
  config.
lucywyman added a commit to lucywyman/bolt that referenced this issue Nov 12, 2020
@lucywyman
(puppetlabsGH-2304) Set default ports for Puppet services if not spec…
67deb34 
…ified

Previously, the docs contained a few examples of the `service-url`
config needed to connect Bolt to the Orchestrator that didn't include
the port. Users assumed this meant the port didn't need to be set in
config, and tried to connect to the orchestrator using the default HTTPS
port 443 instead of the typical Orchestrator port 8143. This updates the
documentation to include the port for URLs that don't have standard
ports (80 for HTTP, 443 for HTTPS). It also sets the default ports for
both PuppetDB URLs and Orchestrator URLs to 8081 and 8143 respectively
if the user does not specify a port.

!feature

* **Set default ports for PuppetDB and Orchestrator** ([2304](puppetlabs#2304))

  We now set the ports for PuppetDB `server_urls` and Orchestrator
  `service-url` to 8081 and 8143 respectively if the port is not set in
  config.
lucywyman added a commit to lucywyman/bolt that referenced this issue Nov 12, 2020
@lucywyman
(puppetlabsGH-2304) Set default ports for Puppet services if not spec…
722d92c 
…ified

Previously, the docs contained a few examples of the `service-url`
config needed to connect Bolt to the Orchestrator that didn't include
the port. Users assumed this meant the port didn't need to be set in
config, and tried to connect to the orchestrator using the default HTTPS
port 443 instead of the typical Orchestrator port 8143. This updates the
documentation to include the port for URLs that don't have standard
ports (80 for HTTP, 443 for HTTPS). It also sets the default ports for
both PuppetDB URLs and Orchestrator URLs to 8081 and 8143 respectively
if the user does not specify a port.

!feature

* **Set default ports for PuppetDB and Orchestrator** ([2304](puppetlabs#2304))

  We now set the ports for PuppetDB `server_urls` and Orchestrator
  `service-url` to 8081 and 8143 respectively if the port is not set in
  config.
beechtom added a commit that referenced this issue Nov 12, 2020
@beechtom
Merge pull request #2334 from lucywyman/GH-2304
5d9a2e4 
(GH-2304) Set default ports for Puppet services if not specified
donoghuc added a commit to donoghuc/bolt that referenced this issue Nov 12, 2020
@donoghuc
(puppetlabsGH-2304) Do not require service-url for pcp config
5b9e8e2 
Given we allow reading orchestrator.conf in the orchestrator-client library, only add a default port to the service-url if one is specified in the pcp config from bolt transport config.
donoghuc added a commit to donoghuc/bolt that referenced this issue Nov 12, 2020
@donoghuc
(puppetlabsGH-2304) Do not require service-url for pcp config
90a5364 
Given we allow reading orchestrator.conf in the orchestrator-client library, only add a default port to the service-url if one is specified in the pcp config from bolt transport config.

!no-release-note
donoghuc added a commit that referenced this issue Nov 13, 2020
@donoghuc
Merge pull request #2348 from donoghuc/fix-pcp-orch.conf
3e6035d 
(GH-2304) Do not require `service-url` for pcp config
dontlaugh pushed a commit to dontlaugh/bolt that referenced this issue Dec 18, 2020
@lucywyman @dontlaugh
(puppetlabsGH-2304) Set default ports for Puppet services if not spec…
a03ead1 
…ified

Previously, the docs contained a few examples of the `service-url`
config needed to connect Bolt to the Orchestrator that didn't include
the port. Users assumed this meant the port didn't need to be set in
config, and tried to connect to the orchestrator using the default HTTPS
port 443 instead of the typical Orchestrator port 8143. This updates the
documentation to include the port for URLs that don't have standard
ports (80 for HTTP, 443 for HTTPS). It also sets the default ports for
both PuppetDB URLs and Orchestrator URLs to 8081 and 8143 respectively
if the user does not specify a port.

!feature

* **Set default ports for PuppetDB and Orchestrator** ([2304](puppetlabs#2304))

  We now set the ports for PuppetDB `server_urls` and Orchestrator
  `service-url` to 8081 and 8143 respectively if the port is not set in
  config.
dontlaugh pushed a commit to dontlaugh/bolt that referenced this issue Dec 18, 2020
@donoghuc @dontlaugh
(puppetlabsGH-2304) Do not require service-url for pcp config
f4000bc 
Given we allow reading orchestrator.conf in the orchestrator-client library, only add a default port to the service-url if one is specified in the pcp config from bolt transport config.

!no-release-note
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs Documentation, hands-on lab, and examples.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

(GH-2304) Set default ports for Puppet services if not specified lucywyman/bolt
1 participant
@nicklewis