Add onboarding troubleshooting #3157
Conversation
mdbirnstiehl
added
backport-8.9
|
A documentation preview will be available soon: |
| *Solution:* | ||
|
|
||
| You need an administrator to give you privileges to create `savedObjects` in {kib} to generate the required `observabilityOnboarding` flow state. |
There was a problem hiding this comment.
To make this more actionable, could we share here the API call that the admin would have to run?
There was a problem hiding this comment.
@ruflin Could someone provide this API call? Not sure exactly how to format that.
There was a problem hiding this comment.
@weltenwort Could someone in your team help out here?
There was a problem hiding this comment.
Are we looking for an API call to grant the privileges? Or instructions to assign them via Kibana's management UI?
There was a problem hiding this comment.
I would go for an API call that the user can copy / paste into Dev Tools
There was a problem hiding this comment.
Hm, that's a bit tricky as much of the call depends on the specific user and their roles. They'd need to add these privileges to one of the roles of the current user, but we don't know how they've structured their roles. And if the user doesn't have these privileges, they probably don't have the privilege to grant new privileges either.
Would it maybe make sense to ship with a default observability role that grants the privileges and instruct them to ask the admin to grant that role in way appropriate to their configured authentication realms?
There was a problem hiding this comment.
@ruflin any suggestion here? How do we want to move forward with the docs?
There was a problem hiding this comment.
Do we even have that amount of control over the roles in serverless? I haven't seen any communication about that aspect.
There was a problem hiding this comment.
Lets take this on in steps. Lets first document the permissions that are needed. From there, we can discuss if we should have a role for it and API calls.
| *Solution:* | ||
|
|
||
| You need an administrator to give you the necessary permissions listed in the error messages and then to restart the onboarding flow. |
There was a problem hiding this comment.
To make this more actionable, could we share here the API call that the admin would have to make? Otherwise the admin comes back to the user and asks what exactly they need to do.
There was a problem hiding this comment.
@ruflin Same as above. Could someone provide this API call.
|
|
||
| * You're an Elastic Cloud Enterprise user without access to the Elastic downloads page. | ||
| * The {agent} was fully downloaded previously. In this case, delete previous downloads and restart the onboarding. |
There was a problem hiding this comment.
If this is the case, can we show a better error message? @yngrdyn
There was a problem hiding this comment.
Here the error in the console should be more align to
The requested URL returned error: 404
There was a problem hiding this comment.
Concretely this is what we are showing
What do you suggest @ruflin ?
There was a problem hiding this comment.
If the agent was already downloaded also the above error shows? I was referring to:
The {agent} was fully downloaded previously. In this case, delete previous downloads and restart the onboarding.
I'm surprised we see a 404 in this case.
There was a problem hiding this comment.
ah no, the 404 it's in case the url for the agent returns the 404 or we cannot connect to kibana to download the script.
In the case of an agent already existing in the host, we would probably would see something like
Error: cannot perform installation as Elastic Agent is already running from this directory
Let me double check this scenario
| + | ||
| To fix this, delete previous downloads and restart the onboarding. | ||
| * You're an Elastic Cloud Enterprise user without access to the Elastic downloads page. |
There was a problem hiding this comment.
Not sure if there is a solution to this one that we can add as it's more of a cause at this point.
| Failed to create API key | ||
|
|
||
| Something went wrong: Unable to create observability-onboarding-state |
There was a problem hiding this comment.
This is a comment for the devs, not docs: We should improve this error so users get already details in the error on what to do.
| [discrete] | ||
| [[logs-troubleshooting-download-agent]] | ||
| == Download {agent} failed |
There was a problem hiding this comment.
Happy to get this section in but I think we should revisit it. It seems odd that someone could have a link for a not supported platform in the first place?
(cherry picked from commit 9552649)
(cherry picked from commit 9552649) Co-authored-by: Mike Birnstiehl <[email protected]>
This PR closes Issue 3116
I've updated the Troubleshoot your logs page to include the information from @yngrdyn 's word doc. I'm adding this as a draft PR because I think there is still room for more discussion and information on what needs to be added. But I thought this would give us a starting point for discussion.