From d2a0db137b13dea8fb986bfea56f0a45fe58d6e5 Mon Sep 17 00:00:00 2001 From: ssz1997 Date: Fri, 28 Apr 2023 17:21:56 -0700 Subject: [PATCH 1/2] add readme.md --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/README.md b/README.md index e69de29bb..acfbf9e33 100644 --- a/README.md +++ b/README.md @@ -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 πŸ“– +Under development. + +## Compatibility with Alluxio 🧩 +Under development. + +## 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) +* Meetup Groups: [Global Online Meetup](https://www.meetup.com/Alluxio-Global-Online-Meetup/), [Bay Area Meetup](http://www.meetup.com/Alluxio), +[New York Meetup](https://www.meetup.com/Alluxio-Open-Source-New-York-Meetup), +[Beijing Alluxio Meetup](https://www.meetup.com/meetup-group-iLMBZGhS/), [Austin Meetup](https://www.meetup.com/Cloud-Data-Orchestration-Austin/) +* [Alluxio Twitter](https://twitter.com/alluxio); [Alluxio Youtube Channel](https://www.youtube.com/channel/UCpibQsajhwqYPLYhke4RigA); [Alluxio Mailing List](https://groups.google.com/forum/?fromgroups#!forum/alluxio-users) + +## 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). From c65088404a979b68267165137b8131dafecbf6c7 Mon Sep 17 00:00:00 2001 From: ssz1997 Date: Mon, 2 Oct 2023 15:37:38 -0700 Subject: [PATCH 2/2] update readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index acfbf9e33..d9cb62a26 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,14 @@ 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 πŸ“– -Under development. +Checkout our up-to-date documentation [here](https://docs.alluxio.io/os/user/edge/en/kubernetes/Install-Alluxio-On-Kubernetes.html). ## Compatibility with Alluxio 🧩 -Under development. +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: @@ -30,10 +34,6 @@ 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) -* Meetup Groups: [Global Online Meetup](https://www.meetup.com/Alluxio-Global-Online-Meetup/), [Bay Area Meetup](http://www.meetup.com/Alluxio), -[New York Meetup](https://www.meetup.com/Alluxio-Open-Source-New-York-Meetup), -[Beijing Alluxio Meetup](https://www.meetup.com/meetup-group-iLMBZGhS/), [Austin Meetup](https://www.meetup.com/Cloud-Data-Orchestration-Austin/) -* [Alluxio Twitter](https://twitter.com/alluxio); [Alluxio Youtube Channel](https://www.youtube.com/channel/UCpibQsajhwqYPLYhke4RigA); [Alluxio Mailing List](https://groups.google.com/forum/?fromgroups#!forum/alluxio-users) ## Contributing 🎁