Skip to content

Commit

Permalink
Rename project name to Arktos (CentaurusInfra#410)
Browse files Browse the repository at this point in the history
  • Loading branch information
Xiaoning Ding authored Jan 30, 2020
1 parent 803c7d0 commit 671a173
Show file tree
Hide file tree
Showing 1,527 changed files with 1,660 additions and 1,673 deletions.
30 changes: 15 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Welcome

Welcome to Alkaid!
Welcome to Arktos!

- [Before you get started](#before-you-get-started)
- [Code of Conduct](#code-of-conduct)
Expand All @@ -20,19 +20,19 @@ Welcome to Alkaid!

## Code of Conduct

Please make sure to read and observe our [Code of Conduct](https://github.com/futurewei-cloud/alkaid/blob/master/code-of-conduct.md).
Please make sure to read and observe our [Code of Conduct](https://github.com/futurewei-cloud/arktos/blob/master/code-of-conduct.md).

# Getting started

- Fork the repository on GitHub
- Visit [README](https://github.com/futurewei-cloud/alkaid#build-alkaid) for build instructions.
- Visit [README](https://github.com/futurewei-cloud/arktos#build-arktos) for build instructions.


# Your First Contribution

We will help you to contribute in different areas like filing issues, developing features, fixing critical bugs and getting your work reviewed and merged.

If you have questions about the development process, feel free to jump into our [slack channel](https://app.slack.com/client/TMNECBVT5/CRRUU7137) or join our [email group](https://groups.google.com/forum/#!forum/alkaid-user).
If you have questions about the development process, feel free to jump into our [slack channel](https://app.slack.com/client/TMNECBVT5/CRRUU7137) or join our [email group](https://groups.google.com/forum/#!forum/arktos-user).

## Find something to work on

Expand All @@ -42,9 +42,9 @@ Here is how you get started.

### Find a good first topic

There are multiple repositories ([Alkaid](https://github.com/futurewei-cloud/alkaid), [Alkaid-vm-runtime](https://github.com/futurewei-cloud/alkaid-vm-runtime), [Alkaid-cniplugins](https://github.com/futurewei-cloud/alkaid-cniplugins)) within the Alkaid organization.
There are multiple repositories ([Arktos](https://github.com/futurewei-cloud/arktos), [Arktos-vm-runtime](https://github.com/futurewei-cloud/arktos-vm-runtime), [Arktos-cniplugins](https://github.com/futurewei-cloud/arktos-cniplugins)) within the Arktos organization.
Each repository has beginner-friendly issues that provide a good starting point.
For example, [Alkaid](https://github.com/futurewei-cloud/alkaid) has [help wanted](https://github.com/futurewei-cloud/alkaid/labels/help%20wanted) and [good first issue](https://github.com/futurewei-cloud/alkaid/labels/good%20first%20issue) labels for issues that should not need deep knowledge of the system. We can help new contributors who wish to work on such issues.
For example, [Arktos](https://github.com/futurewei-cloud/arktos) has [help wanted](https://github.com/futurewei-cloud/arktos/labels/help%20wanted) and [good first issue](https://github.com/futurewei-cloud/arktos/labels/good%20first%20issue) labels for issues that should not need deep knowledge of the system. We can help new contributors who wish to work on such issues.


### Work on an issue
Expand All @@ -55,9 +55,9 @@ then the robot will assign the issue to you and your name will present at `Assig
### File an Issue

While we encourage everyone to contribute code, it is also appreciated when someone reports an issue.
Issues should be filed under the appropriate Alkaid sub-repository.
Issues should be filed under the appropriate Arktos sub-repository.

*Example:* An Alkaid issue should be opened to [Alkaid](https://github.com/futurewei-cloud/alkaid). And the same should apply to [Alkaid-vm-runtime](https://github.com/futurewei-cloud/alkaid-vm-runtime) and [Alkaid-cniplugins](https://github.com/futurewei-cloud/alkaid-cniplugins).
*Example:* An Arktos issue should be opened to [Arktos](https://github.com/futurewei-cloud/arktos). And the same should apply to [Arktos-vm-runtime](https://github.com/futurewei-cloud/arktos-vm-runtime) and [Arktos-cniplugins](https://github.com/futurewei-cloud/arktos-cniplugins).

Please follow the prompted submission guidelines while opening an issue.

Expand All @@ -71,13 +71,13 @@ This is a rough outline of what a contributor's workflow looks like:
- Make commits of logical units.
- Make sure commit messages are in the proper format (see below).
- Push changes in a topic branch to a personal fork of the repository.
- Submit a pull request to [Alkaid](https://github.com/futurewei-cloud/alkaid).
- Submit a pull request to [Arktos](https://github.com/futurewei-cloud/arktos).
- The PR must receive an approval from two team members including at least one maintainer.

## Creating Pull Requests

Pull requests are often called simply "PR".
Alkaid generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process.
Arktos generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process.
To submit a proposed change, please develop the code/fix and add new test cases.
After that, run these local verifications before submitting pull request to predict the pass or
fail of continuous integration.
Expand Down Expand Up @@ -125,17 +125,17 @@ There are multiple types of tests.
The location of the test code varies with type, as do the specifics of the environment needed to successfully run the test:

* Unit: These confirm that a particular function behaves as intended. Unit test source code can be found adjacent to the corresponding source code within a given package. These are easily run locally by any developer.
* Integration: These tests cover interactions of package components or interactions between Alkaid components.
* Integration: These tests cover interactions of package components or interactions between Arktos components.
* End-to-end ("e2e"): These are broad tests of overall system behavior and coherence.

Continuous integration will run these tests on PRs.

## 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 channel](https://app.slack.com/client/TMNECBVT5/CRRUU7137), 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 channel](https://app.slack.com/client/TMNECBVT5/CRRUU7137), 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.
44 changes: 22 additions & 22 deletions README.md
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.
16 changes: 8 additions & 8 deletions SUPPORT.md
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/)
2 changes: 1 addition & 1 deletion build/common.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2014 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion build/debian-hyperkube-base/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Copyright 2017 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion build/lib/release.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2016 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions build/root/Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Copyright 2016 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -158,7 +158,7 @@ update:
else
update: generated_files
CALLED_FROM_MAIN_MAKEFILE=1 hack/make-rules/update.sh
hack/alkaid_copyright.sh $(PWD) $(OUT_DIR)
hack/arktos_copyright.sh $(PWD) $(OUT_DIR)
endif

define CHECK_TEST_HELP_INFO
Expand Down
4 changes: 2 additions & 2 deletions build/run.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2014 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -43,4 +43,4 @@ if [[ ${KUBE_RUN_COPY_OUTPUT} =~ ^[yY]$ ]]; then
kube::build::copy_output
fi

${KUBE_ROOT}/hack/alkaid_copyright.sh ${KUBE_ROOT} ${KUBE_ROOT}/_output
${KUBE_ROOT}/hack/arktos_copyright.sh ${KUBE_ROOT} ${KUBE_ROOT}/_output
2 changes: 1 addition & 1 deletion cluster/gce/config-default.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2014 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion cluster/gce/config-test.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2014 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion cluster/gce/gci/configure-helper.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2016 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion cluster/gce/gci/configure.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2016 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion cluster/gce/gci/master-helper.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2016 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion cluster/gce/util.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2017 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion cluster/kubemark/gce/config-default.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2017 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion cluster/validate-cluster.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

# Copyright 2014 The Kubernetes Authors.
# Copyright 2020 Authors of Alkaid - file modified.
# Copyright 2020 Authors of Arktos - file modified.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion cmd/kube-controller-manager/app/controllermanager.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Copyright 2014 The Kubernetes Authors.
Copyright 2020 Authors of Alkaid - file modified.
Copyright 2020 Authors of Arktos - file modified.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion cmd/kube-controller-manager/app/core.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Copyright 2016 The Kubernetes Authors.
Copyright 2020 Authors of Alkaid - file modified.
Copyright 2020 Authors of Arktos - file modified.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
Loading

0 comments on commit 671a173

Please sign in to comment.