Skip to content

Commit

Permalink
copy v0.6.0 from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nameczz committed Jul 21, 2020
1 parent a0a2783 commit a10e8a0
Show file tree
Hide file tree
Showing 101 changed files with 6,428 additions and 0 deletions.
46 changes: 46 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
id: Changelog
title: Changelog
sidebar_label: Milvus Changelog
---

# Milvus Docs Changelog

## [v0.6.0] 2019-12-07

### Improvements
- \#169, #177, #183 and #184 Update Product FAQ and Operational FAQ topics.
- \#174 Update Install Milvus and Milvus Configuration topics.
Add Index Types, Table Partition, Data Management and Contribute topics.
Update server_config.yaml.
- \#192 Add release note for v0.6.0.

## [v0.5.3] 2019-11-14

### Improvements
- \#155 Add the `nprobe` argument which is missing in search result filter command in Learn Milvus Operations topic.
- \#157 Add release note for v0.5.3.

## [v0.5.1] 2019-11-04

### Improvements
- \#129 Update some parameter descriptions in the `server_config.yaml` file for Milvus configuration.
- \#132 a) Add a new parameter `gpu_search_threshold` in Milvus Configuration; b) Update Troubleshoot.
- \#136 Add release note for v0.5.1.



## [v0.5.0] 2019-10-15

### Improvements
- \#77 Add a new index type `NSG`; Update some parameter names in Milvus configuration file.
- \#78 Add a new parameter `preload_table` in Milvus config file.
- \#79 Add Java SDK doc.
- \#83 Add table row count SDK.
- \#85 Add a description about "why search results are fewer than K in top K search" in Operational FAQ.
- \#87 Add a new index type `IVF_SQ8H` in Learn Milvus Operations.
- \#90 Add parameter `gpu_cache_capacity` and `gpu_cache_threshold` in Milvus config file.
- \#93 Update README and create CONTRIBUTING.md.
- \#100 Update Milvus config file to remove doc about GPU-only search
- \#107 Remove "Delete vectors by range" in Milvus operations

23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Contributing to Milvus Documentation

Thank you for your interest in contributing to Milvus documentation! :tada:

If there's anything you'd like to change in the docs, you can click the **Edit** button located on the upper right of most pages in the [website](https://www.milvus.io/docs/guides/get_started/install_milvus/install_milvus.md), and then [file an issue](https://github.com/milvus-io/docs/issues/new/choose) in the Milvus docs repository.

### Contributing to the Blog

The articles in Milvus Blog are generated from [this markdown sources](https://github.com/milvus-io/community/tree/master/blog).

If you want to write an article intended for the Blog, please [open an issue in the community repository](https://github.com/milvus-io/community/issues/new). In most cases, you might want to share your article on your own blog or other writing medium instead. It's worth asking, though, in case we find your article is a good fit for the Blog.

### Contributing to SDK reference

To make a change to SDK reference documentation, find the [source repository for Python SDK](https://github.com/milvus-io/pymilvus) / [source repository for Java SDK](https://github.com/milvus-io/milvus-sdk-java), and create an issue describing the update or your suggestion.

### About our docs

The Milvus documentation is written in [Markdown](https://commonmark.org/help/).

Not all technical content on milvus.io is located in this repo. Some projects have their own repositories and project-specific documentation.

The SDK reference is generated from the source code located in [pymilvus](https://github.com/milvus-io/pymilvus) and [milvus-sdk-java](https://github.com/milvus-io/milvus-sdk-java) repositories.
Binary file added assets/ads_recommend.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/ads_recommend_cn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/application_arch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/application_arch_cn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions assets/config/log_config.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
* GLOBAL:
FORMAT = "%datetime | %level | %logger | %msg"
FILENAME = "/var/lib/milvus/logs/milvus-%datetime{%H:%m}-global.log"
ENABLED = true
TO_FILE = true
TO_STANDARD_OUTPUT = false
SUBSECOND_PRECISION = 3
PERFORMANCE_TRACKING = false
MAX_LOG_FILE_SIZE = 209715200 ## Throw log files away after 200MB
* DEBUG:
FILENAME = "/var/lib/milvus/logs/milvus-%datetime{%H:%m}-debug.log"
ENABLED = true
* WARNING:
FILENAME = "/var/lib/milvus/logs/milvus-%datetime{%H:%m}-warning.log"
* TRACE:
FILENAME = "/var/lib/milvus/logs/milvus-%datetime{%H:%m}-trace.log"
* VERBOSE:
FORMAT = "%datetime{%d/%M/%y} | %level-%vlevel | %msg"
TO_FILE = false
TO_STANDARD_OUTPUT = false

## Error logs
* ERROR:
ENABLED = true
FILENAME = "/var/lib/milvus/logs/milvus-%datetime{%H:%m}-error.log"
* FATAL:
ENABLED = true
FILENAME = "/var/lib/milvus/logs/milvus-%datetime{%H:%m}-fatal.log"

46 changes: 46 additions & 0 deletions assets/config/server_config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Default values are used when you make no changes to the following parameters.

version: 0.1 # config version

server_config:
address: 0.0.0.0 # milvus server ip address (IPv4)
port: 19530 # milvus server port, must be in range [1025, 65534]
deploy_mode: single # deployment type: single, cluster_readonly, cluster_writable
time_zone: UTC+8 # time zone, must be in format: UTC+X

db_config:
primary_path: /var/lib/milvus # path used to store data and meta
secondary_path: # path used to store data only, split by semicolon

backend_url: sqlite://:@:/ # URI format: dialect://username:password@host:port/database
# Keep 'dialect://:@:/', and replace other texts with real values
# Replace 'dialect' with 'mysql' or 'sqlite'

insert_buffer_size: 1 # GB, maximum insert buffer size allowed, must be a positive integer
# sum of insert_buffer_size and cpu_cache_capacity cannot exceed total memory

preload_table: # preload data at startup, '*' means load all tables, empty value means no preload
# you can specify preload tables like this: table1,table2,table3

metric_config:
enable_monitor: false # enable monitoring or not, must be a boolean
collector: prometheus # prometheus
prometheus_config:
port: 8080 # port prometheus uses to fetch metrics, must be in range [1025, 65534]

cache_config:
cpu_cache_capacity: 4 # GB, CPU memory used for cache, must be a positive integer
cache_insert_data: false # whether to load inserted data into cache, must be a boolean

engine_config:
use_blas_threshold: 20 # if nq < use_blas_threshold, use SSE, faster with fluctuated response times
# if nq >= use_blas_threshold, use OpenBlas, slower with stable response times
gpu_search_threshold: 1000 # threshold beyond which the search computation is executed on GPUs only

gpu_resource_config:
enable: true # whether to enable GPU resources
cache_capacity: 1 # GB, size of GPU memory per card used for cache, must be a positive integer
search_resources: # define the GPU devices used for search computation, must be in format gpux
- gpu0
build_index_resources: # define the GPU devices used for index building, must be in format gpux
- gpu0
Binary file added assets/jaegertraces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/jaegerui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/k8s_arch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/milvus_arch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/milvus_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/mishards.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions assets/monitoring/alert.rules.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
groups:

- name: alert.rules
rules:
# Alert for server down
- alert: MilvusServerDown
expr: up{job="milvus_server"}
for: 1s
labels:
serverity: page

# Alert on CPU temperature too high
- alert: CPUTemperatureTooHigh
expr: CPU_temperature{job="milvus_server"}>=80
for: 1s
labels:
serverity: page

# Alert on GPU temperature too high
- alert: GPUTemperatureTooHigh
expr: GPU_temperature{job="milvus_server"}>=80
for: 1s
labels:
serverity: page

Loading

0 comments on commit a10e8a0

Please sign in to comment.