Skip to content

Commit f026310

Browse files
authored
Spell kube-bind and kcp consistently (#354)
* lowercase kcp On-behalf-of: @SAP christoph.mewes@sap.com * lowercase kube-bind On-behalf-of: @SAP christoph.mewes@sap.com
1 parent fadb9ed commit f026310

15 files changed

Lines changed: 43 additions & 44 deletions

File tree

cli/cmd/kubectl-bind/cmd/kubectlBind_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ func TestKubectlBindCommand(t *testing.T) {
2929
rootCmd := KubectlBindCommand()
3030

3131
require.Equal(t, "kubectl-bind", rootCmd.Use, "Unexpected one-line command description")
32-
require.Equal(t, "kubectl plugin for Kube-Bind.io, bind different remote types into the current cluster.", rootCmd.Short, "Unexpected short command description")
32+
require.Equal(t, "kubectl plugin for kube-bind, bind different remote types into the current cluster.", rootCmd.Short, "Unexpected short command description")
3333
require.Contains(t, rootCmd.Long, "To bind a remote service, use the 'kubectl bind' command.", "Unexpected lond command Long")
3434
require.Equal(t, rootCmd.Example, fmt.Sprintf(bindcmd.BindExampleUses, "kubectl"), "Unexpected command Example")
3535
}

cli/pkg/kubectl/bind/cmd/cmd.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func New(streams genericclioptions.IOStreams) (*cobra.Command, error) {
5353
opts := plugin.NewBindOptions(streams)
5454
cmd := &cobra.Command{
5555
Use: "bind",
56-
Short: "kubectl plugin for Kube-Bind.io, bind different remote types into the current cluster.",
56+
Short: "kubectl plugin for kube-bind, bind different remote types into the current cluster.",
5757
Long: help.Doc(`
5858
kube-bind is a project that aims to provide better support for
5959
service providers and consumers that reside in distinct Kubernetes clusters.

contrib/kcp/hack/update-kcp-codegen.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ fi
2626

2727
REPO_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)
2828

29-
# Generate KCP API resources from CRDs
29+
# Generate kcp API resources from CRDs
3030
(
3131
${KCP_APIGEN_GEN} --input-dir "${REPO_ROOT}"/deploy/crd --output-dir "${REPO_ROOT}"/contrib/kcp/deploy/resources
3232
)

contrib/kcp/test/e2e/backend.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ func bootstrapBackend(t *testing.T, server kcptestingserver.RunningServer, scope
6060

6161
_, backendKubeconfig := wsConfig(t, server, logicalcluster.NewPath("root").Join("kube-bind"))
6262

63-
t.Log("Starting kube-bind backend for KCP")
63+
t.Log("Starting kube-bind backend for kcp")
6464
addr, _ := framework.StartBackend(t,
6565
"--kubeconfig="+backendKubeconfig,
6666
"--multicluster-runtime-provider=kcp",

contrib/kcp/test/e2e/browser.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ func performBindingWithBrowser(t *testing.T, backendAddr string, clusterID strin
7878
})
7979
}
8080

81-
// simulateKCPBrowser simulates browser interaction for KCP binding using templates.
81+
// simulateKCPBrowser simulates browser interaction for kcp binding using templates.
8282
func simulateKCPBrowser(t *testing.T, authURLCh chan string, template string) {
8383
browser := surf.NewBrowser()
8484
authURL := <-authURLCh

contrib/kcp/test/e2e/kcp.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ func createApiBinding(t testing.TB, client *kcpclientset.ClusterClientset, path
129129

130130
func bootstrapKCP(t testing.TB, server kcptestingserver.RunningServer) {
131131
t.Helper()
132-
t.Log("Bootstrapping KCP")
132+
t.Log("Bootstrapping kcp")
133133

134134
cfg := server.BaseConfig(t)
135135
cfg.Host += "/clusters/root"

contrib/kcp/test/e2e/kcp_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func TestKCPNamespacedScope(t *testing.T) {
5050

5151
func testKcpIntegration(t *testing.T, scope kubebindv1alpha2.InformerScope) {
5252
t.Helper()
53-
t.Logf("Testing KCP integration with informer scope %s, tempdir: %s", scope, t.TempDir())
53+
t.Logf("Testing kcp integration with informer scope %s, tempdir: %s", scope, t.TempDir())
5454

5555
// dex
5656
framework.StartDex(t)

deploy/charts/backend/Chart.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: backend
3-
description: A Helm chart for Kube-bind backend deployment
3+
description: A Helm chart for kube-bind backend deployment
44

55
# A chart can be either an 'application' or a 'library' chart.
66
#
@@ -21,4 +21,4 @@ version: 0.1.0
2121
# incremented each time you make changes to the application. Versions are not expected to
2222
# follow Semantic Versioning. They should reflect the version the application is using.
2323
# It is recommended to use it with quotes.
24-
appVersion: "v0.5.1"
24+
appVersion: "v0.5.1"

docs/content/developers/backend/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Starting with v0.5.0, the backend leverages `sigs.k8s.io/multicluster-runtime` f
1515
### Supported Providers
1616

1717
- **Default Provider**: Standard Kubernetes cluster support
18-
- **KCP Provider**: Integration with [kcp](https://github.com/kcp-dev/kcp) through `github.com/kcp-dev/multicluster-provider`
18+
- **kcp Provider**: Integration with [kcp](https://www.kcp.io/) through `github.com/kcp-dev/multicluster-provider`
1919

2020
## Configuration
2121

@@ -30,12 +30,12 @@ The backend can be configured to use different providers:
3030

3131
### Provider Configuration
3232

33-
#### KCP Provider
33+
#### kcp Provider
3434

35-
When using the KCP provider (`--multicluster-runtime-provider kcp`), the backend:
35+
When using the kcp provider (`--multicluster-runtime-provider kcp`), the backend:
3636

3737
- Connects to kcp workspaces through APIExports
38-
- Manages resources across logical clusters
38+
- Manages resources across logical clusters
3939
- Supports advanced multi-tenancy features
4040
- Enables workspace-based isolation
4141

docs/content/setup/helm.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: >
55

66
# Installation with Helm
77

8-
Kube-bind can be installed on an existing Kubernetes cluster using the official Helm OCI charts.
8+
kube-bind can be installed on an existing Kubernetes cluster using the official Helm OCI charts.
99
The backend chart is available as an OCI image for service providers, with konnector charts coming soon for service consumers.
1010

1111
## Quick Start
@@ -21,21 +21,21 @@ The following prerequisites are required. Click the links below for detailed set
2121
- **[cert-manager](#cert-manager-setup)** - For TLS certificate management
2222
- **[OIDC provider](#oidc-provider-setup)** - For authentication (Dex, Keycloak, etc.)
2323

24-
### Install Kube-Bind Backend
24+
### Install kube-bind Backend
2525

2626
1. **Get the latest chart version:**
27-
27+
2828
Visit the [releases page](https://github.com/kube-bind/kube-bind/releases) or check available versions:
2929
```bash
3030
# For latest tag version (recommended for production):
3131
VERSION=$(curl -s https://api.github.com/repos/kube-bind/kube-bind/releases/latest | grep '"tag_name"' | cut -d'"' -f4 | sed 's/v//')
32-
32+
3333
# Or use a specific development version:
3434
# VERSION=0.0.0-<git-sha>
3535
```
3636

3737
2. **Configure your values:**
38-
38+
3939
Edit `deploy/charts/backend/examples/values-local-development.yaml` and replace the placeholder values:
4040
- `### REPLACE ME ###` with your actual OIDC credentials
4141
- Update hostnames to match your setup
@@ -48,7 +48,7 @@ The following prerequisites are required. Click the links below for detailed set
4848
--create-namespace \
4949
--values ./deploy/charts/backend/examples/values-local-development.yaml \
5050
kube-bind oci://ghcr.io/kube-bind/charts/backend --version ${VERSION}
51-
51+
5252
# Or install a specific development version
5353
# helm upgrade --install \
5454
# --namespace kube-bind \
@@ -150,7 +150,7 @@ EOF
150150

151151
### OIDC Provider Setup
152152

153-
Kube-bind requires an OIDC provider for authentication. Here's how to set up Dex as an example:
153+
kube-bind requires an OIDC provider for authentication. Here's how to set up Dex as an example:
154154

155155
#### Install Dex OIDC Provider
156156

@@ -186,21 +186,21 @@ helm repo add dex https://charts.dexidp.io
186186
cat > /tmp/dex-values.yaml <<EOF
187187
config:
188188
issuer: https://auth.example.com # Replace with your domain
189-
189+
190190
logger:
191191
level: "debug"
192-
192+
193193
storage:
194194
type: kubernetes
195195
config:
196196
inCluster: true
197-
197+
198198
web:
199199
https: 0.0.0.0:5557
200200
tlsCert: /etc/dex/tls/tls.crt
201201
tlsKey: /etc/dex/tls/tls.key
202202
http: "0.0.0.0:5556"
203-
203+
204204
connectors:
205205
- type: github
206206
id: github
@@ -210,7 +210,7 @@ config:
210210
clientSecret: ### REPLACE ME ###
211211
redirectURI: https://auth.example.com/callback
212212
org: your-org # Replace with your GitHub org
213-
213+
214214
staticClients:
215215
- id: kube-bind
216216
redirectURIs:
@@ -264,7 +264,7 @@ For production deployments, create your own values file based on the example.
264264

265265
## Available OCI Charts
266266

267-
Kube-bind Helm charts are published as OCI images to GitHub Container Registry:
267+
kube-bind Helm charts are published as OCI images to GitHub Container Registry:
268268

269269
### Backend Chart
270270
- **Registry**: `oci://ghcr.io/kube-bind/charts/backend`
@@ -292,7 +292,7 @@ Development charts are built from every commit to the main branch with the forma
292292
# Install latest stable release (recommended for production)
293293
helm upgrade --install kube-bind oci://ghcr.io/kube-bind/charts/backend --version ${VERSION}
294294

295-
# Install specific release version
295+
# Install specific release version
296296
helm upgrade --install kube-bind oci://ghcr.io/kube-bind/charts/backend --version 1.0.0
297297

298298
# Install development build (for testing)

0 commit comments

Comments
 (0)