forked from CentaurusInfra/arktos
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename project name to Arktos (CentaurusInfra#410)
- Loading branch information
Xiaoning Ding
authored
Jan 30, 2020
1 parent
803c7d0
commit 671a173
Showing
1,527 changed files
with
1,660 additions
and
1,673 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,76 +1,76 @@ | ||
# Alkaid | ||
# Arktos | ||
|
||
<br/> | ||
|
||
|
||
## What Alkaid is | ||
## What Arktos is | ||
|
||
Alkaid is an open source cluster management system designed for large scale clouds. It is evolved from the open source [Kubernetes](https://github.com/kubernetes/kubernetesh) v1.15 codebase with some fundamental improvements. | ||
Arktos is an open source cluster management system designed for large scale clouds. It is evolved from the open source [Kubernetes](https://github.com/kubernetes/kubernetesh) v1.15 codebase with some fundamental improvements. | ||
|
||
Alkaid aims to be an open source solution to address key challenges of large scale clouds, including system scalability, resource efficiency, multitenancy, cross-AZ resiliency, and the native support for the fast-growing modern workloads such as containers and serverless functions. | ||
Arktos aims to be an open source solution to address key challenges of large scale clouds, including system scalability, resource efficiency, multitenancy, cross-AZ resiliency, and the native support for the fast-growing modern workloads such as containers and serverless functions. | ||
|
||
---- | ||
|
||
## Key Features of Alkaid | ||
## Key Features of Arktos | ||
|
||
|
||
### Large Scalability | ||
|
||
Alkaid achieves a scalable architecture by partitioning and replicating system components, including API Server, storage, controllers and data plane. The eventual goal of Alkaid is to support 100K nodes with a single cross-AZ control plane. | ||
Arktos achieves a scalable architecture by partitioning and replicating system components, including API Server, storage, controllers and data plane. The eventual goal of Arktos is to support 100K nodes with a single cross-AZ control plane. | ||
|
||
### Multitenancy | ||
|
||
Alkaid implements a hard multi-tenancy model to meet the strict isolation requirement highly desired by a typical public cloud environment. Tenant is a built-in object in the system, and some flexible multi-tenancy models can also be supported with customized resource authorization rules. | ||
Arktos implements a hard multi-tenancy model to meet the strict isolation requirement highly desired by a typical public cloud environment. Tenant is a built-in object in the system, and some flexible multi-tenancy models can also be supported with customized resource authorization rules. | ||
|
||
### Native VM Support | ||
|
||
In addition to container orchestration, Alkaid implements a built-in support for VMs. In Alkaid a pod can contain either containers or a VM. They are scheduled the same way and launched by node agent using different runtime servers. VMs and containers are both the first-class citizens in Alkaid. | ||
In addition to container orchestration, Arktos implements a built-in support for VMs. In Arktos a pod can contain either containers or a VM. They are scheduled the same way and launched by node agent using different runtime servers. VMs and containers are both the first-class citizens in Arktos. | ||
|
||
|
||
### More Planned Features | ||
|
||
More features are planned but not started yet, including intelligent scheduling, in-place resource update, QoS enforcement, etc. | ||
|
||
|
||
## Build Alkaid | ||
## Build Arktos | ||
|
||
|
||
To build Alkaid, you just need to clone the repo and run "make": | ||
To build Arktos, you just need to clone the repo and run "make": | ||
|
||
##### Note: you need to have a working [Go 1.12 environment](https://golang.org/doc/install). Go 1.13 is not supported yet. | ||
|
||
``` | ||
mkdir -p $GOPATH/src/github.com | ||
cd $GOPATH/src/github.com | ||
git clone https://github.com/futurewei-cloud/alkaid | ||
cd alkaid | ||
git clone https://github.com/futurewei-cloud/arktos | ||
cd arktos | ||
make | ||
``` | ||
|
||
## Run Alkaid | ||
## Run Arktos | ||
|
||
To run a single-node Alkaid cluster in your local development box: | ||
To run a single-node Arktos cluster in your local development box: | ||
|
||
``` | ||
cd $GOPATH/src/github.com/alkaid | ||
hack/alkaid-up.sh | ||
cd $GOPATH/src/github.com/arktos | ||
hack/arktos-up.sh | ||
``` | ||
|
||
After the Alkaid cluster is up, you can access the cluster with [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) tool just like what you do with a Kubernetes cluster. For example: | ||
After the Arktos cluster is up, you can access the cluster with [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) tool just like what you do with a Kubernetes cluster. For example: | ||
|
||
``` | ||
cd $GOPATH/src/github.com/alkaid | ||
cd $GOPATH/src/github.com/arktos | ||
cluster/kubectl.sh get nodes | ||
``` | ||
|
||
For more complicated cluster setups, an automated deployment tool is not available yet. Some manually work is required before the tool is ready. You need to manually setup more worker nodes and register them to a same master server. | ||
|
||
## Documents and Support | ||
|
||
The [design document folder](https://github.com/futurewei-cloud/alkaid/tree/master/docs/design-proposals/) contains the detailed design of already implemented features, and also some thoughts for planned features. | ||
The [design document folder](https://github.com/futurewei-cloud/arktos/tree/master/docs/design-proposals/) contains the detailed design of already implemented features, and also some thoughts for planned features. | ||
|
||
The [user guide folder](https://github.com/futurewei-cloud/alkaid/tree/master/docs/user-guide/) provides information about these features from users' perspective. | ||
The [user guide folder](https://github.com/futurewei-cloud/arktos/tree/master/docs/user-guide/) provides information about these features from users' perspective. | ||
|
||
To report a problem, please [create an issue](https://github.com/futurewei-cloud/alkaid/issues) in the project repo. | ||
To report a problem, please [create an issue](https://github.com/futurewei-cloud/arktos/issues) in the project repo. | ||
|
||
To ask a question, you can either chat with project members in the [slack channels](http://alkaidworkspace.slack.com/), post in the [email group](https://groups.google.com/forum/#!forum/alkaid-user), or [create an issue](https://github.com/futurewei-cloud/alkaid/issues) of question type in the repo. | ||
To ask a question, you can either chat with project members in the [slack channels](http://arktosworkspace.slack.com/), post in the [email group](https://groups.google.com/forum/#!forum/arktos-user), or [create an issue](https://github.com/futurewei-cloud/arktos/issues) of question type in the repo. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,21 @@ | ||
## Support for deploying and using Alkaid | ||
## Support for deploying and using Arktos | ||
|
||
Welcome to Alkaid! We use GitHub for tracking bugs and feature requests. | ||
This isn't the right place to get support for using Alkaid, but the following resources are available below, thanks for understanding. | ||
Welcome to Arktos! We use GitHub for tracking bugs and feature requests. | ||
This isn't the right place to get support for using Arktos, but the following resources are available below, thanks for understanding. | ||
|
||
|
||
### Documentation | ||
|
||
* [User Guide](https://github.com/futurewei-cloud/alkaid/tree/master/docs/user-guide/) | ||
* [Design Documents](https://github.com/futurewei-cloud/alkaid/tree/master/docs/design-proposals/) | ||
* [User Guide](https://github.com/futurewei-cloud/arktos/tree/master/docs/user-guide/) | ||
* [Design Documents](https://github.com/futurewei-cloud/arktos/tree/master/docs/design-proposals/) | ||
|
||
### Slack Channels | ||
|
||
* [Slack](http://alkaidworkspace.slack.com/) : | ||
* [Slack](http://arktosworkspace.slack.com/) : | ||
The `#developers` and `#users` channels are usual places where | ||
people offer support. | ||
|
||
### Google Groups | ||
|
||
* [Alkaid User](https://groups.google.com/forum/#!forum/alkaid-user/) | ||
* [Alkaid Developer](https://groups.google.com/forum/#!forum/alkaid-dev/) | ||
* [Arktos User](https://groups.google.com/forum/#!forum/arktos-user/) | ||
* [Arktos Developer](https://groups.google.com/forum/#!forum/arktos-dev/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.