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

Release notes 14 Nov 2024 #414

Merged
merged 2 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ AWS
GCP
CORS
IAM
ODBC

ApiOutlined
AppstoreOutlined
Expand Down
16 changes: 16 additions & 0 deletions docs/app/admin/AdminControls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,22 @@ In order to allow Ganymede Flows to read and write to an S3 bucket, follow the s
- Press Create Role
5. Add the Role ARN as an [environment secret in the Ganymede environment](#environment-secrets) named _aws_s3_role_arn_.

#### Connecting to Ganymede from an External Tool

Ganymede can generate Service Account credentials for use with other tools, such as BigQuery or ODBC. Access using these credentials is restricted to read-only data of the environment in which they were generated.

To do this, follow the steps below:
1. Navigate to the Environment Settings page, Integration tab
<img alt="Admin - Integration Panel Add Credentials" src="https://ganymede-bio.mo.cloudinary.net/apiServer/ExportCredentals_NewCredentials20241114.png" />
1. Select 'New Credentials' and enter a description and name for the Credentials
1. Click 'Create'
<img alt="Admin - Integration Panel Copy Key" src="https://ganymede-bio.mo.cloudinary.net/apiServer/ExportCredentals_CopyKey20241114.png" />
1. Copy the JSON key that is displayed and save it to a file.
NOTE: This key is only displayed once, so be sure to save it in a secure location.
NOTE: Treat this key as a password, as it provides access to the Ganymede environment.
1. Use the JSON key to authenticate with the external tool.


### Environment Detection in the SDK

The SDK has helper functions to determine the state of the environments, such as production versus
Expand Down
19 changes: 19 additions & 0 deletions docs/releases/202411.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ title: November 2024
displayed_sidebar: releaseSideBar
---

### November 14 2024

**Features**
- **UI**: Service Accounts can be [exported](../app/admin/AdminControls#connecting-to-ganymede-from-an-external-tool) for use in external applications
- Each service account has read-only access to your table data and metadata
- Access is scoped to a single environment's data
- These can be used in tools that support BigQuery or BigQuery via ODBC
- ** Agents**: Connections can be monitored for disconnect or shutdown events
- Configure this option on the Connection details page
- Adjust the monitoring window as needed
- Emails will be sent when the Connection is Disconnected and when it resumes

**Improvements**
- **Agents**: Improved the robustness of Connections that are restarted after updates were made while they were offline
- **UI**: Better handling of authentication for customers who have changed their email domain while using Ganymede

**Bug Fixes**
- **UI**: Fixed an issues where failed Flow Runs were being marked as Platform Error that had other causes

### November 7 2024

**Features**
Expand Down