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: refactor installation guide #3327

Merged
merged 1 commit into from
Oct 17, 2023
Merged

docs: refactor installation guide #3327

merged 1 commit into from
Oct 17, 2023

Conversation

swiatekm
Copy link

@swiatekm swiatekm commented Oct 16, 2023

Made the installation guide more streamlined, mostly by making the critical path as short and straightforward as possible, and moving less used sections to later parts of the document.

Some more specific changes:

  • Compressed the ToC into only the top-level headers, as it was too long
  • Deleted the Prometheus-related troubleshooting sections, given that Otel is now the default.
  • Move some early sections to Troubleshooting, and Troubleshooting to the end
  • Added top-level sections for OpenShift and Non-Helm at the end of the document

Checklist

  • Changelog updated or skip changelog label added
  • Documentation updated

@github-actions github-actions bot added the documentation documentation label Oct 16, 2023
@swiatekm swiatekm force-pushed the docs/installation branch 10 times, most recently from bb62454 to 8efc0a6 Compare October 17, 2023 14:10
@swiatekm swiatekm marked this pull request as ready for review October 17, 2023 14:10
@swiatekm swiatekm requested a review from a team as a code owner October 17, 2023 14:10
@swiatekm swiatekm force-pushed the docs/installation branch 3 times, most recently from 02b06e0 to 0866573 Compare October 17, 2023 14:18

## Uninstalling Sumo Logic Collection
- `kubectl delete job -n ${NAMESPACE} my-release-sumologic-setup`
Copy link
Contributor

Choose a reason for hiding this comment

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

why do we need to delete the job explicitly, isn't the job/pod removed once its complete?

Copy link
Author

Choose a reason for hiding this comment

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

It is after some TTL (https://kubernetes.io/docs/concepts/workloads/controllers/ttlafterfinished/), but this isn't guaranteed to have passed at this point.


## Uninstalling Sumo Logic Collection
- `kubectl delete job -n ${NAMESPACE} my-release-sumologic-setup`
- `kubectl delete job -n ${NAMESPACE} my-release-sumologic-ot-operator-instr` (needed only if `opentelemetry-operator.enabled=true`)
Copy link
Contributor

Choose a reason for hiding this comment

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

same question here I guess.


![dashboard](/images/sumo_k8s_dashboard.png)

[sumo-k8s-app-dashboards]: https://help.sumologic.com/docs/integrations/containers-orchestration/kubernetes#installing-the-kubernetes-app
Copy link
Contributor

Choose a reason for hiding this comment

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

nice looking dashboard!

containers:
otelcol:
securityContext:
privileged: true
Copy link
Contributor

Choose a reason for hiding this comment

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

is this privilege elevation only required in openshift?

Copy link
Author

Choose a reason for hiding this comment

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

I believe so, but I'm not an expert on OpenShift. @kkujawa-sumo do you know?

@swiatekm swiatekm merged commit 435687b into main Oct 17, 2023
15 checks passed
@swiatekm swiatekm deleted the docs/installation branch October 17, 2023 15:40
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.

2 participants