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

GA changes to docs for Agent #2390

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

GA changes to docs for Agent #2390

wants to merge 8 commits into from

Conversation

NickJosevski
Copy link
Contributor

@NickJosevski NickJosevski commented Jul 26, 2024

I took the questions and answers from communit slack to create this FAQ at the end of the trouble shooting page.

I opt'd for keeping the question part vague similar to how customers asked it in slack, so more people consider that a specific issue may be what they're experiencing.

The slack messages will slowly be less accessible to us, as there's a rolling window of what we can see (maybe 90 days of history in community slack).

@NickJosevski NickJosevski marked this pull request as ready for review July 26, 2024 05:49
NickJosevski and others added 3 commits July 29, 2024 11:47
…bernetes-agent/troubleshooting.md

Co-authored-by: Mark Coafield <[email protected]>
remove this to put in other page
@@ -44,6 +44,14 @@ If the Agent install command fails with a timeout error, it could be that:
- (if using the NFS storage solution) The NFS CSI driver has not been installed
- (if using a custom Storage Class) the Storage Class name doesn't match

#### 404 error when setting up the NFS Pod.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@APErebus The 404 error when setting up the NFS pod should also just a troubleshooting node
did you mean to put it here under Installation Issues?

### When trying to install the Kubernetes Agent on an existing cluster, I get an 401: Unauthorized error.

```
Error: GET "https://registry-1.docker.io/v2/octopusdeploy/kubernetes-agent/tags/list":
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is based on this exchange:

image


Check if your version of help is up to date. In versions the error message you might be experiencing is [not shown]([url](https://github.com/helm/helm/blob/1ec0aacb8865d5b1f7ef1cb884bbf9b12579ecef/pkg/action/install.go#L753-L769)).

Once you version of help is up to date, run `helm repo update` and try again.
Copy link
Contributor

Choose a reason for hiding this comment

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

__

Suggested change
Once you version of help is up to date, run `helm repo update` and try again.
Once your version of help is up to date, run `helm repo update` and try again.


## Frequently Asked Questions {#FAQ}

### Can the agent work with Octopus running in an HA Cluster setup?
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Can the agent work with Octopus running in an HA Cluster setup?
### Can the agent work with Octopus running in a HA Cluster setup?



### Can a proxy be specified when setting up the Kubernetes agent?
Yes! Proxy servers for the polling connection that takes place between the agent and Octopus Server. These can be supplied for setup via the `.pollingProxy.*` helm values.
Copy link
Contributor

Choose a reason for hiding this comment

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

the second sentence feels incomplete - update to be:
Yes! Proxy servers for the polling connection that takes place between the agent and Octopus Server are supported - their configuration can be set via the .pollingProxy.* helm values.

If that doesn't help, please [get in touch](https://octopus.com/support).

### I'm having strange behavior relating to ingress in a HA configuration.
Carefully look and see that there is a `serverCommsAddress` property for backwards compatibility, and a `serverCommsAddresses` the latter supporting an array input, mistyping these can happen. This has presented itself as a variety of errors depending on the broader configuration, e.g. you may see "it failed to allocate the public ip" if using load balancers.
Copy link
Contributor

Choose a reason for hiding this comment

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

'Carefully look and see ...' felt odd to me - potential reword?
"Carefully check that both the 'serverCommsAddress' and 'ServerCommsAddress' properties exist. The latter supports an array input - errors in these fields may result in erroneous HA behaviour.

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.

4 participants