From 85bb67675840c952b73f6f2067cde0106b7d06b5 Mon Sep 17 00:00:00 2001 From: Karol Szwaj Date: Tue, 30 Jun 2026 15:05:14 +0200 Subject: [PATCH] Update main Markdown files to kbind and initialize moving the website references Signed-off-by: Karol Szwaj --- .github/ISSUE_TEMPLATE/adopters.yaml | 6 +-- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .gitignore | 1 + ADOPTERS.md | 8 +-- CHANGELOG.md | 4 +- CONTRIBUTING.md | 14 +++--- GOVERNANCE.md | 68 +++++++++++++------------- README.md | 22 ++++----- ROADMAP.md | 42 ++++++++-------- SECURITY.md | 14 +++--- docs/README.md | 2 +- docs/content/community/index.md | 6 +-- docs/content/contributing/index.md | 14 +++--- docs/content/index.md | 10 ++-- docs/mkdocs.yml | 12 ++--- 15 files changed, 113 insertions(+), 112 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/adopters.yaml b/.github/ISSUE_TEMPLATE/adopters.yaml index 2bbfbb406..54d6ec9aa 100644 --- a/.github/ISSUE_TEMPLATE/adopters.yaml +++ b/.github/ISSUE_TEMPLATE/adopters.yaml @@ -1,5 +1,5 @@ name: Register as adopter -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. +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. title: "adopter: COMPANY_NAME" labels: - kind/documentation @@ -25,7 +25,7 @@ body: id: description attributes: label: Description - description: What are you using kube-bind for at your organization? Are you using it for a specific product or project? + description: What are you using kbind for at your organization? Are you using it for a specific product or project? validations: required: true @@ -33,7 +33,7 @@ body: id: maturity attributes: label: Maturity Stage - description: What stage are you at in your adoption of kube-bind? + description: What stage are you at in your adoption of kbind? multiple: false options: - Production diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index a3a833a9d..7ef2c234f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -69,7 +69,7 @@ body: - type: input id: kube_bind_version attributes: - label: kube-bind version + label: kbind version description: Version of kubectl-bind plugin or konnector/backend placeholder: e.g., v0.0.7 validations: diff --git a/.gitignore b/.gitignore index 83bad99d9..fd664da17 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,7 @@ coverage.* *.kubeconfig .kcp .kube-bind +.kbind /dist /hack/tools /build diff --git a/ADOPTERS.md b/ADOPTERS.md index 00feec856..998007860 100644 --- a/ADOPTERS.md +++ b/ADOPTERS.md @@ -1,11 +1,11 @@ -# kube-bind Adopters +# kbind Adopters -This file lists organizations and projects that have adopted kube-bind in +This file lists organizations and projects that have adopted kbind in production or as a core part of their platform. -If you are using kube-bind and would like to be listed here, please open a +If you are using kbind and would like to be listed here, please open a pull request. | Organization | Type | Use Case | Link | |---|---|---|---| -| 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. | | +| 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. | | diff --git a/CHANGELOG.md b/CHANGELOG.md index cebd980d8..c557c731e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,11 +22,11 @@ Major improvements to `PermissionClaims` in APIServiceExportSpec: ### Provider-side Namespace Management Enhanced namespace management on the provider side: - **APIServiceNamespace Controller**: Automatically creates Roles and RoleBindings -- **Namespace Isolation**: Each consumer gets isolated provider-side namespaces +- **Namespace Isolation**: Each consumer gets isolated provider-side namespaces - **RBAC Automation**: Proper permissions created based on scope (namespaced vs cluster-scoped) - **Namespace Pre-provisioning**: Providers can pre-create namespaces for better UX -**Important**: When `ClusterScope` mode is used, cluster-wide permissions are created instead of namespaced ones. +**Important**: When `ClusterScope` mode is used, cluster-wide permissions are created instead of namespaced ones. ## API Changes in v0.5.0 release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48ee2dad1..e13aa5069 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ -# Contributing to kube-bind +# Contributing to kbind -kube-bind is [Apache 2.0 licensed](LICENSE) and we accept contributions via +kbind is [Apache 2.0 licensed](LICENSE) and we accept contributions via GitHub pull requests. -Please read the following guide if you're interested in contributing to kube-bind. +Please read the following guide if you're interested in contributing to kbind. ## Certificate of Origin @@ -31,14 +31,14 @@ bin/kubectl-bind 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: -* [Good first issue](https://github.com/kube-bind/kube-bind/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) issues -* [Help wanted](https://github.com/kube-bind/kube-bind/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues +* [Good first issue](https://github.com/kbind-dev/kbind/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) issues +* [Help wanted](https://github.com/kbind-dev/kbind/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues 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. 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. -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). +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). 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. @@ -76,7 +76,7 @@ Finally, we welcome and value all types of contributions, beyond "just code"! Ot ### Using Kubebuilder CRD Validation Annotations -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). +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). 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). diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 5f95811e3..9d7e4ae52 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -1,6 +1,6 @@ -# kube-bind Project Governance +# kbind Project Governance -The kube-bind project is dedicated to build a vendor-neutral mechanism to bind +The kbind project is dedicated to build a vendor-neutral mechanism to bind services of different kinds into Kubernetes clusters using Kubernetes-native APIs. This governance explains how the project is run. @@ -13,31 +13,31 @@ This governance explains how the project is run. ## Values -The kube-bind and its leadership embrace the following values: +The kbind and its leadership embrace the following values: - * *Openness*: Communication and decision-making happens in the open and is - discoverable for future reference. As much as possible, all discussions and + * *Openness*: Communication and decision-making happens in the open and is + discoverable for future reference. As much as possible, all discussions and work take place in public forums and open repositories. - * *Fairness*: All stakeholders have the opportunity to provide feedback and + * *Fairness*: All stakeholders have the opportunity to provide feedback and submit contributions, which will be considered on their merits. - * *Community over Product or Company*: Sustaining and growing our community - takes priority over shipping code or sponsors' organizational goals. Each + * *Community over Product or Company*: Sustaining and growing our community + takes priority over shipping code or sponsors' organizational goals. Each contributor participates in the project as an individual. - * *Inclusivity*: We innovate through different perspectives and skill sets, + * *Inclusivity*: We innovate through different perspectives and skill sets, which can only be accomplished in a welcoming and respectful environment. - * *Participation*: Responsibilities within the project are earned through - participation, and there is a clear path up the contributor ladder into + * *Participation*: Responsibilities within the project are earned through + participation, and there is a clear path up the contributor ladder into leadership positions. ## Maintainers -kube-bind Maintainers have write access to the [project GitHub repository](https://github.com/kube-bind/kube-bind). +kbind Maintainers have write access to the [project GitHub repository](https://github.com/kbind-dev/kbind). They can merge their own patches or patches from others. The current maintainers -can be found as top-level approvers in [OWNERS](./OWNERS). Maintainers collectively +can be found as top-level approvers in [OWNERS](./OWNERS). Maintainers collectively manage the project's resources and contributors. This privilege is granted with some expectation of responsibility: maintainers -are people who care about the kube-bind project and want to help it grow and +are people who care about the kbind project and want to help it grow and improve. A maintainer is not just someone who can make changes, but someone who has demonstrated their ability to collaborate with the team, get the most 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). A maintainer is a contributor to the project's success and a citizen helping the project succeed. -The collective team of all Maintainers is known as the Maintainer Council, which +The collective team of all Maintainers is known as the Maintainer Council, which is the governing body for the project. ## Becoming a Maintainer @@ -69,7 +69,7 @@ To become a Maintainer you need to demonstrate the following: A new Maintainer must be proposed by an existing maintainer by sending a message to the -[developer mailing list](https://groups.google.com/g/kube-bind-dev). A simple majority +[developer mailing list](https://groups.google.com/g/kube-bind-dev). A simple majority vote of existing Maintainers approves the application. Maintainers who are selected will be granted the necessary GitHub rights, @@ -77,26 +77,26 @@ and invited to the [private maintainer mailing list](https://groups.google.com/g ### Bootstrapping Maintainers -To bootstrap the process, 3 maintainers are defined (in the initial PR adding -this to the repository) that do not necessarily follow the above rules. When a -new maintainer is added following the above rules, the existing maintainers -define one not following the rules to step down, until all of them follow the +To bootstrap the process, 3 maintainers are defined (in the initial PR adding +this to the repository) that do not necessarily follow the above rules. When a +new maintainer is added following the above rules, the existing maintainers +define one not following the rules to step down, until all of them follow the rules. ### Removing a Maintainer -Maintainers may resign at any time if they feel that they will not be able to +Maintainers may resign at any time if they feel that they will not be able to continue fulfilling their project duties. -Maintainers may also be removed after being inactive, failure to fulfill their -Maintainer responsibilities, violating the Code of Conduct, or other reasons. -Inactivity is defined as a period of very low or no activity in the project for +Maintainers may also be removed after being inactive, failure to fulfill their +Maintainer responsibilities, violating the Code of Conduct, or other reasons. +Inactivity is defined as a period of very low or no activity in the project for a year or more, with no definite schedule to return to full Maintainer activity. A Maintainer may be removed at any time by a 2/3 vote of the remaining maintainers. -Depending on the reason for removal, a Maintainer may be converted to Emeritus -status. Emeritus Maintainers will still be consulted on some project matters, +Depending on the reason for removal, a Maintainer may be converted to Emeritus +status. Emeritus Maintainers will still be consulted on some project matters, and can be rapidly returned to Maintainer status if their availability changes. ## Code of Conduct @@ -112,21 +112,21 @@ on the [private Maintainer mailing list](https://groups.google.com/g/kube-bind-d ## Security Response Team The Maintainers will appoint a Security Response Team to handle security reports. -This committee may simply consist of the Maintainer Council themselves. If this -responsibility is delegated, the Maintainers will appoint a team of at least two -contributors to handle it. The Maintainers will review who is assigned to this +This committee may simply consist of the Maintainer Council themselves. If this +responsibility is delegated, the Maintainers will appoint a team of at least two +contributors to handle it. The Maintainers will review who is assigned to this at least once a year. -The Security Response Team is responsible for handling all reports of security +The Security Response Team is responsible for handling all reports of security holes and breaches according to the [security policy](./SECURITY.md). ## Voting -While most business in kube-bind is conducted by "lazy consensus", periodically +While most business in kbind is conducted by "lazy consensus", periodically the Maintainers may need to vote on specific actions or changes. A vote can be taken on [the developer mailing list](https://groups.google.com/g/kube-bind-dev) or [the private Maintainer mailing list](https://groups.google.com/g/kube-bind-dev-private) -for security or conduct matters. Votes may also be taken at the community call +for security or conduct matters. Votes may also be taken at the community call meeting. Any Maintainer may demand a vote be taken. 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. ## Modifying this Charter -Changes to this Governance and its supporting documents may be approved by a -2/3 vote of the Maintainers. \ No newline at end of file +Changes to this Governance and its supporting documents may be approved by a +2/3 vote of the Maintainers. diff --git a/README.md b/README.md index 3cff0189e..b65ca14c6 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ Logo -[![Go Report Card](https://goreportcard.com/badge/github.com/kube-bind/kube-bind)](https://goreportcard.com/report/github.com/kube-bind/kube-bind) -[![GitHub](https://img.shields.io/github/license/kube-bind/kube-bind)](https://github.com/kube-bind/kube-bind/blob/main/LICENSE) -[![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) +[![Go Report Card](https://goreportcard.com/badge/github.com/kbind-dev/kbind)](https://goreportcard.com/report/github.com/kbind-dev/kbind) +[![GitHub](https://img.shields.io/github/license/kbind-dev/kbind)](https://github.com/kbind-dev/kbind/blob/main/LICENSE) +[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kbind-dev/kbind?sort=semver)](https://github.com/kbind-dev/kbind/releases/latest) -# kube-bind +# kbind You are invited to [contribute](#contributing)! ## What is it? -kube-bind provides better support for service providers and consumers that reside in distinct Kubernetes clusters. +kbind (formerly known as kube-bind) provides better support for service providers and consumers that reside in distinct Kubernetes clusters. - A service provider defines its API in terms of CRDs and associated permission claims/limitations, and exports it for use from other clusters. - Service consumers identify the services they want to consume. @@ -36,17 +36,17 @@ $ kubectl get mangodbs ## For more information -For more information go to https://kube-bind.io or watch the [ContainerDays talk](https://www.youtube.com/watch?v=dg0g15Qv5Fo&t=1s) +For more information go to https://kbind.dev or watch the [ContainerDays talk](https://www.youtube.com/watch?v=dg0g15Qv5Fo&t=1s) or the [KubeCon talk](https://www.youtube.com/watch?v=Uv0ivz5xej4). -kube-bind is following this manifesto from the linked talk: +kbind is following this manifesto from the linked talk: -![kube-bind manifesto](docs/images/manifesto.png) +![kbind manifesto](docs/images/manifesto.png) ## Contributing We ❤️ our contributors! If you're interested in helping us out, please check out -[Contributing to kube-bind](./CONTRIBUTING.md) and [kube-bind Project Governance](./GOVERNANCE.md). +[Contributing to kbind](./CONTRIBUTING.md) and [kbind Project Governance](./GOVERNANCE.md). ## Getting in touch @@ -62,7 +62,7 @@ There are several ways to communicate with us: -See the [community page](https://docs.kube-bind.io/main/community) for more details. +See the [community page](https://docs.kbind.dev/main/community) for more details. ## Technical Overview @@ -72,7 +72,7 @@ All the actions shown between the clusters are done by the konnector, except: th ## Usage -To get familiar with setting up the environment, please check out docs at [kube-bind.io](https://docs.kube-bind.io/main/setup). +To get familiar with setting up the environment, please check out docs at [kbind.dev](https://docs.kbind.dev/main/setup). ### Limitations diff --git a/ROADMAP.md b/ROADMAP.md index b4538892b..0e630375b 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,23 +1,23 @@ -# kube-bind Roadmap +# kbind Roadmap -This roadmap reflects the current direction of the kube-bind project. +This roadmap reflects the current direction of the kbind project. Items are grouped by theme, not strict release milestones. -Track progress via [GitHub Issues](https://github.com/kube-bind/kube-bind/issues). +Track progress via [GitHub Issues](https://github.com/kbind-dev/kbind/issues). ## 🏗️ Production Readiness - **Pluggable session storage** — replace in-memory backend session storage with an external/pluggable implementation, enabling replicas > 1 for HA deployments - ([#424](https://github.com/kube-bind/kube-bind/issues/424), - [#488](https://github.com/kube-bind/kube-bind/issues/488)) + ([#424](https://github.com/kbind-dev/kbind/issues/424), + [#488](https://github.com/kbind-dev/kbind/issues/488)) - **CRD lifecycle / BoundSchema changes** — support schema evolution after initial binding, including updates and versioning - ([#404](https://github.com/kube-bind/kube-bind/issues/404)) + ([#404](https://github.com/kbind-dev/kbind/issues/404)) - **Delete flow** — full lifecycle support for APIServiceExport deletion and graceful unbinding - ([#352](https://github.com/kube-bind/kube-bind/issues/352)) + ([#352](https://github.com/kbind-dev/kbind/issues/352)) - **Backend production hardening** — address remaining gaps for production-grade - deployments ([#284](https://github.com/kube-bind/kube-bind/issues/284)) + deployments ([#284](https://github.com/kbind-dev/kbind/issues/284)) ## 🔌 Feature Completeness @@ -25,43 +25,43 @@ Track progress via [GitHub Issues](https://github.com/kube-bind/kube-bind/issues ConfigMaps and Secrets alongside primary CRDs - **Multi-provider/consumer support** — allow a single consumer cluster to bind the same CRD from multiple providers, and other multi-tenancy scenarios - ([#321](https://github.com/kube-bind/kube-bind/issues/321)) + ([#321](https://github.com/kbind-dev/kbind/issues/321)) - **Object metadata propagation** — propagate selected labels/annotations between provider and consumer objects - ([#315](https://github.com/kube-bind/kube-bind/issues/315)) + ([#315](https://github.com/kbind-dev/kbind/issues/315)) - **Reduced konnector permissions** — tighten RBAC footprint of the konnector agent in consumer clusters - ([#303](https://github.com/kube-bind/kube-bind/issues/303)) + ([#303](https://github.com/kbind-dev/kbind/issues/303)) - **UI-only binding flow** — allow service binding without CLI, purely via browser/OIDC redirect flow - ([#406](https://github.com/kube-bind/kube-bind/issues/406)) + ([#406](https://github.com/kbind-dev/kbind/issues/406)) - **Dry-run support** — fix `--dry-run` in `bind apiservice` - ([#365](https://github.com/kube-bind/kube-bind/issues/365)) + ([#365](https://github.com/kbind-dev/kbind/issues/365)) ## 🌐 Ecosystem Integration - **kcp integration** — make the konnector kcp-aware and support serving from - APIBindings ([#317](https://github.com/kube-bind/kube-bind/issues/317), - [#300](https://github.com/kube-bind/kube-bind/issues/300), - [#323](https://github.com/kube-bind/kube-bind/issues/323)) + APIBindings ([#317](https://github.com/kbind-dev/kbind/issues/317), + [#300](https://github.com/kbind-dev/kbind/issues/300), + [#323](https://github.com/kbind-dev/kbind/issues/323)) - **multicluster-runtime refactor** — refactor the konnector to use [multicluster-runtime](https://github.com/kubernetes-sigs/multicluster-runtime) for improved multi-cluster controller patterns - ([#299](https://github.com/kube-bind/kube-bind/issues/299)) + ([#299](https://github.com/kbind-dev/kbind/issues/299)) - **PlatformMesh integration** — provider-side integration with PlatformMesh - ([#447](https://github.com/kube-bind/kube-bind/issues/447)) + ([#447](https://github.com/kbind-dev/kbind/issues/447)) ## 📖 Documentation & Community - Blog post on external integrations - ([#452](https://github.com/kube-bind/kube-bind/issues/452)) + ([#452](https://github.com/kbind-dev/kbind/issues/452)) - CNCF Sandbox application - ([#448](https://github.com/kube-bind/kube-bind/issues/448)) + ([#448](https://github.com/kbind-dev/kbind/issues/448)) - Adopters file --- This roadmap is maintained by the [kube-bind maintainers](./MAINTAINERS.md). Contributions and feedback welcome via -[GitHub Discussions](https://github.com/kube-bind/kube-bind/discussions) or +[GitHub Discussions](https://github.com/kbind-dev/kbind/discussions) or [`#kube-bind`](https://kubernetes.slack.com/archives/C046PRXNJ4W) on Kubernetes Slack. diff --git a/SECURITY.md b/SECURITY.md index 5405d19df..d93d11225 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,18 +1,18 @@ -# Security Process for kube-bind +# Security Process for kbind ## Reporting a Vulnerability -kube-bind uses GitHub to allow submission of private security reports. Please report any security finding via -[this link](https://github.com/kube-bind/kube-bind/security/advisories/new). +kbind uses GitHub to allow submission of private security reports. Please report any security finding via +[this link](https://github.com/kbind-dev/kbind/security/advisories/new). Maintainers will triage your report as soon as possible and get in touch with you via your report in case they have more questions. -As a security researcher, please report vulnerabilities to kube-bind in a [coordinated vulnerability disclosure (CVD)](https://cheatsheetseries.owasp.org/cheatsheets/Vulnerability_Disclosure_Cheat_Sheet.html) +As a security researcher, please report vulnerabilities to kbind in a [coordinated vulnerability disclosure (CVD)](https://cheatsheetseries.owasp.org/cheatsheets/Vulnerability_Disclosure_Cheat_Sheet.html) fashion. -In return, maintainers pledge to engage in good faith and collaborate with security researchers to address and publish vulnerabilities found in kube-bind as soon as possible. We will not pursue or support legal action for good‑faith security research that adheres to this policy and avoids privacy violations, data exfiltration, or service disruption. +In return, maintainers pledge to engage in good faith and collaborate with security researchers to address and publish vulnerabilities found in kbind as soon as possible. We will not pursue or support legal action for good‑faith security research that adheres to this policy and avoids privacy violations, data exfiltration, or service disruption. -Please understand that the maintainers also do not accept results of dependency scanners without proof that the detected CVE / vulnerability can be used against kube-bind. +Please understand that the maintainers also do not accept results of dependency scanners without proof that the detected CVE / vulnerability can be used against kbind. ## Security Advisories -Advisories are managed through GitHub Security Advisories. Where applicable, we request CVE IDs via GitHub’s CNA during the advisory process and credit reporters upon release. Please visit [Security Advisories](https://github.com/kube-bind/kube-bind/security/advisories) to review security bulletins published by the maintainers. +Advisories are managed through GitHub Security Advisories. Where applicable, we request CVE IDs via GitHub’s CNA during the advisory process and credit reporters upon release. Please visit [Security Advisories](https://github.com/kbind-dev/kbind/security/advisories) to review security bulletins published by the maintainers. diff --git a/docs/README.md b/docs/README.md index c05be7ba5..9b9f68aa7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# kube-bind.io Documentation Setup +# kbind.dev Documentation Setup ## Overview diff --git a/docs/content/community/index.md b/docs/content/community/index.md index 2f2de5071..a4746e690 100644 --- a/docs/content/community/index.md +++ b/docs/content/community/index.md @@ -1,6 +1,6 @@ # Community -kube-bind is built and maintained by an open community. We welcome new contributors, users, and curious onlookers. +kbind is built and maintained by an open community. We welcome new contributors, users, and curious onlookers. ## Communication channels @@ -25,5 +25,5 @@ We hold bi-weekly community meetings — every second Thursday at 11am EST (5pm ## Governance and contributing - [Contributing guide](../contributing/index.md) -- [Project governance](https://github.com/kube-bind/kube-bind/blob/main/GOVERNANCE.md) -- [Code of conduct](https://github.com/kube-bind/kube-bind/blob/main/code-of-conduct.md) +- [Project governance](https://github.com/kbind-dev/kbind/blob/main/GOVERNANCE.md) +- [Code of conduct](https://github.com/kbind-dev/kbind/blob/main/code-of-conduct.md) diff --git a/docs/content/contributing/index.md b/docs/content/contributing/index.md index e6f1eb045..7082c9a78 100644 --- a/docs/content/contributing/index.md +++ b/docs/content/contributing/index.md @@ -1,6 +1,6 @@ -# Contributing to kube-bind +# Contributing to kbind -kube-bind is [Apache 2.0 licensed](https://github.com/kube-bind/kube-bind/tree/main/LICENSE) and we accept contributions via +kbind is [Apache 2.0 licensed](https://github.com/kbind-dev/kbind/tree/main/LICENSE) and we accept contributions via GitHub pull requests. Please read the following guide if you're interested in contributing to kube-bind. @@ -10,7 +10,7 @@ Please read the following guide if you're interested in contributing to kube-bin 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](https://github.com/kube-bind/kube-bind/tree/main/DCO) file for details. +contribution. See the [DCO](https://github.com/kbind-dev/kbind/tree/main/DCO) file for details. ## Getting Started @@ -26,20 +26,20 @@ More on the development environment setup can be found in the [developer guide]( 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: -* [Good first issue](https://github.com/kube-bind/kube-bind/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) issues -* [Help wanted](https://github.com/kube-bind/kube-bind/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues +* [Good first issue](https://github.com/kbind-dev/kbind/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) issues +* [Help wanted](https://github.com/kbind-dev/kbind/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues 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. 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. -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 embark 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), send a discussion to our [mailing list](https://groups.google.com/g/kube-bind-dev), and/or join one of our [community meetings](https://docs.google.com/document/d/1qztpKOmdZu5iWq_4N9n3AZpcAPuPhBiGNbje5GPg0iM). +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 embark 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), send a discussion to our [mailing list](https://groups.google.com/g/kube-bind-dev), and/or join one of our [community meetings](https://docs.google.com/document/d/1qztpKOmdZu5iWq_4N9n3AZpcAPuPhBiGNbje5GPg0iM). 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. ### Getting your PR Merged -The `kube-bind` project uses `OWNERS` files to denote the collaborators who can assist you in getting your PR merged. There +The `kbind` project uses `OWNERS` files to denote the collaborators who can assist you in getting your PR merged. There are two roles: reviewer and approver. Merging a PR requires sign off from both a reviewer and an approver. ## Community Roles diff --git a/docs/content/index.md b/docs/content/index.md index 80905e7f9..45f134481 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -1,8 +1,8 @@ -# kube-bind Documentation +# kbind Documentation -## Overview +## Overview -kube-bind is a project that aims to provide better support for service providers and consumers that reside in distinct Kubernetes clusters. +kbind (formerly known as kube-bind) is a project that aims to provide better support for service providers and consumers that reside in distinct Kubernetes clusters. We are actively working towards a stable release, and welcome feedback from the community. ![High-level architecture diagram](high-level.png) @@ -16,7 +16,7 @@ We are actively working towards a stable release, and welcome feedback from the ## Getting Started -- **[Quickstart](./setup/quickstart.md)** - Get up and running with kube-bind quickly +- **[Quickstart](./setup/quickstart.md)** - Get up and running with kbind quickly - **[Setup Guide](./setup/index.md)** - Complete installation and deployment options - **[Usage Guide](./usage/index.md)** - Learn the core concepts and APIs @@ -38,4 +38,4 @@ There are several ways to communicate with us: -See the [community page](./community/index.md) for more details. \ No newline at end of file +See the [community page](./community/index.md) for more details. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b6ffda233..0c49ca305 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,7 +1,7 @@ -site_name: kube-bind -repo_url: https://github.com/kube-bind/kube-bind -repo_name: kube-bind/kube-bind -site_url: https://docs.kube-bind.io/ +site_name: kbind +repo_url: https://github.com/kbind-dev/kbind +repo_name: kbind-dev/kbind +site_url: https://docs.kbind.dev/ # Site content docs_dir: "content" @@ -60,12 +60,12 @@ extra: social: - icon: fontawesome/brands/github - link: https://github.com/kube-bind + link: https://github.com/kbind-dev - icon: fontawesome/brands/slack link: https://kubernetes.slack.com/archives/C021U8WSAFK image: high-level.png - title: kube-bind + title: kbind description: "Bind APIs from other clusters." plugins: