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

Docs: Add quickstart user guide #265

Merged

Conversation

mlevesquedion
Copy link
Contributor

@mlevesquedion mlevesquedion commented Jan 28, 2021

This PR adds a user guide that shows how to configure and run the analyzer. The intent is to provide a "quickstart" tutorial that allows users to quickly grasp how they can start applying the analyzer.

  • (N/A) [ ] Running against a large codebase such as Kubernetes does not error out. (See DEVELOPING.md for instructions on how to do that.)
  • Appropriate changes to README are included in PR

After making this change, the analyzer no longer produces a report. There are many ways to
address reports, the important thing is to modify the code so that the Source can no longer
reach the Sink. For example, you may wish to define a "Sanitizer" function that removes the
password, making the `auth` struct safe to log. See [the documentation](../configuration/README.md)
Copy link
Member

Choose a reason for hiding this comment

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

Authentication

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are you referring to auth? I think I prefer auth here, because that is IMO the most specific label, being the name of the variable in the example. WDYT?

Copy link
Member

@vinayakankugoyal vinayakankugoyal Jan 28, 2021

Choose a reason for hiding this comment

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

It says 'making the auth struct safe to log.' But there is no auth struct there is an Authentication struct.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In my understanding, the auth variable is a struct of type Authentication. I see your point, though. The sanitizer would work with values of type Authentication.

I've reworded it. WDYT?

Copy link
Member

Choose a reason for hiding this comment

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

I am thinking do we really need the line
For example, you may wish to define ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's good to make a nod to it here. Sources, Sinks and Sanitizers are (in my understanding) the 3 core concepts to understand for levee. Sources and Sinks are more fundamental, which is why they get most of the attention in this guide. But I think Sanitizers should at least get a mention.

Copy link
Collaborator

@PurelyApplied PurelyApplied left a comment

Choose a reason for hiding this comment

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

Looks pretty good. I've got a handful of nits, but this is a good addition.

guides/quickstart.md Outdated Show resolved Hide resolved
guides/quickstart.md Show resolved Hide resolved
guides/quickstart.md Outdated Show resolved Hide resolved
guides/quickstart.md Outdated Show resolved Hide resolved
guides/quickstart.md Outdated Show resolved Hide resolved
guides/quickstart.md Outdated Show resolved Hide resolved
guides/quickstart.md Show resolved Hide resolved
guides/quickstart.md Outdated Show resolved Hide resolved
guides/quickstart.md Outdated Show resolved Hide resolved
@mlevesquedion
Copy link
Contributor Author

Thank you for your comments! PTAAL.

@mlevesquedion
Copy link
Contributor Author

I've changed the config to use Value instead of Val when configuring the field tag, as per discussion here: #266 (comment)

I'm marking this PR a draft until that's merged. (Currently, using Value causes the configuration to be invalid, i.e. the tagged field won't be detected.)

@mlevesquedion mlevesquedion marked this pull request as draft February 1, 2021 14:20
@mlevesquedion mlevesquedion marked this pull request as ready for review February 1, 2021 20:56
@mlevesquedion mlevesquedion merged commit 2436ffd into google:master Feb 3, 2021
@mlevesquedion mlevesquedion deleted the add-quickstart-user-guide branch February 3, 2021 20:11
@mlevesquedion mlevesquedion changed the title Add quickstart user guide Docs: Add quickstart user guide Feb 19, 2021
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.

None yet

3 participants