Skip to content

Commit 0f2b4dd

Browse files
committed
Merge branch 'main' of github.com:NetApp/Innovation-Labs
2 parents 6de393a + 0ce1305 commit 0f2b4dd

File tree

4 files changed

+121
-142
lines changed

4 files changed

+121
-142
lines changed

netapp-neo/DEPLOY-V2.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,20 @@ In order for the connector to be able to securely communicate with M365 Copilot.
4545
14. Fill in the required fields and click "Add".
4646
15. Copy the value of the client secret.
4747

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.
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.
4949

5050
## 2\. Getting Started
5151

5252
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.
5353

54-
### Deploy using Docker/Podman
54+
### Deploy using Docker/Podman
5555

5656
#### Pull the image
5757

5858
```bash
5959
docker pull ghcr.io/netapp/netapp-copilot-connector:2.2.5
6060
```
61+
6162
> \[!TIP\]
6263
> Neo v2.x latest and last GA version is 2.2.5.
6364
@@ -84,7 +85,7 @@ NETAPP_CONNECTOR_LICENSE=<License key for the connector> # Please see License se
8485
docker-compose up -d
8586
```
8687

87-
4. **Access the connector**
88+
4. **Access the connector**
8889

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

@@ -97,6 +98,7 @@ This Helm chart deploys NetApp Neo for Microsoft 365 Copilot on a Kubernetes clu
9798
## Overview
9899

99100
The chart bootstraps a deployment of NetApp Neo, which includes the following Kubernetes resources:
101+
100102
- **StatefulSet**: Manages the connector pod, ensuring stable network identity and storage.
101103
- **PersistentVolumeClaim**: Provides persistent storage for connector data (e.g., database).
102104
- **Service**: Exposes the connector within the cluster on a stable endpoint.
@@ -210,32 +212,31 @@ helm uninstall netapp-connector --namespace netapp-connector
210212

211213
The following table lists the configurable parameters of NetApp Neo chart and their default values.
212214

213-
| Parameter | Description | Default |
214-
|-----------|-------------|---------|
215-
| `main.name` | The base name for all created resources. | `netapp-connector-main` |
216-
| `main.replicaCount` | Number of connector pods to run. Only 1 is supported. | `1` |
217-
| `main.image.repository` | The container image repository. | `ghcr.io/netapp/netapp-copilot-connector` |
218-
| `main.image.tag` | The container image tag. If empty, defaults to the chart's `appVersion`. | `""` |
219-
| `main.image.pullPolicy` | The image pull policy. | `Always` |
220-
| `main.service.type` | The type of Kubernetes service to create. | `ClusterIP` |
221-
| `main.service.port` | The port exposed by the service and container. | `8080` |
222-
| `main.ingress.enabled` | If true, create an Ingress resource. | `false` |
223-
| `main.ingress.host` | The hostname for the Ingress rule. Required if Ingress is enabled. | `nil` |
224-
| `main.ingress.path` | The path for the Ingress rule. | `/` |
225-
| `main.ingress.pathType` | The path type for the Ingress rule (`Prefix`, `Exact`, `ImplementationSpecific`). | `Prefix` |
226-
| `main.ingress.className` | The `ingressClassName` to associate with the Ingress. | `""` |
227-
| `main.ingress.tls` | Ingress TLS configuration (list of objects with `secretName` and `hosts`). | `[]` |
228-
| `main.persistence.enabled` | If true, create a `PersistentVolumeClaim`. | `true` |
229-
| `main.persistence.accessMode` | The access mode for the PVC. | `ReadWriteOnce` |
230-
| `main.persistence.size` | The size of the persistent volume. | `1Gi` |
231-
| `main.persistence.mountPath` | The path inside the container where the volume is mounted. | `/app/data` |
232-
| `main.env.*` | Non-sensitive environment variables. See `values.yaml` for all options. | (various) |
233-
| `main.credentials.*` | Sensitive credentials stored in a Secret. **Must be provided by the user.** | (placeholders) |
215+
| Parameter | Description | Default |
216+
| ----------------------------- | --------------------------------------------------------------------------------- | ----------------------------------------- |
217+
| `main.name` | The base name for all created resources. | `netapp-connector-main` |
218+
| `main.replicaCount` | Number of connector pods to run. Only 1 is supported. | `1` |
219+
| `main.image.repository` | The container image repository. | `ghcr.io/netapp/netapp-copilot-connector` |
220+
| `main.image.tag` | The container image tag. If empty, defaults to the chart's `appVersion`. | `""` |
221+
| `main.image.pullPolicy` | The image pull policy. | `Always` |
222+
| `main.service.type` | The type of Kubernetes service to create. | `ClusterIP` |
223+
| `main.service.port` | The port exposed by the service and container. | `8080` |
224+
| `main.ingress.enabled` | If true, create an Ingress resource. | `false` |
225+
| `main.ingress.host` | The hostname for the Ingress rule. Required if Ingress is enabled. | `nil` |
226+
| `main.ingress.path` | The path for the Ingress rule. | `/` |
227+
| `main.ingress.pathType` | The path type for the Ingress rule (`Prefix`, `Exact`, `ImplementationSpecific`). | `Prefix` |
228+
| `main.ingress.className` | The `ingressClassName` to associate with the Ingress. | `""` |
229+
| `main.ingress.tls` | Ingress TLS configuration (list of objects with `secretName` and `hosts`). | `[]` |
230+
| `main.persistence.enabled` | If true, create a `PersistentVolumeClaim`. | `true` |
231+
| `main.persistence.accessMode` | The access mode for the PVC. | `ReadWriteOnce` |
232+
| `main.persistence.size` | The size of the persistent volume. | `1Gi` |
233+
| `main.persistence.mountPath` | The path inside the container where the volume is mounted. | `/app/data` |
234+
| `main.env.*` | Non-sensitive environment variables. See `values.yaml` for all options. | (various) |
235+
| `main.credentials.*` | Sensitive credentials stored in a Secret. **Must be provided by the user.** | (placeholders) |
234236

235237
---
236-
For more information, see the official [Helm documentation](https://helm.sh/docs/) and [Kubernetes documentation](https://kubernetes.io/docs/home/).
237-
238238

239+
For more information, see the official [Helm documentation](https://helm.sh/docs/) and [Kubernetes documentation](https://kubernetes.io/docs/home/).
239240

240241
# 3\. Initial Setup and First Admin User
241242

@@ -327,6 +328,7 @@ You can monitor the crawl progress through:
327328
1. **Visit the Microsoft 365 Admin Center**: Go to [Search and Intelligence](https://admin.microsoft.com/Adminportal/Home?source=applauncher#/MicrosoftSearch/connectors)
328329
2. **Enable Connector Results**: Ensure you have selected **_Include Connector Results_** for NetApp Neo
329330
3. **Test in Microsoft 365 Copilot**: Try searching for content from your indexed files using natural language queries
331+
4. **Control Access**: Verify that search results respect the original file permissions from your SMB shares. Item level permissions will be attempted to be preserved based on the ACLs read during the crawl, however this may not always be possible depending on your environment and configuration. It is recommended to test access with different user accounts to ensure proper security. In addition to item level permissions, you can also configure (recommended) broader access controls using Microsoft Entra groups and roles using the Microsoft 365 Admin Center -> Copilot Connectors settings -> Staging Permissions to control users and groups that can access content from the connector.
330332

331333
![Select Include Connector Results in the Search and Intelligence Admin Centre](./media/2025-07-15_09-47-23.png)
332334

netapp-neo/README.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,7 @@ The NetApp Neo: Connector for M365 Copilot is a containerized solution that enab
2929

3030
## Getting Started
3131

32-
Want to get up and running quickly? Head over to
33-
34-
- the Neo v3.x [User Quickstart for M365](./USER_QUICKSTART_M365.md) guide for a step-by-step guide to deploying the connector and connecting your first share.
35-
- the Neo v2.x (**phasing out**) [User Quickstart for M365](./DEPLOY-V2.md) guide for a step-by-step guide to deploying the connector and connecting your first share.
36-
37-
## Security Information
38-
39-
The NetApp Neo: Connector for M365 Copilot is designed with security in mind. All relevant security information is available in the [Security Information](SECURITY.md) document. This includes information on how the connector handles data, how it communicates with Microsoft Graph, and how it is secured.
40-
41-
## Frequently Asked Questions (FAQ)
42-
Most frequently asked questions are available in our [NEO FAQ](FAQ.md)
32+
Want to get up and running quickly? Head over to [User Documentation](https://netapp.github.io/netapp-connector-docs/)
4333

4434
## Support
4535

0 commit comments

Comments
 (0)