openshift-docs
openshift-docs copied to clipboard
openshift
OCPBUGS 1931: Adding the bindDN and bindPassword to example
Version(s): 4.12+
Issue: https://issues.redhat.com/browse/OCPBUGS-1931
Link to docs preview: https://57519--ocpdocs-pr.netlify.app/openshift-enterprise/latest/authentication/ldap-syncing.html#ldap-syncing-config-rfc2307_ldap-syncing-groups
QE review:
- [ ] QE has approved this change.
Additional information:
@bergerhoffer: Jira Issue OCPBUGS-1931 is in a security level that is not in the allowed security levels for this repo. Allowed security levels for this repo are:
- Red Hat Employee
- default
In response to this:
Version(s): 4.9+
Issue: https://issues.redhat.com/browse/OCPBUGS-1931
Link to docs preview:
QE review:
- [ ] QE has approved this change.
Additional information:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
🤖 Mon Oct 28 19:41:54 - Prow CI generated the docs preview:
https://57519--ocpdocs-pr.netlify.app/openshift-dedicated/latest/authentication/ldap-syncing.html https://57519--ocpdocs-pr.netlify.app/openshift-enterprise/latest/authentication/ldap-syncing.html https://57519--ocpdocs-pr.netlify.app/openshift-rosa/latest/authentication/ldap-syncing.html
@stlaz Can you please review to make sure that the addition of the bindDN and bindPassword are appropriate here?
Preview: https://57519--docspreview.netlify.app/openshift-enterprise/latest/authentication/ldap-syncing.html#ldap-syncing-config-rfc2307_ldap-syncing-groups
Only versions 4.10+ are still in maintenance. I am removing labels from earlier versions from this PR.
@bergerhoffer 4.9 is EOL. Unless this is critical information, please update the applicable versions to 4.10+
The branch/enterprise-4.14 label has been added to this PR.
This is because your PR targets the main branch and is labeled for enterprise-4.13. And any PR going into main must also target the latest version branch (enterprise-4.14).
If the update in your PR does NOT apply to version 4.14 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.
![openshift-ci[bot] avatar](https://avatars.githubusercontent.com/in/91280?v=4 "Published by a pub.dev verified publisher"){kind=small}
Only versions 4.11+ are still in maintenance. I am removing labels from earlier versions from this PR.
Issues go stale after 90d of inactivity.
Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.
If this issue is safe to close now please do so with /close.
/lifecycle stale
@xingxingxia Can you please test this out to see if this update is okay?
Preview: https://57519--ocpdocs-pr.netlify.app/openshift-enterprise/latest/authentication/ldap-syncing.html#ldap-syncing-config-rfc2307_ldap-syncing-groups
The branch/enterprise-4.16 label has been added to this PR.
This is because your PR targets the main branch and is labeled for enterprise-4.15. And any PR going into main must also target the latest version branch (enterprise-4.16).
If the update in your PR does NOT apply to version 4.16 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.
~~Hi @xingxingxia Can you PTAL?~~
Ignore this, I see you replied in the Jira!
Issues go stale after 90d of inactivity.
Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.
If this issue is safe to close now please do so with /close.
/lifecycle stale
Issues go stale after 90d of inactivity.
Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.
If this issue is safe to close now please do so with /close.
/lifecycle stale
The branch/enterprise-4.18 label has been added to this PR.
This is because your PR targets the main branch and is labeled for enterprise-4.17. And any PR going into main must also target the latest version branch (enterprise-4.18).
If the update in your PR does NOT apply to version 4.18 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.
I'm not sure how to progress with this one. @xingxingxia Per your comment in the Jira, you noted that we do already mention bindDN and bindPassword in the auto syncing section.
But we don't mention it in the base example at the beginning of the document "About the RFC 2307 configuration file".
Can we add them there like this PR proposes, or should we not?
@bergerhoffer it is fine to add them in all configuration/snippet occurrences. But there is no test case covering the two fields and I'm not sure of the right format for bindPassword. Give me some time to test it and update here.
@bergerhoffer tested, the PR's added format .bindPassword.file and content works.
Also, below simple format (.bindPassword with string value) and content also works. You can note this maybe.
I say "works", because if I give wrong password (in .bindPassword directly or in .bindPassword.file) the sync command failed with error: could not bind to the LDAP server: LDAP Result Code 49 "Invalid Credentials", and only when I give correct password (ditto) it succeeded.
bindDN: cn=admin,dc=example,dc=com
bindPassword: <password>
You can add bindDN/bindPassword for all configuration/snippet occurrences if there are others missing bindDN/bindPassword.
@bergerhoffer tested, the PR's added format .bindPassword.file and content works. Also, below simple format (.bindPassword with string value) and content also works. You can note this maybe. I say "works", because if I give wrong password (in .bindPassword directly or in .bindPassword.file) the sync command failed with
error: could not bind to the LDAP server: LDAP Result Code 49 "Invalid Credentials", and only when I give correct password (ditto) it succeeded.bindDN: cn=admin,dc=example,dc=com bindPassword: <password>You can add bindDN/bindPassword for all configuration/snippet occurrences if there are others missing bindDN/bindPassword.
Thanks! I don't think it's necessary to note the alternative method, so I'll just move forward with this update.