Skip to content

Commit

Permalink
Merge from3.6.0 (#2441)
Browse files Browse the repository at this point in the history
* Update mkdocs.yml

* release 3.6.0 (#2222)

* release 3.6.0

* Update mkdocs.yml

---------

Co-authored-by: abby.huang <[email protected]>

* Update nebula-comm-release-note.md

* Update 1.text-based-index-restrictions.md

* Update mkdocs.yml

* Update nebula-comm-release-note.md

* Update 1.introduction-to-nebula-operator.md

* add compile using docker (#2223)

* add compile using docker

* Update 7.compile-using-docker.md

* Update canvas-snapshot.md

* index desc updates (#2227)

* Update 1.numeric.md

* helm chart install updates (#2228)

* Update 2.management-user.md

* exchange vid support prefix (#2232) (#2233)

* Update use-importer.md

* Update upgrade-nebula-ent-from-3.x-3.4.md (#2234)

* add-find-single-shortest-path (#2236)

* Update ex-ug-export-from-nebula.md

* Update 4.ldap.md

* Update 0-2.relates.md

* Update logs.md

* Update 0.FAQ.md

* add-reserved-keywords-in-ent3.6.0 (#2237)

* Update 1.configurations.md

* Update 4.schema.md

* hide ent-content in 3.6.0 (#2238)

* hide ent-content in 3.6.0

* Update mkdocs.yml

* tag more ent content

* more fixes

* Update 1.quick-start-workflow.md

* add the inner join clause doc (#2239)

* add the inner join clause doc

* Update 2.find-path.md

* Update use-importer.md

* sync-sc-to-v3.6.0-ent (#2242)

* Update mkdocs.yml

* fix links (#2243)

* Update 1.text-based-index-restrictions.md

* Update 3.graph-config.md

* Update 1.authentication.md

* Update 2.compile-br.md

* Update mkdocs.yml (#2244)

* Update st-ug-limitations.md

* Update st-ug-import-data.md

* Update 11.import-data.md

* Update st-ug-import-data.md

* Update use-importer.md

* Update use-importer.md

* Update notification-endpoint.md

* dashboard advanced config (#2245)

* balance leader desc updates (#2247)

* Update notification-endpoint.md

* Update 2.deploy-connect-dashboard-ent.md (#2248)

* Update manage-storage-host.md (#2249)

* Update 2.deploy-connect-dashboard-ent.md

* Update 4.storage-config.md

* comment fixes (#2252)

* Update 5.show-native-index-status.md

* Update 9.notification.md

* Update notification-endpoint.md

* update screenshots (#2256)

* fixed missing installation step (#2257)

* Update 3.2create-cluster-with-helm.md

* [TO BE REVIEWED]v3.5.0-sc core-zone updates (#2250) (#2258)

* v3.5.0-sc core-zone updates

additions

v3.5.0-sc core-zone updates

* updates

* Update 5.zone.md

* Update docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md

* fix comment

* comment fix and change routing to reading

* Update 3.graph-config.md

* commit fix

* comment fix

* Update docs-2.0/4.deployment-and-installation/5.zone.md

* Update 5.zone.md

* fix comments

* [wip] [sc]updates for operator (#2255) (#2259)

* Update 4.ssl.md (#2260)

added enable_storage_ssl

* Update 6.delete-tag.md (#2262)

* Update 1.search-with-text-based-index.md

* Opt fix (#2266)

* two more opts

* ttl opts

Update ttl-options.md

* operator-version-updated (#2269)

* returned info updates using docker compose deployment (#2270)

* Update 5.zone.md

* add note for using memtracker (#2271)

* Remove parameters from dynamic flags (#2273)

* update (#2276)

* dashboard database user (#2275)

* dashboard database user

* update

* Update 1.configurations.md (#2279)

* example of scope and order of variable and set operator (#2280)

* update explorer iframe (#2282)

* update (#2281)

* update

* Update docs-2.0/nebula-dashboard-ent/8.faq.md

* Update docs-2.0/nebula-explorer/faq.md

* Update ex-ug-deploy.md

* Update faq.md

* Update nebula-console.md

* Update nebula-console.md

* Update 1.numeric.md

* update use-importer.md: add notes on csv delimiter (#2285) (#2287)

* update use-importer.md

add notes on csv delimiter

* Update docs-2.0/nebula-importer/use-importer.md

---------

Co-authored-by: jyf111 <[email protected]>

* update alter user (#2289)

* Update 2.management-user.md

* Update 2.management-user.md

* rotate audit logs (#2296)

* rotate audit logs

* Update audit-log.md

* Update audit-log.md

* Update audit-log.md

* Update audit-log.md

* record slow queries in log files (#2297)

* record slow queries in log files

* Update 3.graph-config.md

* remove DML from slow queries (#2298)

* 3.6.0 ent release note (#2300)

* 3.6.0 ent release note

* Update nebula-ent-release-note.md

* Update nebula-ent-release-note.md

* Update nebula-ent-release-note.md

* Update 3.graph-config.md

* Update source-monitoring-metrics.md

* Explorer compatibility (#2299)

* explorer/studio compatibility

* Update ex-ug-deploy.md

* Update ex-ug-deploy.md

* Update studio-release-note.md

* Update st-ug-what-is-graph-studio.md

* Update explorer-release-note.md

* Update studio-release-note.md

* Update ex-ug-deploy.md

* change zone fields to dynamically configurable (#2304)

* upgrade-doc-for-3.6.0-ent (#2303)

* upgrade-doc-for-3.6.0-ent

* Update upgrade-nebula-ent-from-3.x-3.4.md

* Update upgrade-nebula-ent-from-3.x-3.4.md

* Update upgrade-nebula-ent-from-3.x-3.4.md

* upgrade 2.x-3.x (#2305)

* Update nebula-ent-release-note.md

* Update nebula-ent-release-note.md

* Update ex-ug-connect.md

* Importer 4.1.0 update (#2286)

* importer 4.1.0 support ssl (#2284)

* importer 4.1.0 support ssl

* update

* Update mkdocs.yml

* Operator updates for 3.6.0 (#2277)

* operator-updates-for-3.6.0

* operator-updates-for-3.6.0

* Update 3.1create-cluster-with-kubectl.md

* Update 3.1create-cluster-with-kubectl.md

* Update 3.2create-cluster-with-helm.md

* Update 3.2create-cluster-with-helm.md

* minor fixes

* Update 4.connect-to-nebula-graph-service.md

* Update 4.connect-to-nebula-graph-service.md

* Update 8.5.enable-ssl.md

* add schedulerName

* comment fix

* studio 3.8.0 (#2307)

* studio 3.8.0

* Update docs-2.0/20.appendix/release-notes/studio-release-note.md

* Update Java and go client versions (#2308)

* Filter out community content and support bilingual  (#2314)

* Update keywords-and-reserved-words.md

* Update keywords-and-reserved-words.md

* new docs pv expansion & admission control (#2319)

* new docs pv expansion & admission control

1. add new docs pv expansion & admission control
2. reorganize content catalogue

* add operator 1.7.x

* keep operator comm content consistency between en & ch (#2318)

* keep operator comm content consistency between en & ch

* broken link fix

* Add operator port (#2320)

* Add operator port

* Update port desc

* Update docs-2.0-zh/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md

* Update port

---------

Co-authored-by: abby.huang <[email protected]>

* Updated keywords

* Correct format for keywords

* update note level (#2327)

* Update deploy-zh.yml

* Update requirements.txt

* Update deploy-zh.yml

* enhance docs (#2328)

* adjust note color (#2329)

* Update requirements.txt

* Update mkdocs.yml

* enable code actions (#2333)

* update exchange parameter (#2337)

* Simplified versions logic

* Update font for bilingual

* Update font settings

* CMS Enhancement (#2339)

* CMS Enhancement

* Update mkdocs.yml

* Update mkdocs.yml

* update

* update

* update

* Update mkdocs.yml

* fix case (#2340)

- as titled

* Modify the description of neighbor ports (#2341)

* fix link and search (#2342)

* Update 404.html

* Create algolia-search.html

* Create algolia-search.html

* Update 404.html

* Update comments.md (#2343)

* Update comments.md (#2344)

* exchange import mode (#2349)

Co-authored-by: Chris Chen <[email protected]>

* update comments (#2348)

* update comments

* Update docs-2.0-en/3.ngql-guide/1.nGQL-overview/comments.md

* snapshot enhancement (#2350)

Co-authored-by: Chris Chen <[email protected]>

* Update 1.install-nebula-graph-by-compiling-the-source-code.md

* Update 3.nebula-cpp-client.md

* Update mkdocs.yml (#2351)

* Update nebula-comm-release-note.md

* Update nebula-comm-release-note.md (#2353)

* reorganize content for operator (#58)

* reorganize content for operator

Update mkdocs.yml

* add en content

* replace what is operator

* Update first 3 sections.

* Update 2.3.create-cluster.md

* update and polish cluster creating doc

* Update quick create cluster

* Update sample code

* Update 2.3.create-cluster.md

* Updated operator TOC

* push the cluster upgrading doc

* add the delete clusters doc

* Update 4.2.configuration.md

optimize cluster configurations

optimize cluster configurations

Update 4.2.configuration.md

* add scaling clusters doc

* add HPA

* add pv expansion % pv reclaim

* add enable mtls

* add admission control

* add balancing&rolling update&self-healing

* Update hyperlink

* add log & backup

* add faq

* add zone

* comment fix & operator management docs optimization

* fix

* minor changes

* comment fix

* Update docs-2.0-en/k8s-operator/3.operator-management/3.1.customize-installation.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/3.operator-management/3.3.upgrade-operator.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.1.installation/4.1.2.cluster-upgrade.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.1.installation/4.1.2.cluster-upgrade.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.1.installation/4.1.3.cluster-uninstall.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.1.installation/4.1.3.cluster-uninstall.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.1.installation/4.1.3.cluster-uninstall.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/1.introduction-to-nebula-operator.md

Co-authored-by: Chris Chen <[email protected]>

* comment fix

* format adjustment

---------

Co-authored-by: Chris Chen <[email protected]>

* reorganize operator

* reorganize operator (#2354)

* reorganize operator

Co-Authored-By: Chris Chen <[email protected]>

* broken links

Co-Authored-By: Chris Chen <[email protected]>

* broken links fix again

Co-Authored-By: Chris Chen <[email protected]>

* Update 6.deploy-nebula-graph-with-peripherals.md

Co-Authored-By: Chris Chen <[email protected]>

---------

Co-authored-by: Chris Chen <[email protected]>

* add spaces for between cn and en char (#2356)

FIX

Co-authored-by: Chris Chen <[email protected]>

* Update nebula-comm-release-note.md

* no-use-of-independent-operator-release-note-doc (#2357)

* optimize ulimit (#2358)

Co-authored-by: abby.huang <[email protected]>
Co-authored-by: Chris Chen <[email protected]>

* Update studio-release-note.md

* Update nebula-comm-release-note.md

* Update 6.eco-tool-version.md

* Update CONTRIBUTING.md to delete broken links

* optimize schema limits (#2360)

Co-authored-by: Chris Chen <[email protected]>

* Query statement overview (#2359)

* query statement overview

* Update 1.general-query-statements-overview.md

* Update 1.general-query-statements-overview.md

* more changes

1. remove path and subgraph to general statements
2. add kill sessions statements in cheatsheet
3. link changes

* Update 1.general-query-statements-overview.md

* Update 1.general-query-statements-overview.md

* comment fix

* Update 1.general-query-statements-overview.md

* add the relevant en doc

* Update 1.general-query-statements-overview.md

* Update docs-2.0-en/3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.md

* comment fix

---------

Co-authored-by: cooper-lzy <[email protected]>
Co-authored-by: Chris Chen <[email protected]>

* Update 1.general-query-statements-overview.md

* Update pdf.css

* escape \| to | display fix (#2361)

* remove-externalTrafficPolicy-Local- (#2365)

* optimiz IP description (#2367)

Co-authored-by: Chris Chen <[email protected]>

* Update source_ngql_for_quick_start.md (#2370)

* operator-release-1.7.3 (#2371)

* operator-release-1.7.3

* comment fix

* Turn off autoplay (#2375)

* Turn off autoplay

vesoft-inc/nebula-docs-cn#3072

* Update 1.quick-start-workflow.md

* Update docs-2.0-zh/1.introduction/3.nebula-graph-architecture/3.graph-service.md

Co-authored-by: Chris Chen <[email protected]>

---------

Co-authored-by: Chris Chen <[email protected]>

* [TO BE MERGED]local pv usage & failover (#107) (#2376)

* local pv usage & failover

* Update 4.4.1.use-local-pv.md

* Update 4.4.1.use-local-pv.md

* Update 4.4.1.use-local-pv.md

Update 4.4.1.use-local-pv.md

* add EN translations

* Update 4.4.1.use-local-pv.md

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md



* Update 4.4.1.use-local-pv.md

---------

Co-authored-by: Chris Chen <[email protected]>

* Support restart of service pods (#103) (#2377)

* support restart of service pods

* add example to show how to use secret

* Update 3.1.customize-installation.md

* Update mkdocs.yml

* minor changes

* Update docs-2.0-zh/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-zh/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md



* comment fix

* Update mkdocs.yml

* comment fix

---------

Co-authored-by: Chris Chen <[email protected]>

* Support restart of service pods (#2378)

* Support restart of service pods (#103)

* support restart of service pods

* add example to show how to use secret

* Update 3.1.customize-installation.md

* Update mkdocs.yml

* minor changes

* Update docs-2.0-zh/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-zh/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md

Co-authored-by: Chris Chen <[email protected]>

* comment fix

* Update mkdocs.yml

* comment fix

---------

Co-authored-by: Chris Chen <[email protected]>

* support-restart-of-service-pods

Co-Authored-By: Chris Chen <[email protected]>

---------

Co-authored-by: Chris Chen <[email protected]>

* fix

Co-Authored-By: Chris Chen <[email protected]>

* add demo link (#2381)

* add demo link

Added live demo link in foreword.----- #2379
Fixed the issue of schema description.

* update

* Add statements of fetch all edges by a starting vertex&minor changes (#2380)

* add statements of fetch all edges by a starting vertex&minor changes

Co-Authored-By: Chris Chen <[email protected]>

* add example to retrieve all edges

Co-Authored-By: Chris Chen <[email protected]>

* fix line display

Co-Authored-By: Chris Chen <[email protected]>

---------

Co-authored-by: Chris Chen <[email protected]>

* Update 0.FAQ.md

* Adjusting directory (#117) (#2382)

* Adjustin directory

Adjusting the directory to which the connectors belong

* update

* Update mkdocs.yml

* Update mkdocs.yml

* update

* Modify studio release note (#2383)

* Modify studio release note

Modify the description of the arm architecture.

* Update docs-2.0-en/20.appendix/release-notes/studio-release-note.md

Co-authored-by: Chris Chen <[email protected]>

---------

Co-authored-by: Chris Chen <[email protected]>

* Update 2.match.md

* Modify the description of graph pattern (#119) (#2385)

* Modify the description of graph pattern

The upper and lower bounds of the graph pattern can be set.

* Update 2.match.md

* update

* update

* Update 3.graph-patterns.md

* add annotation to some examples of `LOOKUP` clause (#2388)

* add annotation to some examples of `LOOKUP` clause

- as titled

* Update 5.lookup.md

---------

Co-authored-by: abby.huang <[email protected]>

* get template config (#2317)

* [WIP]get template config

* Update ex-ug-parameter.md

* Update mkdocs.yml

* add annotation to some examples of `FETCH` clause (#2389)

* add annotation to some examples of `FETCH` clause

as titled

* Update docs-2.0-zh/3.ngql-guide/7.general-query-statements/4.fetch.md

---------

Co-authored-by: abby.huang <[email protected]>

* Update 4.ssl.md

* modify contact information (#2392)

* Spark related products add utf8 encoding hints (#2395)

#2391

* Update optional-match.md (#2396)

Update OPTIONAL MATCH detail

* Update 7.get-subgraph.md. Add annotation to example of last paragraph. (#2394)

* Update 7.get-subgraph.md. Add annotation to example of last paragraph,

* Add a space to improve writing consistency.

---------

Co-authored-by: Steam <[email protected]>

* Update 6.find-path.md (#2397)

* Update 6.find-path.md

Add annotation to example of find-path

* modify pr format

* Update 6.find-path.md

---------

Co-authored-by: Steam <[email protected]>
Co-authored-by: abby.huang <[email protected]>

* unhide faq questions (#2404)

* unhide faq questions

* updates

* fix

* Update 0.FAQ.md

* add survey banner

* add annotation to some examples of `type-conversion` clause (#2398)

as titled

* add annotation to some examples of `string` clause (#2399)

as titled

* add annotation to some examples of `arithmetic` clause (#2401)

as titled

* add annotation to some examples of `list` clause (#2400)

as titled

* add annotation to some examples of `aggregating` clause (#2402)

as titled

* change announce bar height

* change announce bar height for EN

* change to outdated for EN

* descriptions for escape character `\` (#2406)

* descriptions for escape character `\`

Update 1.create-tag.md

add-on

changes

* Update 1.create-edge.md

* changes

* Update docs-2.0-en/3.ngql-guide/11.edge-type-statements/1.create-edge.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/3.ngql-guide/14.native-index-statements/1.create-native-index.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-en/3.ngql-guide/9.space-statements/1.create-space.md

* Update docs-2.0-en/3.ngql-guide/9.space-statements/1.create-space.md

---------

Co-authored-by: Chris Chen <[email protected]>

* Update 6.cheatsheet-for-ngql.md (#2408)

* update thread desc

* add comment for nGQL-overview

as titled.

* add comment for 2.string.md (#2410)

* Update 2.string.md

add part of comment for string.md

* modify format

---------

Co-authored-by: Steam <[email protected]>

* docs: add annotation to first two examples of `MATCH` clause (#2409)

* add annotation (#2411)

* add annotation

as title

* modify format

* Update 2.match.md

---------

Co-authored-by: Steam <[email protected]>
Co-authored-by: abby.huang <[email protected]>

* fix-cla-sign-in-404-error (#2413)

* fix-cla-sign-in-404-error

* Update how-to-contribute.md

* Update docs-2.0-en/15.contribution/how-to-contribute.md

Co-authored-by: Chris Chen <[email protected]>

---------

Co-authored-by: Chris Chen <[email protected]>

* update pipe.md (#2414)

* Update 4.pipe.md

* Update 4.pipe.md

* how to recycle running logs (#215) (#2415)

* how to recycle running logs

* Update 0.FAQ.md

Update 0.FAQ.md

* addons

* Update docs-2.0-en/5.configurations-and-logs/2.log-management/logs.md



* Update docs-2.0-en/5.configurations-and-logs/2.log-management/logs.md



* Update docs-2.0-en/5.configurations-and-logs/2.log-management/logs.md



* Update docs-2.0-en/5.configurations-and-logs/2.log-management/logs.md



* comment fix

---------

Co-authored-by: Chris Chen <[email protected]>

* disable THP permanently (#221) (#2419)

commentfix

fix

Update docs-2.0-en/5.configurations-and-logs/1.configurations/6.kernel-config.md

Co-authored-by: Chris Chen <[email protected]>

* configuration files updates (#2420)

Co-authored-by: Chris Chen <[email protected]>

* test

* add api reference for Java & python (#2421)

* updates-on-memtracker (#2422)

* add annotation to some examples of `comparison` clause (#2417)

as titled

* add annotation to some examples of `WITH` clause (#2418)

* add annotation to some examples of `WITH` clause

as titled

* modify description

---------

Co-authored-by: Steam <[email protected]>

* add related user practices (#2424)

* add related user practices

* Update use-importer.md

* Update use-importer.md

---------

Co-authored-by: cooper-lzy <[email protected]>

* Reorg prop reference content (#240) (#2426)

* reorg-prop-reference-content

* Update 3.property-reference.md

* Update 3.property-reference.md

* Update 3.property-reference.md

* add en doc

* changes

* Update docs-2.0-en/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md



* Update docs-2.0-en/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md



* Update docs-2.0-en/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md



* commentfix

* Update 3.property-reference.md

---------

Co-authored-by: Chris Chen <[email protected]>

* Update 1.resource-preparations.md (#2429)

* Update 1.resource-preparations.md

* Update 1.resource-preparations.md

* Update 1.resource-preparations.md

* Update 1.resource-preparations.md (#2430)

* broken link fix (#2432)

* broken link fix

* Update docs-2.0-en/3.ngql-guide/8.clauses-and-options/yield.md

Co-authored-by: Chris Chen <[email protected]>

* Update docs-2.0-zh/3.ngql-guide/8.clauses-and-options/yield.md

Co-authored-by: Chris Chen <[email protected]>

---------

Co-authored-by: Chris Chen <[email protected]>

* Add api reference (#2434)

* add api reference for Java & python

* add cpp api

* update

* Update mkdocs.yml (#2435)

* add_api_for_go_client (#2437)

* add_api_for_go_client

* update

* Update_actions_versions (#2438)

* add annotation to some examples of `set` clause (#2433)

* add annotation to some examples of `set` clause

as titled

* Update 6.set.md

---------

Co-authored-by: cooper-lzy <[email protected]>

* Update mkdocs.yml

---------

Co-authored-by: abby.huang <[email protected]>
Co-authored-by: Omar Arab Oghli <[email protected]>
Co-authored-by: jyf111 <[email protected]>
Co-authored-by: Chris Chen <[email protected]>
Co-authored-by: Steam <[email protected]>
Co-authored-by: knqiufan <[email protected]>
Co-authored-by: Mr.AI <[email protected]>
Co-authored-by: Driskoll <[email protected]>
Co-authored-by: E2ern1ty <[email protected]>
Co-authored-by: Gong Jialu <[email protected]>
Co-authored-by: wuu <[email protected]>
Co-authored-by: MuYi <[email protected]>
Co-authored-by: yuxuan.wang <[email protected]>
  • Loading branch information
14 people authored Jan 30, 2024
1 parent 2cf99f3 commit 70e5335
Show file tree
Hide file tree
Showing 319 changed files with 6,549 additions and 3,709 deletions.
9 changes: 4 additions & 5 deletions .github/workflows/deploy-en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0 # fetch all commits/branches for gitversion

- name: Setup Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.8'

Expand All @@ -39,7 +39,6 @@ jobs:
git fetch origin gh-pages --depth=1 # fix mike's CI update
mike list
mike deploy ${{ env.ACTIONTEST }} -p --rebase
# The set-default command is only applicable to the latest version and must be commented in older versions.
# mike set-default ${{ env.ACTIONTEST }} -p --rebase
# mike list
# mike set-default ${{ env.ACTIONTEST }} -p --rebase
mike list

9 changes: 4 additions & 5 deletions .github/workflows/deploy-zh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 1 # fetch all commits/branches for gitversion

- name: Setup Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.8'

Expand All @@ -43,14 +43,13 @@ jobs:
git fetch origin gh-pages-zh --depth=1 # fix mike's CI update
mike list
mike deploy ${{ env.ACTIONTEST }} -b gh-pages-zh -p --rebase
# The set-default command is only applicable to the latest version and must be commented in older versions.
# mike set-default ${{ env.ACTIONTEST }} -b gh-pages-zh -p --rebase
# mike set-default ${{ env.ACTIONTEST }} -b gh-pages-zh -p --rebase

- name: show Chinese git branches
run: |
git branch
git checkout .
git checkout gh-pages-zh
git checkout gh-pages-zh
- name: Compress
run: |
Expand Down
9 changes: 0 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,6 @@ You can start from any of the documents in this repository:
- Raise or resolve [docs issues][_issues].
- Review Pull Requests created by others.

## Before Contributing

Before contributing, please take a quick look at the rules described in these documents to keep the style consistent.

- [Markdown Rules](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md)
- [About This Manual](https://docs.nebula-graph.io/manual-EN/0.about-this-manual/)
- [Introduction to Query Language](https://docs.nebula-graph.io/manual-EN/2.query-language/0.README/)
<!-- - [Developer Documentation Style Guide](docs/manual-EN/4.contributions/developer-documentation-style-guide.md)-->

## How to Contribute

There are many ways to contribute:
Expand Down
5 changes: 4 additions & 1 deletion docs-2.0-en/14.client/1.nebula-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,11 @@ NebulaGraph supports multiple types of clients for users to connect to and manag

!!! note

For now, only NebulaGraph Java is thread-safe.
Only the following classes are thread-safe:

- NebulaPool and SessionPool in NebulaGraph Java
- ConnectionPool and SessionPool in NebulaGraph Go

!!! caution

The following clients can also be used to connect to and manage NebulaGraph, but there is no uptime guarantee.
Expand Down
6 changes: 5 additions & 1 deletion docs-2.0-en/14.client/3.nebula-cpp-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[NebulaGraph CPP](https://github.com/vesoft-inc/nebula-cpp/tree/{{cpp.branch}}) is a C++ client for connecting to and managing the NebulaGraph database.

## Limitations
## Prerequisites

You have installed C++ and GCC 4.8 or later versions.

Expand Down Expand Up @@ -103,6 +103,10 @@ Compile the CPP file to an executable file, then you can use it. The following s
$ LIBRARY_PATH=/usr/local/nebula/lib64:$LIBRARY_PATH g++ -std=c++11 SessionExample.cpp -I/usr/local/nebula/include -lnebula_graph_client -o session_example
```

## API reference

Click [here](https://vesoft-inc.github.io/nebula-cpp/release-3.4/annotated.html) to check the classes and functions provided by the CPP Client.

## Core of the example code

Nebula CPP clients provide both Session Pool and Connection Pool methods to connect to NebulaGraph. Using the Connection Pool method requires users to manage session instances by themselves.
Expand Down
8 changes: 6 additions & 2 deletions docs-2.0-en/14.client/4.nebula-java-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ See [github](https://github.com/vesoft-inc/nebula-java/tree/{{java.branch}}).

!!! note

We recommend that each thread uses one session. If multiple threads use the same session, the performance will be reduced.
We recommend that each thread use one session. If multiple threads use the same session, the performance will be reduced.

When importing a Maven project with tools such as IDEA, set the following dependency in `pom.xml`.

Expand Down Expand Up @@ -57,7 +57,11 @@ If you cannot download the dependency for the daily development version, set the

If there is no Maven to manage the project, manually download the [JAR file](https://repo1.maven.org/maven2/com/vesoft/) to install NebulaGraph Java.

### Core of the example code
## API reference

Click [here](https://vesoft-inc.github.io/nebula-java/release-3.6/annotated.html) to check the classes and functions provided by the Java Client.

## Core of the example code

The NebulaGraph Java client provides both Connection Pool and Session Pool modes, using Connection Pool requires the user to manage session instances.

Expand Down
4 changes: 4 additions & 0 deletions docs-2.0-en/14.client/5.nebula-python-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ $ pip install nebula3-python==<version>
$ pip install .
```

## API reference

Click [here](https://vesoft-inc.github.io/nebula-python/release-3.4/annotated.html) to check the classes and functions provided by the Python Client.

## Core of the example code


Expand Down
4 changes: 4 additions & 0 deletions docs-2.0-en/14.client/6.nebula-go-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ Run the following command to install or update NebulaGraph Go:
$ go get -u -v github.com/vesoft-inc/nebula-go/v3@v{{go.release}}
```

## API reference

Click [here](https://pkg.go.dev/github.com/vesoft-inc/nebula-go/[email protected]#section-documentation) to check the functions and types provided by the GO Client.

## Core of the example code

The NebulaGraph GO client provides both Connection Pool and Session Pool, using Connection Pool requires the user to manage the session instances.
Expand Down
16 changes: 7 additions & 9 deletions docs-2.0-en/15.contribution/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,23 @@

You are welcome to contribute any code or files to the project. But firstly we suggest you raise an issue on the [github](https://github.com/vesoft-inc/nebula) or the [forum](https://github.com/vesoft-inc/nebula/discussions) to start a discussion with the community. Check through the topic for Github.

### Sign the Contributor License Agreement (CLA)
### Sign the Contributor License Agreement [CLA](https://www.apache.org/licenses/contributor-agreements.html)

What is [CLA](https://www.apache.org/licenses/contributor-agreements.html)?
1. Open the [CLA sign-in](https://cla-assistant.io/) page.
2. Click the **Sign in with GitHub** button to sign in.
3. Read and agree to the [vesoft inc. Contributor License Agreement](https://cla-assistant.io/vesoft-inc/).

Here is the [vesoft inc. Contributor License Agreement](https://cla-assistant.io/vesoft-inc/).

Click the **Sign in with GitHub to agree** button to sign the CLA.

If you have any questions, send an email to `[email protected]`.
If you have any questions, submit an [issue](https://github.com/vesoft-inc/nebula/issues).

## Modify a single document

This manual is written in the Markdown language. Click the `pencil` icon on the right of the document title to commit the modification.

This method applies to modify a single document only.
This method applies to modifying a single document only.

## Batch modify or add files

This method applies to contribute codes, modify multiple documents in batches, or add new documents.
This method applies to contributing code, modifying multiple documents in batches, or adding new documents.

## Step 1: Fork in the github.com

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0-en/2.quick-start/1.quick-start-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can quickly get started with NebulaGraph by deploying NebulaGraph with Docke

For more information about how to use NebulaGraph with Docker Desktop, see the following video:

<iframe width="560" height="315" src="https://www.youtube.com/embed/8zKer-4RXEg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/embed/8zKer-4RXEg" title="YouTube video player" frameborder="0" allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>


=== "Using Docker Compose"
Expand Down
18 changes: 13 additions & 5 deletions docs-2.0-en/2.quick-start/6.cheatsheet-for-ngql.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@
| int rank(edge) | Returns the rank value of an edge. |
|vertex | Returns the information of vertices, including VIDs, tags, properties, and values.|
|edge | Returns the information of edges, including edge types, source vertices, destination vertices, ranks, properties, and values.|
|vertices | Returns the information of vertices in a subgraph. For more information, see [GET SUBGRAPH](../3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md).|
|edges | Returns the information of edges in a subgraph. For more information, see [GET SUBGRAPH](../3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md).|
|path | Returns the information of a path. For more information, see [FIND PATH](../3.ngql-guide/16.subgraph-and-path/2.find-path.md).|
|vertices | Returns the information of vertices in a subgraph. For more information, see [GET SUBGRAPH](../3.ngql-guide/7.general-query-statements/7.get-subgraph.md).|
|edges | Returns the information of edges in a subgraph. For more information, see [GET SUBGRAPH](../3.ngql-guide/7.general-query-statements/7.get-subgraph.md).|
|path | Returns the information of a path. For more information, see [FIND PATH](../3.ngql-guide/7.general-query-statements/6.find-path.md).|

* For statements compatible with openCypher

Expand Down Expand Up @@ -418,8 +418,8 @@
| Type | Syntax | Example | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| [GET SUBGRAPH](../3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md) | `GET SUBGRAPH [WITH PROP] [<step_count> {STEP|STEPS}] FROM {<vid>, <vid>...} [{IN | OUT | BOTH} <edge_type>, <edge_type>...] YIELD [VERTICES AS <vertex_alias>] [,EDGES AS <edge_alias>] ` | `GET SUBGRAPH 1 STEPS FROM "player100" YIELD VERTICES AS nodes, EDGES AS relationships` | Retrieves information of vertices and edges reachable from the source vertices of the specified edge types and returns information of the subgraph. |
| [FIND PATH](../3.ngql-guide/16.subgraph-and-path/2.find-path.md) | `FIND { SHORTEST | ALL | NOLOOP } PATH [WITH PROP] FROM <vertex_id_list> TO <vertex_id_list> OVER <edge_type_list> [REVERSELY | BIDIRECT] [<WHERE clause>] [UPTO <N> {STEP|STEPS}] YIELD path as <alias> [| ORDER BY $-.path] [| LIMIT <M>]` | `FIND SHORTEST PATH FROM "player102" TO "team204" OVER * YIELD path as p` | Finds the paths between the selected source vertices and destination vertices. A returned path is like `(<vertex_id>)-[:<edge_type_name>@<rank>]->(<vertex_id)`. |
| [GET SUBGRAPH](../3.ngql-guide/7.general-query-statements/7.get-subgraph.md) | `GET SUBGRAPH [WITH PROP] [<step_count> {STEP|STEPS}] FROM {<vid>, <vid>...} [{IN | OUT | BOTH} <edge_type>, <edge_type>...] YIELD [VERTICES AS <vertex_alias>] [,EDGES AS <edge_alias>] ` | `GET SUBGRAPH 1 STEPS FROM "player100" YIELD VERTICES AS nodes, EDGES AS relationships` | Retrieves information of vertices and edges reachable from the source vertices of the specified edge types and returns information of the subgraph. |
| [FIND PATH](../3.ngql-guide/7.general-query-statements/6.find-path.md) | `FIND { SHORTEST | ALL | NOLOOP } PATH [WITH PROP] FROM <vertex_id_list> TO <vertex_id_list> OVER <edge_type_list> [REVERSELY | BIDIRECT] [<WHERE clause>] [UPTO <N> {STEP|STEPS}] YIELD path as <alias> [| ORDER BY $-.path] [| LIMIT <M>]` | `FIND SHORTEST PATH FROM "player102" TO "team204" OVER * YIELD path as p` | Finds the paths between the selected source vertices and destination vertices. A returned path is like `(<vertex_id>)-[:<edge_type_name>@<rank>]->(<vertex_id)`. |
## Query tuning statements
Expand Down Expand Up @@ -453,3 +453,11 @@
| Syntax | Example | Description |
| --------------------------------------------------- | ----------------------------------------------- | -------------------------------------------- |
| `KILL QUERY (session=<session_id>, plan=<plan_id>)` | `KILL QUERY(SESSION=1625553545984255,PLAN=163)` | Terminates the query being executed, and is often used to terminate slow queries. |
* [Kill sessions](../3.ngql-guide/17.query-tuning-statements/2.kill-session.md)
| Syntax | Example | Description |
| ------------------------------------------------------ | --------------------------------------------------- | --------------------------------------------------- |
| `KILL {SESSION|SESSIONS} <SessionId>` | `KILL SESSION 1672887983842984` | Terminates a single session. |
| `SHOW SESSIONS | YIELD $-.SessionId AS sid [WHERE <filter_clause>] | KILL {SESSION|SESSIONS} $-.sid` | `SHOW SESSIONS | YIELD $-.SessionId AS sid, $-.CreateTime as CreateTime | ORDER BY $-.CreateTime ASC | LIMIT 2 | KILL SESSIONS $-.sid` | Terminates multiple sessions based on specified criteria. |
| `SHOW SESSIONS | KILL SESSIONS $-.SessionId` | `SHOW SESSIONS | KILL SESSIONS $-.SessionId` | Terminates all sessions. |
25 changes: 12 additions & 13 deletions docs-2.0-en/20.appendix/0.FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,17 @@ From NebulaGraph version 3.0.0, the Storage services added in the configuration

From NebulaGraph version 3.0.0, patterns support matching multiple tags at the same time, so you need to specify a tag name when querying properties. The original statement `RETURN variable_name.property_name` is changed to `RETURN variable_name.<tag_name>.property_name`.

<!--
### "How to resolve `[ERROR (-1005)]: Used memory hits the high watermark(0.800000) of total system memory.`?"

The reason for this error may be that `system_memory_high_watermark_ratio` specifies the trigger threshold of the memory high watermark alarm mechanism. The default value is `0.8`. If the system memory usage is higher than this value, an alarm mechanism will be triggered, and NebulaGraph will stop querying.
### "How to resolve `Used memory hits the high watermark(0.800000) of total system memory.`?"

The error may be caused if the system memory usage is higher than the threshold specified by`system_memory_high_watermark_ratio`, which defaults to `0.8`. When the threshold is exceeded, an alarm is triggered and NebulaGraph stops processing queries.

Possible solutions are as follows:

* Clean the system memory to make it below the threshold.
* [Modify the Graph configuration](../5.configurations-and-logs/1.configurations/1.configurations.md). Add the `system_memory_high_watermark_ratio` parameter to the configuration files of all Graph servers, and set it greater than `0.8`, such as `0.9`.

-->
However, the `system_memory_high_watermark_ratio` parameter is deprecated. It is recommended that you use the Memory Tracker feature instead to limit the memory usage of Graph and Storage services. For more information, see [Memory Tracker for Graph service](../5.configurations-and-logs/1.configurations/3.graph-config.md#memory-tracker-configurations) and [Memory Tracker for Storage service](../5.configurations-and-logs/1.configurations/4.storage-config.md#memory-tracker-configurations).

### "How to resolve the error `Storage Error E_RPC_FAILURE`?"

Expand All @@ -85,16 +85,16 @@ It is a known issue. Just retry 1 to N times, where N is the partition number. T

If this error occurs when logging in to NebulaGraph, you can consider using `df -h` to view the disk space and check whether the local disk is full.

<!--
### "How to resolve `[ERROR (-1005)]: Schema not exist: xxx`?"

### "How to resolve `Schema not exist: xxx`?"

If the system returns `Schema not exist` when querying, make sure that:

- Whether there is a tag or an edge type in the Schema.

- Whether the name of the tag or the edge type is a keyword. If it is a keyword, enclose them with backquotes (\`). For more information, see [Keywords](../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md).

-->


### Unable to download SNAPSHOT packages when compiling Exchange, Connectors, or Algorithm

Expand Down Expand Up @@ -313,12 +313,7 @@ You can use [NebulaGraph Algorithm](../graph-computing/nebula-algorithm.md).

### "The runtime log files are too large. How to recycle the logs?"

By default, the runtime logs of NebulaGraph are stored in `/usr/local/nebula/logs/`. The INFO level log files are `nebula-graphd.INFO, nebula-storaged.INFO, nebula-metad.INFO`. If an alarm or error occurs, the suffixes are modified as `.WARNING` or `.ERROR`.

NebulaGraph uses [glog](https://github.com/google/glog) to print logs. `glog` cannot recycle the outdated files. To rotate logs, you can:

- Add the parameters `timestamp_in_logfile_name=true` (timestamp added to logfile) and `max_log_size=500` (log size limit in MB) to the configuration files of the three services, and then use crontab to delete logs periodically. For more information, see [`Glog should delete old log files automatically`](https://github.com/google/glog/issues/423).
- Use [logrotate](https://github.com/logrotate/logrotate) to manage log files. Before using logrotate, modify the configurations of corresponding services and set `timestamp_in_logfile_name` to `false`.
{{nebula.name}} uses [glog](https://github.com/google/glog) for log printing, which does not support log recycling. You can manage runtime logs by using cron jobs or the log management tool [logrotate](https://man7.org/linux/man-pages/man8/logrotate.8.html). For operational details, see [Log recycling](../5.configurations-and-logs/2.log-management/logs.md).

### "How to check the NebulaGraph version?"

Expand Down Expand Up @@ -380,6 +375,10 @@ NebulaGraph {{ nebula.release }} does not provide any commands or tools to suppo

You also need to run [Balance Data and Balance leader](../8.service-tuning/load-balance.md) after scaling in/out storaged.

You can scale Graph and Storage services with Dashboard Enterprise Edition. For details, see [Scale](../nebula-dashboard-ent/4.cluster-operator/operator/scale.md).

You can also use NebulaGraph Operator to scale Graph and Storage services. For details, see [Deploy NebulaGraph clusters](../k8s-operator/4.cluster-administration/4.1.installation/4.1.1.cluster-install.md).

#### Add or remove disks in the Storage nodes

Currently, Storage cannot dynamically recognize new added disks. You can add or remove disks in the Storage nodes of the distributed cluster by following these steps:
Expand Down
Loading

0 comments on commit 70e5335

Please sign in to comment.