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

DOC-4519-audit-log #117

Merged
merged 7 commits into from
Aug 14, 2024
Merged

DOC-4519-audit-log #117

merged 7 commits into from
Aug 14, 2024

Conversation

mendonk
Copy link
Contributor

@mendonk mendonk commented Aug 12, 2024

Add audit log streaming feature to customer documentation.
Tested and works 100%

@mendonk mendonk requested a review from aimurphy August 12, 2024 21:21
@mendonk mendonk self-assigned this Aug 12, 2024
@mlr
Copy link
Contributor

mlr commented Aug 12, 2024

Antora site build successful! ✅
Deploying draft.
Deployment successful! View draft

Copy link
Contributor

@aimurphy aimurphy left a comment

Choose a reason for hiding this comment

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

Please review my comments.

modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
@aimurphy
Copy link
Contributor

aimurphy commented Aug 12, 2024

Looking at the API docs again, I believe the DevOps API endpoint can be used instead of contacting DataStax Support. I asked for clarification on the ticket.

If that is true, we should add this as alternative last step, like:

. Finalize the audit log streaming configuration:

<tabs for DataStax Support // Astra DevOps API>

The DataStax Support tab would have the current last step on it.
The Astra DevOps API would either link to the endpoint docs (easiest) or show the DevOps API call & response:

[source,curl,subs="verbatim,quotes"]
----
curl --request POST \
  --url 'https://api.astra.datastax.com/v2/organizations/**ORG_ID**/telemetry/auditLogs' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer **APPLICATION_TOKEN**' \
  --data '{
  "pulsar": {
    "endpoint": "pulsar+**BROKER_SERVICE_URL**",
    "auth_strategy": "token",
    "topic": "**TOPIC_FULL_NAME**",
    "auth_name": "token",
    "token": "**PULSAR_AUTHENTICATION_TOKEN**"
  }
}'
----

It might be easier to link to the docs bc the authentication data depends on the Pulsar Broker config.
Make sure to clarify that it's the Astra DevOps API, not the Astra Streaming DevOps API.

@mlr
Copy link
Contributor

mlr commented Aug 13, 2024

Antora site build successful! ✅
Deploying draft.
Deployment successful! View draft

@mlr
Copy link
Contributor

mlr commented Aug 13, 2024

Antora site build successful! ✅
Deploying draft.
Deployment successful! View draft

@mlr
Copy link
Contributor

mlr commented Aug 13, 2024

Antora site build successful! ✅
Deploying draft.
Deployment successful! View draft

@mlr
Copy link
Contributor

mlr commented Aug 13, 2024

Antora site build successful! ✅
Deploying draft.
Deployment successful! View draft

@mendonk mendonk requested review from aimurphy and rogerb-ds August 13, 2024 20:24
Copy link
Contributor

@aimurphy aimurphy left a comment

Choose a reason for hiding this comment

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

Few more comments, please consider them.

modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
modules/operations/pages/monitoring/stream-audit-logs.adoc Outdated Show resolved Hide resolved
@mlr
Copy link
Contributor

mlr commented Aug 14, 2024

Antora site build failure! ❌

{"level":"error","time":1723652786454,"name":"asciidoctor","file":{"path":"modules/operations/pages/monitoring/stream-audit-logs.adoc"},"source":{"url":"https://github.com/datastax/astra-streaming-docs.git","refname":"DOC-4519-audit-log-telemetry","reftype":"branch"},"msg":"target of xref not found: astra-api-docs:ROOT:attachment$devops-api/index.html#tag/Organization-Operations/operation/configureTelemetry"} {"level":"error","time":1723652786457,"name":"asciidoctor","file":{"path":"modules/operations/pages/monitoring/stream-audit-logs.adoc"},"source":{"url":"https://github.com/datastax/astra-streaming-docs.git","refname":"DOC-4519-audit-log-telemetry","reftype":"branch"},"msg":"target of xref not found: astra-api-docs:ROOT:attachment$devops-api/index.html#tag/Organization-Operations/operation/configureTelemetry"} {"level":"error","time":1723652786459,"name":"asciidoctor","file":{"path":"modules/operations/pages/monitoring/stream-audit-logs.adoc"},"source":{"url":"https://github.com/datastax/astra-streaming-docs.git","refname":"DOC-4519-audit-log-telemetry","reftype":"branch"},"msg":"target of xref not found: astra-api-docs:ROOT:attachment$devops-api/index.html#tag/Organization-Operations/operation/deleteTelemetryConfig"} > tailwindcss > tailwindcss build -c ${npm_config_tailwind_config_path} -i ${npm_config_css_path} -o ${npm_config_css_path} --minify Browserslist: caniuse-lite is outdated. Please run: npx update-browserslist-db@latest Why you should do it regularly: https://github.com/browserslist/update-db#readme Rebuilding... Done in 7858ms.

@mlr
Copy link
Contributor

mlr commented Aug 14, 2024

Antora site build failure! ❌

{"level":"error","time":1723653068141,"name":"asciidoctor","file":{"path":"modules/operations/pages/monitoring/stream-audit-logs.adoc"},"source":{"url":"https://github.com/datastax/astra-streaming-docs.git","refname":"DOC-4519-audit-log-telemetry","reftype":"branch"},"msg":"target of xref not found: astra-api-docs:ROOT:attachment$devops-api/index.html#tag/Organization-Operations/operation/configureTelemetry"} {"level":"error","time":1723653068144,"name":"asciidoctor","file":{"path":"modules/operations/pages/monitoring/stream-audit-logs.adoc"},"source":{"url":"https://github.com/datastax/astra-streaming-docs.git","refname":"DOC-4519-audit-log-telemetry","reftype":"branch"},"msg":"target of xref not found: astra-api-docs:ROOT:attachment$devops-api/index.html#tag/Organization-Operations/operation/configureTelemetry"} {"level":"error","time":1723653068145,"name":"asciidoctor","file":{"path":"modules/operations/pages/monitoring/stream-audit-logs.adoc"},"source":{"url":"https://github.com/datastax/astra-streaming-docs.git","refname":"DOC-4519-audit-log-telemetry","reftype":"branch"},"msg":"target of xref not found: astra-api-docs:ROOT:attachment$devops-api/index.html#tag/Organization-Operations/operation/deleteTelemetryConfig"} > tailwindcss > tailwindcss build -c ${npm_config_tailwind_config_path} -i ${npm_config_css_path} -o ${npm_config_css_path} --minify Browserslist: caniuse-lite is outdated. Please run: npx update-browserslist-db@latest Why you should do it regularly: https://github.com/browserslist/update-db#readme Rebuilding... Done in 7802ms.

@aimurphy
Copy link
Contributor

Those references should work, they are in prod. Maybe need to update the branch from main?

Copy link
Contributor

@aimurphy aimurphy left a comment

Choose a reason for hiding this comment

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

@mlr
Copy link
Contributor

mlr commented Aug 14, 2024

Antora site build successful! ✅
Deploying draft.
Deployment successful! View draft

@mendonk mendonk merged commit 7c3dc01 into main Aug 14, 2024
1 check passed
@mendonk mendonk deleted the DOC-4519-audit-log-telemetry branch August 14, 2024 19:48
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.

3 participants