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.

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

add basic security pages #985

Merged
merged 6 commits into from
Jul 16, 2024
Merged

add basic security pages #985

merged 6 commits into from
Jul 16, 2024

Conversation

matt257
Copy link
Contributor

@matt257 matt257 commented Jul 16, 2024

https://osc.github.io/ood-documentation-test/add-basic-security-pages/


add basic security pages
incorporated feedback from my last attempt

Security Concerns
-----------------

**The Good:**
Copy link
Contributor

Choose a reason for hiding this comment

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

I know I gave you this phrase in the other comment, but we likely need something better.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmm, maybe "State of Security" ? the section could be updated as security concerns are found and develop

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe it's just one section called considerations?

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, you know I meant those 2 headings The good and The bad - maybe it's just one section? Or maybe advantages and limitations? Then maybe another section called controls for things like file browsing that you can change after you install?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think what you have is a good start. Can you fix the conflict so we can see how it's deployed and looks.

Comment on lines +46 to +48
authentication/overview
how-tos/monitoring/logging
customizations
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not in love with blink links. I mean - yes we log, but what's the context here, is that good or bad? Does it need updated, does the default work well? Yes we have customizations, but are they secure/insecure?

I think what we need is more up the page where the other considerations are. Something like

  • Out of the box OnDemand will let users explore the file entire system. The web server runs as the users, so it will still adhere to FACLs when attempting to view files. However, you set an allowlist to only show certain file paths or disable this altogether. (with links to the given configurations)

It's stuff like that - describing some behaviors that may be unwanted and specific links on how to control that.

We can keep this ToC here - but I feel like we need to be more direct with the reader and not just hope they explore and find the relevant info (and make the relevant connections) themselves.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

... yes we log, but what's the context here, is that good or bad?

the context is logging works as 'how-tos/monitoring/logging' describes.

I don't think I can tell people if a feature is good or bad. I think I can only remove doubt about what a feature is, so people can be convinced whatever judgements they make (if they make any) are just.


If there are specific situations you think should be documented I can open up issues and work on writing something up for them and getting them added.

i'll try to update the 'considerations' from your comment

@matt257
Copy link
Contributor Author

matt257 commented Jul 16, 2024

@johrstrom johrstrom self-requested a review July 16, 2024 18:46
Copy link
Contributor

@johrstrom johrstrom left a comment

Choose a reason for hiding this comment

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

OK, this is a good start. We can touch it up as we go.

@matt257
Copy link
Contributor Author

matt257 commented Jul 16, 2024

thanks! that sounds like a good plan to me.

@matt257 matt257 merged commit 669ff87 into latest Jul 16, 2024
1 check passed
@matt257 matt257 deleted the add-basic-security-pages branch July 16, 2024 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants