Skip to content

Commit b04552e

Browse files
authored
Merge pull request #573 from cnvergence/update-kube-bind
Update main Markdown files to kbind and initialize moving the website
2 parents d8d99c6 + 85bb676 commit b04552e

15 files changed

Lines changed: 113 additions & 112 deletions

File tree

.github/ISSUE_TEMPLATE/adopters.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Register as adopter
2-
description: If your organization is using kube-bind, we would be delighted to add you to our list of adopters. Please report how you use kube-bind and we will take care of adding it to our adopters list.
2+
description: If your organization is using kbind, we would be delighted to add you to our list of adopters. Please report how you use kbind and we will take care of adding it to our adopters list.
33
title: "adopter: COMPANY_NAME"
44
labels:
55
- kind/documentation
@@ -25,15 +25,15 @@ body:
2525
id: description
2626
attributes:
2727
label: Description
28-
description: What are you using kube-bind for at your organization? Are you using it for a specific product or project?
28+
description: What are you using kbind for at your organization? Are you using it for a specific product or project?
2929
validations:
3030
required: true
3131

3232
- type: dropdown
3333
id: maturity
3434
attributes:
3535
label: Maturity Stage
36-
description: What stage are you at in your adoption of kube-bind?
36+
description: What stage are you at in your adoption of kbind?
3737
multiple: false
3838
options:
3939
- Production

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ body:
6969
- type: input
7070
id: kube_bind_version
7171
attributes:
72-
label: kube-bind version
72+
label: kbind version
7373
description: Version of kubectl-bind plugin or konnector/backend
7474
placeholder: e.g., v0.0.7
7575
validations:

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ coverage.*
88
*.kubeconfig
99
.kcp
1010
.kube-bind
11+
.kbind
1112
/dist
1213
/hack/tools
1314
/build

ADOPTERS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# kube-bind Adopters
1+
# kbind Adopters
22

3-
This file lists organizations and projects that have adopted kube-bind in
3+
This file lists organizations and projects that have adopted kbind in
44
production or as a core part of their platform.
55

6-
If you are using kube-bind and would like to be listed here, please open a
6+
If you are using kbind and would like to be listed here, please open a
77
pull request.
88

99
| Organization | Type | Use Case | Link |
1010
|---|---|---|---|
11-
| Platform Mesh | OSS Project | Uses kube-bind as the cross-cluster service binding layer, enabling users to add kube-bind as a provider and automatically create bindings between workload clusters and managed services within their platform. | <https://platform-mesh.io> |
11+
| Platform Mesh | OSS Project | Uses kbind as the cross-cluster service binding layer, enabling users to add kbind as a provider and automatically create bindings between workload clusters and managed services within their platform. | <https://platform-mesh.io> |

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ Major improvements to `PermissionClaims` in APIServiceExportSpec:
2222
### Provider-side Namespace Management
2323
Enhanced namespace management on the provider side:
2424
- **APIServiceNamespace Controller**: Automatically creates Roles and RoleBindings
25-
- **Namespace Isolation**: Each consumer gets isolated provider-side namespaces
25+
- **Namespace Isolation**: Each consumer gets isolated provider-side namespaces
2626
- **RBAC Automation**: Proper permissions created based on scope (namespaced vs cluster-scoped)
2727
- **Namespace Pre-provisioning**: Providers can pre-create namespaces for better UX
2828

29-
**Important**: When `ClusterScope` mode is used, cluster-wide permissions are created instead of namespaced ones.
29+
**Important**: When `ClusterScope` mode is used, cluster-wide permissions are created instead of namespaced ones.
3030

3131
## API Changes in v0.5.0 release
3232

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Contributing to kube-bind
1+
# Contributing to kbind
22

3-
kube-bind is [Apache 2.0 licensed](LICENSE) and we accept contributions via
3+
kbind is [Apache 2.0 licensed](LICENSE) and we accept contributions via
44
GitHub pull requests.
55

6-
Please read the following guide if you're interested in contributing to kube-bind.
6+
Please read the following guide if you're interested in contributing to kbind.
77

88
## Certificate of Origin
99

@@ -31,14 +31,14 @@ bin/kubectl-bind
3131

3232
Starting to participate in a new project can sometimes be overwhelming, and you may not know where to begin. Fortunately, we are here to help! We track all of our tasks here in GitHub, and we label our issues to categorize them. Here are a couple of handy links to check out:
3333

34-
* [Good first issue](https://github.com/kube-bind/kube-bind/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) issues
35-
* [Help wanted](https://github.com/kube-bind/kube-bind/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues
34+
* [Good first issue](https://github.com/kbind-dev/kbind/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) issues
35+
* [Help wanted](https://github.com/kbind-dev/kbind/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues
3636

3737
You're certainly not limited to only these kinds of issues, though! If you're comfortable, please feel free to try working on anything that is open.
3838

3939
We do use the assignee feature in GitHub for issues. If you find an unassigned issue, comment asking if you can be assigned, and ideally wait for a maintainer to respond. If you find an assigned issue and you want to work on it or help out, please reach out to the assignee first.
4040

41-
Sometimes you might get an amazing idea and start working on a huge amount of code. We love and encourage excitement like this, but we do ask that before you embarking on a giant pull request, please reach out to the community first for an initial discussion. You could [file an issue](https://github.com/kube-bind/kube-bind/issues/new/choose).
41+
Sometimes you might get an amazing idea and start working on a huge amount of code. We love and encourage excitement like this, but we do ask that before you embarking on a giant pull request, please reach out to the community first for an initial discussion. You could [file an issue](https://github.com/kbind-dev/kbind/issues/new/choose).
4242

4343
Finally, we welcome and value all types of contributions, beyond "just code"! Other types include triaging bugs, tracking down and fixing flaky tests, improving our documentation, helping answer community questions, proposing and reviewing designs, etc.
4444

@@ -76,7 +76,7 @@ Finally, we welcome and value all types of contributions, beyond "just code"! Ot
7676

7777
### Using Kubebuilder CRD Validation Annotations
7878

79-
All of the API resources for `kube-bind` are `CustomResourceDefinitions`, and we generate YAML spec for them from our Go types using [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder).
79+
All of the API resources for `kbind` are `CustomResourceDefinitions`, and we generate YAML spec for them from our Go types using [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder).
8080

8181
When adding a field that requires validation, custom annotations are used to translate this logic into the generated OpenAPI spec. [This doc](https://book.kubebuilder.io/reference/markers/crd-validation.html) gives an overview of possible validations. These annotations map directly to concepts in the [OpenAPI Spec](https://swagger.io/specification/#data-type-format) so, for instance, the `format` of strings is defined there, not in kubebuilder. Furthermore, Kubernetes has forked the OpenAPI project [here](https://github.com/kubernetes/kube-openapi/tree/master/pkg/validation) and extends more formats in the extensions-apiserver [here](https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1/types_jsonschema.go#L27).
8282

GOVERNANCE.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# kube-bind Project Governance
1+
# kbind Project Governance
22

3-
The kube-bind project is dedicated to build a vendor-neutral mechanism to bind
3+
The kbind project is dedicated to build a vendor-neutral mechanism to bind
44
services of different kinds into Kubernetes clusters using Kubernetes-native APIs.
55
This governance explains how the project is run.
66

@@ -13,31 +13,31 @@ This governance explains how the project is run.
1313

1414
## Values
1515

16-
The kube-bind and its leadership embrace the following values:
16+
The kbind and its leadership embrace the following values:
1717

18-
* *Openness*: Communication and decision-making happens in the open and is
19-
discoverable for future reference. As much as possible, all discussions and
18+
* *Openness*: Communication and decision-making happens in the open and is
19+
discoverable for future reference. As much as possible, all discussions and
2020
work take place in public forums and open repositories.
21-
* *Fairness*: All stakeholders have the opportunity to provide feedback and
21+
* *Fairness*: All stakeholders have the opportunity to provide feedback and
2222
submit contributions, which will be considered on their merits.
23-
* *Community over Product or Company*: Sustaining and growing our community
24-
takes priority over shipping code or sponsors' organizational goals. Each
23+
* *Community over Product or Company*: Sustaining and growing our community
24+
takes priority over shipping code or sponsors' organizational goals. Each
2525
contributor participates in the project as an individual.
26-
* *Inclusivity*: We innovate through different perspectives and skill sets,
26+
* *Inclusivity*: We innovate through different perspectives and skill sets,
2727
which can only be accomplished in a welcoming and respectful environment.
28-
* *Participation*: Responsibilities within the project are earned through
29-
participation, and there is a clear path up the contributor ladder into
28+
* *Participation*: Responsibilities within the project are earned through
29+
participation, and there is a clear path up the contributor ladder into
3030
leadership positions.
3131

3232
## Maintainers
3333

34-
kube-bind Maintainers have write access to the [project GitHub repository](https://github.com/kube-bind/kube-bind).
34+
kbind Maintainers have write access to the [project GitHub repository](https://github.com/kbind-dev/kbind).
3535
They can merge their own patches or patches from others. The current maintainers
36-
can be found as top-level approvers in [OWNERS](./OWNERS). Maintainers collectively
36+
can be found as top-level approvers in [OWNERS](./OWNERS). Maintainers collectively
3737
manage the project's resources and contributors.
3838

3939
This privilege is granted with some expectation of responsibility: maintainers
40-
are people who care about the kube-bind project and want to help it grow and
40+
are people who care about the kbind project and want to help it grow and
4141
improve. A maintainer is not just someone who can make changes, but someone who
4242
has demonstrated their ability to collaborate with the team, get the most
4343
knowledgeable people to review code and docs, contribute high-quality code, and
@@ -46,7 +46,7 @@ follow through to fix issues (in code or tests).
4646
A maintainer is a contributor to the project's success and a citizen helping
4747
the project succeed.
4848

49-
The collective team of all Maintainers is known as the Maintainer Council, which
49+
The collective team of all Maintainers is known as the Maintainer Council, which
5050
is the governing body for the project.
5151

5252
## Becoming a Maintainer
@@ -69,34 +69,34 @@ To become a Maintainer you need to demonstrate the following:
6969
<!-- add any additional Maintainer requirements here -->
7070

7171
A new Maintainer must be proposed by an existing maintainer by sending a message to the
72-
[developer mailing list](https://groups.google.com/g/kube-bind-dev). A simple majority
72+
[developer mailing list](https://groups.google.com/g/kube-bind-dev). A simple majority
7373
vote of existing Maintainers approves the application.
7474

7575
Maintainers who are selected will be granted the necessary GitHub rights,
7676
and invited to the [private maintainer mailing list](https://groups.google.com/g/kube-bind-dev-private).
7777

7878
### Bootstrapping Maintainers
7979

80-
To bootstrap the process, 3 maintainers are defined (in the initial PR adding
81-
this to the repository) that do not necessarily follow the above rules. When a
82-
new maintainer is added following the above rules, the existing maintainers
83-
define one not following the rules to step down, until all of them follow the
80+
To bootstrap the process, 3 maintainers are defined (in the initial PR adding
81+
this to the repository) that do not necessarily follow the above rules. When a
82+
new maintainer is added following the above rules, the existing maintainers
83+
define one not following the rules to step down, until all of them follow the
8484
rules.
8585

8686
### Removing a Maintainer
8787

88-
Maintainers may resign at any time if they feel that they will not be able to
88+
Maintainers may resign at any time if they feel that they will not be able to
8989
continue fulfilling their project duties.
9090

91-
Maintainers may also be removed after being inactive, failure to fulfill their
92-
Maintainer responsibilities, violating the Code of Conduct, or other reasons.
93-
Inactivity is defined as a period of very low or no activity in the project for
91+
Maintainers may also be removed after being inactive, failure to fulfill their
92+
Maintainer responsibilities, violating the Code of Conduct, or other reasons.
93+
Inactivity is defined as a period of very low or no activity in the project for
9494
a year or more, with no definite schedule to return to full Maintainer activity.
9595

9696
A Maintainer may be removed at any time by a 2/3 vote of the remaining maintainers.
9797

98-
Depending on the reason for removal, a Maintainer may be converted to Emeritus
99-
status. Emeritus Maintainers will still be consulted on some project matters,
98+
Depending on the reason for removal, a Maintainer may be converted to Emeritus
99+
status. Emeritus Maintainers will still be consulted on some project matters,
100100
and can be rapidly returned to Maintainer status if their availability changes.
101101

102102
## Code of Conduct
@@ -112,21 +112,21 @@ on the [private Maintainer mailing list](https://groups.google.com/g/kube-bind-d
112112
## Security Response Team
113113

114114
The Maintainers will appoint a Security Response Team to handle security reports.
115-
This committee may simply consist of the Maintainer Council themselves. If this
116-
responsibility is delegated, the Maintainers will appoint a team of at least two
117-
contributors to handle it. The Maintainers will review who is assigned to this
115+
This committee may simply consist of the Maintainer Council themselves. If this
116+
responsibility is delegated, the Maintainers will appoint a team of at least two
117+
contributors to handle it. The Maintainers will review who is assigned to this
118118
at least once a year.
119119

120-
The Security Response Team is responsible for handling all reports of security
120+
The Security Response Team is responsible for handling all reports of security
121121
holes and breaches according to the [security policy](./SECURITY.md).
122122

123123
## Voting
124124

125-
While most business in kube-bind is conducted by "lazy consensus", periodically
125+
While most business in kbind is conducted by "lazy consensus", periodically
126126
the Maintainers may need to vote on specific actions or changes.
127127
A vote can be taken on [the developer mailing list](https://groups.google.com/g/kube-bind-dev) or
128128
[the private Maintainer mailing list](https://groups.google.com/g/kube-bind-dev-private)
129-
for security or conduct matters. Votes may also be taken at the community call
129+
for security or conduct matters. Votes may also be taken at the community call
130130
meeting. Any Maintainer may demand a vote be taken.
131131

132132
Most votes require a simple majority of all Maintainers to succeed. Maintainers
@@ -135,5 +135,5 @@ Governance require a 2/3 vote of all Maintainers.
135135

136136
## Modifying this Charter
137137

138-
Changes to this Governance and its supporting documents may be approved by a
139-
2/3 vote of the Maintainers.
138+
Changes to this Governance and its supporting documents may be approved by a
139+
2/3 vote of the Maintainers.

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
<img alt="Logo" width="196px" style="margin-right: 30px;" align="left" src="./docs/images/logo.png"></img>
22

3-
[![Go Report Card](https://goreportcard.com/badge/github.com/kube-bind/kube-bind)](https://goreportcard.com/report/github.com/kube-bind/kube-bind)
4-
[![GitHub](https://img.shields.io/github/license/kube-bind/kube-bind)](https://github.com/kube-bind/kube-bind/blob/main/LICENSE)
5-
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kube-bind/kube-bind?sort=semver)](https://github.com/kube-bind/kube-bind/releases/latest)
3+
[![Go Report Card](https://goreportcard.com/badge/github.com/kbind-dev/kbind)](https://goreportcard.com/report/github.com/kbind-dev/kbind)
4+
[![GitHub](https://img.shields.io/github/license/kbind-dev/kbind)](https://github.com/kbind-dev/kbind/blob/main/LICENSE)
5+
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kbind-dev/kbind?sort=semver)](https://github.com/kbind-dev/kbind/releases/latest)
66

7-
# kube-bind
7+
# kbind
88

99
You are invited to [contribute](#contributing)!
1010

1111
## What is it?
1212

13-
kube-bind provides better support for service providers and consumers that reside in distinct Kubernetes clusters.
13+
kbind (formerly known as kube-bind) provides better support for service providers and consumers that reside in distinct Kubernetes clusters.
1414

1515
- A service provider defines its API in terms of CRDs and associated permission claims/limitations, and exports it for use from other clusters.
1616
- Service consumers identify the services they want to consume.
@@ -36,17 +36,17 @@ $ kubectl get mangodbs
3636

3737
## For more information
3838

39-
For more information go to https://kube-bind.io or watch the [ContainerDays talk](https://www.youtube.com/watch?v=dg0g15Qv5Fo&t=1s)
39+
For more information go to https://kbind.dev or watch the [ContainerDays talk](https://www.youtube.com/watch?v=dg0g15Qv5Fo&t=1s)
4040
or the [KubeCon talk](https://www.youtube.com/watch?v=Uv0ivz5xej4).
4141

42-
kube-bind is following this manifesto from the linked talk:
42+
kbind is following this manifesto from the linked talk:
4343

44-
![kube-bind manifesto](docs/images/manifesto.png)
44+
![kbind manifesto](docs/images/manifesto.png)
4545

4646
## Contributing
4747

4848
We ❤️ our contributors! If you're interested in helping us out, please check out
49-
[Contributing to kube-bind](./CONTRIBUTING.md) and [kube-bind Project Governance](./GOVERNANCE.md).
49+
[Contributing to kbind](./CONTRIBUTING.md) and [kbind Project Governance](./GOVERNANCE.md).
5050

5151
## Getting in touch
5252

@@ -62,7 +62,7 @@ There are several ways to communicate with us:
6262
<!-- TODO(community-call-advertise): once a YouTube channel is set up, add: -->
6363
<!-- - See recordings of past community meetings on [YouTube](TODO-youtube-url). -->
6464

65-
See the [community page](https://docs.kube-bind.io/main/community) for more details.
65+
See the [community page](https://docs.kbind.dev/main/community) for more details.
6666

6767
## Technical Overview
6868

@@ -72,7 +72,7 @@ All the actions shown between the clusters are done by the konnector, except: th
7272

7373
## Usage
7474

75-
To get familiar with setting up the environment, please check out docs at [kube-bind.io](https://docs.kube-bind.io/main/setup).
75+
To get familiar with setting up the environment, please check out docs at [kbind.dev](https://docs.kbind.dev/main/setup).
7676

7777
### Limitations
7878

0 commit comments

Comments
 (0)