rename ctrlmesh

Author: Eikykun

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
-<!-- Thank you for contributing to Kridge!
+<!-- Thank you for contributing to ctrlmesh!
 
 Note: 
 

.github/workflows/release.yaml

@@ -103,7 +103,7 @@ jobs:
       with:
         go-version: ${{ env.GO_VERSION }}
         cache: false
-    - name: Release the kridge with GoReleaser
+    - name: Release the ctrlmesh with GoReleaser
       uses: goreleaser/goreleaser-action@v4
       with:
         distribution: goreleaser

.gitignore

@@ -19,3 +19,4 @@ bin/
 .idea/**
 demo/**
 testdemo/**
+.DS_Store

.goreleaser.yaml

@@ -22,8 +22,8 @@ builds:
   ldflags:
   - -s -w
   main: ./pkg/cmd/manager
-  id: "kridge-manager"
-  binary: kridge-manager
+  id: "ctrlmesh-manager"
+  binary: ctrlmesh-manager
 - env:
   - CGO_ENABLED=0
   # GOOS list to build for.
@@ -39,8 +39,8 @@ builds:
   ldflags:
   - -s -w
   main: ./pkg/cmd/proxy
-  id: "kridge-proxy"
-  binary: kridge-proxy
+  id: "ctrlmesh-proxy"
+  binary: ctrlmesh-proxy
 - env:
   - CGO_ENABLED=0
   goos:
@@ -60,7 +60,7 @@ archives:
   - "manager"
   - "proxy"
   - "cert-generator"
-  name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
+  name_template: "ctrlmesh_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
   builds_info:
     mode: 0644
     # format is `time.RFC3339Nano`
@@ -130,49 +130,49 @@ changelog:
 release:
   github:
     owner: KusionStack
-    name: kridge
+    name: controller-mesh
   draft: false
   footer: |
     ## Docker Images
-    * `kusionstack/kridge-manager:{{ .Tag }}`
-    * `kusionstack/kridge-proxy:{{ .Tag }}`
-    * `kusionstack/kridge-init:{{ .Tag }}`
+    * `kusionstack/ctrlmesh-manager:{{ .Tag }}`
+    * `kusionstack/ctrlmesh-proxy:{{ .Tag }}`
+    * `kusionstack/ctrlmesh-init:{{ .Tag }}`
 
 dockers:
 - id: manager
   ids:
-  - kridge-manager
+  - ctrlmesh-manager
   goos: linux
   goarch: amd64
   image_templates:
-  - 'kusionstack/{{ .ProjectName }}-manager:{{ .Tag }}'
-  - 'kusionstack/{{ .ProjectName }}-manager:latest'
+  - 'kusionstack/ctrlmesh-manager:{{ .Tag }}'
+  - 'kusionstack/ctrlmesh-manager:latest'
   dockerfile: ./artifacts/goreleaser/manager.Dockerfile
   use: docker
   build_flag_templates:
   - "--pull"
   - "--label=org.opencontainers.image.created={{.Date}}"
-  - "--label=org.opencontainers.image.name={{.ProjectName}}-manager"
+  - "--label=org.opencontainers.image.name=ctrlmesh-manager"
   - "--label=org.opencontainers.image.revision={{.FullCommit}}"
   - "--label=org.opencontainers.image.version={{.Version}}"
   - "--label=org.opencontainers.image.source={{.GitURL}}"
   - "--platform=linux/amd64"
 - id: proxy
   ids:
-  - kridge-proxy
+  - ctrlmesh-proxy
   goos: linux
   goarch: amd64
   image_templates:
-  - 'kusionstack/{{ .ProjectName }}-proxy:{{ .Tag }}'
-  - 'kusionstack/{{ .ProjectName }}-proxy:latest'
+  - 'kusionstack/ctrlmesh-proxy:{{ .Tag }}'
+  - 'kusionstack/ctrlmesh-proxy:latest'
   dockerfile: ./artifacts/goreleaser/proxy.Dockerfile
   extra_files:
   - artifacts/scripts/
   use: docker
   build_flag_templates:
   - "--pull"
   - "--label=org.opencontainers.image.created={{.Date}}"
-  - "--label=org.opencontainers.image.name={{.ProjectName}}-proxy"
+  - "--label=org.opencontainers.image.name=ctrlmesh-proxy"
   - "--label=org.opencontainers.image.revision={{.FullCommit}}"
   - "--label=org.opencontainers.image.version={{.Version}}"
   - "--label=org.opencontainers.image.source={{.GitURL}}"
@@ -183,16 +183,16 @@ dockers:
   goos: linux
   goarch: amd64
   image_templates:
-  - 'kusionstack/{{ .ProjectName }}-init:{{ .Tag }}'
-  - 'kusionstack/{{ .ProjectName }}-init:latest'
+  - 'kusionstack/ctrlmesh-init:{{ .Tag }}'
+  - 'kusionstack/ctrlmesh-init:latest'
   dockerfile: ./artifacts/goreleaser/init.Dockerfile
   extra_files:
   - artifacts/scripts/
   use: docker
   build_flag_templates:
   - "--pull"
   - "--label=org.opencontainers.image.created={{.Date}}"
-  - "--label=org.opencontainers.image.name={{.ProjectName}}-init"
+  - "--label=org.opencontainers.image.name=ctrlmesh-init"
   - "--label=org.opencontainers.image.revision={{.FullCommit}}"
   - "--label=org.opencontainers.image.version={{.Version}}"
   - "--label=org.opencontainers.image.source={{.GitURL}}"

Makefile

@@ -38,7 +38,7 @@ help: ## Display this help.
 ##@ Development
 
 manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
-	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=kridge-kusionstack-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
+	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=ctrlmesh-kusionstack-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
 
 generate-client: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	@artifacts/scripts/generate_client.sh

README.md

@@ -3,9 +3,9 @@
 [简体中文](https://github.com/KusionStack/kusion/blob/main/README-zh.md)
 | [English](https://github.com/KusionStack/kusion/blob/main/README.md)
 
-# Kridge
+# Controller Mesh
 
-Kridge is a solution that helps developers manage their controllers/operators better.
+KusionStack Controller Mesh is a solution that helps developers manage their controllers/operators better.
 
 The design architecture of this project is based on [openkruise/controllermesh](https://github.com/openkruise/controllermesh).
 
@@ -16,7 +16,7 @@ The design architecture of this project is based on [openkruise/controllermesh](
 3. **Circuit breaker and rate limiter**: Not only Kubernetes operation requests, but also other external operation requests.
 4. **Multicluster routing and sharding**: This feature is supported by [kusionstack/kaera(karbour)]()
 
-<p align="center"><img width="800" src="./docs/img/img5.png"/></p>
+<p align="center"><img width="800" src="./docs/img/mesh-arch-2.png"/></p>
 
 ## Quick Start
 Visit [Quick Start]().
@@ -32,34 +32,34 @@ $ helm repo add kusionstack https://kusionstack.io/charts
 $ helm repo update
 
 # Install the latest version.
-$ helm install kridge kusionstack/kridge --version v0.1.0
+$ helm install ctrlmesh kusionstack/ctrlmesh --version v0.1.0
 
 # Uninstall
-$ helm uninstall kridge
+$ helm uninstall ctrlmesh
 ```
 **Proxy**  
 1. Apply your [ShardingConfig]().
-2. Add label `kridge.kusionstack.io/enable-proxy=true` on pod template.
+2. Add label `ctrlmesh.kusionstack.io/enable-proxy=true` on pod template.
 
 
 ## Principles
 
-Generally, a `kridge-proxy` container will be injected into each operator Pod that has configured in Kridge.
+Generally, a `ctrlmesh-proxy` container will be injected into each operator Pod that has configured in ShardingConfigs.
 This proxy container will intercept and handle the connection by between API/Oth Server and controllers/webhooks in the Pod.
 
-<p align="center"><img width="550" src="./docs/img/img3.png"/></p>
+<p align="center"><img width="550" src="./docs/img/fake-configmap.png"/></p>
 
 ApiServer proxy method:
 - *iptables nat*: 
 - *fake kubeconfig*: 
 
-The `kridge-manager` dispatches rules to the proxies, so that they can route requests according to the rules.
+The `ctrlmesh-manager` dispatches rules to the proxies, so that they can route requests according to the rules.
 
 
-A core CRD in Kridge is `ShardingConfig`. It contains all rules for user's controller:
+A core CRD in ControllerMesh is `ShardingConfig`. It contains all rules for user's controller:
 
 ```yaml
-apiVersion: kridge.kusionstack.io/v1alpha1
+apiVersion: ctrlmesh.kusionstack.io/v1alpha1
 kind: ShardingConfig
 metadata:
   name: sharding-demo
@@ -79,7 +79,7 @@ spec:
       - services
     selector:
       matchExpressions:
-      - key: kridge.kusionstack.io/namespace
+      - key: ctrlmesh.kusionstack.io/namespace
         operator: In
         values:
         - ns-a
@@ -101,19 +101,19 @@ spec:
 
 When `manager` is first launched, shard labels will be added to all configured resources.
 
-- `kridge.kusionstack.io/sharding-hash`: the hash value calculated based on the namespace ranges from 0 to 31.
-- `kridge.kusionstack.io/namespace`: the namespace referring to this resource.
-- `kridge.kusionstack.io/control`: under kridge control.
+- `ctrlmesh.kusionstack.io/sharding-hash`: the hash value calculated based on the namespace ranges from 0 to 31.
+- `ctrlmesh.kusionstack.io/namespace`: the namespace referring to this resource.
+- `ctrlmesh.kusionstack.io/control`: under ctrlmesh-manager control.
 
 
-In this repo, Kridge only support `ObjectSelector` type of flow control,
-which means the `kridge-proxy `will proxy list&watch requests to the ApiServer, 
+In this repo, we only support `ObjectSelector` type of flow control,
+which means the `ctrlmesh-proxy `will proxy http/s requests to the ApiServer, 
 and inject a `LabelSelector` into the request param for the requested resource type.
 
 
 
 
 Router:
 
-<p align="center"><img width="500" src="./docs/img/img1.png"/></p>
+<p align="center"><img width="600" src="./docs/img/mesh-proxy.png"/></p>
 

artifacts/goreleaser/manager.Dockerfile

@@ -1,11 +1,11 @@
 FROM ubuntu:focal
 
 WORKDIR /
-COPY kridge-manager .
+COPY ctrlmesh-manager .
 
 RUN ln -s /usr/bin/* /usr/sbin/ && apt-get update -y \
   && apt-get install --no-install-recommends -y ca-certificates \
   && apt-get clean && rm -rf /var/log/*log /var/lib/apt/lists/* /var/log/apt/* /var/lib/dpkg/*-old /var/cache/debconf/*-old
 
 
-ENTRYPOINT ["/kridge-manager"]
+ENTRYPOINT ["/ctrlmesh-manager"]

artifacts/goreleaser/proxy.Dockerfile

@@ -1,7 +1,7 @@
 FROM ubuntu:focal
 
 WORKDIR /
-COPY kridge-proxy .
+COPY ctrlmesh-proxy .
 
 RUN apt-get update && \
   apt-get install --no-install-recommends -y \
@@ -20,10 +20,10 @@ RUN apt-get update && \
   rm -rf  /var/log/*log /var/lib/apt/lists/* /var/log/apt/* /var/lib/dpkg/*-old /var/cache/debconf/*-old
 
 # Sudoers used to allow tcpdump and other debug utilities.
-RUN useradd -m --uid 1359 kridge-proxy && \
-  echo "kridge-proxy ALL=NOPASSWD: ALL" >> /etc/sudoers
+RUN useradd -m --uid 1359 ctrlmesh-proxy && \
+  echo "ctrlmesh-proxy ALL=NOPASSWD: ALL" >> /etc/sudoers
 
 COPY artifacts/scripts/proxy-poststart.sh /poststart.sh
-RUN mkdir /kridge && chmod 777 /kridge
+RUN mkdir /ctrlmesh && chmod 777 /ctrlmesh
 
-ENTRYPOINT ["/kridge-proxy"]
+ENTRYPOINT ["/ctrlmesh-proxy"]

artifacts/images/manager.Dockerfile

@@ -9,7 +9,7 @@ COPY artifacts/ artifacts/
 COPY pkg/ pkg/
 COPY vendor/ vendor/
 
-RUN CGO_ENABLED=0 GO111MODULE=on GOOS=linux GOARCH=amd64 go build -mod=vendor -a -o kridge-manager ./pkg/cmd/manager/main.go
+RUN CGO_ENABLED=0 GO111MODULE=on GOOS=linux GOARCH=amd64 go build -mod=vendor -a -o ctrlmesh-manager ./pkg/cmd/manager/main.go
 
 
 FROM ubuntu:focal
@@ -18,5 +18,5 @@ RUN ln -s /usr/bin/* /usr/sbin/ && apt-get update -y \
   && apt-get install --no-install-recommends -y ca-certificates \
   && apt-get clean && rm -rf /var/log/*log /var/lib/apt/lists/* /var/log/apt/* /var/lib/dpkg/*-old /var/cache/debconf/*-old
 WORKDIR /
-COPY --from=builder /workspace/kridge-manager .
-ENTRYPOINT ["/kridge-manager"]
+COPY --from=builder /workspace/ctrlmesh-manager .
+ENTRYPOINT ["/ctrlmesh-manager"]

artifacts/images/proxy.Dockerfile

@@ -8,7 +8,7 @@ COPY artifacts/ artifacts/
 COPY pkg/ pkg/
 COPY vendor/ vendor/
 
-RUN CGO_ENABLED=0 GO111MODULE=on GOOS=linux GOARCH=amd64 go build -mod=vendor -a -o kridge-proxy ./pkg/cmd/proxy/main.go
+RUN CGO_ENABLED=0 GO111MODULE=on GOOS=linux GOARCH=amd64 go build -mod=vendor -a -o ctrlmesh-proxy ./pkg/cmd/proxy/main.go
 
 FROM ubuntu:focal
 
@@ -29,10 +29,10 @@ RUN apt-get update && \
   rm -rf  /var/log/*log /var/lib/apt/lists/* /var/log/apt/* /var/lib/dpkg/*-old /var/cache/debconf/*-old
 
 # Sudoers used to allow tcpdump and other debug utilities.
-RUN useradd -m --uid 1359 kridge-proxy && \
-  echo "kridge-proxy ALL=NOPASSWD: ALL" >> /etc/sudoers
+RUN useradd -m --uid 1359 ctrlmesh-proxy && \
+  echo "ctrlmesh-proxy ALL=NOPASSWD: ALL" >> /etc/sudoers
 WORKDIR /
 COPY artifacts/scripts/proxy-poststart.sh /poststart.sh
-RUN mkdir /kridge && chmod 777 /kridge
-COPY --from=builder /workspace/kridge-proxy .
-ENTRYPOINT ["/kridge-proxy"]
+RUN mkdir /ctrlmesh && chmod 777 /ctrlmesh
+COPY --from=builder /workspace/ctrlmesh-proxy .
+ENTRYPOINT ["/ctrlmesh-proxy"]