Populate repo with useful documentations about the ocm project

Signed-off-by: Mike Ng <[email protected]>

Author: mikeshng

.github/workflows/dco.yml

@@ -0,0 +1,21 @@
+name: DCO
+on:
+  workflow_dispatch: {}
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  dco_check:
+    runs-on: ubuntu-latest
+    name: DCO Check
+    steps:
+    - name: Get PR Commits
+      id: 'get-pr-commits'
+      uses: tim-actions/get-pr-commits@master
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+    - name: DCO Check
+      uses: tim-actions/dco@master
+      with:
+        commits: ${{ steps.get-pr-commits.outputs.commits }}

CODE_OF_CONDUCT.md

@@ -0,0 +1,80 @@
+# Contributor Covenant Code of Conduct
+
+The Open Cluster Management project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
+The English text of the CNCF Code of Conduct is made available here for reference.
+Additional [language translations](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) are available.
+
+## Our pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery, and unwelcomed sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior, and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [[email protected]](mailto:[email protected]). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.
+
+[Homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this Code of Conduct, see
+https://www.contributor-covenant.org/faq.

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+**Table of Contents**
+
+- [Contributing guidelines](#contributing-guidelines)
+    - [Terms](#terms)
+    - [Certificate of Origin](#certificate-of-origin)
+    - [DCO Sign Off](#dco-sign-off)
+    - [Code of Conduct](#code-of-conduct)
+    - [Contributing a patch](#contributing-a-patch)
+    - [Issue and pull request management](#issue-and-pull-request-management)
+
+# Contributing guidelines
+
+## Terms
+
+All contributions to the repository must be submitted under the terms of the [Apache Public License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+## Certificate of Origin
+
+By contributing to this project, you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the [DCO](DCO) file for details.
+
+## DCO Sign Off
+
+You must sign off your commit to state that you certify the [DCO](DCO). To certify your commit for DCO, add a line like the following at the end of your commit message:
+
+```
+Signed-off-by: John Smith <[email protected]>
+```
+
+This can be done with the `--signoff` option to `git commit`. See the [Git documentation](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s) for details.
+
+## Code of Conduct
+
+The Open Cluster Management project has adopted the CNCF Code of Conduct. Refer to our [Community Code of Conduct](CODE_OF_CONDUCT.md) for details.
+
+## Contributing a patch
+
+1. Submit an issue describing your proposed change to the repository in question. The repository owners will respond to your issue promptly.
+2. Fork the desired repository, then develop and test your code changes.
+3. Submit a pull request.
+
+## Issue and pull request management
+
+Anyone can comment on issues and submit reviews for pull requests. In order to be assigned an issue or pull request, you can leave a `/assign <your Github ID>` comment on the issue or pull request.

DCO

@@ -0,0 +1,37 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.

MISSION.md

@@ -0,0 +1,86 @@
+## Mission Statement
+
+We seek to form an open community around multicluster and multicloud scenarios for containerized applications. We propose to anchor the initial community around github.com/open-cluster-management-io and open-cluster-management.io.
+
+We seek to add value to the community by a focused effort around many aspects of how users are deploying and managing Kubernetes clusters today. We seek to engage other parts of the community and both contribute to pre-existing efforts and invite contributors in those communities to cross-collaborate as part of this project.
+
+We are initially interested in the following lifecycles associated with expanding adoption of Kubernetes:
+
+1. Cluster Lifecycle. How are clusters provisioned, upgraded, registered, scaled out or in and decommissioned?
+2. Policy & Configuration Lifecycle. How are clusters configured, audited, secured, access controlled, managed for quota or cost?
+3. Application Lifecycle. How are containerized or hybrid applications delivered across one or more clusters? How are those applications kept current with ongoing changes?
+
+Our initial goals for the project are to define API and reference implementations for common use cases that we have observed as users grow their adoption of Kubernetes:
+
+- Define API for cluster registration independent of cluster CRUD lifecycle.
+- Define API for work distribution across multiple clusters.
+- Define API for dynamic placement of content and behavior across multiple clusters.
+- Define API for policy definition to ensure desired configuration and security settings are auditable or enforceable.
+- Define API for distributed application delivery across many clusters and the ability to deliver ongoing updates.
+
+We expect that over time, the project will make sense to contribute to an appropriate foundation for stewardship. In the meantime, we intend to engage and contribute where similar use cases are under active discussion in the community including the Kubernetes SIG-Multicluster and SIG-Policy workgroups, among others.
+
+## Contributor Code of Conduct
+The Open Cluster Management project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). The English text of the CNCF Code of Conduct is made available here for reference. Additional [language translations](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) are available.
+
+"As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+Examples of unacceptable behavior by participants include:
+The use of sexualized language or imagery
+Personal attacks
+Trolling or insulting/derogatory comments
+Public or private harassment
+Publishing others' private information, such as physical or electronic addresses, without explicit permission
+Other unethical or unprofessional conduct.
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+Instances of abusive, harassing, or otherwise unacceptable behavior in Open Cluster Management may be reported by contacting `[email protected]`." [[Reference](https://github.com/cncf/foundation/blob/master/code-of-conduct.md)]
+
+## Getting Involved
+
+Anyone who is interested in getting involved is welcome to contribute in a number of ways:
+
+Join the recurring meeting forums (see below) to provide input as a stakeholder and help validate proposed use cases.
+Suggest enhancements via github.com/open-cluster-management-io/enhancements for consideration to the community.
+Contribute to development via Pull Request for new enhancements or defect fixes.
+
+Suggested API and implementations will be accepted in accordance with the broad use cases outlined above. Our goal is to reserve the Kubernetes API Group open-cluster-management.io for well-reviewed and widely supported features.
+
+## Community Meeting Forum
+
+To ensure opportunities for broad user contributions, a public forum will be hosted to demonstrate new capabilities, solicit feedback and offer a forum for real time Q&A.
+Meeting recordings will be posted to a YouTube channel for offline viewing.
+
+The community meets on a bi-weekly cadence on Thursday at 15:30 UTC.
+
+Meeting Agenda and Topics can be found here: https://github.com/open-cluster-management-io/community/projects/1.
+
+## Communication
+
+See the following options to connect with the community:
+
+ - [Website](https://open-cluster-management.io)
+ - [Slack](https://kubernetes.slack.com/archives/C01GE7YSUUF)
+ - [Mailing group](https://groups.google.com/g/open-cluster-management)
+ - [Community meetings](https://github.com/open-cluster-management-io/community#community-meetings)
+ - [YouTube channel](https://www.youtube.com/channel/UC7xxOh2jBM5Jfwt3fsBzOZw)
+
+## Governance
+
+* **Committees** The project will initially have a 3-person Bootstrap Steering Committee. The present steering
+  committee is a bootstrap committee and we want to work towards a future state where there is community representation and community determination of the steering committee members. In that future state, the steering committee size may be expanded to meet the needs of the community.
+
+* **Special Interest Group (SIG)** are persistent open groups that focus on a part of the project.
+  SIGs must have open and transparent proceedings.
+  Anyone is welcome to participate and contribute provided they follow the Code of Conduct.
+
+  The project has a bootstrap [sig-architecture](sig-architecture) to provide oversight and guidance on API and architectural aspects of the project to ensure a consistent and robust technical foundation for the project. More SIGs are expected to be established with the evolution of the project.
+
+## Public Roadmap
+
+Roadmap is tracked using GitHub project. See https://github.com/open-cluster-management-io/community/projects/2
+
+## Security Response
+
+Please see https://github.com/open-cluster-management-io/ocm/blob/main/SECURITY.md.

OWNERS

@@ -0,0 +1,5 @@
+approvers:
+- deads2k
+- jnpacker
+- mikeshng
+- qiujian16

README.md

@@ -1 +1,60 @@
-# ocm
+![image](assets/ocm-logo.png)
+
+Welcome! The open-cluster-management.io project is focused on enabling end-to-end visibility and control across your Kubernetes clusters.
+
+Please read the [MISSION.md](MISSION.md) statement for more information.
+
+The open-cluster-management architecture uses a hub - agent model. The hub centralizes control of all the managed clusters. An agent, which we call the klusterlet, resides on each managed cluster to manage registration to the hub and run instructions from the hub.
+
+
+![image](assets/ocm-arch.png)
+
+There are a number of key use cases that are enabled by this project, and are categorized to 3 sub projects.
+
+### Cluster Lifecycle: Cluster registration and management
+
+The API and controllers provide the function for cluster registration, manifests delivery, cluster scheduling and addon management. Simple core functions connect clusters, such as the klusterlet, to the hub. Other components run on this base. The following repositories describe the API and controllers:
+
+* https://github.com/open-cluster-management-io/api
+* https://github.com/open-cluster-management-io/registration
+* https://github.com/open-cluster-management-io/work
+* https://github.com/open-cluster-management-io/placement
+* https://github.com/open-cluster-management-io/registration-operator
+* https://github.com/open-cluster-management-io/addon-framework
+
+### Application Lifecycle: Delivery, upgrade, and configuration of applications on Kubernetes clusters
+
+* Centrally create, update, and delete Kubernetes clusters across multiple private and public clouds.
+* Automatically deploy applications to specific clusters by subscribing to different workload (resource) channels, such as GitHub, Helm repository, ObjectStore, and resource templates.
+
+The application model defines a Kubernetes-first way of describing the application. Your existing Kubernetes apps or `kustomized` apps can be adapted with the addition of a few new objects: `Channel`, and `Subscription`. Changes made to the app are then easily delivered to managed clusters based on the dynamic placement engine.
+
+The following repositories describe the underlying API and controllers for the app model:
+
+* https://github.com/open-cluster-management-io/multicloud-operators-subscription
+* https://github.com/open-cluster-management-io/multicloud-operators-channel
+
+### GRC: Governance, Risk and Compliance across Kubernetes clusters
+
+* Use prebuilt security and configuration controllers toto enforce policies on Kubernetes configuration across your clusters.
+
+Policy controllers allow the declarative expression of a desired condition that can be audited or enforced against a set of managed clusters. _Policies_ allow you to drive cross-cluster configuration or validate that a certain configuration explicitly does not exist.
+
+
+The following repositories describe the underlying API and controllers for the GRC model:
+
+* https://github.com/open-cluster-management-io/config-policy-controller
+* https://github.com/open-cluster-management-io/governance-policy-status-sync
+* https://github.com/open-cluster-management-io/governance-policy-spec-sync
+* https://github.com/open-cluster-management-io/governance-policy-template-sync
+* https://github.com/open-cluster-management-io/governance-policy-propagator
+
+### Get connected
+
+See the following options to connect with the community:
+
+ - [Website](https://open-cluster-management.io)
+ - [Slack](https://kubernetes.slack.com/archives/C01GE7YSUUF)
+ - [Mailing group](https://groups.google.com/g/open-cluster-management)
+ - [Community meetings](https://github.com/open-cluster-management-io/community/projects/1)
+ - [YouTube channel](https://www.youtube.com/channel/UC7xxOh2jBM5Jfwt3fsBzOZw)

SECURITY.md

@@ -0,0 +1,4 @@
+# Security Response
+
+If you've found a security issue that you'd like to disclose confidentially please contact Red Hat's Product Security team.
+Details at https://access.redhat.com/security/team/contact

assets/ocm-arch.drawio

@@ -0,0 +1 @@
+Refer to our [Open Cluster Management Community Code of Conduct](https://github.com/open-cluster-management/community/blob/main/CODE_OF_CONDUCT.md)