-
Notifications
You must be signed in to change notification settings - Fork 1.8k
docs: Update the API pull documentation #13689
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
Conversation
Maffooch
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove additional commits for other PRs
df25487 to
b2bdf56
Compare
b2bdf56 to
c5f1261
Compare
| If you are connecting to SonarQube via HTTPS, the issuer of the certificate that is presented by | ||
| SonarQube must be trusted. | ||
|
|
||
| One way of achieving this is by defining the `REQUESTS_CA_BUNDLE` environment variable to point |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
REQUESTS_CA_BUNDLEenvironment variable
this is an env var within SonarQube? Just want to specify
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, this appears to be an env variable of the python requests library (see here). Although its usage in DefectDojo is not really documented besides in one sentence here and in the helm instructions (e.g. here)
As far as I understand, REQUESTS_CA_BUNDLE should ideally point to a file (or a directory) that includes custom trusted CA certificate(s) as well as the other trusted CA certificates already present (i.e. it overrides the default trust store).
I would propose to reflect this in the documentation by referencing the official requests docs.
Another alternative could be to bind /etc/ssl/certs to a read-only mounted volume, add the custom trusted CA certificates with Ubuntu's update-ca-certificates command and then set REQUESTS_CA_BUNDLE to /etc/ssl/certs/ca-certificates.crt
Writing these lines, I wonder, if it would make sense to have a dedicated page for this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sNiXx That would be very helpful (a page about REQUESTS_CA_BUNDLE). But can be a follow up PR as it's not blocking this.
mtesauro
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved.
Pinged @paulOsinski and he's good with the extra docs happening in a future PR
Confirmed with paulOsinski that we're good here before dismissing.
Description
Updating a few minor inconsistencies and errors, but also adding more details about custom trust configuration.
Test results
N/A
Documentation
This is a docs-only PR