-
Notifications
You must be signed in to change notification settings - Fork 12
OAuth2 #265
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
base: master
Are you sure you want to change the base?
OAuth2 #265
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| ## cloud-auth() | ||
|
|
||
| *Description:* Configures cloud-based authentication for the syslog-ng-otlp() destination. This option enables OAuth2 authentication for gRPC connections using the syslog-ng cloud authentication framework. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| The following authentication methods are available: | ||
|
|
||
| ### oauth2() | ||
|
|
||
| Configures OAuth2 authentication for gRPC-based destinations. Tokens are automatically injected into gRPC metadata for each request. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. it works in http destinations as well |
||
|
|
||
| The `oauth2()` option supports the following parameters: | ||
| - client_id() | ||
| - client_secret() | ||
| - token_url() | ||
| - scope() | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. also,
authentication methods full keyword list is |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -79,6 +79,8 @@ version 3.18 and later. | |
|
|
||
| {% include doc/admin-guide/options/cert-file.md %} | ||
|
|
||
| {% include doc/admin-guide/options/cloud-auth.md %} | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. azure-auth-header() is still missing here, even though it can be considered as an obsolete option, it is still the only pure "C" solution, see we should keep it currently |
||
|
|
||
| ## content-compression() | ||
|
|
||
| | Type:| string| | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,7 @@ Advantages of using `syslog-ng-otlp()`: | |
| * The `workers()` option makes the scaling of the driver flexible. | ||
| * An integrated application layer acknowledgement is available. | ||
| * Google service authentication (ADC or ALTS), and improved load balancing are supported. | ||
| * The syslog-ng-otlp() destination supports OAuth2 authentication via cloud-auth(oauth2()). | ||
|
|
||
| ### Example: Configure syslog-ng-otlp() destination on the sender node | ||
|
|
||
|
|
@@ -18,3 +19,21 @@ destination d_syslog_ng_otlp { | |
| syslog-ng-otlp(url("your-receiver-syslog-ng-instance:4317")); | ||
| }; | ||
| ``` | ||
|
|
||
| ### Example: Configure syslog-ng-otlp() destination using OAuth2 | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. though syslog-ng-otlp() is based on opentelemetry() but the server side (source) does not implement oauth2 (yet?!) just do not not modify this doc file plz |
||
|
|
||
| ```config | ||
| destination d_syslog_ng_otlp { | ||
| syslog-ng-otlp( | ||
| url("example.com:443") | ||
| cloud-auth( | ||
| oauth2( | ||
| client_id("client-id") | ||
| client_secret("client-secret") | ||
| token_url("https://auth.example.com/token") | ||
| scope("api-scope") | ||
| ) | ||
| ) | ||
| ); | ||
| }; | ||
| ``` | ||
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.
it is not just for the yslog-ng-otlp(), it is an option fr all the http+grpc based destinations