Skip to content

Commit

Permalink
Added before you begin.
Browse files Browse the repository at this point in the history
  • Loading branch information
YiyunNi committed Jul 27, 2021
1 parent 2098f0e commit b7d5916
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 40 deletions.
46 changes: 46 additions & 0 deletions site/en/getstarted/prerequisite-docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
id: prerequisite-docker.md
label: prerequisite
order: 0
---

Before proceeding to installation, you must check the eligibility of your hardware and software.

{{tab}}

# Check if your CPU supports SIMD extension instruction set

Milvus' computing operations depend on CPU’s support for SIMD (Single Instruction, Multiple Data) extension instruction set. Whether your CPU supports SIMD extension instruction set is crucial to index building and vector similarity search within Milvus. Ensure that your CPU supports at least one of the following SIMD instruction sets:

- SSE4.2
- AVX
- AVX2
- AVX512

Run the lscpu command to check if your CPU supports the SIMD instruction sets mentioned above:

```
lscpu | grep -e sse4_2 -e avx -e avx2 -e avx512
```

# Check your Docker and Docker Compose version

- Docker version 19.03 or higher is required.

<div class="alert note">
Follow <a href="https://docs.docker.com/get-docker/">Get Docker</a> to install Docker on your system.
</div>

- Docker Compose version 1.25.1 or higher is required.

<div class="alert note">
See <a href="https://docs.docker.com/compose/install/">Install Docker Compose</a> for Docker Compose installation guide.
</div>

# Install Docker Desktop

| Operating system | Requirements |
| ---------- | ----------------- |
| **macOS** | Install Docker for Mac. See [installation instructions](https://docs.docker.com/docker-for-mac/). <br/> **Note:** Set the Docker virtual machine (VM) to have at least 2 vCPU (virtual CPU) and 8 GB of initial memory. Otherwise, installation may fail. |
| **Linux with local Docker** |Install Docker according to the [instructions](https://docs.docker.com/installation/#installation) for your operating system. |
| **Windows with Docker Desktop WSL2 backend** | Install Docker according to the [instructions](https://docs.docker.com/docker-for-windows/wsl-tech-preview/). <br/> <div class="alert note"> Store sources in the local Linux file system, not in the Windows remote mount at /mnt/c. </div> |
34 changes: 34 additions & 0 deletions site/en/getstarted/prerequisite-helm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: prerequisite-helm.md
label: prerequisite
order: 1
---

Before proceeding to installation, you must check the eligibility of your hardware and software.

{{tab}}

# Check if your CPU supports SIMD extension instruction set

Milvus' computing operations depend on CPU’s support for SIMD (Single Instruction, Multiple Data) extension instruction set. Whether your CPU supports SIMD extension instruction set is crucial to index building and vector similarity search within Milvus. Ensure that your CPU supports at least one of the following SIMD instruction sets:

- SSE4.2
- AVX
- AVX2
- AVX512

Run the lscpu command to check if your CPU supports the SIMD instruction sets mentioned above:

```
lscpu | grep -e sse4_2 -e avx -e avx2 -e avx512
```

# Check your Kubernetes and Helm version
- Kubernetes version 1.14.0 or higher is required.
- [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) is required.

<div class="alert note">
Installing minikube will also install hypervisor and kubectl. Kubectl is a command-line tool for managing Kubernetes from your local workstation.
</div>

- Helm version 3.0.0 or higher is required. See [Helm docs](https://helm.sh/docs/).
28 changes: 1 addition & 27 deletions site/en/getstarted/standalone/install_standalone-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,34 +17,8 @@ Installing Milvus with Docker Compose can only be used for testing and cannot be

{{tab}}

## Before You Begin

Before moving forward to installation, you must check the eligibility of your Docker, Docker Compose, and hardware in line with Milvus' requirement.

<details><summary>Check your Docker and Docker Compose version</summary>

<li>Docker version 19.03 or higher is required. </li>

<div class="alert note">
Follow <a href="https://docs.docker.com/get-docker/">Get Docker</a> to install Docker on your system.
</div>

<li>Docker Compose version 1.25.1 or higher is required. </li>

<div class="alert note">
See <a href="https://docs.docker.com/compose/install/">Install Docker Compose</a> for Docker Compose installation guide.
</div>

</details>

<details><summary>Check whether your CPU supports SIMD extension instruction set</summary>

{{fragments/cpu_support.md}}
</details>



## Install Milvus Standalone
## Install Milvus Standalone with Docker Compose


1. Download and save **docker-compose.standalone.yml** as **docker-compose.yml**:
Expand Down
9 changes: 0 additions & 9 deletions site/en/getstarted/standalone/install_standalone-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,6 @@ Installing Milvus with Docker Compose can only be used for testing and cannot be

{{tab}}

## Prerequisites
- Kubernetes version 1.14.0 or higher is required.
- [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) is required.

<div class="alert note">
Installing minikube will also install hypervisor and kubectl. Kubectl is a command-line tool for managing Kubernetes from your local workstation.
</div>

- Helm version 3.0.0 or higher is required. See [Helm docs](https://helm.sh/docs/).

## 1. Start a local Kubernetes cluster:
```
Expand Down
16 changes: 12 additions & 4 deletions site/en/menuStructure/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,21 @@
"label3": null,
"order": 0
},
{
"id": "prerequisite-docker.md",
"title": "Before you Begin",
"label1": "prerequisite",
"label2": null,
"label3": null,
"order": 1
},
{
"id": "installmilvus",
"title": "Install Milvus",
"label1": "getstarted",
"label2": null,
"label3": null,
"order": 1,
"order": 2,
"isMenu": true

},
Expand All @@ -90,23 +98,23 @@
"label1": "getstarted",
"label2": "",
"label3": "",
"order": 2
"order": 3
},
{
"id": "explore_pymilvus.md",
"title": "Explore PyMilvus-ORM",
"label1": "getstarted",
"label2": "",
"label3": "",
"order": 3
"order": 4
},
{
"id": "systemconfigurations",
"title": "System Configurations",
"label1": "getstarted",
"label2": null,
"label3": null,
"order": 4,
"order": 5,
"isMenu": true
},
{
Expand Down

0 comments on commit b7d5916

Please sign in to comment.