Bug 1473438 - [DOCS] Logging secure forward patch command formatting
[DOCS] Logging secure forward patch command formatting
Status: ON_QA
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation (Show other bugs)
3.4.0
Unspecified Unspecified
unspecified Severity medium
: ---
: ---
Assigned To: Brandi
Anping Li
Vikram Goyal
:
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2017-07-20 16:46 EDT by Steven Walter
Modified: 2018-06-22 16:27 EDT (History)
3 users (show)

See Also:
Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed:
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)

  None (edit)
Description Steven Walter 2017-07-20 16:46:43 EDT
Document URL: 
https://docs.openshift.com/container-platform/3.4/install_config/aggregate_logging.html

Section Number and Name: 
Understanding Deployment -> Fluentd ->  Configuring Fluentd to Send Logs to an External Log Aggregator

Describe the issue: 
The patch commands are a tad confusing. 

$ oc patch secrets/logging-fluentd --type=json \
  --patch "[{'op':'add','path':'/data/your_ca_cert','value':'$(base64 /path/to/your_ca_cert.pem)'}]"
$ oc patch secrets/logging-fluentd --type=json \
  --patch "[{'op':'add','path':'/data/your_private_key','value':'$(base64 /path/to/your_private_key.pem)'}]"

It points to /data/your_ca_cert and /data/your_private_key -- it is misleading and people mistake this to mean /path/to/your/cert/on/this/host when in reality this is a path inside the json. In the json it's {"data": {"your_private_key"}} but this is not obvious to the outside view

Error you get when you think that "path" is asking for path on your machine:

Error from server: jsonpatch add operation does not apply: doc is missing path: /etc/origin/master/ca.crt


Suggestions for improvement: 
Add a note saying "Replace 'your_private_key' with some generic name. This is not a path on your host system, but is the link to the JSON path." or something similar to that. 

Additional information:
Comment 1 Brandi 2018-06-22 16:27:56 EDT
Added the note in the following PR:

https://github.com/openshift/openshift-docs/pull/10368

Anping, PTAL. 

Thanks!

Note You need to log in before you can comment on or make changes to this bug.