Skip to content

Commit

Permalink
describe versions panel; max active runs (#379)
Browse files Browse the repository at this point in the history
* point to download agent from release notes

* clarify installation instructions

* flesh out admin panel with latest changes

* describe max active runs

* upd

* spellcheck
  • Loading branch information
bensonlee5 authored Sep 21, 2024
1 parent 64e179c commit 3b9ab93
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 4 deletions.
12 changes: 12 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -328,3 +328,15 @@ xxxxxxxx
xxxxxxxxxxxx
BenchlingClass
DataValidation
Autorun
dropdowns
greyed
requeues
unselected
VM
hoc
NotebookIcon
CaretRightOutlined
NodeIndexOutlined
NotificationOutlined
FlowEditor
15 changes: 13 additions & 2 deletions docs/app/admin/AdminControls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Admin page enables administrators to manage user access, configure environme

The Roles panel shown below enables administrators to specify access levels for different users. The Last Seen column is populated in the permissions panel for users that have accessed Ganymede after [August 2024](../../releases/202408#august-15-2024), when the feature was introduced.

<img alt="Admin - Access Panel" src="https://ganymede-bio.mo.cloudinary.net/apiServer/Admin_Panel_20240903.png" />
<img alt="Admin - Access Panel" src="https://ganymede-bio.mo.cloudinary.net/apiServer/Admin_Panel_20240920.png" />
&nbsp;

There are five levels of access for Flows and Agents.
Expand All @@ -36,7 +36,7 @@ For dashboards, permissions can be viewed by navigating to the dashboards page a
The Secrets panel enables administrators to configure secrets that are used by Ganymede cloud to connect to external services such as Benchling or AWS. These secrets are specific to the nodes used within a given environment (i.e. - development or production environment).
The example shown in the image below shows an environment with a AWS S3 Role ARN specified, enabling connectivity between Ganymede cloud and AWS S3 Storage when using the [S3_Read](../../nodes/App/S3_Read) or [S3_Write](../../nodes/App/S3_Write) nodes.

<img alt="Admin - Secrets Panel" src="https://ganymede-bio.mo.cloudinary.net/apiServer/SecretsPanel_20240903.png" />
<img alt="Admin - Secrets Panel" src="https://ganymede-bio.mo.cloudinary.net/apiServer/SecretsPanel_20240920.png" />

Admins can add secrets by clicking on the Add Secret button and edit secrets as appropriate.

Expand All @@ -48,6 +48,17 @@ Secrets cannot be viewed from this panel, so if a secret is lost, it can either

Any secrets entered here will not be committed into code, but can be printed by environment users with the *Writer* or *Admin* role in notebooks.

### Environment Version

The Environment Version panel displays version information for the Ganymede environment:

<img alt="Admin - Version Panel" src="https://ganymede-bio.mo.cloudinary.net/apiServer/VersionPanel_20240920.png" />

- **Environment Versions**: The version of the Ganymede environment
- **Connection Versions**: The latest version of each Connection, along with links to each Connection page
- **Agent Versions**: The latest version of each Agent, along with links to historical Agent binaries
- **Flow Versions**: The latest version of each Flow, along with links to the Flow Version History page showing commit history for each Flow

### Platform Integration Details

The Integration panel contains details about the Ganymede environment, which can be used for integration with external systems, as well as for IP whitelisting Ganymede.
Expand Down
33 changes: 33 additions & 0 deletions docs/app/agents/AgentInstall.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ To install a Connection, open the Ganymede application in a browser window and n
1. Select the Windows EXE option to download the agent in your browser.
1. An executable named \<your_agent>_\<id\>.exe should download to the PC

:::info

If you would like to download the Windows Agent through a script, you can do so [through the Ganymede API](../../api/download-agent.api.mdx).

:::

### Step 2: Run the Agent Installer

<div class="text--center">
Expand Down Expand Up @@ -50,6 +56,12 @@ To install a Connection, open the Ganymede application in a browser window and n
1. Ensure the **Launch Ganymede Agent** checkbox is checked.
2. Click **Finish** to exit the installer and start the Agent service.

:::info

The Windows Agent installer can be [run headlessly](./DebuggingAgents.mdx#q-can-windows-agents-be-installed-headlessly) if desired.

:::

### Step 3: Check the Connection Status

1. Navigate to the Connections page in Ganymede.
Expand Down Expand Up @@ -101,6 +113,25 @@ There may be a slight delay as the service connection resumes.

## Linux Installation

### Step 1: Download the Agent

1. Open the Ganymede application in a Google Chrome window: \<tenant\>.ganymede.bio
2. On the top panel, navigate to the appropriate environment (e.g. - development or production, as appropriate) for your tenant (if not already there).
3. Navigate to the Connections page by selecting the <div className="button darkblue_button"><ApiOutlined /></div> icon in the left toolbar.
4. Select the Agents subsection of the Connections page to view all available Agents.
5. Find your Agent and hover over the <div className="button darkblue_button_mui_reverse"><DownloadOutlined /> Download</div> button.
1. Select the Linux option to download the agent in your browser.
1. An executable named \<your_agent>_\<id\>.exe should download to the PC

:::info

If you would like to download the Linux Agent through a script, you can do so [through the Ganymede API](../../api/download-agent.api.mdx).

:::


### Step 2: Create the Agent Service file

After downloading the agent, modify permissions for the binary to 755.

```bash
Expand Down Expand Up @@ -142,6 +173,8 @@ WantedBy=multi-user.target
- **StandardError**: log file for Connection errors.
- **WantedBy**: Specifies that, if the service has been enabled, it should start when multi-user.target is reached during boot. This occurs when the system is operational and ready for multiple users to log in and use the system in non-graphical mode.

### Step 3: Start the Agent Service

Once the service file is created, start the Agent by copying the file to /etc/systemd/system/ and setting permissions of the service file to 644. For example, if the systemd service file were named _ganymede_example_agent.service_, run:

```bash
Expand Down
3 changes: 2 additions & 1 deletion docs/app/flows/FlowEditor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Click the <div className="button darkblue_button">**Manage <SettingOutlined />**
* **Id**: Unique ID for the Flow.
* **Owner**: Owner of the Flow. The Flow will appear on the home page for the owner of a flow.
* [**Retries**](#configuring-retries): How many times the Flow would retry to execute a node, in case of an error or a timeout.
* **Max Active Runs**: Maximum number of Flow runs that can be active for the Flow at the same time; additional Flow runs requested are queued for later execution. This can be useful, for example, for preventing contention issues resulting from multiple Flow runs making similar requests to a third-party API in a Flow used for synchronizing systems.
* **Production Mode**: Toggle to place Flow in *production mode*, which makes all tabular data written by the Flow to be done append-only.

:::info
Expand Down Expand Up @@ -83,7 +84,7 @@ The Run Queue Bar located at the bottom of the screen contains buttons for execu

To create a new Flow, click the <div className="button darkblue_button">**Manage <SettingOutlined />**</div> button in the upper right hand corner of the screen. Then click the <div className="button black_button"><PlusOutlined /> Add New Flow</div> button on the sidebar. This action exposes a modal for naming and describing the Flow.

<img alt="Add new flow" src="https://ganymede-bio.mo.cloudinary.net/apiServer/AddNewFlow_20240617.png"/>
<img alt="Add new flow" src="https://ganymede-bio.mo.cloudinary.net/apiServer/AddNewFlow_20240920.png"/>

### Documenting Flows

Expand Down
2 changes: 1 addition & 1 deletion docs/releases/202409.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ displayed_sidebar: releaseSideBar
### September 12 2024

**Features**
- **UI**: The Environment Version summary is available in the Environment Settings menu
- **UI**: The [Environment Version summary](../app/admin/AdminControls#environment-version) is available in the Environment Settings menu
- This summary includes the version number of each Agent, Connection, and Flow in the environment
- Clicking an Agent or Flow will show the history of that item
- This view can be used in cases where stability and traceability are important
Expand Down

0 comments on commit 3b9ab93

Please sign in to comment.