-
Notifications
You must be signed in to change notification settings - Fork 219
Add docs for AutoOps on ECK #4792
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
Merged
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
e8815ec
eck installation
wajihaparvez 129560f
eck troubleshooting
wajihaparvez 7f30275
delete duplicate content
wajihaparvez d764c3c
more troubleshooting
wajihaparvez b8f51dc
consolidating changes from Michael's PR
wajihaparvez 5238d56
vale checks
wajihaparvez 239ec15
small fix
wajihaparvez 3522ed1
Merge branch 'main' into autoops-eck
wajihaparvez 66e3d77
PR review
wajihaparvez caf625a
shaina review
wajihaparvez 3f4350b
Merge branch 'main' into autoops-eck
wajihaparvez c4784e9
fix links
wajihaparvez a986b5d
michael review
wajihaparvez e8f80fd
more clarification
wajihaparvez eeb5c54
Add helm instructions
wajihaparvez db7fd7a
Merge branch 'main' into autoops-eck
wajihaparvez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
deploy-manage/monitor/autoops/autoops-sm-troubleshoot-eck-no-clusters.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| eck: ga 3.3 | ||
| navigation_title: Connected clusters not appearing with ECK | ||
| products: | ||
| - id: cloud-kubernetes | ||
| --- | ||
|
|
||
| # Troubleshoot connected clusters not appearing with ECK installation | ||
|
|
||
| If you are using the ECK installation method (`AutoOpsAgentPolicy` resource) to connect your {{es}} clusters to AutoOps, but you can't view any connected clusters in your account, go through this guide to diagnose and fix common issues. | ||
|
|
||
| ## Verify `AutoOpsAgentPolicy` status | ||
|
|
||
| Check if the `AutoOpsAgentPolicy` resource was successfully created and the ECK operator is processing it correctly. | ||
|
|
||
| :::::{stepper} | ||
|
|
||
| ::::{step} Check if the policy was created | ||
| Run the following command. | ||
| ```shell | ||
| kubectl get autoopsagentpolicy <policy_name> | ||
| ``` | ||
| If the policy doesn't appear, there was an issue with its creation. | ||
|
|
||
| If the policy appears, run the following command to check its status and any associated events. | ||
|
|
||
| ```shell | ||
| kubectl describe autoopsagentpolicy <policy_name> | ||
| ``` | ||
| :::: | ||
|
|
||
| ::::{step} Confirm the issue by checking logs | ||
| Run the following command to show logs. | ||
| ```shell | ||
| kubectl logs -f -n <ECK_operator_namespace> -l control-plane=elastic-operator | ||
| ``` | ||
| If the log contains any errors mentioning `AutoOpsAgentPolicy` or the policy's name, this confirms that the policy's creation and processing is causing the issue. | ||
| :::: | ||
|
|
||
| ::::{step} Re-add the YAML manifest to your configuration file | ||
| Repeat the steps to [install the agent](../autoops/cc-connect-self-managed-to-autoops.md#install-agent) with ECK as your installation method. This should resolve any issues with the policy. | ||
| :::: | ||
|
|
||
| ::::: | ||
|
|
||
| ## Verify that {{agent}} was deployed | ||
|
|
||
| Check if `AutoOpsAgentPolicy` successfully deployed {{agent}} for your {{es}} clusters. | ||
|
|
||
| :::::{stepper} | ||
|
|
||
| ::::{step} List agent deployments | ||
| Run the following command. | ||
| ```shell | ||
| kubectl get deployments -l autoops.k8s.elastic.co/policy-name=<policy_name> | ||
| ``` | ||
| If no deployments appear, there might be an issue with the `resourceSelector` label applied to your {{es}} clusters. If deployments appear but pods are not running, there might be an issue with a specific pod. | ||
| :::: | ||
|
|
||
| ::::{step} Check cluster labels and agent pods | ||
| If no deployments appeared in the previous step, run the following command to check your cluster labels. | ||
| ```shell | ||
| kubectl get elasticsearch <elasticsearch_cluster_name> --show-labels | ||
| ``` | ||
| Make sure that the label you applied in the [Launch AutoOps](../autoops/cc-connect-self-managed-to-autoops.md#launch-autoops) step of the wizard appears correctly in the list. | ||
|
|
||
| If deployments appeared in the previous step, run the following command to check pod status. | ||
| ```shell | ||
| kubectl get pods -l autoops.k8s.elastic.co/policy-name=<policy_name> | ||
| ``` | ||
|
|
||
| If the status indicates that a pod is crashing or in a pending state, run the following command to inspect its events: | ||
| ```shell | ||
| kubectl describe pod <agent_pod_name> | ||
| ``` | ||
| :::: | ||
|
|
||
| ::::: | ||
|
|
||
| ## Validate connection secrets | ||
|
|
||
| Make sure there are no errors in your secret keys. | ||
|
|
||
| :::::{stepper} | ||
|
|
||
| ::::{step} Verify secret content | ||
| Run the following command. | ||
| ```shell | ||
| kubectl get secret <secret_name> -o yaml | ||
| ``` | ||
| Make sure the secret has the following required keys: | ||
| * `autoops-token` | ||
| * `autoops-otel-url` | ||
| * `cloud-connected-mode-api-key` | ||
| :::: | ||
|
|
||
| ::::{step} Confirm secret reference | ||
| Run the following command to confirm that `AutoOpsAgentPolicy` is actually referencing the correct configuration. | ||
| ```shell | ||
| kubectl get autoopsagentpolicy <policy_name> -o jsonpath='{.spec.autoOpsRef.secretName}' | ||
| ``` | ||
| The command should return the correct `.spec.autoOpsRef.secretName`. | ||
| :::: | ||
|
|
||
| ::::: | ||
|
|
||
| ## Check for authorization errors | ||
|
|
||
| When you go through the installation wizard, the ECK operator attempts to create an API key for {{agent}} within {{es}}. If there is an issue with this creation, authorization errors will appear in the operator logs. | ||
| :::::{stepper} | ||
|
|
||
| ::::{step} Pull operator logs | ||
| Run the following command. | ||
| ```shell | ||
| kubectl logs -f -n <ECK_operator_namespace> -l control-plane=elastic-operator | ||
| ``` | ||
| :::: | ||
|
|
||
| ::::{step} Inspect logs | ||
| If any errors in the logs mention "authorization" or "unauthorized connection", go through the installation wizard again so that the operator can reattempt creating a user or API key. | ||
| :::: | ||
|
|
||
| ## Ensure that {{agent}} is allowed to send data to AutoOps | ||
|
|
||
| :::{include} ../_snippets/autoops-allowlist-port-and-urls.md | ||
| ::: | ||
|
|
||
| ## Check cluster health | ||
|
|
||
| Ensure that the {{es}} clusters you are trying to connect to AutoOps are healthy. {{agent}} may fail to connect clusters in a Red state. | ||
|
wajihaparvez marked this conversation as resolved.
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.