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

HPCC-30680 Documentation covering platform security manager configuration #18111

Merged
merged 1 commit into from
Feb 19, 2024
Merged

HPCC-30680 Documentation covering platform security manager configuration #18111

merged 1 commit into from
Feb 19, 2024

Conversation

kenrowland
Copy link
Contributor

@kenrowland kenrowland commented Dec 5, 2023 •
edited
Loading

…tion

Added document covering the LDAP security manager

Signed-Off-By: Kenneth Rowland [email protected]

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@kenrowland kenrowland requested a review from afishbeck December 5, 2023 13:59
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 5, 2023

https://track.hpccsystems.com/browse/HPCC-30680
Jira updated

JamesDeFabia
JamesDeFabia reviewed Dec 5, 2023
View reviewed changes
Copy link
Contributor

@JamesDeFabia JamesDeFabia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments inline

devdoc/SecurityConfig.md Outdated
@@ -0,0 +1,83 @@
# Security Configuration #
This document covers security configuration values and meanings. It does not server as
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

server s/b serve

devdoc/SecurityConfig.md Outdated
config manager or yaml files.

## Supported Configurations ##
Security is configured as either through an LDAP server or a plugin. Additionally, these are
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove word: "as"
Security is configured either through an LDAP server or a plugin

devdoc/SecurityConfig.md Outdated
## Supported Configurations ##
Security is configured as either through an LDAP server or a plugin. Additionally, these are
supported in both legacy deployments that use _environment.xml_ and containerized deployments
using Kubernetes and helm charts. While these methods differ, the configuration values
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Helm s/b capitalized

devdoc/SecurityConfig.md Outdated
sections below: LDAP and Plugin Security Managers.

### LDAP ###
LDAP is a protocol that connects to an Active Driectory server (AD). The term LDAP is used
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling: Directory

devdoc/SecurityConfig.md Outdated
primary vehicle for setting these values. However, some values are not available through the tool and must be set
manually in the environment.xml if needed for a legacy deployment.

In containerized environments, a ldap configuration block is required for each component. Currently, this results in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LDAP s/b all caps

afishbeck
afishbeck reviewed Dec 14, 2023
View reviewed changes
devdoc/SecurityConfig.md Outdated
@@ -0,0 +1,83 @@
# Security Configuration #
This document covers security configuration values and meanings. It does not server as
the source for how to configure security, but rahter what the different values mean. These
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"rather"

afishbeck
afishbeck reviewed Dec 14, 2023
View reviewed changes
devdoc/SecurityConfig.md

### LDAP ###
LDAP is a protocol that connects to an Active Driectory server (AD). The term LDAP is used
interchangeably with AD. Below are the configuration values for an LDAP connection. These are valid for both legacy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a side comment, but "interchangeably with AD." I guess is true but that's a bit unfortunate. I wish we could use other LDAP backends especially if we could have a stand alone one that easily worked on a single developer laptop helm deployment.

afishbeck
afishbeck reviewed Dec 14, 2023
View reviewed changes
devdoc/SecurityConfig.md Outdated
5. Must be configured manually in the environment.xml in legacy environments

### Plugin Security Managers ###
Plugin security managers are separate shared object loaded and intialized by the system. The manager interface is
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

objects

@afishbeck
Copy link
Member

This is great for filling in some documentation holes.

JamesDeFabia
JamesDeFabia approved these changes Feb 7, 2024
View reviewed changes
Copy link
Contributor

@JamesDeFabia JamesDeFabia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks OK from my POV

@ghalliday
Copy link
Member

@kenrowland please squash and I will merge

@kenrowland
HPCC-30680 Documentation covering platform security manager configura…
0182727 
…tion

Added document covering the LDAP security manager

Signed-Off-By: Kenneth Rowland [email protected]
@kenrowland
Copy link
Contributor Author

@ghalliday Please merge

@ghalliday ghalliday merged commit 179d2e9 into hpcc-systems:master Feb 19, 2024
48 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@afishbeck afishbeck afishbeck left review comments

@JamesDeFabia JamesDeFabia JamesDeFabia approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@kenrowland @afishbeck @ghalliday @JamesDeFabia