Add checkpoints, overview, and Redis to Seqera AI install guide by odagayev · Pull Request #1266 · seqeralabs/docs

odagayev · 2026-04-02T19:06:49Z

Summary

Adds an Overview section explaining what the CX person is installing (web + CLI chat capabilities) with a sequenced component table (MCP → DB → Redis → Agent backend → Portal)
Restructures the guide into 5 numbered steps, each with a verification checkpoint (concrete commands + expected output) so CX engineers know exactly when a step succeeded before moving on
Adds a Permissions subsection to prerequisites listing all required access (K8s, DB admin, DNS, IAM, secrets, Helm, TLS)
Adds Redis as a prerequisite, installation step, and reference entries (env vars + Helm values)
Removes Helm-only deployment requirement — Platform can be deployed via Helm, Kubernetes, or Docker Compose
Updates database guidance to recommend using the same instance as Platform (with option for a separate instance)

Test plan

Verify doc renders correctly in Docusaurus preview
Review checkpoint commands for accuracy with engineering
Validate Redis Helm values and env var names against the actual chart

Made with Cursor

Restructure the enterprise Seqera AI installation doc to be more checkpoint-oriented so CX engineers have clear success indicators at each stage. Adds an overview of what is being installed, sequential numbered steps (MCP first, then DB, Redis, agent backend, verify), permissions section, Redis as a prerequisite, and removes the Helm-only deployment requirement. Made-with: Cursor

netlify · 2026-04-02T19:06:55Z

✅ Deploy Preview for seqera-docs ready!

Name	Link
🔨 Latest commit	`791023d`
🔍 Latest deploy log	https://app.netlify.com/projects/seqera-docs/deploys/69d7ac22ceb4050008980422
😎 Deploy Preview	https://deploy-preview-1266--seqera-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

justinegeffen · 2026-04-09T13:29:24Z

platform-enterprise_docs/enterprise/install-seqera-ai.md


+## Overview
+
+Seqera AI enables users to interact with Seqera Platform through a conversational AI interface, available through both the web (portal) and the CLI. Deploying Seqera AI involves standing up the following components in sequence:


@odagayev - what happens if the sequence isn't followed? Can the user expect an error? Is there a way to remediate?

justinegeffen · 2026-04-09T13:30:35Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

+Seqera AI requires its own MySQL database for session state and conversation history. You can create this database on the same instance that hosts your Platform database (recommended) or on a separate dedicated instance.
+
+:::tip Recommended: Use the same database instance as Platform
+Creating the Seqera AI database on your existing Platform database instance simplifies infrastructure management, reduces costs, and avoids additional networking configuration. The Seqera AI database is lightweight and does not compete for resources with the Platform database under typical usage.


Do we have an idea of "typical usage" parameters? If there are competing resource requirements where can this be managed?

This should not be a recommendation.

We should not be advising customers on how they do their database techologies.

Seqera AI should be on it's own DB schema separate from platform, it can live on it's own host.

Note recommending infrastructure goes against the persona the installation documentation is intended for which is an experienced system administrator.

@odagayev - where in the Enterprise docs would this content live? If it's meant as an installation guide, it would go under this section: https://docs.seqera.io/platform-enterprise/enterprise/overview and should follow the same structure and persona.

@gavinelder - I know we have a persona file for this; is there an opportunity to create a template for this/other content that follows the current structure and content guidelines?

justinegeffen · 2026-04-09T13:39:03Z

Thanks, @odagayev!

I've added some comments and also wanted to confirm how we can test/validate all the steps provided. Also looping DevOps in here as they have done a lot of work on the Enterprise installation docs and may have feedback on this.

bebosudo

some initial comments

bebosudo · 2026-04-09T15:41:06Z

platform-enterprise_docs/enterprise/install-seqera-ai.md


- **Seqera Enterprise 26.1+** deployed via [Helm](./platform-helm.md)
+- **Seqera Enterprise 26.1+** deployed and accessible. Platform can be deployed via [Helm](./platform-helm.md), [Kubernetes](./platform-kubernetes.md), or [Docker Compose](./platform-docker-compose.md) — a Helm-based deployment is not required.
 - **MySQL 8.0+ database**


Shouldn't kubernetes be a requirement too?

bebosudo · 2026-04-09T15:43:09Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

+Connect to your database instance and create the Seqera AI database and user:
+
+```sql
+CREATE DATABASE seqera_ai;
+CREATE USER 'seqera_ai'@'%' IDENTIFIED BY '<secure-password>';
+GRANT ALL PRIVILEGES ON seqera_ai.* TO 'seqera_ai'@'%';
+FLUSH PRIVILEGES;
+```
+


Suggested change

Connect to your database instance and create the Seqera AI database and user:

```sql

CREATE DATABASE seqera_ai;

CREATE USER 'seqera_ai'@'%' IDENTIFIED BY '<secure-password>';

GRANT ALL PRIVILEGES ON seqera_ai.* TO 'seqera_ai'@'%';

FLUSH PRIVILEGES;

```

do we need to provide instructions on how to set up a mysql db? are these instructions generic to all mysql implementations?

bebosudo · 2026-04-09T15:44:06Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

+### Checkpoint: Verify database connectivity
+
+Confirm the database is accessible from your cluster:
+
+```bash
+kubectl run db-check --rm -it --restart=Never \
+    --image=mysql:8.0 -- \
+    mysql -h <db-hostname> -u seqera_ai -p<secure-password> -e "SELECT 1;"
+```
+
+You should see a result set with the value `1`. If this fails, check security group rules and network connectivity.
+


Suggested change

### Checkpoint: Verify database connectivity

Confirm the database is accessible from your cluster:

```bash

kubectl run db-check --rm -it --restart=Never \

--image=mysql:8.0 -- \

mysql -h <db-hostname> -u seqera_ai -p<secure-password> -e "SELECT 1;"

```

You should see a result set with the value `1`. If this fails, check security group rules and network connectivity.

This feels like out of scope for this guide
The helm chart already has an init container that stops until the db is available

bebosudo · 2026-04-09T15:44:45Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

+
+## Step 3: Provision Redis
+
+Seqera AI requires a Redis instance for caching and session management. Use a managed Redis service or a self-managed instance, as long as it is accessible from your cluster on port 6379.


Suggested change

Seqera AI requires a Redis instance for caching and session management. Use a managed Redis service or a self-managed instance, as long as it is accessible from your cluster on port 6379.

Seqera AI requires a Redis-compatible instance for caching and session management. Seqera recommends a managed Redis service.

bebosudo · 2026-04-09T15:45:02Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

+
+Seqera AI requires a Redis instance for caching and session management. Use a managed Redis service or a self-managed instance, as long as it is accessible from your cluster on port 6379.
+
+- **Engine**: Redis 6.0+


were the apps tested with redis 6?

bebosudo · 2026-04-09T15:45:31Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

+Seqera AI requires a Redis instance for caching and session management. Use a managed Redis service or a self-managed instance, as long as it is accessible from your cluster on port 6379.
+
+- **Engine**: Redis 6.0+
+- **Security group**: Allow inbound Redis (port 6379) from your cluster


Suggested change

- **Security group**: Allow inbound Redis (port 6379) from your cluster

this is out of scope for this guide

gavinelder · 2026-04-09T15:40:22Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

 Before you begin, you need:

- **Seqera Enterprise 26.1+** deployed via [Helm](./platform-helm.md)
+- **Seqera Enterprise 26.1+** deployed and accessible. Platform can be deployed via [Helm](./platform-helm.md), [Kubernetes](./platform-kubernetes.md), or [Docker Compose](./platform-docker-compose.md) — a Helm-based deployment is not required.


Suggested change

- **Seqera Enterprise 26.1+** deployed and accessible. Platform can be deployed via [Helm](./platform-helm.md), [Kubernetes](./platform-kubernetes.md), or [Docker Compose](./platform-docker-compose.md) — a Helm-based deployment is not required.

- **Seqera Enterprise 26.1+** deployed and accessible.

At most we should link back to the front page for the platform install docs, we do not have to rehash or make comment that Helm-Based install is not required.

gavinelder · 2026-04-09T15:41:13Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

- **Seqera Enterprise 26.1+** deployed via [Helm](./platform-helm.md)
+- **Seqera Enterprise 26.1+** deployed and accessible. Platform can be deployed via [Helm](./platform-helm.md), [Kubernetes](./platform-kubernetes.md), or [Docker Compose](./platform-docker-compose.md) — a Helm-based deployment is not required.
 - **MySQL 8.0+ database**
+- **Redis 6.0+** instance accessible from your cluster


This does not align to the other language used in the installation documentation.

Redis 6 is no longer supported and EOL and not compatible with other platform components.

gavinelder · 2026-04-09T15:41:41Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

+- **Secret management**: Access to create Kubernetes secrets in the target namespace
+- **Helm**: Permission to install and upgrade Helm releases in the target namespace
+- **TLS certificate management**: Access to provision or reference TLS certificates (e.g., via AWS Certificate Manager)
+


This should move up to requirements.

gavinelder · 2026-04-09T15:41:57Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

+- **Database administration**: Ability to create databases and users on the MySQL instance
+- **DNS management**: Access to create or update DNS records for the Seqera AI subdomains
+- **AWS IAM** (if using Bedrock): Permissions to invoke Bedrock models in the target AWS account
+- **Secret management**: Access to create Kubernetes secrets in the target namespace


Secrets management is a deployment choice and not a requirement.

gavinelder · 2026-04-09T15:48:41Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

 | **MCP server** | Model Context Protocol server providing Platform-aware tools (workflows, datasets, compute environments). |
 | **Portal web interface** | Browser-based interface for Seqera AI and related Platform features. |
-| **MySQL database** | Dedicated database for session state and conversation history. **Separate from Platform database**. |
+| **MySQL database** | Database for session state and conversation history. Can share the same instance as Platform (recommended) or use a dedicated instance. |


Suggested change

| **MySQL database** | Database for session state and conversation history. Can share the same instance as Platform (recommended) or use a dedicated instance. |

| MySQL database | Dedicated database for session state and conversation history.

From claudio

The original wording correctly states the requirement for a dedicated database separate from the Platform database. The proposed change introduces deployment methodology detail which is out of scope for a requirements.

Database = A logically separated, named collection of structured data with its own schema, access controls, and namespace.
Instance = A running deployment of a database engine that may host one or more databases.

gavinelder · 2026-04-09T15:50:05Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

 1. Results stream back to the CLI via Server-Sent Events (SSE).

-## Configure Helm values
+## Step 1: Deploy the MCP server


We should move this to it's own stand alone install guide. ( Noted for future improvement)

gavinelder · 2026-04-09T15:51:36Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

+
+You should see a result set with the value `1`. If this fails, check security group rules and network connectivity.
+
+## Step 3: Provision Redis


This is a requirement and not something we specify in documentation.

The target persona should know how to do this.

gavinelder · 2026-04-09T15:51:53Z

platform-enterprise_docs/enterprise/install-seqera-ai.md

+Seqera AI requires a Redis instance for caching and session management. Use a managed Redis service or a self-managed instance, as long as it is accessible from your cluster on port 6379.
+
+- **Engine**: Redis 6.0+
+- **Security group**: Allow inbound Redis (port 6379) from your cluster


Redundant and cloud specific.

christopher-hakkaart and others added 4 commits April 7, 2026 12:03

Merge branch 'master' into sasha-ent-ai-install-checkpoints-v2

9c4e823

Merge branch 'master' into sasha-ent-ai-install-checkpoints-v2

1fa6e41

Merge branch 'master' into sasha-ent-ai-install-checkpoints-v2

918818d

Merge branch 'master' into sasha-ent-ai-install-checkpoints-v2

993c983

justinegeffen approved these changes Apr 9, 2026

View reviewed changes

justinegeffen reviewed Apr 9, 2026

View reviewed changes

justinegeffen requested a review from a team April 9, 2026 13:39

justinegeffen added 1. Editor review Needs a language review 1. Dev/PM/SME Needs a review by a Dev/PM/SME do not merge Do not merge until this label is removed labels Apr 9, 2026

Merge branch 'master' into sasha-ent-ai-install-checkpoints-v2

791023d

bebosudo reviewed Apr 9, 2026

View reviewed changes

gavinelder reviewed Apr 9, 2026

View reviewed changes

justinegeffen marked this pull request as draft April 9, 2026 18:17

justinegeffen added the enterprise-26.1 label Apr 9, 2026


		## Overview

		Seqera AI enables users to interact with Seqera Platform through a conversational AI interface, available through both the web (portal) and the CLI. Deploying Seqera AI involves standing up the following components in sequence:


		## Step 3: Provision Redis

		Seqera AI requires a Redis instance for caching and session management. Use a managed Redis service or a self-managed instance, as long as it is accessible from your cluster on port 6379.

	Seqera AI requires a Redis instance for caching and session management. Use a managed Redis service or a self-managed instance, as long as it is accessible from your cluster on port 6379.
	Seqera AI requires a Redis-compatible instance for caching and session management. Seqera recommends a managed Redis service.


		Seqera AI requires a Redis instance for caching and session management. Use a managed Redis service or a self-managed instance, as long as it is accessible from your cluster on port 6379.

		- Engine: Redis 6.0+

	- Seqera Enterprise 26.1+ deployed and accessible. Platform can be deployed via [Helm](./platform-helm.md), [Kubernetes](./platform-kubernetes.md), or [Docker Compose](./platform-docker-compose.md) — a Helm-based deployment is not required.
	- Seqera Enterprise 26.1+ deployed and accessible.

	\| MySQL database \| Database for session state and conversation history. Can share the same instance as Platform (recommended) or use a dedicated instance. \|
	\| MySQL database \| Dedicated database for session state and conversation history.


		You should see a result set with the value `1`. If this fails, check security group rules and network connectivity.

		## Step 3: Provision Redis

Conversation

odagayev commented Apr 2, 2026

Summary

Test plan

Uh oh!

netlify bot commented Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for seqera-docs ready!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gavinelder Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justinegeffen commented Apr 9, 2026

Uh oh!

bebosudo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

netlify bot commented Apr 2, 2026 •

edited

Loading

gavinelder Apr 9, 2026 •

edited

Loading