Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update doc #52

Merged
merged 1 commit into from
Aug 30, 2021
Merged

update doc #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions doc/user/add-ons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,29 @@ This section links to third party projects that provide functionality required b
## coredns
[CoreDNS](https://coredns.io/) is a flexible, extensible DNS server which can be [installed](https://github.com/coredns/deployment/tree/master/kubernetes) as the in-cluster DNS for pods.

NebulaGraph each component can communicate via DNS like _x.default.svc.cluster.local_, coredns is used for address resolution.

## cert-manager
**Note:**
If you set helm chart nebula-operator _.Values.admissionWebhook.create_ to false, the cert-manager is not needed.

[cert-manager](https://cert-manager.io/) is a tool that automates certificate management. It makes use of extending the Kubernetes API server using a Webhook server to provide dynamic admission control over cert-manager resources.

Consult the [cert-manager installation documentation](https://cert-manager.io/docs/installation/kubernetes/) to get started.

cert-manager is used for validating NebulaGraph each component replicas, if you run it in production environment and care high availability, you should set _.Values.admissionWebhook.create_ to true and install cert-manager.

## openkruise
**Note:**
nebula-operator need advanced features for StatefulSet when it starts.
nebula-operator need advanced features for StatefulSet when it starts. nebula-operator will update nebula cluster pod in-place instead of destroying it.

[openkruise](https://openkruise.io/en-us/) is a full set of standard extensions for Kubernetes. It works well with original Kubernetes and provides more powerful and efficient features for managing applications Pods, sidecar containers, and even images on Node.

Consult the [openkruise installation documentation](https://openkruise.io/en-us/docs/installation.html) to get started.

## sig-storage-local-static-provisioner
**Note:**
Only you deploy NebulaGraph with local storage when it is required.
It is required in the scenario that you deploy NebulaGraph with local storage.

[local-static-provisioner](https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner) manages the PersistentVolume lifecycle for pre-allocated disks by detecting and creating PVs for each local disk on the host, and cleaning up the disks when released. It does not support dynamic provisioning.

Expand Down