Skip to content

Commit 4fe97c6

Browse files
committed
add readme and logos
1 parent 03a5089 commit 4fe97c6

25 files changed

+1735
-10
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing to kcp
2+
3+
We're thrilled that you're interested in contributing to kcp! Please visit our
4+
[full contributing guide](https://docs.kcp.io/kcp/main/en/CONTRIBUTING/) on our documentation site.
5+
6+
Beside that, what coverns the project and all contributions to it must follow
7+
the [KCP Project Governance](./GOVERNANCE.md).
8+
9+
From the KCP Project Governance, the following manifesto should guide the technical
10+
decisions through-out all contributions:
11+
12+
> kcp maintainers strive to be good citizens in the Kubernetes project.
13+
> kcp maintainers see kcp always as part of the Kubernetes ecosystem and always strive to keep that ecosystem united. In particular, this means:
14+
> - kcp strives to not divert from Kubernetes, but strives to extend its use-cases to non-container control planes while keeping the ecosystems of libraries and tooling united.
15+
> - kcp – as a consumer of Kubernetes API Machinery – will strive to stay 100% compatible with the semantics of Kubernetes APIs, while removing container orchestration specific functionality.
16+
> - kcp strives to upstream changes to Kubernetes code as much as possible.

README.md

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,56 @@
1-
# Generic Control Plane
1+
# <img alt="Logo" width="80px" src="./contrib/logo/blue-green.png" style="vertical-align: middle;" /> Generic Control Plane
22

3-
Generic Control Plane is a Kubernetes API Server flavor that is designed to be used in a standalone mode. It is a lightweight control plane that can be used for development, testing, and learning purposes.
3+
## Overview
44

5-
It has all the core components of a Kubernetes control plane without container primitives.
5+
Generic Control plane (gcp) is a Kubernetes control plane focusing on:
66

7-
## Usage
7+
- A **control plane** for Kubernetes-native APIs that can be used **without Kubernetes**
8+
- Enabling API service providers to **offer APIs centrally**
89

9-
```
10-
# Build the control plane
11-
make
12-
# Get all the options
13-
./bin/gcp start options
14-
# Start the control plane
10+
gcp can be a building block for SaaS service providers who need a robust API base platform out-of-the-box.
11+
The goal is to be useful to cloud providers as well as enterprise IT departments offering APIs within their company.
12+
13+
## Documentation
14+
15+
To get started with gcp:
16+
17+
```bash
18+
# Clone the repository
19+
git clone https://github.com/kcp-dev/generic-controlplane.git
20+
21+
# Build the project
22+
cd generic-controlplane && make build
23+
24+
# Start standalone gcp
1525
./bin/gcp start
26+
27+
# Access the gcp API
28+
export KUBECONFIG=.gcp/admin.kubeconfig
29+
30+
# Check resources in the gcp API
31+
kubectl api-resources
1632
```
33+
34+
## Contributing
35+
36+
We ❤️ our contributors! If you're interested in helping us out, please check out [contributing to gcp](CONTRIBUTING.md).
37+
38+
This community has a [Code of Conduct](./code-of-conduct.md). Please make sure to follow it.
39+
40+
## Getting in touch
41+
42+
There are several ways to communicate with us:
43+
44+
- The [`#kcp-dev` channel](https://app.slack.com/client/T09NY5SBT/C021U8WSAFK) in the [Kubernetes Slack workspace](https://slack.k8s.io).
45+
- Our mailing lists:
46+
- [kcp-dev](https://groups.google.com/g/kcp-dev) for development discussions.
47+
- [kcp-users](https://groups.google.com/g/kcp-users) for discussions among users and potential users.
48+
- By joining the kcp-dev mailing list, you should receive an invite to our bi-weekly community meetings.
49+
- See recordings of past community meetings on [YouTube](https://www.youtube.com/channel/UCfP_yS5uYix0ppSbm2ltS5Q).
50+
- The next community meeting dates are available via our [CNCF community group](https://community.cncf.io/kcp/).
51+
- Check the [community meeting notes document](https://docs.google.com/document/d/1PrEhbmq1WfxFv1fTikDBZzXEIJkUWVHdqDFxaY1Ply4) for future and past meeting agendas.
52+
- Browse the [shared Google Drive](https://drive.google.com/drive/folders/1FN7AZ_Q1CQor6eK0gpuKwdGFNwYI517M?usp=sharing) to share design docs, notes, etc.
53+
- Members of the kcp-dev mailing list can view this drive.
54+
55+
## License
56+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkcp-dev%2Fkcp.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkcp-dev%2Fkcp?ref=badge_large)

code-of-conduct.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
This project is following the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
2+
3+
# Community Code of Conduct
4+
5+
As contributors, maintainers, and participants in the CNCF community, and in the interest of fostering
6+
an open and welcoming community, we pledge to respect all people who participate or contribute
7+
through reporting issues, posting feature requests, updating documentation,
8+
submitting pull requests or patches, attending conferences or events, or engaging in other community or project activities.
9+
10+
We are committed to making participation in the CNCF community a harassment-free experience for everyone, regardless of age, body size, caste, disability, ethnicity, level of experience, family status, gender, gender identity and expression, marital status, military or veteran status, nationality, personal appearance, race, religion, sexual orientation, socieconomic status, tribe, or any other dimension of diversity.
11+
12+
## Scope
13+
14+
This code of conduct applies:
15+
* within project and community spaces,
16+
* in other spaces when an individual CNCF community participant's words or actions are directed at or are about a CNCF project, the CNCF community, or another CNCF community participant.
17+
18+
### CNCF Events
19+
20+
CNCF events that are produced by the Linux Foundation with professional events staff are governed by the Linux Foundation [Events Code of Conduct](https://events.linuxfoundation.org/code-of-conduct/) available on the event page. This is designed to be used in conjunction with the CNCF Code of Conduct.
21+
22+
## Our Standards
23+
24+
The CNCF Community is open, inclusive and respectful. Every member of our community has the right to have their identity respected.
25+
26+
Examples of behavior that contributes to a positive environment include but are not limited to:
27+
28+
* Demonstrating empathy and kindness toward other people
29+
* Being respectful of differing opinions, viewpoints, and experiences
30+
* Giving and gracefully accepting constructive feedback
31+
* Accepting responsibility and apologizing to those affected by our mistakes,
32+
and learning from the experience
33+
* Focusing on what is best not just for us as individuals, but for the
34+
overall community
35+
* Using welcoming and inclusive language
36+
37+
38+
Examples of unacceptable behavior include but are not limited to:
39+
40+
* The use of sexualized language or imagery
41+
* Trolling, insulting or derogatory comments, and personal or political attacks
42+
* Public or private harassment in any form
43+
* Publishing others' private information, such as a physical or email
44+
address, without their explicit permission
45+
* Violence, threatening violence, or encouraging others to engage in violent behavior
46+
* Stalking or following someone without their consent
47+
* Unwelcome physical contact
48+
* Unwelcome sexual or romantic attention or advances
49+
* Other conduct which could reasonably be considered inappropriate in a
50+
professional setting
51+
52+
The following behaviors are also prohibited:
53+
* Providing knowingly false or misleading information in connection with a Code of Conduct investigation or otherwise intentionally tampering with an investigation.
54+
* Retaliating against a person because they reported an incident or provided information about an incident as a witness.
55+
56+
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.
57+
By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect
58+
of managing a CNCF project.
59+
Project maintainers who do not follow or enforce the Code of Conduct may be temporarily or permanently removed from the project team.
60+
61+
## Reporting
62+
63+
For incidents occurring in the Kubernetes community, contact the [Kubernetes Code of Conduct Committee](https://git.k8s.io/community/committee-code-of-conduct) via <conduct@kubernetes.io>. You can expect a response within three business days.
64+
65+
For other projects, or for incidents that are project-agnostic or impact multiple CNCF projects, please contact the [CNCF Code of Conduct Committee](https://www.cncf.io/conduct/committee/) via conduct@cncf.io. Alternatively, you can contact any of the individual members of the [CNCF Code of Conduct Committee](https://www.cncf.io/conduct/committee/) to submit your report. For more detailed instructions on how to submit a report, including how to submit a report anonymously, please see our [Incident Resolution Procedures](https://www.cncf.io/conduct/procedures/). You can expect a response within three business days.
66+
67+
For incidents ocurring at CNCF event that is produced by the Linux Foundation, please contact eventconduct@cncf.io.
68+
69+
## Enforcement
70+
71+
Upon review and investigation of a reported incident, the CoC response team that has jurisdiction will determine what action is appropriate based on this Code of Conduct and its related documentation.
72+
73+
For information about which Code of Conduct incidents are handled by project leadership, which incidents are handled by the CNCF Code of Conduct Committee, and which incidents are handled by the Linux Foundation (including its events team), see our [Jurisdiction Policy](https://www.cncf.io/conduct/jurisdiction/).
74+
75+
## Amendments
76+
77+
Consistent with the CNCF Charter, any substantive changes to this Code of Conduct must be approved by the Technical Oversight Committee.
78+
79+
## Acknowledgements
80+
81+
This Code of Conduct is adapted from the Contributor Covenant
82+
(http://contributor-covenant.org), version 2.0 available at
83+
http://contributor-covenant.org/version/2/0/code_of_conduct/

contrib/logo/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# KCP Logo
2+
3+
The logo of KCP is a hypercube, viewed symmetrically in a way that it forms two
4+
nested, equally oriented, centered regular hexagons with the connecting hypercube
5+
lines clearly visible, either through color contrast or a line.
6+
7+
There are these variants, to be used depending on context:
8+
9+
1. normal <img alt="Logo" width="198px" align="right" src="./blue-green.png"/><br clear="right"/>
10+
1. high contrast <img alt="Logo" width="210px" align="right" src="./blue-green-high-contrast.png"/><br clear="right"/>
11+
2. glow <img alt="Logo" width="205px" align="right" src="./blue-green-glow.png"/><br clear="right"/>
12+
13+
Moreover, there is a red-blue variant:
14+
1. normal <img alt="Logo" width="198px" align="right" src="./red-blue.png"/><br clear="right"/>
15+
2. high contrast <img alt="Logo" width="210px" align="right" src="./red-blue-high-contrast.png"/><br clear="right"/>
16+
3. glow <img alt="Logo" width="205px" align="right" src="./red-blue-glow.png"/><br clear="right"/>
17+
18+
Depending on context one or the other variant makes more sense visually.
19+
20+
The KCP font is [Ubuntu](https://fonts.google.com/specimen/Ubuntu).
21+
22+
The application used for the original files is [Amadine](https://amadine.com/).
23+
24+
## Copyright 2022 The KCP Authors.
25+
26+
Licensed under the Apache License, Version 2.0 (the "License");
27+
you may not use this file except in compliance with the License.
28+
You may obtain a copy of the License at
29+
30+
http://www.apache.org/licenses/LICENSE-2.0
31+
32+
Unless required by applicable law or agreed to in writing, software
33+
distributed under the License is distributed on an "AS IS" BASIS,
34+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
35+
See the License for the specific language governing permissions and
36+
limitations under the License.

contrib/logo/blue-green-glow.png

237 KB
Loading
192 KB
Loading
Lines changed: 105 additions & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)