Add a documentation page for Arktos (#156)

zmn223 · Xiaoning Ding · web-flow · commit 4fa2fd3d1385 · 2020-04-05T15:32:21.000-07:00
* Add yaml files for documentation page (#1) * Added .md files for documentation page * Add files via upload * Update Arktos-Release-Notes.md * Addressed PR comments * Updated mkdocs.yml Co-authored-by: Xiaoning Ding <xiaoning.ding@futurewei.com>
diff --git a/docs/slides/arktos_current_work_and_next.pdf b/docs/slides/arktos_current_work_and_next.pdf
diff --git a/docs/user-guide/Arktos-Release-Notes.md b/docs/user-guide/Arktos-Release-Notes.md
@@ -0,0 +1,93 @@
+# Roadmap
+
+## Arktos Release v0.1 (1/30/2020)
+Arktos is an open source cluster management system designed for large scale clouds. It is evolved from the open source Kubernetes v1.15 codebase with some fundamental improvements.
+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.
+
+Today we announce the v0.1 release of Arktos.
+
+### Repos
+1. Arktos: https://github.com/futurewei-cloud/arktos 
+1. Arktos-cniplugins: https://github.com/futurewei-cloud/arktos-cniplugins
+1. Arktos-vm-runtime: https://github.com/futurewei-cloud/arktos-vm-runtime
+
+### Released Components
+1. Unified Node Agent
+1. Unified Scheduler
+1. Partitioned and Scalable Controller Manager
+1. API Server/Core Server with Multi-Tenancy and Unified Pod Support
+1. Arktos VM Runtime Server
+
+### Features
+1. Multi-tenancy Features 
+     1. Introduce a new layer “tenant” before “namespace” in API resource URL schema, to provide a clear and isolated resource hierarchy for tenants.
+     1. Introduce a new API resource “tenant”, to keep tenant-level configurations and properties.
+     1. The metadata section of all exiting API resources has a new member: tenantName.
+     1. API Server, ClientGo, Scheduler, Controllers and CLI changes for the new resource model.
+1. Unified VM/Container Support:
+     1. Extend “pod” definition to both containers and VM. Now a pod can contain one VM, or one or more containers.
+     1. Enhance scheduler to schedule container pods and VM pods in the same way (unified scheduling).
+     1. Enhance kubelet to support multiple CRI runtimes (unified agent).
+     1. Implement a VM runtime server evolved from project Virtlet, with new features like VM reboot, snapshot, restore, etc.
+     1. Enhance kubelet to handle VM state changes and configuration changes.
+     1. Introduce a new API resource “action” and the corresponding handles (action framework) to support some VM specific actions which are not appropriate to be expressed as state machine changes, like reboot and snapshot.
+1. Artkos Integration with OpenStack Neutron
+     1. Arktos network controller integrate with neutron.
+     1. Arktos CNI plugins for neutron. 
+1. Arktos integration with Mizar
+     1. Arktos CNI plugins for mizar-mp.
+1. Scalability
+     1. Partitioned and scalable controller managers with active-active support.
+     1. API Server Partitioning (in progress)
+     1. ETCD partitioning (in progress)
+### Known Issues
+1. Go 1.13 is not supported yet.
+### Features in Planning
+1. Intelligent scheduling
+1. in-place resource update 
+1. QoS enforcement
+
+## Arktos Release v0.2 (3/30/2020)
+
+### Features Added
+1. Multi-tenancy Features
+     1. Tenancy short-path support
+     2. Add Tenant Controller  
+     3. Tenancy-aware token Authenticator 
+     4. Tenancy-aware Cert Authenticator 
+     5. Tenancy-aware RBAC Authorizer  
+     6. Tenancy in kubeconfig context  
+     7. Stabilization on multi-tenancy API Model  
+     8. More test and workaround fixes Added  
+
+2. Scalability Features
+     1. API Server Data Partitioning
+     2. Active-active controller framework - new Kubernetes master component: Workload Controller Manager
+     3. Set up test environments for data partitioned environment 
+     4. Add kube-up and start-kubemark for AWS
+     
+3. Unifed VM/containers
+     1. Add support for primary runtime 
+     2. Add volume driver for OpenStack Cinder 
+     3. Fix issues related to VM pod vCPU settings 
+   
+4. Documentation
+   1. New documentation readthedocs page
+
+### Known Issues
+
+   1. Create new tenant make events related to the tenant populated to all api servers
+   2. Performance testing: Scheduling Throughput is one fourth of pre-arktos
+   3. AWS: Register kubemark master as a node
+   4. AWS: Start-kubemark failed to run without sudo password
+   5. Get coredns working with kubeadm
+   6. AWS: Add workload-controller-manager to aws kube-up and start-kubemark
+
+### Future Releases 
+   1. Performance test result  
+   2. ETCD partitioning
+   3. Intelligent scheduling
+   4. In-place resource update
+   5. QoS enforcement
+
+
diff --git a/docs/user-guide/CONTRIBUTING.md b/docs/user-guide/CONTRIBUTING.md
@@ -0,0 +1,142 @@
+# Welcome
+
+Welcome to Arktos! 
+
+-   [Before you get started](#before-you-get-started)
+    -   [Code of Conduct](#code-of-conduct)
+-   [Getting started](#getting-started)
+-   [Your First Contribution](#your-first-contribution)
+    -   [Find something to work on](#find-something-to-work-on)
+        -   [Find a good first topic](#find-a-good-first-topic)
+        -   [Work on an Issue](#work-on-an-issue)
+        -   [File an Issue](#file-an-issue)
+-   [Contributor Workflow](#contributor-workflow)
+    -   [Creating Pull Requests](#creating-pull-requests)
+    -   [Code Review](#code-review)
+    -   [Testing](#testing)
+    -   [Documents and Support](#documents-and-support)
+
+# Before you get started
+
+## Code of Conduct
+
+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/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/arktos-user).
+
+## Find something to work on
+
+We are always in need of help, be it fixing documentation, reporting bugs or writing some code.
+Look at places where you feel best coding practices aren't followed, code refactoring is needed or tests are missing.
+Here is how you get started.
+
+### Find a good first topic
+
+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, [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
+
+When you are willing to take on an issue, you can assign it to yourself. Just reply with `/assign` or `/assign @yourself` on an issue,
+then the robot will assign the issue to you and your name will present at `Assignees` list.
+
+### 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 Arktos sub-repository.
+
+*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.
+
+# Contributor Workflow
+
+Please do not ever hesitate to ask a question or send a pull request.
+
+This is a rough outline of what a contributor's workflow looks like:
+
+- Fork [Arktos](https://github.com/futurewei-cloud/arktos).
+- Create a topic branch in your forked repo from where to base the contribution. This is usually master.
+- 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 [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".
+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.
+
+## Code Review
+
+To make it easier for your PR to receive reviews, consider the reviewers will need you to:
+
+* follow [good coding guidelines](https://github.com/golang/go/wiki/CodeReviewComments).
+* write [good commit messages](https://chris.beams.io/posts/git-commit/).
+* break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue.
+* label PRs with appropriate reviewers: to do this read the messages the bot sends you to guide you through the PR process.
+
+### Format of the commit message
+
+We follow a rough convention for commit messages that is designed to answer two questions: what changed and why.
+The subject line should feature the what and the body of the commit should describe the why.
+
+```
+scripts: add test codes for metamanager
+
+this add some unit test codes to imporve code coverage for metamanager
+
+Fixes #12
+```
+
+The format can be described more formally as follows:
+
+```
+<subsystem>: <what changed>
+<BLANK LINE>
+<why this change was made>
+<BLANK LINE>
+<footer>
+```
+
+The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
+
+Note: if your pull request isn't getting enough attention, you can use the reach out on Slack to get help finding reviewers.
+
+
+## Testing
+
+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 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/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/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/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/arktos-user), or [create an issue](https://github.com/futurewei-cloud/arktos/issues) of question type in the repo.
diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md
@@ -0,0 +1,79 @@
+# Arktos
+
+
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/futurewei-cloud/arktos)](https://goreportcard.com/report/github.com/futurewei-cloud/arktos)
+[![LICENSE](https://img.shields.io/badge/license-apache%202.0-green)](https://github.com/futurewei-cloud/arktos/blob/master/LICENSE)
+
+
+## What Arktos is
+
+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. 
+
+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 Arktos
+
+
+### Large Scalability
+
+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
+
+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, 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 Arktos
+
+
+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/arktos
+cd arktos
+make
+```
+
+## Run Arktos
+
+To run a single-node Arktos cluster in your local development box:
+
+```
+cd $GOPATH/src/github.com/arktos
+hack/arktos-up.sh
+```
+
+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/arktos
+cluster/kubectl.sh get nodes
+```
+
+For more complicated cluster setups, please refer to [Arktos Cluster Setup Guide](https://github.com/futurewei-cloud/arktos/blob/master/docs/setup-guide/multi-node-dev-cluster.md).   
+
+## Documents and Support
+
+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/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/arktos/issues) in the project repo. 
+
+To ask a question, here is [the invitation](https://join.slack.com/t/arktosworkspace/shared_invite/zt-cmak5gjq-rBxX4vX2TGMyNeU~jzAMLQ) to join [Arktos slack channels](http://arktosworkspace.slack.com/). You can also 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.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,33 @@
+site_name: Arktos
+docs_dir: 'docs'
+site_dir: '.tmp/documentation'
+repo_url: https://github.com/futurewei-cloud/arktos
+theme:
+    name: readthedocs
+    highlightjs: true
+    hljs_languages:
+        - yaml
+nav:
+    - Home: 'user-guide/README.md'
+    - 'Getting Started':
+        - Contributing: 'user-guide/CONTRIBUTING.md'
+        - Multi-node Setup Guide: 'setup-guide/multi-node-dev-cluster.md'
+        - Roadmap: 'user-guide/Arktos-Release-Notes.md'
+    - 'Multi-Tenancy':
+        - Multi-Tenancy Design Overview: 'design-proposals/multi-tenancy/multi-tenancy-overview.md'
+        - Multi-Tenancy API Resource Model: 'design-proposals/multi-tenancy/multi-tenancy-api-resource-model.md'
+        - Multi-Tenancy Access Control: 'design-proposals/multi-tenancy/multi-tenancy-access-control.md'
+        - Multi-Tenancy Scheduler and Controllers: 'design-proposals/multi-tenancy/multi-tenancy-schduler-agent-and-controllers.md'
+        - Multi-Tenancy Networking: 'design-proposals/multi-tenancy/network.md'
+    - 'Scalability':
+        - Controller Scalability: 'design-proposals/controller/scaleout-framework/ControllerFramework.md'
+        - API Server Data Partition: 'design-proposals/apiserver/Data-Partition-Design.md'
+
+    - 'Unified VM/Container':
+        - Support for Multi Runtimes in Agent: 'design-proposals/node/Support-multiple-runtimes.md'
+        - VPC Support for VMs and Containers: 'design-proposals/network/NICAndVPCSupportInArktos.md'
+        - Action APIs to Support VM-specific Lifecycle Events: 'design-proposals/apiserver/Action-API-design.md'
+        - Common Abstract Between VM and Container: 'design-proposals/apiserver/VM-Container-Common.md'
+    - 'Document':
+        - Current Works and Next: 'slides/arktos_current_work_and_next.pdf'
+        - Arktos Overview and Demo at KubeCon 2019: 'slides/kubecon2019_na_booth_demo.pptx'
diff --git a/readthedocs.yaml b/readthedocs.yaml
@@ -0,0 +1,12 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
