Bug 1470653

Summary: capsule-certs-generate fails with "Parameter certs-tar invalid: ... is not one of regexes matching Error during configuration"
Product: Red Hat Satellite Reporter: Peter Ondrejka <pondrejk>
Component: Docs Install GuideAssignee: csherrar
Status: CLOSED CURRENTRELEASE QA Contact: Michaela Slaninkova <mslanink>
Severity: low Docs Contact:
Priority: low    
Version: 6.3.0CC: adahms, bbuckingham, csherrar, ddolguik, ehelms, inecas, jalviso, pondrejk, swadeley
Target Milestone: UnspecifiedKeywords: Triaged
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-01-08 00:18:03 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Peter Ondrejka 2017-07-13 11:58:27 UTC
Description of problem:

Calling capsule-certs-generate with --certs-tar value enclosed in quote marks (just like instructed in documetation -- https://access.redhat.com/documentation/en-us/red_hat_satellite/6.2/html-single/installation_guide/#installing_capsule_server) results in error:

# capsule-certs-generate --node-fqdn "mycapsule.example.com" --certs-tar "~/mycapsule.cexample.com-certs.tar"
Parameter certs-tar invalid: ~/mycapsule.cexample.com-certs.tar is not one of regexes matching /^(([a-zA-Z]:[\\\/Error during configuration, exiting

Supplying the value without quotes results in successful certs creation.

Version-Release number of selected component (if applicable):

satellite-6.3.0-16.0.beta.el7sat.noarch

How reproducible:

always

Actual results:
Error

Expected results:
no Error, or more instructive message

Comment 1 Brad Buckingham 2017-07-18 20:49:40 UTC
Peter, is this a regression from 6.2?

Comment 3 Eric Helms 2017-07-27 19:25:57 UTC
This sounds like a documentation bug if we could flag it as such to update the docs to exclude the quotes.

Comment 4 Ivan Necas 2017-08-08 08:47:39 UTC
Moving to `Documentation`, as `ls "~/.ssh"` doesn't work for ~ extrapolation, we should not expect the installer doing more logic around that. We should not instruct people to use invalid way of passing paths to CLI tools.

Comment 5 Andrew Dahms 2017-08-09 06:56:27 UTC
Assigning to Charles for review.

Comment 6 Peter Ondrejka 2017-08-14 08:06:06 UTC
(In reply to Brad Buckingham from comment #1)
> Peter, is this a regression from 6.2?

Hey, I don't remember this happening in 6.2, though I might be wrong. I'm ok with passing this to docs, though the displayed message could be improved.

Comment 8 Andrew Dahms 2017-09-07 01:40:16 UTC
Assigning to Clifton to follow up on any changes required for this bug.

Comment 10 csherrar 2017-11-01 17:42:31 UTC
(In reply to Peter Ondrejka from comment #9)

> Clifton, can you please watch
> https://bugzilla.redhat.com/show_bug.cgi?id=1466688 and update docs
> accordingly? There is also a similar problem with satellite-change-hostname
> but I'll notify Russel in the related bug
> https://bugzilla.redhat.com/show_bug.cgi?id=1451564
> 
> Cheers

Hi Peter,

I will follow the linked bug and update the docs accordingly.

Thanks

Comment 12 Stephen Wadeley 2017-11-08 09:40:45 UTC
Hello

Re: the tilde

I think we can just drop ~/ and not replace it with /root as this is the root user's home directory.

If the reader follows the instructions as we write them then it will just work.

Comment 13 csherrar 2017-11-08 09:55:20 UTC
(In reply to Stephen Wadeley from comment #11)
> Hello

Hi Stephen,

BZ#1466688 has not been verified or closed yet. Shall I proceed anyway with the current recommendations?

BZ#1470653: Replace tilda with /root/

> /root/mycapsule.example.com-certs.tar instead of
> ~/mycapsule.example.com-certs.tar

BZ#1451564: Replace --capsule-parent-fqdn

> Procedure 7.8. Rename a Satellite Server:
> -- step 5 needs --foreman-proxy-content-parent-fqdn instead of
> --capsule-paretnt-fqdn

Regards,

Comment 17 Stephen Wadeley 2017-11-08 10:35:34 UTC
(In reply to csherrar from comment #13)
> (In reply to Stephen Wadeley from comment #11)
> > Hello
> 
> Hi Stephen,
> 
> BZ#1466688 has not been verified or closed yet. Shall I proceed anyway with
> the current recommendations?
You do not *have* to wait for that one to clear. We can see from Ivan's comments[1][2] that the important thing is for Docs not to have ~/ inside double quotation marks.
We should keep commands as simple as possible and remove "" when they are not required.
If there is a space in some command argument, then you need to quote that.

> 
> BZ#1470653: Replace tilda with /root/
> 
> > /root/mycapsule.example.com-certs.tar instead of
> > ~/mycapsule.example.com-certs.tar

See my comment 12
> 
> BZ#1451564: Replace --capsule-parent-fqdn
> 
> > Procedure 7.8. Rename a Satellite Server:
> > -- step 5 needs --foreman-proxy-content-parent-fqdn instead of
> > --capsule-paretnt-fqdn
> 
Russell raised BZ#1510718 to fix that. I think that is not related to ~/ or "".

I suggest you wait a few more days for some of my bugs to be resolved and make their way to master.
e.g.: BZ#1504280 and BZ#1490043

Most of these issue should be gone then.

Thank you


[1] https://bugzilla.redhat.com/show_bug.cgi?id=1466688#c5
[2] https://bugzilla.redhat.com/show_bug.cgi?id=1470653#c4

Comment 18 csherrar 2017-11-08 10:51:11 UTC
(In reply to Stephen Wadeley from comment #17)

> You do not *have* to wait for that one to clear. We can see from Ivan's
> comments[1][2] that the important thing is for Docs not to have ~/ inside
> double quotation marks.
> We should keep commands as simple as possible and remove "" when they are
> not required.
> If there is a space in some command argument, then you need to quote that.

Thanks, I will be more proactive and apply recommendations as tickets develop.

> I suggest you wait a few more days for some of my bugs to be resolved and
> make their way to master.
> e.g.: BZ#1504280 and BZ#1490043
> 
> Most of these issue should be gone then.

I will pull down master as BZ#1504280 is now merged and check/make these changes.

Comment 28 Andrew Dahms 2018-01-08 00:18:03 UTC
This content is live on the Customer Portal.

Closing.

Comment 29 Andrew Dahms 2018-01-15 04:50:10 UTC
Updating the component and doc type.