[Website]: AutoOps Cloud Connect: document Kibana-side network requirements

Open Beginner friendly
  • Is something wrong?
#9,208 1 comment 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Read the AutoOps Cloud Connect page at cc-connect-self-managed-to-autoops and check the Prerequisites and Kibana tab sections. Add the Kibana server's outbound HTTPS requirement, explain the reported connection failure, and document the proxy limitation and cloud setup alternative. The work is done when those instructions cover all three cases accurately.

Written by the indexing model from the issue text.

Description

source:web Team:Admin triaged
Before you submit
  • This issue is about a documentation page, flow, or piece of content.
Type of issue

Missing information

What documentation page or section is affected

https://www.elastic.co/docs/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops

What happened?

The page lists network requirements for the AutoOps agent (i.e. https://api.elastic-cloud.com and the regional otel-auto-ops URL).
But it says nothing about Kibana, so users with outbound network restrictions for the Kibana server might not be aware.

What's missing:

  1. Before you begin -> Prerequisites. Add a note that if you use the Kibana tab for the setup, the Kibana server (not the browser) needs outbound HTTPS (443) to cloud.elastic.co, or whatever xpack.cloud_connect.cloudUrl is set to. (AFAIK api.elastic-cloud.com is not needed for Kibana, but only for the AutoOps Agent).
  2. Get started -> Kibana tab. Repeat that requirement before the "paste the key and click Connect" step, and say what it looks like when it fails. (see screen below)
  3. Missing proxy setting. Cloud Connect in Kibana has no proxy setting (tracked in https://github.com/elastic/kibana/issues/298952). Until that is fixed, we should add a note that, if Kibana server can only reach the internet via proxy, they can't do the setup in Kibana and should instead run through the cloud connect setup via https://cloud.elastic.co/login?redirectTo=%2Fconnect-cluster-services -> "Install AutoOps agent".
Additional info

For 2. I got this error when I blocked outboud traffic for Kibana. It's a bit misleading as it suggests the API key is invalid, when in reality it couldn't reach the endpoint. Will raise a Kibana issue for that.

Image
Dominant language
No language data
Stars
50
Forks
268
Avg merge
4d 5h
Merged PRs (30d)
210

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elastic/docs-content

All issues in elastic/docs-content

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.