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

feat: Harvest should define and document auth precedence #1882

Merged
merged 3 commits into from
Apr 4, 2023
Merged

Conversation

cgrinds
Copy link
Collaborator

@cgrinds cgrinds commented Mar 31, 2023

Fixes: #1867

docs/configure-harvest-basic.md Outdated Show resolved Hide resolved
Comment on lines +114 to 121
if err != nil {
abs, err2 := filepath.Abs(credPath)
if err2 != nil {
abs = credPath
}
return fmt.Errorf("failed to read file=%s error: %w", abs, err)
}
if p == nil {
Copy link
Contributor

Choose a reason for hiding this comment

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

logic hasn't changed yet for absolute path?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

absolute path is only used in the error to help customers figure out the readfile error and where the file is being read from

name: "no default, poller credentials_file",
pollerName: "test",
want: PollerAuth{Username: "username", Password: "from-secrets-file"},
defaultDefined: true,
Copy link
Contributor

Choose a reason for hiding this comment

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

false

Hardikl
Hardikl previously approved these changes Apr 3, 2023

| parameter | description | default | Link |
|----------------------|----------------------------------------------------------------------------|--------------|-----------------------------|
| `auth_sytle` | One of `basic_auth` or `certificate_auth` | `basic_auth` | [link](#Pollers) |
Copy link
Contributor

Choose a reason for hiding this comment

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

Description should add that it is an optional field if using credentials_file and credentials_script

rahulguptajss
rahulguptajss previously approved these changes Apr 4, 2023
@cgrinds cgrinds dismissed stale reviews from rahulguptajss and Hardikl via 06204ab April 4, 2023 12:00
@cgrinds cgrinds merged commit 8e8a256 into main Apr 4, 2023
@cgrinds cgrinds deleted the cbg-auth branch April 4, 2023 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Harvest should document auth mechanism precedence
3 participants