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

Add readme.md #10

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add readme.md #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2a0db1
add readme.md
ssz1997 Apr 29, 2023
c650884
update readme
ssz1997 Oct 2, 2023
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
48 changes: 48 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
[![logo](docs/resources/alluxio_logo.png "Alluxio")](https://www.alluxio.io)

## What is Alluxio❓
[Alluxio](https://www.alluxio.io) (formerly known as Tachyon)
is a virtual distributed storage system. It bridges the gap between
computation frameworks and storage systems, enabling computation applications to connect to
numerous storage systems through a common interface. For more information, checkout the
[Alluxio repository](https://www.github.com/Alluxio/alluxio).

## What is k8s-operator❓
This repository defines an [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
for Alluxio system. It not only installs Alluxio on your kubernetes cluster, providing all the benefits
brought by Alluxio, but also simplifies your day-2 operations - maintaining, monitoring, and optimizing.

## Who Owns and Manages Alluxio Project 🏘
Alluxio Open Source Foundation is the owner of Alluxio project.
Project operation is done by Alluxio Project Management Committee (PMC).
You can checkout more details in its structure and how to join Alluxio PMC
[here](https://github.com/Alluxio/alluxio/wiki/Alluxio-Project-Management-Committee-(PMC)).

## Quick Start and Documentation 📖
Checkout our up-to-date documentation [here](https://docs.alluxio.io/os/user/edge/en/kubernetes/Install-Alluxio-On-Kubernetes.html).

## Compatibility with Alluxio 🧩
The minimum version
| k8s-operator\alluxio | v300 | v301 | v302 | v303 | v304 |
|----------------------|------|------|------|------|------|
| v1.0.0 | ✅ | ✅ | ✅ | ✅ | |
| v1.0.1 | ✅ | ✅ | ✅ | ✅ | |

## Community and Events 📣
Please use the following to reach members of the community:

* [Alluxio Community Slack Channel](https://www.alluxio.io/slack): post your questions here if you seek for help for general questions or issues using Alluxio.
* [Special Interest Groups (SIG) for Alluxio users and developers](#contributing)
* Community Events: [upcoming online office hours, meetups and webinars](https://www.alluxio.io/events)

## Contributing 🎁

Contributions via GitHub pull requests are gladly accepted from their original author. Along with
any pull requests, please state that the contribution is your original work and that you license the
work to the project under the project's open source license. Whether or not you state this
explicitly, by submitting any copyrighted material via pull request, email, or other means you agree
to license the material under the project's open source license and warrant that you have the legal
authority to do so.
For a more detailed step-by-step guide, please read
[how to contribute to Alluxio](https://docs.alluxio.io/os/user/stable/en/contributor/Contributor-Getting-Started.html).
For new contributor, please take two [new contributor tasks](https://github.com/Alluxio/new-contributor-tasks).