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.

Sign up for GitHub

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

update connectivity check #363

Closed
wants to merge 1 commit into from
Closed

update connectivity check #363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/app/agents/Agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Users specify these actions by configuring the Agent in the Ganymede app. Doing

After creating an Agent, users can build and install local executables called Connections, individual instances of a given Agent, on instrument PCs. Each Connection consists of a combination of user-defined code and Ganymede configuration, providing flexibility in capturing files and interacting with the Ganymede ecosystem.

For system requirements, see [Agent Network Config & Prerequisites](../configuration/AgentNetworkConfig).
For system requirements, see [Agent Network Config & Prerequisites](../configuration/AgentSystemRequirements).

### Terminology

Expand Down Expand Up @@ -512,7 +512,7 @@ To do so, follow the steps below:
- Use Windows Credential Manager to store the remote user's credentials on the local system.
- Or, create matching local (if cross-domain) or domain (if on the same domain, e.g. AD) user accounts on both the remote and local systems.
2. **Check Network**:
- Ensure both systems can communicate as described on the [Agent Network Config page](../configuration/AgentNetworkConfig)
- Ensure both systems can communicate as described on the [Agent Network Config page](../configuration/AgentSystemRequirements)
3. **Service Configuration**:
- Open `services.msc` on the local system.
- Find and right-click the Ganymede service > `Properties` > `Log On`. Use the local user account where the credentials are stored (not the "Local System Account").
Expand Down
2 changes: 1 addition & 1 deletion docs/app/agents/AgentLogs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ The messages in the table below are OS-agnostic messages that are printed depend
| Unable to ping API Server at \{api_url.geturl()\} | | Health Check | INITIALIZING | Error | N/A |
| Unable to ping Pub/Server API Server | Unable to ping Pub/Server for Ganymede Cloud. | Health Check | INITIALIZING | Error | N/A |
| Unable to ping GCS API Server | | Health Check | INITIALIZING | Error | N/A |
| Stopping and disabling connection service. It will not resume without user intervention. Exe: \{exe location\}. Reason: Health checks did not pass, agent functionality limited. Connection service must shut down until this is resolved. | Startup health check did not run successfully. The health check is described on https://docs.ganymede.bio/app/configuration/AgentNetworkConfig#testing-connectivity. Stopping and disabling service. | Health Check | INITIALIZING | Info | Exception |
| Stopping and disabling connection service. It will not resume without user intervention. Exe: \{exe location\}. Reason: Health checks did not pass, agent functionality limited. Connection service must shut down until this is resolved. | Startup health check did not run successfully. The health check is described on https://docs.ganymede.bio/app/configuration/AgentSystemRequirements#testing-connectivity. Stopping and disabling service. | Health Check | INITIALIZING | Info | Exception |
| Stopping and disabling connection service. It will not resume without user intervention. Exe: \{exe location\}. Reason: Agent cannot be found in api-server. Connection service must shut down. | Either unable to register connection or share that connection state is live. Had an ApiException in internal Agent API communication with 404 status code. | Register Connection | INITIALIZING | Error | openapi_client.ApiException with 404 status code |
| Unable to register connection. | Either unable to register connection or share that connection state is live. Did not have an ApiException in internal Agent API communication with 404 status code. | Register Connection | INITIALIZING | Error | Exception (other than openapi_client.ApiException with 404 status code) |
| Starting new connection \{id\} with labels \{labels\} and vars \{variables\} | Registering connection | Register Connection | INITIALIZING | Info | N/A |
Expand Down
6 changes: 3 additions & 3 deletions docs/app/agents/DebuggingAgents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ A: No, there are no command-line scripts that need to execute for the Windows Ag

#### Q: Are there any known application dependencies or pre-requisites for the Windows Agent (e.g. - .NET, KBs, Redist)?

A: No, the full set of Agent requirements can be found on the [Agent System Requirements page](../configuration/AgentNetworkConfig.mdx).
A: No, the full set of Agent requirements can be found on the [Agent System Requirements page](../configuration/AgentSystemRequirements.mdx).

## Troubleshooting

Expand All @@ -73,7 +73,7 @@ Check for existing installations that might conflict with the current installati

#### Issue: I've installed an Agent Connection, but do not see the Connection in logs.

This is likely a network issue, which can be confirmed by [testing connectivity](../configuration/AgentNetworkConfig#testing-connectivity).
This is likely a network issue, which can be confirmed by [testing connectivity](../configuration/AgentSystemRequirements#testing-connectivity).

Another way to confirm this is to see

Expand All @@ -83,7 +83,7 @@ ssl.SSLCertVerificationError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verif

in the Connection logs file found locally on the computer. These logs can be found in the directory that the Agent Connection is installed in.

To resolve, ensure that outbound port 443 communication is available to the web addresses mentioned on the [Agent System Requirements page](../configuration/AgentNetworkConfig#testing-connectivity).
To resolve, ensure that outbound port 443 communication is available to the web addresses mentioned on the [Agent System Requirements page](../configuration/AgentSystemRequirements#testing-connectivity).

#### Issue: The Agent Connection is not actively running. How do I check?

Expand Down
8 changes: 4 additions & 4 deletions .../app/configuration/AgentNetworkConfig.mdx → ...configuration/AgentSystemRequirements.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: AgentNetworkConfig
id: AgentSystemRequirements
title: Agent System Requirements
displayed_sidebar: webUiSidebar
---
Expand Down Expand Up @@ -39,9 +39,9 @@ If direct access to the internet is not allowed (proxy), configure your Proxy to
For Windows Agents, connectivity can be tested by running the following commands in PowerShell:

```powershell
$ Test-NetConnection -ComputerName storage.googleapis.com -Port 443
$ Test-NetConnection -ComputerName pubsub.googleapis.com -Port 443
$ Test-NetConnection -ComputerName <tenant_name>.ganymede.bio -Port 443
$ IWR -URI storage.googleapis.com
$ IWR -URI pubsub.googleapis.com
$ IWR -URI <tenant_name>.ganymede.bio
```

### Linux Agents
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ module.exports = {
label: 'Agents & Connections',
collapsed: true,
items: [
'app/configuration/AgentNetworkConfig',
'app/configuration/AgentSystemRequirements',
{
type: 'doc',
id: 'app/agents/Agent',
Expand Down
Loading