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

(Documentation) Emphasize security recommendations early in the installation process #5330

Closed
ADubhlaoich opened this issue Apr 2, 2024 · 4 comments
Assignees
Labels
backlog Pull requests/issues that are backlog items proposal An issue that proposes a feature request ready for refinement An issue that was triaged and it is ready to be refined

Comments

@ADubhlaoich
Copy link
Contributor

Is your feature request related to a problem? Please describe.
As a user, I want to know best practices earlier, so that I can secure my cluster sooner.

Describe the solution you'd like
When I am following critical instructions for setup and configuration steps, I want to be informed of best practices.

Describe alternatives you've considered
I think that some of these best practices could theoretically be enabled by default, but some of the best practices relate to specific use cases. On first run/deployment there could be a series of checks and subsequent recommendations, but that gets into the scope of code changes instead of just documentation.

Additional context
This issue was inspired by the current Security documentation page under Configuration. I don't think it's very well written, and it struck me that if something is of enough importance to be recommended, the information should be juxtaposed with where it would be relevant.

@ADubhlaoich ADubhlaoich added the proposal An issue that proposes a feature request label Apr 2, 2024
@ADubhlaoich ADubhlaoich self-assigned this Apr 2, 2024
@ADubhlaoich
Copy link
Contributor Author

ADubhlaoich commented Apr 2, 2024

I'm already working on this issue: trying to get into the habit of defining problems publicly before I work on them, following the open source ethos.

There's a number of significantly sore thumbs in the existing page:

  • Incorrect usage of the software name: Lots of "the" Ingress Controller. You can guess in context, but there's a few out there.
  • Marketing/product management tone: It'll give most regular users an ick feeling.
  • Passive tone: If we feel strongly enough to mention anything, it should be imperative. Instructions are direct, recommendations are indirect.
  • Unnecessary words: There are too many "promise" sentences and unqualified superlatives.

The game plan is to fix the grammar and tone, strip the unnecessary words, then identify where the critical information could be inserted into other existing documentation as part of the critical paths.

There's something to be said about a reference document for securing a cluster, but that feels like it could be part of a general purpose "Design recommendations" page that could be part of the Overview.

@ADubhlaoich
Copy link
Contributor Author

Pushed out an initial PR for this effort.

A lot of it was removing unnecessary sentences, and updating links - I plan to re-order some of the sections, too.

Since I added a link to the Prometheus documentation, I noticed that it requires some work as well.

I'll have to ask some of the team what the relevancy of NGINX snippets are for security recommendations, because the block of text that currently exists just seems to be a dumped in copy & paste from the existing snippets configuration document.

@vepatel vepatel added backlog Pull requests/issues that are backlog items ready for refinement An issue that was triaged and it is ready to be refined labels Apr 8, 2024
@ADubhlaoich
Copy link
Contributor Author

Took the working PR out of draft: I will socialize it for review with the team this week.

There's further refinement that could be done with the entire documentation set with regard to security, but I don't want to blow the scope of that PR up. I'm going to check where the document is linked from: it should be mentioned as part of the deployment process.

If it's something a reader only finds because they've had an incident, then it's already too late for them.

@ADubhlaoich
Copy link
Contributor Author

@vepatel Any insight on other areas of the docs that recommendations could be made early?

It seems like most of the time the most secure option is suggested anyway: the actual security recommendations page just stuck out like a sore thumb, but I addressed that in a previous PR.

@github-project-automation github-project-automation bot moved this from Todo ☑ to Done 🚀 in NGINX Ingress Controller Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Pull requests/issues that are backlog items proposal An issue that proposes a feature request ready for refinement An issue that was triaged and it is ready to be refined
Projects
Archived in project
Development

No branches or pull requests

2 participants