Skip to content

Commit 02437a8

Browse files
committed
fix: update User Quick Start Guide and docker-compose to reflect latest changes and version updates
1 parent 0f2b4dd commit 02437a8

File tree

2 files changed

+12
-98
lines changed

2 files changed

+12
-98
lines changed

netapp-neo/USER_QUICKSTART_M365.md

Lines changed: 11 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,24 @@
11
# NetApp Neo deployment User Quick Start Guide (v3.x)
22

3-
> \[!IMPORTANT\]
4-
> NetApp Neo for M365 Copilot is currently in **Private Preview**. This means that the connector is not yet fully supported and may have some limitations. The connector requires a license to activate. You can request access to the connector by joining the Early Access Program (EAP). Please book a meeting with the following link to join the EAP: [Book a meeting with NetApp](https://outlook.office.com/bookwithme/user/[email protected]/meetingtype/nm-mXkp-TUO1CdzOmFfIBw2?anonymous&ismsaljsauthenabled&ep=mlink).
5-
6-
> \[!IMPORTANT\]
7-
> AWS ECS (Fargate) is NOT supported. This is due to the containers being unable to mount shares to the container(s) - a critical requirement of NetApp Neo.
3+
> \[!IMPORTANT\]
4+
>
5+
> - **THIS GUIDE HAS BEEN SUPERSEDED.** Please refer to the latest version of this guide at: [NetApp Project Neo Documentation](https://netapp.github.io/netapp-connector-docs/)
6+
> - NetApp Neo for M365 Copilot is currently in **Private Preview**. This means that the connector is not yet fully supported and may have some limitations. The connector requires a license to activate. You can request access to the connector by joining the Early Access Program (EAP). Please book a meeting with the following link to join the EAP: [Book a meeting with NetApp](https://outlook.office.com/bookwithme/user/[email protected]/meetingtype/nm-mXkp-TUO1CdzOmFfIBw2?anonymous&ismsaljsauthenabled&ep=mlink).
7+
> - AWS ECS (Fargate) is NOT supported. This is due to the containers being unable to mount shares to the container(s) - a critical requirement of NetApp Neo.
88
99
## 1\. Prerequisites
1010

11-
### Network Requirements
12-
13-
- **Port 443** open for outbound traffic to the MS Graph API
14-
- **Port 8080** open for internal management of the connector
15-
- **Port 445** open for SMB file share access
16-
- SMB File Share(s) must be routable to the connector
17-
18-
### Software Requirements
19-
20-
- Microsoft 365 Copilot License
21-
- Docker installed on the machine where the connector will be deployed
22-
- Access to the offline tar image of the connector
23-
- (Optional) Docker Compose installed on the machine where the connector will be deployed
24-
- (Optional) Access to a Kubernetes cluster for deployment
25-
26-
### Register the connector in Azure Entra
27-
28-
In order for the connector to be able to securely communicate with M365 Copilot.
29-
30-
![Select App Registration in the Add menu in Microsoft Azure Entra](./media/2025-03-10_20-17-27.png)
31-
32-
1. Navigate to the Azure Entra portal and select "Add" and select the "App Registration" option.
33-
2. Fill in the required fields and click "Register". (No Redirect URI is required)
34-
3. Copy the Application (client) ID and Directory (tenant) ID from the Overview page.
35-
4. Navigate to the "API permissions" page and select "Add a permission".
36-
5. Select "Microsoft Graph" and then "Application permissions".
37-
6. Search for "ExternalConnection.ReadWrite.OwnedBy" and select the checkbox.
38-
7. Search for "ExternalItem.ReadWrite.OwnedBy" and select the checkbox.
39-
8. Search for "User.Read" and select the checkbox.
40-
9. Search for "User.Read.All" and select the checkbox.
41-
10. Search for "Group.Read.All" and select the checkbox
42-
11. Click "Add permissions".
43-
12. Click "Graph admin consent for (tenant)" and click "Yes".
44-
13. Navigate to the "Certificates & secrets" page and click "New client secret".
45-
14. Fill in the required fields and click "Add".
46-
15. Copy the value of the client secret.
47-
48-
You have successfully registered the connector in Azure ENTRA. You will need the Application ID, Directory ID, and Client Secret for the next steps.
49-
11+
Please refer to the latest prerequisites here: [Prerequisites](https://netapp.github.io/netapp-connector-docs/prerequisites.html)
5012

5113
## 2\. Getting Started
5214

53-
The easiest way to get started is by using the pre-built container image. You can run the connector using Docker/Podman or deploy it to a Kubernetes cluster using Helm.
15+
Please refer to the latest quickstart instructions here: [Quick Start](https://netapp.github.io/netapp-connector-docs/quick-start.html)
5416

5517
### Database Options
5618

57-
**Version 3.0+ supports multiple database backends:**
58-
59-
- **PostgreSQL**: For production deployments with high availability (Recommended)
60-
- **MySQL**: Alternative production database option
19+
Please refer to the latest database options here: [Database Options](https://netapp.github.io/netapp-connector-docs/prerequisites.html#database-options)
6120

62-
To use PostgreSQL or MySQL, set the `DATABASE_URL` environment variable:
63-
64-
```bash
65-
# PostgreSQL example
66-
DATABASE_URL=postgresql://user:password@localhost:5432/netapp_connector
67-
68-
# MySQL example
69-
DATABASE_URL=mysql://user:password@localhost:3306/netapp_connector
70-
```
71-
72-
### Deploy using Docker/Podman
21+
### Deploy using Docker/Podman
7322

7423
#### Pull the image
7524

@@ -80,7 +29,7 @@ docker pull ghcr.io/netapp/netapp-copilot-connector:latest
8029
or for a specific version:
8130

8231
```bash
83-
docker pull ghcr.io/netapp/netapp-copilot-connector:3.0.0
32+
docker pull ghcr.io/netapp/netapp-copilot-connector:3.1.0
8433
```
8534

8635
> \[!TIP\]
@@ -92,57 +41,22 @@ docker pull ghcr.io/netapp/netapp-copilot-connector:3.0.0
9241
>
9342
> For GPU support, uncomment the `deploy` section in the `docker-compose.yml` file and ensure you have the appropriate GPU runtime installed.
9443
95-
#### Configure and Run
96-
97-
1. **Download the sample configuration files:**
98-
99-
- Download the [Sample .env file](./dist/.env.example ".env.example") and rename it to `.env`
100-
- Download the [docker-compose.yml](./dist/docker-compose.yml "docker-compose.yml") file
101-
102-
2. **Configure the `.env` file with the required environment variables:**
103-
104-
```bash
105-
# NetApp Settings (Required)
106-
NETAPP_CONNECTOR_LICENSE=your-licence-key-here
107-
108-
# Microsoft Graph configuration (Required)
109-
MS_GRAPH_CLIENT_ID=your-client-id-here
110-
MS_GRAPH_CLIENT_SECRET=your-client-secret-here
111-
MS_GRAPH_TENANT_ID=your-tenant-id-here
112-
113-
# Database Configuration (Required- PostgreSQL is recommended)
114-
DB_TYPE=postgres # Options postgres, mysql
115-
## For PostgreSQL:
116-
DATABASE_URL=postgresql://user:password@localhost:5432/netapp_connector
117-
## or for MySQL:
118-
DATABASE_URL=mysql://user:password@localhost:3306/netapp_connector
119-
120-
# Authentication (Optional - defaults provided)
121-
JWT_SECRET_KEY=your-secret-key-here
122-
ACCESS_TOKEN_EXPIRE_MINUTES=1440
123-
124-
# Multi-container deployments (Optional)
125-
ENCRYPTION_KEY=your-shared-encryption-key
126-
```
127-
12844
3. **Run the connector using Docker Compose:**
12945

13046
```bash
13147
docker-compose up -d
13248
```
13349

134-
4. **Access the connector**
50+
4. **Access the connector**
13551

13652
The connector will be deployed and will be accessible on port 8080. You can access the API documentation at `http://localhost:8080/docs`.
13753

13854
Trouble deploying the connector? Check the [Troubleshooting](#troubleshooting) section for common issues.
13955

140-
14156
### Deploy using Kubernetes and Helm
14257

14358
If you are using Kubernetes, you can deploy the connector using Helm. Please refer to the [Helm Deployment](../charts/netapp-copilot-connector/README.md "charts/netapp-copilot-connector/README.md") document for more information.
14459

145-
14660
## 3\. Initial Setup and First Admin User
14761

14862
> \[!IMPORTANT\]

netapp-neo/dist/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ services:
3838
- db
3939

4040
neoui:
41-
image: ghcr.io/beezy-dev/neo-ui-framework:3.0.4-2
41+
image: ghcr.io/beezy-dev/neo-ui-framework:3.1.0
4242
container_name: neoui
4343
ports:
4444
- "8080:80"

0 commit comments

Comments
 (0)