From 8397a4a0cec935706aa364ef02cbb971cd5ebbac Mon Sep 17 00:00:00 2001 From: Tim Meusel Date: Mon, 20 Feb 2023 15:15:47 +0100 Subject: [PATCH 1/2] README.md: Fix cacert documentation The cacert option isn't mandatory: https://github.com/puppetlabs/orchestrator_client-ruby/blob/master/lib/orchestrator_client/config.rb#L31-L36 --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8529ff5..5bfbbc0 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ expected to be at `~/.puppetlabs/token` which is the default location used by ### initialization Settings * `service-url` **[required]** - Base URL for the location of the Orchestrator API service -* `cacert` **[required]** - Path to the CA certificate file needed to verify the SSL connection to the API. +* `cacert` - Path to the CA certificate file needed to verify the SSL connection to the API. * `token-file`- Path to a file with the RBAC token in it (defaults to `~/.puppetlabs/token`) * `token` - Pass directly the RBAC token, if specified the token will be used instead of a token from file. * `User-Agent`- Set `User-Agent` header for HTTP requests. Defaults to `OrchestratorRubyClient/[VERSION]` @@ -37,11 +37,10 @@ expected to be at `~/.puppetlabs/token` which is the default location used by require 'orchestrator_client' # Create a new client -# Requires at least a server name and path to the CA certificate +# Requires at least a server name client = OrchestratorClient.new({ 'service-url' => 'https://orchestrator.example.lan:8143/orchestrator/v1', - 'cacert' => '/path/to/cert' }) ## Access endpoints through the client object From f314fc15b7e6a06ba7f2eadf62dfec5383eb6318 Mon Sep 17 00:00:00 2001 From: Tim Meusel Date: Tue, 1 Oct 2024 20:25:57 +0200 Subject: [PATCH 2/2] Update README.md Co-authored-by: Cas Donoghue --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5bfbbc0..3d07c23 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ expected to be at `~/.puppetlabs/token` which is the default location used by ### initialization Settings * `service-url` **[required]** - Base URL for the location of the Orchestrator API service -* `cacert` - Path to the CA certificate file needed to verify the SSL connection to the API. +* `cacert` - Path to the CA certificate file needed to verify the SSL connection to the API (defaults to `/etc/puppetlabs/puppet/ssl/certs/ca.pem`). * `token-file`- Path to a file with the RBAC token in it (defaults to `~/.puppetlabs/token`) * `token` - Pass directly the RBAC token, if specified the token will be used instead of a token from file. * `User-Agent`- Set `User-Agent` header for HTTP requests. Defaults to `OrchestratorRubyClient/[VERSION]`