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.

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

Kubernetes releted docs in README.md. #146

Merged
merged 1 commit into from
Jan 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Vineyard follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

In cases of abusive, harassing, or any unacceptable behaviors, please don't hesitate to contact the project team at coc@v6d.io.
In cases of abusive, harassing, or any unacceptable behaviors, please don't hesitate to contact the project team at [coc@v6d.io](mailto:coc@v6d.io).
5 changes: 3 additions & 2 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Decisions are made based on consensus between maintainers. In extreme cases, a s
where each maintainer receives one vote.

Proposals and ideas can either be submitted for agreement via a github issue or PR,
or by sending an email to `community@v6d.io`.
or by sending an email to [community@v6d.io](mailto:community@v6d.io).

In general, we prefer that technical issues and maintainer membership are amicably worked out between the persons involved.
If a dispute cannot be decided independently, get a third-party maintainer (e.g. a mutual contact with some background
Expand All @@ -67,4 +67,5 @@ The Vineyard [Code of Conduct](CODE_OF_CONDUCT.md) is aligned with the CNCF Code

## Credits

Some contents in this documents have been borrowed from [BFE](https://github.com/bfenetworks/bfe/blob/develop/GOVERNANCE.md) and [OpenYurt](https://github.com/alibaba/openyurt/blob/master/GOVERNANCE.md).
Some contents in this documents have been borrowed from [BFE](https://github.com/bfenetworks/bfe/blob/develop/GOVERNANCE.md)
and [OpenYurt](https://github.com/alibaba/openyurt/blob/master/GOVERNANCE.md).
46 changes: 44 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
an in-memory immutable data manager
</p>

|Build and Test| |Coverage| |Docs|
|Build and Test| |Coverage| |Docs| |Artifact HUB|

Vineyard is an in-memory immutable data manager
that provides **out-of-box high-level** abstraction and **zero-copy in-memory** sharing for
Expand Down Expand Up @@ -141,14 +141,54 @@ Besides sharing the high level data abstractions, vineyard extends the capabily
of data structures by drivers, enabling out-of-box reusable runtines for the
boilerplate part in computation jobs.

Integrate with Kubernetes
-------------------------

Deployment
^^^^^^^^^^

For better leveraging the scale-in/out capability of Kubernetes for worker pods of
a data analytical job, vineyard could be deployed on Kubernetes to as a DaemonSet
in Kubernetes cluster. Vineyard pods shares memory with worker pods using a UNIX
domain socket with fine-grained access control.

The UNIX domain socket can be either mounted on ``hostPath`` or via a ``PersistentVolumeClaim``.
When users bundle vineyard and the workload to the same pod, the UNIX domain socket
could also be shared using an ``emptyDir``.

Vineyard Objects as Resources
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Vineyard objects are abstracted as Kubernetes resources(i.e., CRDs). Each CRD contains
the metadata of the represented vineyard object Location specs that describe which
node an object is located are added to the CRDs of local objects

Vineyard Operator
^^^^^^^^^^^^^^^^^

Vineyard Operator will

+ be responsible for managing the status of vineyard cluster
+ manage the CRDs (which represents objects in vineyard) in the cluster
+ provide the scale in/out capability of vineyard on Kubernetes
+ be responsible for data checkpoint, fault tolarence, etc.

Install vineyard
----------------

Vineyard is distributed as a `python package`_ and can be easily installed with ``pip``:

.. code:: shell

pip3 install vineyard
pip3 install vineyard

Vineyard also has tight integration with Kubernetes and Helm. Vineyard can be deployed
with ``helm``:

.. code:: shell

helm repo add vineyard https://dl.bintray.com/libvineyard/charts/
helm install vineyard vineyard/vineyard

The latest version of online documentation can be found at https://v6d.io.

Expand Down Expand Up @@ -193,3 +233,5 @@ Thank you in advance for your contributions to vineyard!
:target: https://codecov.io/gh/alibaba/libvineyard
.. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
:target: https://v6d.io
.. |Artifact HUB| image:: https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/vineyard
:target: https://artifacthub.io/packages/helm/vineyard/vineyard
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ We adopt a private disclosure process for security issues.
### Private Disclosure Process
If you find a bug, a security vulnerability or any security related issues,
please DO NOT file a public issue. Do not create a Github issue.
Instead, send your report privately to security@v6d.io.
Instead, send your report privately to [security@v6d.io](mailto:security@v6d.io).
Security reports are greatly appreciated and we will publicly thank you for it.

Please provide as much information as possible, so we can react quickly.
Expand Down
2 changes: 2 additions & 0 deletions charts/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
index.yaml
*.tgz
24 changes: 24 additions & 0 deletions charts/vineyard/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
vineyard
========

Vineyard is an in-memory immutable data manager that provides **out-of-box high-level**
abstraction and **zero-copy in-memory** sharing for distributed data in big data tasks,
such as numerical computing, machine learning, and graph analytics.


Install
-------

Vineyard is an has been integrated with [Helm](https://helm.sh/). Deploy vineyard as
a `DaemonSet` using `helm`:

```bash
helm repo add vineyard https://dl.bintray.com/libvineyard/charts/
helm install vineyard vineyard/vineyard
```

License
-------

**libvineyard** is distributed under [Apache License 2.0](https://github.com/alibaba/libvineyard/blob/main/LICENSE).
Please note that third-party libraries may not have the same license as libvineyard.
16 changes: 0 additions & 16 deletions charts/vineyard/README.rst

This file was deleted.